# File generated from our OpenAPI spec
# frozen_string_literal: true
# typed: true
module Stripe
module FinancialConnections
# Describes an owner of an account.
class AccountOwner < StripeObject
# The email address of the owner.
sig { returns(T.nilable(String)) }
def email; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The full name of the owner.
sig { returns(String) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The ownership object that this owner belongs to.
sig { returns(String) }
def ownership; end
# The raw phone number of the owner.
sig { returns(T.nilable(String)) }
def phone; end
# The raw physical address of the owner.
sig { returns(T.nilable(String)) }
def raw_address; end
# The timestamp of the refresh that updated this owner.
sig { returns(T.nilable(Integer)) }
def refreshed_at; end
end
end
end
# typed: true
module Stripe
module FinancialConnections
# Describes a snapshot of the owners of an account at a particular point in time.
class AccountOwnership < StripeObject
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# A paginated list of owners for this account.
sig { returns(Stripe::ListObject) }
def owners; end
end
end
end
# typed: true
module Stripe
module Entitlements
# A summary of a customer's active entitlements.
class ActiveEntitlementSummary < APIResource
# The customer that is entitled to this feature.
sig { returns(String) }
def customer; end
# The list of entitlements this customer has.
sig { returns(Stripe::ListObject) }
def entitlements; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
end
end
end
# typed: true
module Stripe
module Billing
class AlertTriggered < APIResource
# A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.
sig { returns(Stripe::Billing::Alert) }
def alert; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# ID of customer for which the alert triggered
sig { returns(String) }
def customer; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The value triggering the alert
sig { returns(String) }
def value; end
end
end
end
# typed: true
module Stripe
class Application < APIResource
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The name of the application.
sig { returns(T.nilable(String)) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
end
end
# typed: true
module Stripe
module Tax
# A Tax Association exposes the Tax Transactions that Stripe attempted to create on your behalf based on the PaymentIntent input
class Association < APIResource
class TaxTransactionAttempt < Stripe::StripeObject
class Committed < Stripe::StripeObject
# The [Tax Transaction](https://stripe.com/docs/api/tax/transaction/object)
sig { returns(String) }
def transaction; end
end
class Errored < Stripe::StripeObject
# Details on why we couldn't commit the tax transaction.
sig { returns(String) }
def reason; end
end
# Attribute for field committed
sig { returns(T.nilable(Committed)) }
def committed; end
# Attribute for field errored
sig { returns(T.nilable(Errored)) }
def errored; end
# The source of the tax transaction attempt. This is either a refund or a payment intent.
sig { returns(String) }
def source; end
# The status of the transaction attempt. This can be `errored` or `committed`.
sig { returns(String) }
def status; end
end
# The [Tax Calculation](https://stripe.com/docs/api/tax/calculations/object) that was included in PaymentIntent.
sig { returns(String) }
def calculation; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The [PaymentIntent](https://stripe.com/docs/api/payment_intents/object) that this Tax Association is tracking.
sig { returns(String) }
def payment_intent; end
# Information about the tax transactions linked to this payment intent
sig { returns(T.nilable(T::Array[TaxTransactionAttempt])) }
def tax_transaction_attempts; end
class FindParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Valid [PaymentIntent](https://stripe.com/docs/api/payment_intents/object) id
sig { returns(String) }
def payment_intent; end
sig { params(_payment_intent: String).returns(String) }
def payment_intent=(_payment_intent); end
sig { params(expand: T.nilable(T::Array[String]), payment_intent: String).void }
def initialize(expand: nil, payment_intent: nil); end
end
# Finds a tax association object by PaymentIntent id.
sig {
params(params: T.any(::Stripe::Tax::Association::FindParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Association)
}
def self.find(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
# These bank accounts are payment methods on `Customer` objects.
#
# On the other hand [External Accounts](https://docs.stripe.com/api#external_accounts) are transfer
# destinations on `Account` objects for connected accounts.
# They can be bank accounts or debit cards as well, and are documented in the links above.
#
# Related guide: [Bank debits and transfers](https://docs.stripe.com/payments/bank-debits-transfers)
class BankAccount < APIResource
class FutureRequirements < Stripe::StripeObject
class Error < Stripe::StripeObject
# The code for the type of error.
sig { returns(String) }
def code; end
# An informative message that indicates the error type and provides additional details about the error.
sig { returns(String) }
def reason; end
# The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
sig { returns(String) }
def requirement; end
end
# Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
sig { returns(T.nilable(T::Array[String])) }
def currently_due; end
# Fields that are `currently_due` and need to be collected again because validation or verification failed.
sig { returns(T.nilable(T::Array[Error])) }
def errors; end
# Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account.
sig { returns(T.nilable(T::Array[String])) }
def past_due; end
# Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
sig { returns(T.nilable(T::Array[String])) }
def pending_verification; end
end
class Requirements < Stripe::StripeObject
class Error < Stripe::StripeObject
# The code for the type of error.
sig { returns(String) }
def code; end
# An informative message that indicates the error type and provides additional details about the error.
sig { returns(String) }
def reason; end
# The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
sig { returns(String) }
def requirement; end
end
# Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
sig { returns(T.nilable(T::Array[String])) }
def currently_due; end
# Fields that are `currently_due` and need to be collected again because validation or verification failed.
sig { returns(T.nilable(T::Array[Error])) }
def errors; end
# Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account.
sig { returns(T.nilable(T::Array[String])) }
def past_due; end
# Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
sig { returns(T.nilable(T::Array[String])) }
def pending_verification; end
end
# The account this bank account belongs to. Only applicable on Accounts (not customers or recipients) This property is only available when returned as an [External Account](/api/external_account_bank_accounts/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# The name of the person or business that owns the bank account.
sig { returns(T.nilable(String)) }
def account_holder_name; end
# The type of entity that holds the account. This can be either `individual` or `company`.
sig { returns(T.nilable(String)) }
def account_holder_type; end
# The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
sig { returns(T.nilable(String)) }
def account_type; end
# A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.
sig { returns(T.nilable(T::Array[String])) }
def available_payout_methods; end
# Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
sig { returns(T.nilable(String)) }
def bank_name; end
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
# Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.
sig { returns(String) }
def currency; end
# The ID of the customer that the bank account is associated with.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# Whether this bank account is the default external account for its currency.
sig { returns(T.nilable(T::Boolean)) }
def default_for_currency; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
sig { returns(T.nilable(FutureRequirements)) }
def future_requirements; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The last four digits of the bank account number.
sig { returns(String) }
def last4; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Information about the requirements for the bank account, including what information needs to be collected.
sig { returns(T.nilable(Requirements)) }
def requirements; end
# The routing transit number for the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
# For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.
#
# For external accounts, possible values are `new`, `errored` and `verification_failed`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.
sig { returns(String) }
def status; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
end
end
# typed: true
module Stripe
module Tax
class CalculationLineItem < APIResource
class TaxBreakdown < Stripe::StripeObject
class Jurisdiction < Stripe::StripeObject
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
# A human-readable name for the jurisdiction imposing the tax.
sig { returns(String) }
def display_name; end
# Indicates the level of the jurisdiction imposing the tax.
sig { returns(String) }
def level; end
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.
sig { returns(T.nilable(String)) }
def state; end
end
class TaxRateDetails < Stripe::StripeObject
# A localized display name for tax type, intended to be human-readable. For example, "Local Sales and Use Tax", "Value-added tax (VAT)", or "Umsatzsteuer (USt.)".
sig { returns(String) }
def display_name; end
# The tax rate percentage as a string. For example, 8.5% is represented as "8.5".
sig { returns(String) }
def percentage_decimal; end
# The tax type, such as `vat` or `sales_tax`.
sig { returns(String) }
def tax_type; end
end
# The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
# Attribute for field jurisdiction
sig { returns(Jurisdiction) }
def jurisdiction; end
# Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address).
sig { returns(String) }
def sourcing; end
# Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax.
sig { returns(T.nilable(TaxRateDetails)) }
def tax_rate_details; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(String) }
def taxability_reason; end
# The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def taxable_amount; end
end
# The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
sig { returns(Integer) }
def amount; end
# The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount_tax; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The ID of an existing [Product](https://stripe.com/docs/api/products/object).
sig { returns(T.nilable(String)) }
def product; end
# The number of units of the item being purchased. For reversals, this is the quantity reversed.
sig { returns(Integer) }
def quantity; end
# A custom identifier for this line item.
sig { returns(String) }
def reference; end
# Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.
sig { returns(String) }
def tax_behavior; end
# Detailed account of taxes relevant to this line item.
sig { returns(T.nilable(T::Array[TaxBreakdown])) }
def tax_breakdown; end
# The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.
sig { returns(String) }
def tax_code; end
end
end
end
# typed: true
module Stripe
# You can store multiple cards on a customer in order to charge the customer
# later. You can also store multiple debit cards on a recipient in order to
# transfer to those cards later.
#
# Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)
class Card < APIResource
class Networks < Stripe::StripeObject
# The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.
sig { returns(T.nilable(String)) }
def preferred; end
end
# Attribute for field account
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# City/District/Suburb/Town/Village.
sig { returns(T.nilable(String)) }
def address_city; end
# Billing address country, if provided when creating card.
sig { returns(T.nilable(String)) }
def address_country; end
# Address line 1 (Street address/PO Box/Company name).
sig { returns(T.nilable(String)) }
def address_line1; end
# If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
sig { returns(T.nilable(String)) }
def address_line1_check; end
# Address line 2 (Apartment/Suite/Unit/Building).
sig { returns(T.nilable(String)) }
def address_line2; end
# State/County/Province/Region.
sig { returns(T.nilable(String)) }
def address_state; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def address_zip; end
# If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
sig { returns(T.nilable(String)) }
def address_zip_check; end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
# A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.
sig { returns(T.nilable(T::Array[String])) }
def available_payout_methods; end
# Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
sig { returns(String) }
def brand; end
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def brand_product; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an [External Account](/api/external_account_cards/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.
sig { returns(T.nilable(String)) }
def currency; end
# The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).
sig { returns(T.nilable(String)) }
def cvc_check; end
# Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig { returns(T.nilable(T::Boolean)) }
def default_for_currency; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# (For tokenized numbers only.) The last four digits of the device account number.
sig { returns(T.nilable(String)) }
def dynamic_last4; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(String) }
def funding; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(String) }
def last4; end
# 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])) }
def metadata; end
# Cardholder name.
sig { returns(T.nilable(String)) }
def name; end
# Attribute for field networks
sig { returns(T.nilable(Networks)) }
def networks; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Status of a card based on the card issuer.
sig { returns(T.nilable(String)) }
def regulated_status; end
# For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.
sig { returns(T.nilable(String)) }
def status; end
# If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.
sig { returns(T.nilable(String)) }
def tokenization_method; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
end
end
# typed: true
module Stripe
class ConnectCollectionTransfer < APIResource
# Amount transferred, in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
# ID of the account that funds are being collected for.
sig { returns(T.any(String, Stripe::Account)) }
def destination; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
end
end
# typed: true
module Stripe
module V2
class DeletedObject < APIResource
# String representing the type of the object that has been deleted. Objects of the same type share the same value of the object field.
sig { returns(T.nilable(String)) }
def object; end
# The ID of the object that's being deleted.
sig { returns(String) }
def id; end
end
end
end
# 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
class Source < Stripe::StripeObject
# The coupon that was redeemed to create this discount.
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
def coupon; end
# Attribute for field type
sig { returns(String) }
def type; end
end
# 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)) }
def checkout_session; end
# 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) }
def coupon; end
# The ID of the customer associated with this discount.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# The ID of the account associated with this discount.
sig { returns(T.nilable(String)) }
def customer_account; end
# 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)) }
def end; 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) }
def id; end
# The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
sig { returns(T.nilable(String)) }
def invoice; end
# 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)) }
def invoice_item; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The promotion code applied to create this discount.
sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
def promotion_code; end
# Attribute for field source
sig { returns(Source) }
def source; end
# Date that the coupon was applied.
sig { returns(Integer) }
def start; end
# The subscription that this coupon is applied to, if it is applied to a particular subscription.
sig { returns(T.nilable(String)) }
def subscription; end
# The subscription item that this coupon is applied to, if it is applied to a particular subscription item.
sig { returns(T.nilable(String)) }
def subscription_item; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
end
end
# typed: true
module Stripe
module Treasury
# Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.
# Stripe or the platform can control Features via the requested field.
class FinancialAccountFeatures < APIResource
class CardIssuing < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Represents the reason why the status is `pending` or `restricted`.
sig { returns(String) }
def code; end
# Represents what the user should do, if anything, to activate the Feature.
sig { returns(T.nilable(String)) }
def resolution; end
# The `platform_restrictions` that are restricting this Feature.
sig { returns(T.nilable(String)) }
def restriction; end
end
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
# Whether the Feature is operational.
sig { returns(String) }
def status; end
# Additional details; includes at least one entry when the status is not `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class DepositInsurance < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Represents the reason why the status is `pending` or `restricted`.
sig { returns(String) }
def code; end
# Represents what the user should do, if anything, to activate the Feature.
sig { returns(T.nilable(String)) }
def resolution; end
# The `platform_restrictions` that are restricting this Feature.
sig { returns(T.nilable(String)) }
def restriction; end
end
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
# Whether the Feature is operational.
sig { returns(String) }
def status; end
# Additional details; includes at least one entry when the status is not `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class FinancialAddresses < Stripe::StripeObject
class Aba < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Represents the reason why the status is `pending` or `restricted`.
sig { returns(String) }
def code; end
# Represents what the user should do, if anything, to activate the Feature.
sig { returns(T.nilable(String)) }
def resolution; end
# The `platform_restrictions` that are restricting this Feature.
sig { returns(T.nilable(String)) }
def restriction; end
end
# Requested bank partner for this Financial Account
sig { returns(T.nilable(String)) }
def bank; end
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
# Whether the Feature is operational.
sig { returns(String) }
def status; end
# Additional details; includes at least one entry when the status is not `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
# Toggle settings for enabling/disabling the ABA address feature
sig { returns(T.nilable(Aba)) }
def aba; end
end
class InboundTransfers < Stripe::StripeObject
class Ach < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Represents the reason why the status is `pending` or `restricted`.
sig { returns(String) }
def code; end
# Represents what the user should do, if anything, to activate the Feature.
sig { returns(T.nilable(String)) }
def resolution; end
# The `platform_restrictions` that are restricting this Feature.
sig { returns(T.nilable(String)) }
def restriction; end
end
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
# Whether the Feature is operational.
sig { returns(String) }
def status; end
# Additional details; includes at least one entry when the status is not `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
# Toggle settings for enabling/disabling an inbound ACH specific feature
sig { returns(T.nilable(Ach)) }
def ach; end
end
class IntraStripeFlows < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Represents the reason why the status is `pending` or `restricted`.
sig { returns(String) }
def code; end
# Represents what the user should do, if anything, to activate the Feature.
sig { returns(T.nilable(String)) }
def resolution; end
# The `platform_restrictions` that are restricting this Feature.
sig { returns(T.nilable(String)) }
def restriction; end
end
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
# Whether the Feature is operational.
sig { returns(String) }
def status; end
# Additional details; includes at least one entry when the status is not `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class OutboundPayments < Stripe::StripeObject
class Ach < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Represents the reason why the status is `pending` or `restricted`.
sig { returns(String) }
def code; end
# Represents what the user should do, if anything, to activate the Feature.
sig { returns(T.nilable(String)) }
def resolution; end
# The `platform_restrictions` that are restricting this Feature.
sig { returns(T.nilable(String)) }
def restriction; end
end
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
# Whether the Feature is operational.
sig { returns(String) }
def status; end
# Additional details; includes at least one entry when the status is not `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class UsDomesticWire < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Represents the reason why the status is `pending` or `restricted`.
sig { returns(String) }
def code; end
# Represents what the user should do, if anything, to activate the Feature.
sig { returns(T.nilable(String)) }
def resolution; end
# The `platform_restrictions` that are restricting this Feature.
sig { returns(T.nilable(String)) }
def restriction; end
end
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
# Whether the Feature is operational.
sig { returns(String) }
def status; end
# Additional details; includes at least one entry when the status is not `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
# Toggle settings for enabling/disabling an outbound ACH specific feature
sig { returns(T.nilable(Ach)) }
def ach; end
# Toggle settings for enabling/disabling a feature
sig { returns(T.nilable(UsDomesticWire)) }
def us_domestic_wire; end
end
class OutboundTransfers < Stripe::StripeObject
class Ach < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Represents the reason why the status is `pending` or `restricted`.
sig { returns(String) }
def code; end
# Represents what the user should do, if anything, to activate the Feature.
sig { returns(T.nilable(String)) }
def resolution; end
# The `platform_restrictions` that are restricting this Feature.
sig { returns(T.nilable(String)) }
def restriction; end
end
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
# Whether the Feature is operational.
sig { returns(String) }
def status; end
# Additional details; includes at least one entry when the status is not `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class UsDomesticWire < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Represents the reason why the status is `pending` or `restricted`.
sig { returns(String) }
def code; end
# Represents what the user should do, if anything, to activate the Feature.
sig { returns(T.nilable(String)) }
def resolution; end
# The `platform_restrictions` that are restricting this Feature.
sig { returns(T.nilable(String)) }
def restriction; end
end
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
# Whether the Feature is operational.
sig { returns(String) }
def status; end
# Additional details; includes at least one entry when the status is not `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
# Toggle settings for enabling/disabling an outbound ACH specific feature
sig { returns(T.nilable(Ach)) }
def ach; end
# Toggle settings for enabling/disabling a feature
sig { returns(T.nilable(UsDomesticWire)) }
def us_domestic_wire; end
end
# Toggle settings for enabling/disabling a feature
sig { returns(T.nilable(CardIssuing)) }
def card_issuing; end
# Toggle settings for enabling/disabling a feature
sig { returns(T.nilable(DepositInsurance)) }
def deposit_insurance; end
# Settings related to Financial Addresses features on a Financial Account
sig { returns(T.nilable(FinancialAddresses)) }
def financial_addresses; end
# InboundTransfers contains inbound transfers features for a FinancialAccount.
sig { returns(T.nilable(InboundTransfers)) }
def inbound_transfers; end
# Toggle settings for enabling/disabling a feature
sig { returns(T.nilable(IntraStripeFlows)) }
def intra_stripe_flows; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Settings related to Outbound Payments features on a Financial Account
sig { returns(T.nilable(OutboundPayments)) }
def outbound_payments; end
# OutboundTransfers contains outbound transfers features for a FinancialAccount.
sig { returns(T.nilable(OutboundTransfers)) }
def outbound_transfers; end
end
end
end
# typed: true
module Stripe
module V2
class FinancialAddressCreditSimulation < APIResource
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# The status of the request, signifying whether a simulated credit was initiated.
sig { returns(String) }
def status; end
# 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) }
def livemode; end
end
end
end
# typed: true
module Stripe
module V2
class FinancialAddressGeneratedMicrodeposits < APIResource
# The amounts of the microdeposits that were generated.
sig { returns(T::Array[Stripe::V2::Amount]) }
def amounts; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# Closed Enum. The status of the request.
sig { returns(String) }
def status; end
# 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) }
def livemode; end
end
end
end
# typed: true
module Stripe
# Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is
# automatically applied to future invoices and payments using the `customer_balance` payment method.
# Customers can fund this balance by initiating a bank transfer to any account in the
# `financial_addresses` field.
# Related guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions)
class FundingInstructions < APIResource
class BankTransfer < Stripe::StripeObject
class FinancialAddress < Stripe::StripeObject
class Aba < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field account_holder_address
sig { returns(AccountHolderAddress) }
def account_holder_address; end
# The account holder name
sig { returns(String) }
def account_holder_name; end
# The ABA account number
sig { returns(String) }
def account_number; end
# The account type
sig { returns(String) }
def account_type; end
# Attribute for field bank_address
sig { returns(BankAddress) }
def bank_address; end
# The bank name
sig { returns(String) }
def bank_name; end
# The ABA routing number
sig { returns(String) }
def routing_number; end
end
class Iban < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field account_holder_address
sig { returns(AccountHolderAddress) }
def account_holder_address; end
# The name of the person or business that owns the bank account
sig { returns(String) }
def account_holder_name; end
# Attribute for field bank_address
sig { returns(BankAddress) }
def bank_address; end
# The BIC/SWIFT code of the account.
sig { returns(String) }
def bic; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
# The IBAN of the account.
sig { returns(String) }
def iban; end
end
class SortCode < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field account_holder_address
sig { returns(AccountHolderAddress) }
def account_holder_address; end
# The name of the person or business that owns the bank account
sig { returns(String) }
def account_holder_name; end
# The account number
sig { returns(String) }
def account_number; end
# Attribute for field bank_address
sig { returns(BankAddress) }
def bank_address; end
# The six-digit sort code
sig { returns(String) }
def sort_code; end
end
class Spei < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field account_holder_address
sig { returns(AccountHolderAddress) }
def account_holder_address; end
# The account holder name
sig { returns(String) }
def account_holder_name; end
# Attribute for field bank_address
sig { returns(BankAddress) }
def bank_address; end
# The three-digit bank code
sig { returns(String) }
def bank_code; end
# The short banking institution name
sig { returns(String) }
def bank_name; end
# The CLABE number
sig { returns(String) }
def clabe; end
end
class Swift < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field account_holder_address
sig { returns(AccountHolderAddress) }
def account_holder_address; end
# The account holder name
sig { returns(String) }
def account_holder_name; end
# The account number
sig { returns(String) }
def account_number; end
# The account type
sig { returns(String) }
def account_type; end
# Attribute for field bank_address
sig { returns(BankAddress) }
def bank_address; end
# The bank name
sig { returns(String) }
def bank_name; end
# The SWIFT code
sig { returns(String) }
def swift_code; end
end
class Zengin < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field account_holder_address
sig { returns(AccountHolderAddress) }
def account_holder_address; end
# The account holder name
sig { returns(T.nilable(String)) }
def account_holder_name; end
# The account number
sig { returns(T.nilable(String)) }
def account_number; end
# The bank account type. In Japan, this can only be `futsu` or `toza`.
sig { returns(T.nilable(String)) }
def account_type; end
# Attribute for field bank_address
sig { returns(BankAddress) }
def bank_address; end
# The bank code of the account
sig { returns(T.nilable(String)) }
def bank_code; end
# The bank name of the account
sig { returns(T.nilable(String)) }
def bank_name; end
# The branch code of the account
sig { returns(T.nilable(String)) }
def branch_code; end
# The branch name of the account
sig { returns(T.nilable(String)) }
def branch_name; end
end
# ABA Records contain U.S. bank account details per the ABA format.
sig { returns(T.nilable(Aba)) }
def aba; end
# Iban Records contain E.U. bank account details per the SEPA format.
sig { returns(T.nilable(Iban)) }
def iban; end
# Sort Code Records contain U.K. bank account details per the sort code format.
sig { returns(T.nilable(SortCode)) }
def sort_code; end
# SPEI Records contain Mexico bank account details per the SPEI format.
sig { returns(T.nilable(Spei)) }
def spei; end
# The payment networks supported by this FinancialAddress
sig { returns(T.nilable(T::Array[String])) }
def supported_networks; end
# SWIFT Records contain U.S. bank account details per the SWIFT format.
sig { returns(T.nilable(Swift)) }
def swift; end
# The type of financial address
sig { returns(String) }
def type; end
# Zengin Records contain Japan bank account details per the Zengin format.
sig { returns(T.nilable(Zengin)) }
def zengin; end
end
# The country of the bank account to fund
sig { returns(String) }
def country; end
# A list of financial addresses that can be used to fund a particular balance
sig { returns(T::Array[FinancialAddress]) }
def financial_addresses; end
# The bank_transfer type
sig { returns(String) }
def type; end
end
# Attribute for field bank_transfer
sig { returns(BankTransfer) }
def bank_transfer; end
# 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) }
def currency; end
# The `funding_type` of the returned instructions
sig { returns(String) }
def funding_type; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
end
end
# typed: true
module Stripe
# A line item.
class LineItem < APIResource
class AdjustableQuantity < Stripe::StripeObject
# Attribute for field enabled
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field maximum
sig { returns(T.nilable(Integer)) }
def maximum; end
# Attribute for field minimum
sig { returns(T.nilable(Integer)) }
def minimum; end
end
class Discount < Stripe::StripeObject
# The amount discounted.
sig { returns(Integer) }
def amount; end
# 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)
sig { returns(Stripe::Discount) }
def discount; end
end
class Display < Stripe::StripeObject
# Attribute for field description
sig { returns(T.nilable(String)) }
def description; end
# Attribute for field images
sig { returns(T::Array[String]) }
def images; end
# Attribute for field name
sig { returns(String) }
def name; end
end
class TaxCalculationReference < Stripe::StripeObject
# The calculation identifier for tax calculation response.
sig { returns(T.nilable(String)) }
def calculation_id; end
# The calculation identifier for tax calculation response line item.
sig { returns(T.nilable(String)) }
def calculation_item_id; end
end
class Tax < Stripe::StripeObject
# Amount of tax applied for this rate.
sig { returns(Integer) }
def amount; end
# Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
#
# Related guide: [Tax rates](/billing/taxes/tax-rates)
sig { returns(Stripe::TaxRate) }
def rate; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(T.nilable(String)) }
def taxability_reason; end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(T.nilable(Integer)) }
def taxable_amount; end
end
# Attribute for field adjustable_quantity
sig { returns(T.nilable(AdjustableQuantity)) }
def adjustable_quantity; end
# Total discount amount applied. If no discounts were applied, defaults to 0.
sig { returns(Integer) }
def amount_discount; end
# Total before any discounts or taxes are applied.
sig { returns(Integer) }
def amount_subtotal; end
# Total tax amount applied. If no tax was applied, defaults to 0.
sig { returns(Integer) }
def amount_tax; end
# Total after discounts and taxes.
sig { returns(Integer) }
def amount_total; end
# 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) }
def currency; end
# An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
sig { returns(T.nilable(String)) }
def description; end
# The discounts applied to the line item.
sig { returns(T.nilable(T::Array[Discount])) }
def discounts; end
# Attribute for field display
sig { returns(T.nilable(Display)) }
def display; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The price used to generate the line item.
sig { returns(T.nilable(Stripe::Price)) }
def price; end
# The ID of the product for this line item.
#
# This will always be the same as `price.product`.
sig { returns(T.nilable(T.any(String, Stripe::Product))) }
def product; end
# The quantity of products being purchased.
sig { returns(T.nilable(Integer)) }
def quantity; end
# The tax calculation identifiers of the line item.
sig { returns(T.nilable(TaxCalculationReference)) }
def tax_calculation_reference; end
# The taxes applied to the line item.
sig { returns(T.nilable(T::Array[Tax])) }
def taxes; end
end
end
# typed: true
module Stripe
module Billing
module Analytics
class MeterUsageRow < APIResource
# Timestamp indicating the end of the bucket. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def bucket_end_time; end
# Timestamp indicating the start of the bucket. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def bucket_start_time; end
# The aggregated meter usage value for the specified bucket.
sig { returns(Float) }
def bucket_value; end
# A set of key-value pairs representing the dimensions of the meter usage.
sig { returns(T.nilable(T::Hash[String, String])) }
def dimensions; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The unique identifier for the meter. Null if no meters were provided and usage was aggregated across all meters.
sig { returns(T.nilable(String)) }
def meter_id; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
end
end
end
end
# typed: true
module Stripe
# A quote line defines a set of changes, in the order provided, that will be applied upon quote acceptance.
class QuoteLine < APIResource
class Action < Stripe::StripeObject
class AddDiscount < Stripe::StripeObject
class DiscountEnd < Stripe::StripeObject
# The discount end type.
sig { returns(String) }
def type; end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
def coupon; end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
def discount; end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(DiscountEnd)) }
def discount_end; end
# The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
sig { returns(T.nilable(Integer)) }
def index; end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
def promotion_code; end
end
class AddItem < Stripe::StripeObject
class Discount < Stripe::StripeObject
class DiscountEnd < Stripe::StripeObject
# The discount end timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# The discount end type.
sig { returns(String) }
def type; end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
def coupon; end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
def discount; end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(DiscountEnd)) }
def discount_end; end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
def promotion_code; end
end
class Trial < Stripe::StripeObject
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
end
# The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
sig { returns(T::Array[Discount]) }
def discounts; end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
# ID of the price to which the customer should be subscribed.
sig { returns(T.any(String, Stripe::Price)) }
def price; end
# Quantity of the plan to which the customer should be subscribed.
sig { returns(T.nilable(Integer)) }
def quantity; end
# The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
sig { returns(T.nilable(T::Array[Stripe::TaxRate])) }
def tax_rates; end
# Options that configure the trial on the subscription item.
sig { returns(T.nilable(Trial)) }
def trial; end
end
class RemoveDiscount < Stripe::StripeObject
class DiscountEnd < Stripe::StripeObject
# The discount end timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# The discount end type.
sig { returns(String) }
def type; end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
def coupon; end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
def discount; end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(DiscountEnd)) }
def discount_end; end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
def promotion_code; end
end
class RemoveItem < Stripe::StripeObject
# ID of a price to remove.
sig { returns(T.any(String, Stripe::Price)) }
def price; end
end
class SetDiscount < Stripe::StripeObject
class DiscountEnd < Stripe::StripeObject
# The discount end timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# The discount end type.
sig { returns(String) }
def type; end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
def coupon; end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
def discount; end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(DiscountEnd)) }
def discount_end; end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
def promotion_code; end
end
class SetItem < Stripe::StripeObject
class Discount < Stripe::StripeObject
class DiscountEnd < Stripe::StripeObject
# The discount end timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# The discount end type.
sig { returns(String) }
def type; end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
def coupon; end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
def discount; end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(DiscountEnd)) }
def discount_end; end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
def promotion_code; end
end
class Trial < Stripe::StripeObject
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
end
# The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
sig { returns(T::Array[Discount]) }
def discounts; end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
# ID of the price to which the customer should be subscribed.
sig { returns(T.any(String, Stripe::Price)) }
def price; end
# Quantity of the plan to which the customer should be subscribed.
sig { returns(T.nilable(Integer)) }
def quantity; end
# The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
sig { returns(T.nilable(T::Array[Stripe::TaxRate])) }
def tax_rates; end
# Options that configure the trial on the subscription item.
sig { returns(T.nilable(Trial)) }
def trial; end
end
# Details for the `add_discount` type.
sig { returns(T.nilable(AddDiscount)) }
def add_discount; end
# Details for the `add_item` type.
sig { returns(T.nilable(AddItem)) }
def add_item; end
# Details for the `add_metadata` type: specify a hash of key-value pairs.
sig { returns(T.nilable(T::Hash[String, String])) }
def add_metadata; end
# Details for the `remove_discount` type.
sig { returns(T.nilable(RemoveDiscount)) }
def remove_discount; end
# Details for the `remove_item` type.
sig { returns(T.nilable(RemoveItem)) }
def remove_item; end
# Details for the `remove_metadata` type: specify an array of metadata keys.
sig { returns(T.nilable(T::Array[String])) }
def remove_metadata; end
# Details for the `set_discounts` type.
sig { returns(T.nilable(T::Array[SetDiscount])) }
def set_discounts; end
# Details for the `set_items` type.
sig { returns(T.nilable(T::Array[SetItem])) }
def set_items; end
# Details for the `set_metadata` type: specify an array of key-value pairs.
sig { returns(T.nilable(T::Hash[String, String])) }
def set_metadata; end
# The type of action the quote line performs.
sig { returns(String) }
def type; end
end
class AppliesTo < Stripe::StripeObject
# A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
sig { returns(T.nilable(String)) }
def new_reference; end
# The ID of the schedule the line applies to.
sig { returns(T.nilable(String)) }
def subscription_schedule; end
# Describes whether the quote line is affecting a new schedule or an existing schedule.
sig { returns(String) }
def type; end
end
class CancelSubscriptionSchedule < Stripe::StripeObject
# Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
sig { returns(String) }
def cancel_at; end
# If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def invoice_now; end
# If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def prorate; end
end
class EndsAt < Stripe::StripeObject
class DiscountEnd < Stripe::StripeObject
# The ID of a specific discount.
sig { returns(String) }
def discount; end
end
class Duration < Stripe::StripeObject
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
end
# The timestamp value that will be used to determine when to make changes to the subscription schedule, as computed from the `ends_at` field. For example, if `ends_at[type]=upcoming_invoice`, the upcoming invoice date will be computed at the time the `ends_at` field was specified and saved. This field will not be recomputed upon future requests to update or finalize the quote unless `ends_at` is respecified. This field is guaranteed to be populated after quote acceptance.
sig { returns(T.nilable(Integer)) }
def computed; end
# Use the `end` time of a given discount.
sig { returns(T.nilable(DiscountEnd)) }
def discount_end; end
# Time span for the quote line starting from the `starts_at` date.
sig { returns(T.nilable(Duration)) }
def duration; end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# Select a way to pass in `ends_at`.
sig { returns(String) }
def type; end
end
class SetPauseCollection < Stripe::StripeObject
class Set < Stripe::StripeObject
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
end
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
sig { returns(T.nilable(Set)) }
def set; end
# Defines the type of the pause_collection behavior for the quote line.
sig { returns(String) }
def type; end
end
class StartsAt < Stripe::StripeObject
class DiscountEnd < Stripe::StripeObject
# The ID of a specific discount.
sig { returns(String) }
def discount; end
end
class LineEndsAt < Stripe::StripeObject
# Unique identifier for the object.
sig { returns(String) }
def id; end
end
# The timestamp value that will be used to determine when to make changes to the subscription schedule, as computed from the `starts_at` field. For example, if `starts_at[type]=upcoming_invoice`, the upcoming invoice date will be computed at the time the `starts_at` field was specified and saved. This field will not be recomputed upon future requests to update or finalize the quote unless `starts_at` is respecified. This field is guaranteed to be populated after quote acceptance.
sig { returns(T.nilable(Integer)) }
def computed; end
# Use the `end` time of a given discount.
sig { returns(T.nilable(DiscountEnd)) }
def discount_end; end
# The timestamp the given line ends at.
sig { returns(T.nilable(LineEndsAt)) }
def line_ends_at; end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# Select a way to pass in `starts_at`.
sig { returns(String) }
def type; end
end
class TrialSettings < Stripe::StripeObject
class EndBehavior < Stripe::StripeObject
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
end
# Defines how the subscription should behave when a trial ends.
sig { returns(T.nilable(EndBehavior)) }
def end_behavior; end
end
# A list of items the customer is being quoted for.
sig { returns(T.nilable(T::Array[Action])) }
def actions; end
# Details to identify the subscription schedule the quote line applies to.
sig { returns(T.nilable(AppliesTo)) }
def applies_to; end
# For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
# A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
sig { returns(T.nilable(CancelSubscriptionSchedule)) }
def cancel_subscription_schedule; end
# Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
sig { returns(T.nilable(EndsAt)) }
def ends_at; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
sig { returns(T.nilable(String)) }
def proration_behavior; end
# Details to modify the pause_collection behavior of the subscription schedule.
sig { returns(T.nilable(SetPauseCollection)) }
def set_pause_collection; end
# Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
sig { returns(T.nilable(String)) }
def set_schedule_end; end
# Details to identify the earliest timestamp where the proposed change should take effect.
sig { returns(T.nilable(StartsAt)) }
def starts_at; end
# Settings related to subscription trials.
sig { returns(T.nilable(TrialSettings)) }
def trial_settings; end
end
end
# typed: true
module Stripe
class ReserveTransaction < APIResource
# Attribute for field amount
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
end
end
# typed: true
module Stripe
module Issuing
# When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.
class Settlement < APIResource
# The Bank Identification Number reflecting this settlement record.
sig { returns(String) }
def bin; end
# The date that the transactions are cleared and posted to user's accounts.
sig { returns(Integer) }
def clearing_date; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The total interchange received as reimbursement for the transactions.
sig { returns(Integer) }
def interchange_fees_amount; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# The total net amount required to settle with the network.
sig { returns(Integer) }
def net_total_amount; end
# The card network for this settlement report. One of ["visa", "maestro"]
sig { returns(String) }
def network; end
# The total amount of fees owed to the network.
sig { returns(Integer) }
def network_fees_amount; end
# The Settlement Identification Number assigned by the network.
sig { returns(String) }
def network_settlement_identifier; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The total amount of any additional fees assessed by the card network.
sig { returns(T.nilable(Integer)) }
def other_fees_amount; end
# The total number of additional fees assessed by the card network.
sig { returns(T.nilable(Integer)) }
def other_fees_count; end
# One of `international` or `uk_national_net`.
sig { returns(String) }
def settlement_service; end
# The current processing status of this settlement.
sig { returns(String) }
def status; end
# The total transaction amount reflected in this settlement.
sig { returns(Integer) }
def transaction_amount; end
# The total number of transactions reflected in this settlement.
sig { returns(Integer) }
def transaction_count; end
end
end
end
# typed: true
module Stripe
# Source mandate notifications should be created when a notification related to
# a source mandate must be sent to the payer. They will trigger a webhook or
# deliver an email to the customer.
class SourceMandateNotification < APIResource
class AcssDebit < Stripe::StripeObject
# The statement descriptor associate with the debit.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
end
class BacsDebit < Stripe::StripeObject
# Last 4 digits of the account number associated with the debit.
sig { returns(T.nilable(String)) }
def last4; end
end
class SepaDebit < Stripe::StripeObject
# SEPA creditor ID.
sig { returns(T.nilable(String)) }
def creditor_identifier; end
# Last 4 digits of the account number associated with the debit.
sig { returns(T.nilable(String)) }
def last4; end
# Mandate reference associated with the debit.
sig { returns(T.nilable(String)) }
def mandate_reference; end
end
# Attribute for field acss_debit
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`.
sig { returns(T.nilable(Integer)) }
def amount; end
# Attribute for field bacs_debit
sig { returns(T.nilable(BacsDebit)) }
def bacs_debit; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`.
sig { returns(String) }
def reason; end
# Attribute for field sepa_debit
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# `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.
#
# Stripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).
# We recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).
# This newer API provides access to our latest features and payment method types.
#
# Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).
sig { returns(Stripe::Source) }
def source; end
# The status of the mandate notification. Valid statuses are `pending` or `submitted`.
sig { returns(String) }
def status; end
# The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as `three_d_secure`.
sig { returns(String) }
def type; end
end
end
# typed: true
module Stripe
class TaxDeductedAtSource < APIResource
# Unique identifier for the object.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.
sig { returns(Integer) }
def period_end; end
# The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.
sig { returns(Integer) }
def period_start; end
# The TAN that was supplied to Stripe when TDS was assessed
sig { returns(String) }
def tax_deduction_account_number; end
end
end
# typed: true
module Stripe
module Tax
class TransactionLineItem < APIResource
class Reversal < Stripe::StripeObject
# The `id` of the line item to reverse in the original transaction.
sig { returns(String) }
def original_line_item; end
end
# The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
sig { returns(Integer) }
def amount; end
# The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount_tax; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The ID of an existing [Product](https://stripe.com/docs/api/products/object).
sig { returns(T.nilable(String)) }
def product; end
# The number of units of the item being purchased. For reversals, this is the quantity reversed.
sig { returns(Integer) }
def quantity; end
# A custom identifier for this line item in the transaction.
sig { returns(String) }
def reference; end
# If `type=reversal`, contains information about what was reversed.
sig { returns(T.nilable(Reversal)) }
def reversal; end
# Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.
sig { returns(String) }
def tax_behavior; end
# The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.
sig { returns(String) }
def tax_code; end
# If `reversal`, this line item reverses an earlier transaction.
sig { returns(String) }
def type; end
end
end
end
# typed: true
module Stripe
# Account Links are the means by which a Connect platform grants a connected account permission to access
# Stripe-hosted applications, such as Connect Onboarding.
#
# Related guide: [Connect Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding)
class AccountLink < APIResource
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The timestamp at which this account link will expire.
sig { returns(Integer) }
def expires_at; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The URL for the account link.
sig { returns(String) }
def url; end
class CreateParams < Stripe::RequestParams
class CollectionOptions < Stripe::RequestParams
# Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify `collection_options`, the default value is `currently_due`.
sig { returns(T.nilable(String)) }
def fields; end
sig { params(_fields: T.nilable(String)).returns(T.nilable(String)) }
def fields=(_fields); end
# Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
sig { returns(T.nilable(String)) }
def future_requirements; end
sig { params(_future_requirements: T.nilable(String)).returns(T.nilable(String)) }
def future_requirements=(_future_requirements); end
sig { params(fields: T.nilable(String), future_requirements: T.nilable(String)).void }
def initialize(fields: nil, future_requirements: nil); end
end
# The identifier of the account to create an account link for.
sig { returns(String) }
def account; end
sig { params(_account: String).returns(String) }
def account=(_account); end
# The collect parameter is deprecated. Use `collection_options` instead.
sig { returns(T.nilable(String)) }
def collect; end
sig { params(_collect: T.nilable(String)).returns(T.nilable(String)) }
def collect=(_collect); end
# Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.
sig { returns(T.nilable(::Stripe::AccountLink::CreateParams::CollectionOptions)) }
def collection_options; end
sig {
params(_collection_options: T.nilable(::Stripe::AccountLink::CreateParams::CollectionOptions)).returns(T.nilable(::Stripe::AccountLink::CreateParams::CollectionOptions))
}
def collection_options=(_collection_options); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user.
sig { returns(T.nilable(String)) }
def refresh_url; end
sig { params(_refresh_url: T.nilable(String)).returns(T.nilable(String)) }
def refresh_url=(_refresh_url); end
# The URL that the user will be redirected to upon leaving or completing the linked flow.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# The type of account link the user is requesting.
#
# You can create Account Links of type `account_update` only for connected accounts where your platform is responsible for collecting requirements, including Custom accounts. You can't create them for accounts that have access to a Stripe-hosted Dashboard. If you use [Connect embedded components](/connect/get-started-connect-embedded-components), you can include components that allow your connected accounts to update their own information. For an account without Stripe-hosted Dashboard access where Stripe is liable for negative balances, you must use embedded components.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(account: String, collect: T.nilable(String), collection_options: T.nilable(::Stripe::AccountLink::CreateParams::CollectionOptions), expand: T.nilable(T::Array[String]), refresh_url: T.nilable(String), return_url: T.nilable(String), type: String).void
}
def initialize(
account: nil,
collect: nil,
collection_options: nil,
expand: nil,
refresh_url: nil,
return_url: nil,
type: nil
); end
end
# Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.
sig {
params(params: T.any(::Stripe::AccountLink::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::AccountLink)
}
def self.create(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# A notice to a Connected account. Notice can be sent by Stripe on your behalf or you can opt to send the notices yourself.
#
# See the [guide to send notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) to your connected accounts.
class AccountNotice < APIResource
class Email < Stripe::StripeObject
# Content of the email in plain text. The copy must match exactly the language that Stripe Compliance has approved for use.
sig { returns(String) }
def plain_text; end
# Email address of the recipient.
sig { returns(String) }
def recipient; end
# Subject of the email.
sig { returns(String) }
def subject; end
end
class LinkedObjects < Stripe::StripeObject
# Associated [Capability](https://stripe.com/docs/api/capabilities)
sig { returns(T.nilable(String)) }
def capability; end
# Associated [Credit Underwriting Record](https://stripe.com/docs/api/issuing/credit_underwriting_record)
sig { returns(T.nilable(String)) }
def issuing_credit_underwriting_record; end
# Associated [Issuing Dispute](https://stripe.com/docs/api/issuing/disputes)
sig { returns(T.nilable(String)) }
def issuing_dispute; end
end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# When present, the deadline for sending the notice to meet the relevant regulations.
sig { returns(T.nilable(Integer)) }
def deadline; end
# Information about the email when sent.
sig { returns(T.nilable(Email)) }
def email; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Information about objects related to the notice.
sig { returns(T.nilable(LinkedObjects)) }
def linked_objects; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Reason the notice is being sent. The reason determines what copy the notice must contain. See the [regulated customer notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) guide. All reasons might not apply to your integration, and Stripe might add new reasons in the future, so we recommend an internal warning when you receive an unknown reason.
sig { returns(String) }
def reason; end
# Date when the notice was sent. When absent, you must send the notice, update the content of the email and date when it was sent.
sig { returns(T.nilable(Integer)) }
def sent_at; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Set to false to only return unsent AccountNotices.
sig { returns(T.nilable(T::Boolean)) }
def sent; end
sig { params(_sent: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def sent=(_sent); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), sent: T.nilable(T::Boolean), starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
sent: nil,
starting_after: nil
); end
end
class UpdateParams < Stripe::RequestParams
class Email < Stripe::RequestParams
# Content of the email in plain text. The copy must match exactly the language that Stripe Compliance has approved for use.
sig { returns(String) }
def plain_text; end
sig { params(_plain_text: String).returns(String) }
def plain_text=(_plain_text); end
# Email address of the recipient.
sig { returns(String) }
def recipient; end
sig { params(_recipient: String).returns(String) }
def recipient=(_recipient); end
# Subject of the email.
sig { returns(String) }
def subject; end
sig { params(_subject: String).returns(String) }
def subject=(_subject); end
sig { params(plain_text: String, recipient: String, subject: String).void }
def initialize(plain_text: nil, recipient: nil, subject: nil); end
end
# Information about the email you sent.
sig { returns(::Stripe::AccountNotice::UpdateParams::Email) }
def email; end
sig {
params(_email: ::Stripe::AccountNotice::UpdateParams::Email).returns(::Stripe::AccountNotice::UpdateParams::Email)
}
def email=(_email); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Date when you sent the notice.
sig { returns(Integer) }
def sent_at; end
sig { params(_sent_at: Integer).returns(Integer) }
def sent_at=(_sent_at); end
sig {
params(email: ::Stripe::AccountNotice::UpdateParams::Email, expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), sent_at: Integer).void
}
def initialize(email: nil, expand: nil, metadata: nil, sent_at: nil); end
end
# Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
sig {
params(params: T.any(::Stripe::AccountNotice::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates an AccountNotice object.
sig {
params(account_notice: String, params: T.any(::Stripe::AccountNotice::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::AccountNotice)
}
def self.update(account_notice, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.
#
# We recommend that you create an AccountSession each time you need to display an embedded component
# to your user. Do not save AccountSessions to your database as they expire relatively
# quickly, and cannot be used more than once.
#
# Related guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components)
class AccountSession < APIResource
class Components < Stripe::StripeObject
class AccountManagement < Stripe::StripeObject
class Features < Stripe::StripeObject
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T::Boolean) }
def disable_stripe_user_authentication; end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T::Boolean) }
def external_account_collection; end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class AccountOnboarding < Stripe::StripeObject
class Features < Stripe::StripeObject
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T::Boolean) }
def disable_stripe_user_authentication; end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T::Boolean) }
def external_account_collection; end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class BalanceReport < Stripe::StripeObject
class Features < Stripe::StripeObject; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class Balances < Stripe::StripeObject
class Features < Stripe::StripeObject
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T::Boolean) }
def disable_stripe_user_authentication; end
# Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T::Boolean) }
def edit_payout_schedule; end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T::Boolean) }
def external_account_collection; end
# Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T::Boolean) }
def instant_payouts; end
# Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T::Boolean) }
def standard_payouts; end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class CapitalFinancing < Stripe::StripeObject
class Features < Stripe::StripeObject; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class CapitalFinancingApplication < Stripe::StripeObject
class Features < Stripe::StripeObject; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class CapitalFinancingPromotion < Stripe::StripeObject
class Features < Stripe::StripeObject; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class DisputesList < Stripe::StripeObject
class Features < Stripe::StripeObject
# Whether to allow capturing and cancelling payment intents. This is `true` by default.
sig { returns(T::Boolean) }
def capture_payments; end
# Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
sig { returns(T::Boolean) }
def destination_on_behalf_of_charge_management; end
# Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
sig { returns(T::Boolean) }
def dispute_management; end
# Whether sending refunds is enabled. This is `true` by default.
sig { returns(T::Boolean) }
def refund_management; end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class Documents < Stripe::StripeObject
class Features < Stripe::StripeObject; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class FinancialAccount < Stripe::StripeObject
class Features < Stripe::StripeObject
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T::Boolean) }
def disable_stripe_user_authentication; end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T::Boolean) }
def external_account_collection; end
# Whether to allow sending money.
sig { returns(T::Boolean) }
def send_money; end
# Whether to allow transferring balance.
sig { returns(T::Boolean) }
def transfer_balance; end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class FinancialAccountTransactions < Stripe::StripeObject
class Features < Stripe::StripeObject
# Whether to allow card spend dispute management features.
sig { returns(T::Boolean) }
def card_spend_dispute_management; end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class InstantPayoutsPromotion < Stripe::StripeObject
class Features < Stripe::StripeObject
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T::Boolean) }
def disable_stripe_user_authentication; end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T::Boolean) }
def external_account_collection; end
# Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T::Boolean) }
def instant_payouts; end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class IssuingCard < Stripe::StripeObject
class Features < Stripe::StripeObject
# Whether to allow card management features.
sig { returns(T::Boolean) }
def card_management; end
# Whether to allow card spend dispute management features.
sig { returns(T::Boolean) }
def card_spend_dispute_management; end
# Whether to allow cardholder management features.
sig { returns(T::Boolean) }
def cardholder_management; end
# Whether to allow spend control management features.
sig { returns(T::Boolean) }
def spend_control_management; end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class IssuingCardsList < Stripe::StripeObject
class Features < Stripe::StripeObject
# Whether to allow card management features.
sig { returns(T::Boolean) }
def card_management; end
# Whether to allow card spend dispute management features.
sig { returns(T::Boolean) }
def card_spend_dispute_management; end
# Whether to allow cardholder management features.
sig { returns(T::Boolean) }
def cardholder_management; end
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T::Boolean) }
def disable_stripe_user_authentication; end
# Whether to allow spend control management features.
sig { returns(T::Boolean) }
def spend_control_management; end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class NotificationBanner < Stripe::StripeObject
class Features < Stripe::StripeObject
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T::Boolean) }
def disable_stripe_user_authentication; end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T::Boolean) }
def external_account_collection; end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class PaymentDetails < Stripe::StripeObject
class Features < Stripe::StripeObject
# Whether to allow capturing and cancelling payment intents. This is `true` by default.
sig { returns(T::Boolean) }
def capture_payments; end
# Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
sig { returns(T::Boolean) }
def destination_on_behalf_of_charge_management; end
# Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
sig { returns(T::Boolean) }
def dispute_management; end
# Whether sending refunds is enabled. This is `true` by default.
sig { returns(T::Boolean) }
def refund_management; end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class PaymentDisputes < Stripe::StripeObject
class Features < Stripe::StripeObject
# Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
sig { returns(T::Boolean) }
def destination_on_behalf_of_charge_management; end
# Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
sig { returns(T::Boolean) }
def dispute_management; end
# Whether sending refunds is enabled. This is `true` by default.
sig { returns(T::Boolean) }
def refund_management; end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class Payments < Stripe::StripeObject
class Features < Stripe::StripeObject
# Whether to allow capturing and cancelling payment intents. This is `true` by default.
sig { returns(T::Boolean) }
def capture_payments; end
# Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
sig { returns(T::Boolean) }
def destination_on_behalf_of_charge_management; end
# Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
sig { returns(T::Boolean) }
def dispute_management; end
# Whether sending refunds is enabled. This is `true` by default.
sig { returns(T::Boolean) }
def refund_management; end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class PayoutDetails < Stripe::StripeObject
class Features < Stripe::StripeObject; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class PayoutReconciliationReport < Stripe::StripeObject
class Features < Stripe::StripeObject; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class Payouts < Stripe::StripeObject
class Features < Stripe::StripeObject
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T::Boolean) }
def disable_stripe_user_authentication; end
# Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T::Boolean) }
def edit_payout_schedule; end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T::Boolean) }
def external_account_collection; end
# Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T::Boolean) }
def instant_payouts; end
# Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T::Boolean) }
def standard_payouts; end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class PayoutsList < Stripe::StripeObject
class Features < Stripe::StripeObject; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class TaxRegistrations < Stripe::StripeObject
class Features < Stripe::StripeObject; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
class TaxSettings < Stripe::StripeObject
class Features < Stripe::StripeObject; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field features
sig { returns(Features) }
def features; end
end
# Attribute for field account_management
sig { returns(AccountManagement) }
def account_management; end
# Attribute for field account_onboarding
sig { returns(AccountOnboarding) }
def account_onboarding; end
# Attribute for field balance_report
sig { returns(BalanceReport) }
def balance_report; end
# Attribute for field balances
sig { returns(Balances) }
def balances; end
# Attribute for field capital_financing
sig { returns(T.nilable(CapitalFinancing)) }
def capital_financing; end
# Attribute for field capital_financing_application
sig { returns(T.nilable(CapitalFinancingApplication)) }
def capital_financing_application; end
# Attribute for field capital_financing_promotion
sig { returns(T.nilable(CapitalFinancingPromotion)) }
def capital_financing_promotion; end
# Attribute for field disputes_list
sig { returns(DisputesList) }
def disputes_list; end
# Attribute for field documents
sig { returns(Documents) }
def documents; end
# Attribute for field financial_account
sig { returns(FinancialAccount) }
def financial_account; end
# Attribute for field financial_account_transactions
sig { returns(FinancialAccountTransactions) }
def financial_account_transactions; end
# Attribute for field instant_payouts_promotion
sig { returns(InstantPayoutsPromotion) }
def instant_payouts_promotion; end
# Attribute for field issuing_card
sig { returns(IssuingCard) }
def issuing_card; end
# Attribute for field issuing_cards_list
sig { returns(IssuingCardsList) }
def issuing_cards_list; end
# Attribute for field notification_banner
sig { returns(NotificationBanner) }
def notification_banner; end
# Attribute for field payment_details
sig { returns(PaymentDetails) }
def payment_details; end
# Attribute for field payment_disputes
sig { returns(PaymentDisputes) }
def payment_disputes; end
# Attribute for field payments
sig { returns(Payments) }
def payments; end
# Attribute for field payout_details
sig { returns(PayoutDetails) }
def payout_details; end
# Attribute for field payout_reconciliation_report
sig { returns(PayoutReconciliationReport) }
def payout_reconciliation_report; end
# Attribute for field payouts
sig { returns(Payouts) }
def payouts; end
# Attribute for field payouts_list
sig { returns(PayoutsList) }
def payouts_list; end
# Attribute for field tax_registrations
sig { returns(TaxRegistrations) }
def tax_registrations; end
# Attribute for field tax_settings
sig { returns(TaxSettings) }
def tax_settings; end
end
# The ID of the account the AccountSession was created for
sig { returns(String) }
def account; end
# The client secret of this AccountSession. Used on the client to set up secure access to the given `account`.
#
# The client secret can be used to provide access to `account` from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.
#
# Refer to our docs to [setup Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled.
sig { returns(String) }
def client_secret; end
# Attribute for field components
sig { returns(Components) }
def components; end
# The timestamp at which this AccountSession will expire.
sig { returns(Integer) }
def expires_at; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
class CreateParams < Stripe::RequestParams
class Components < Stripe::RequestParams
class AccountManagement < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def disable_stripe_user_authentication; end
sig {
params(_disable_stripe_user_authentication: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def disable_stripe_user_authentication=(_disable_stripe_user_authentication); end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T.nilable(T::Boolean)) }
def external_account_collection; end
sig {
params(_external_account_collection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def external_account_collection=(_external_account_collection); end
sig {
params(disable_stripe_user_authentication: T.nilable(T::Boolean), external_account_collection: T.nilable(T::Boolean)).void
}
def initialize(
disable_stripe_user_authentication: nil,
external_account_collection: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountManagement::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountManagement::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountManagement::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountManagement::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class AccountOnboarding < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def disable_stripe_user_authentication; end
sig {
params(_disable_stripe_user_authentication: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def disable_stripe_user_authentication=(_disable_stripe_user_authentication); end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T.nilable(T::Boolean)) }
def external_account_collection; end
sig {
params(_external_account_collection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def external_account_collection=(_external_account_collection); end
sig {
params(disable_stripe_user_authentication: T.nilable(T::Boolean), external_account_collection: T.nilable(T::Boolean)).void
}
def initialize(
disable_stripe_user_authentication: nil,
external_account_collection: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountOnboarding::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountOnboarding::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountOnboarding::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountOnboarding::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class AppInstall < Stripe::RequestParams
class Features < Stripe::RequestParams
# The list of apps allowed to be enabled in the embedded component.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def allowed_apps; end
sig {
params(_allowed_apps: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def allowed_apps=(_allowed_apps); end
sig { params(allowed_apps: T.nilable(T.any(String, T::Array[String]))).void }
def initialize(allowed_apps: nil); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::AppInstall::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::AppInstall::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::AppInstall::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::AppInstall::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class AppViewport < Stripe::RequestParams
class Features < Stripe::RequestParams
# The list of apps allowed to be enabled in the embedded component.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def allowed_apps; end
sig {
params(_allowed_apps: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def allowed_apps=(_allowed_apps); end
sig { params(allowed_apps: T.nilable(T.any(String, T::Array[String]))).void }
def initialize(allowed_apps: nil); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::AppViewport::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::AppViewport::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::AppViewport::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::AppViewport::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class BalanceReport < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::BalanceReport::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::BalanceReport::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::BalanceReport::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::BalanceReport::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class Balances < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def disable_stripe_user_authentication; end
sig {
params(_disable_stripe_user_authentication: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def disable_stripe_user_authentication=(_disable_stripe_user_authentication); end
# Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T.nilable(T::Boolean)) }
def edit_payout_schedule; end
sig {
params(_edit_payout_schedule: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def edit_payout_schedule=(_edit_payout_schedule); end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T.nilable(T::Boolean)) }
def external_account_collection; end
sig {
params(_external_account_collection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def external_account_collection=(_external_account_collection); end
# Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T.nilable(T::Boolean)) }
def instant_payouts; end
sig { params(_instant_payouts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def instant_payouts=(_instant_payouts); end
# Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T.nilable(T::Boolean)) }
def standard_payouts; end
sig { params(_standard_payouts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def standard_payouts=(_standard_payouts); end
sig {
params(disable_stripe_user_authentication: T.nilable(T::Boolean), edit_payout_schedule: T.nilable(T::Boolean), external_account_collection: T.nilable(T::Boolean), instant_payouts: T.nilable(T::Boolean), standard_payouts: T.nilable(T::Boolean)).void
}
def initialize(
disable_stripe_user_authentication: nil,
edit_payout_schedule: nil,
external_account_collection: nil,
instant_payouts: nil,
standard_payouts: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Balances::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::Balances::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Balances::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::Balances::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class CapitalFinancing < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancing::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancing::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancing::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancing::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class CapitalFinancingApplication < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancingApplication::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancingApplication::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancingApplication::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancingApplication::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class CapitalFinancingPromotion < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancingPromotion::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancingPromotion::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancingPromotion::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancingPromotion::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class CapitalOverview < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalOverview::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalOverview::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalOverview::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalOverview::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class DisputesList < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether to allow capturing and cancelling payment intents. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def capture_payments; end
sig { params(_capture_payments: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def capture_payments=(_capture_payments); end
# Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
sig { returns(T.nilable(T::Boolean)) }
def destination_on_behalf_of_charge_management; end
sig {
params(_destination_on_behalf_of_charge_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def destination_on_behalf_of_charge_management=(
_destination_on_behalf_of_charge_management
); end
# Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def dispute_management; end
sig {
params(_dispute_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def dispute_management=(_dispute_management); end
# Whether sending refunds is enabled. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def refund_management; end
sig { params(_refund_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refund_management=(_refund_management); end
sig {
params(capture_payments: T.nilable(T::Boolean), destination_on_behalf_of_charge_management: T.nilable(T::Boolean), dispute_management: T.nilable(T::Boolean), refund_management: T.nilable(T::Boolean)).void
}
def initialize(
capture_payments: nil,
destination_on_behalf_of_charge_management: nil,
dispute_management: nil,
refund_management: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::DisputesList::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::DisputesList::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::DisputesList::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::DisputesList::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class Documents < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Documents::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::Documents::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Documents::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::Documents::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class ExportTaxTransactions < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::ExportTaxTransactions::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::ExportTaxTransactions::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::ExportTaxTransactions::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::ExportTaxTransactions::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class FinancialAccount < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def disable_stripe_user_authentication; end
sig {
params(_disable_stripe_user_authentication: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def disable_stripe_user_authentication=(_disable_stripe_user_authentication); end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T.nilable(T::Boolean)) }
def external_account_collection; end
sig {
params(_external_account_collection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def external_account_collection=(_external_account_collection); end
# Whether to allow sending money.
sig { returns(T.nilable(T::Boolean)) }
def send_money; end
sig { params(_send_money: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def send_money=(_send_money); end
# Whether to allow transferring balance.
sig { returns(T.nilable(T::Boolean)) }
def transfer_balance; end
sig { params(_transfer_balance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def transfer_balance=(_transfer_balance); end
sig {
params(disable_stripe_user_authentication: T.nilable(T::Boolean), external_account_collection: T.nilable(T::Boolean), send_money: T.nilable(T::Boolean), transfer_balance: T.nilable(T::Boolean)).void
}
def initialize(
disable_stripe_user_authentication: nil,
external_account_collection: nil,
send_money: nil,
transfer_balance: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccount::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccount::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccount::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccount::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class FinancialAccountTransactions < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether to allow card spend dispute management features.
sig { returns(T.nilable(T::Boolean)) }
def card_spend_dispute_management; end
sig {
params(_card_spend_dispute_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def card_spend_dispute_management=(_card_spend_dispute_management); end
sig { params(card_spend_dispute_management: T.nilable(T::Boolean)).void }
def initialize(card_spend_dispute_management: nil); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccountTransactions::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccountTransactions::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccountTransactions::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccountTransactions::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class InstantPayoutsPromotion < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def disable_stripe_user_authentication; end
sig {
params(_disable_stripe_user_authentication: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def disable_stripe_user_authentication=(_disable_stripe_user_authentication); end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T.nilable(T::Boolean)) }
def external_account_collection; end
sig {
params(_external_account_collection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def external_account_collection=(_external_account_collection); end
# Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T.nilable(T::Boolean)) }
def instant_payouts; end
sig { params(_instant_payouts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def instant_payouts=(_instant_payouts); end
sig {
params(disable_stripe_user_authentication: T.nilable(T::Boolean), external_account_collection: T.nilable(T::Boolean), instant_payouts: T.nilable(T::Boolean)).void
}
def initialize(
disable_stripe_user_authentication: nil,
external_account_collection: nil,
instant_payouts: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::InstantPayoutsPromotion::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::InstantPayoutsPromotion::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::InstantPayoutsPromotion::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::InstantPayoutsPromotion::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class IssuingCard < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether to allow card management features.
sig { returns(T.nilable(T::Boolean)) }
def card_management; end
sig { params(_card_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def card_management=(_card_management); end
# Whether to allow card spend dispute management features.
sig { returns(T.nilable(T::Boolean)) }
def card_spend_dispute_management; end
sig {
params(_card_spend_dispute_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def card_spend_dispute_management=(_card_spend_dispute_management); end
# Whether to allow cardholder management features.
sig { returns(T.nilable(T::Boolean)) }
def cardholder_management; end
sig {
params(_cardholder_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def cardholder_management=(_cardholder_management); end
# Whether to allow spend control management features.
sig { returns(T.nilable(T::Boolean)) }
def spend_control_management; end
sig {
params(_spend_control_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def spend_control_management=(_spend_control_management); end
sig {
params(card_management: T.nilable(T::Boolean), card_spend_dispute_management: T.nilable(T::Boolean), cardholder_management: T.nilable(T::Boolean), spend_control_management: T.nilable(T::Boolean)).void
}
def initialize(
card_management: nil,
card_spend_dispute_management: nil,
cardholder_management: nil,
spend_control_management: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCard::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCard::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCard::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCard::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class IssuingCardsList < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether to allow card management features.
sig { returns(T.nilable(T::Boolean)) }
def card_management; end
sig { params(_card_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def card_management=(_card_management); end
# Whether to allow card spend dispute management features.
sig { returns(T.nilable(T::Boolean)) }
def card_spend_dispute_management; end
sig {
params(_card_spend_dispute_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def card_spend_dispute_management=(_card_spend_dispute_management); end
# Whether to allow cardholder management features.
sig { returns(T.nilable(T::Boolean)) }
def cardholder_management; end
sig {
params(_cardholder_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def cardholder_management=(_cardholder_management); end
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def disable_stripe_user_authentication; end
sig {
params(_disable_stripe_user_authentication: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def disable_stripe_user_authentication=(_disable_stripe_user_authentication); end
# Whether to allow spend control management features.
sig { returns(T.nilable(T::Boolean)) }
def spend_control_management; end
sig {
params(_spend_control_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def spend_control_management=(_spend_control_management); end
sig {
params(card_management: T.nilable(T::Boolean), card_spend_dispute_management: T.nilable(T::Boolean), cardholder_management: T.nilable(T::Boolean), disable_stripe_user_authentication: T.nilable(T::Boolean), spend_control_management: T.nilable(T::Boolean)).void
}
def initialize(
card_management: nil,
card_spend_dispute_management: nil,
cardholder_management: nil,
disable_stripe_user_authentication: nil,
spend_control_management: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCardsList::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCardsList::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCardsList::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCardsList::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class NotificationBanner < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def disable_stripe_user_authentication; end
sig {
params(_disable_stripe_user_authentication: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def disable_stripe_user_authentication=(_disable_stripe_user_authentication); end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T.nilable(T::Boolean)) }
def external_account_collection; end
sig {
params(_external_account_collection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def external_account_collection=(_external_account_collection); end
sig {
params(disable_stripe_user_authentication: T.nilable(T::Boolean), external_account_collection: T.nilable(T::Boolean)).void
}
def initialize(
disable_stripe_user_authentication: nil,
external_account_collection: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::NotificationBanner::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::NotificationBanner::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::NotificationBanner::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::NotificationBanner::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class PaymentDetails < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether to allow capturing and cancelling payment intents. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def capture_payments; end
sig { params(_capture_payments: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def capture_payments=(_capture_payments); end
# Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
sig { returns(T.nilable(T::Boolean)) }
def destination_on_behalf_of_charge_management; end
sig {
params(_destination_on_behalf_of_charge_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def destination_on_behalf_of_charge_management=(
_destination_on_behalf_of_charge_management
); end
# Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def dispute_management; end
sig {
params(_dispute_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def dispute_management=(_dispute_management); end
# Whether sending refunds is enabled. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def refund_management; end
sig { params(_refund_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refund_management=(_refund_management); end
sig {
params(capture_payments: T.nilable(T::Boolean), destination_on_behalf_of_charge_management: T.nilable(T::Boolean), dispute_management: T.nilable(T::Boolean), refund_management: T.nilable(T::Boolean)).void
}
def initialize(
capture_payments: nil,
destination_on_behalf_of_charge_management: nil,
dispute_management: nil,
refund_management: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDetails::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDetails::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDetails::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDetails::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class PaymentDisputes < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
sig { returns(T.nilable(T::Boolean)) }
def destination_on_behalf_of_charge_management; end
sig {
params(_destination_on_behalf_of_charge_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def destination_on_behalf_of_charge_management=(
_destination_on_behalf_of_charge_management
); end
# Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def dispute_management; end
sig {
params(_dispute_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def dispute_management=(_dispute_management); end
# Whether sending refunds is enabled. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def refund_management; end
sig { params(_refund_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refund_management=(_refund_management); end
sig {
params(destination_on_behalf_of_charge_management: T.nilable(T::Boolean), dispute_management: T.nilable(T::Boolean), refund_management: T.nilable(T::Boolean)).void
}
def initialize(
destination_on_behalf_of_charge_management: nil,
dispute_management: nil,
refund_management: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDisputes::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDisputes::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDisputes::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDisputes::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class PaymentMethodSettings < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentMethodSettings::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentMethodSettings::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentMethodSettings::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentMethodSettings::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class Payments < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether to allow capturing and cancelling payment intents. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def capture_payments; end
sig { params(_capture_payments: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def capture_payments=(_capture_payments); end
# Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
sig { returns(T.nilable(T::Boolean)) }
def destination_on_behalf_of_charge_management; end
sig {
params(_destination_on_behalf_of_charge_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def destination_on_behalf_of_charge_management=(
_destination_on_behalf_of_charge_management
); end
# Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def dispute_management; end
sig {
params(_dispute_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def dispute_management=(_dispute_management); end
# Whether sending refunds is enabled. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def refund_management; end
sig { params(_refund_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refund_management=(_refund_management); end
sig {
params(capture_payments: T.nilable(T::Boolean), destination_on_behalf_of_charge_management: T.nilable(T::Boolean), dispute_management: T.nilable(T::Boolean), refund_management: T.nilable(T::Boolean)).void
}
def initialize(
capture_payments: nil,
destination_on_behalf_of_charge_management: nil,
dispute_management: nil,
refund_management: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Payments::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::Payments::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Payments::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::Payments::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class PayoutDetails < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutDetails::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutDetails::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutDetails::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutDetails::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class PayoutReconciliationReport < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutReconciliationReport::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutReconciliationReport::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutReconciliationReport::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutReconciliationReport::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class Payouts < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def disable_stripe_user_authentication; end
sig {
params(_disable_stripe_user_authentication: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def disable_stripe_user_authentication=(_disable_stripe_user_authentication); end
# Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T.nilable(T::Boolean)) }
def edit_payout_schedule; end
sig {
params(_edit_payout_schedule: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def edit_payout_schedule=(_edit_payout_schedule); end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T.nilable(T::Boolean)) }
def external_account_collection; end
sig {
params(_external_account_collection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def external_account_collection=(_external_account_collection); end
# Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T.nilable(T::Boolean)) }
def instant_payouts; end
sig { params(_instant_payouts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def instant_payouts=(_instant_payouts); end
# Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T.nilable(T::Boolean)) }
def standard_payouts; end
sig { params(_standard_payouts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def standard_payouts=(_standard_payouts); end
sig {
params(disable_stripe_user_authentication: T.nilable(T::Boolean), edit_payout_schedule: T.nilable(T::Boolean), external_account_collection: T.nilable(T::Boolean), instant_payouts: T.nilable(T::Boolean), standard_payouts: T.nilable(T::Boolean)).void
}
def initialize(
disable_stripe_user_authentication: nil,
edit_payout_schedule: nil,
external_account_collection: nil,
instant_payouts: nil,
standard_payouts: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Payouts::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::Payouts::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Payouts::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::Payouts::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class PayoutsList < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutsList::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutsList::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutsList::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutsList::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class ProductTaxCodeSelector < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::ProductTaxCodeSelector::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::ProductTaxCodeSelector::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::ProductTaxCodeSelector::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::ProductTaxCodeSelector::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class Recipients < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether to allow sending money.
sig { returns(T.nilable(T::Boolean)) }
def send_money; end
sig { params(_send_money: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def send_money=(_send_money); end
sig { params(send_money: T.nilable(T::Boolean)).void }
def initialize(send_money: nil); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Attribute for param field features
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Recipients::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::Recipients::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Recipients::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::Recipients::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class ReportingChart < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::ReportingChart::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::ReportingChart::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::ReportingChart::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::ReportingChart::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class TaxRegistrations < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxRegistrations::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxRegistrations::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxRegistrations::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxRegistrations::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class TaxSettings < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxSettings::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxSettings::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxSettings::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxSettings::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class TaxThresholdMonitoring < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxThresholdMonitoring::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxThresholdMonitoring::Features)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxThresholdMonitoring::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxThresholdMonitoring::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
# Configuration for the [account management](/connect/supported-embedded-components/account-management/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountManagement))
}
def account_management; end
sig {
params(_account_management: T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountManagement)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountManagement))
}
def account_management=(_account_management); end
# Configuration for the [account onboarding](/connect/supported-embedded-components/account-onboarding/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountOnboarding))
}
def account_onboarding; end
sig {
params(_account_onboarding: T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountOnboarding)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountOnboarding))
}
def account_onboarding=(_account_onboarding); end
# Configuration for the [app install](/connect/supported-embedded-components/app-install/) embedded component.
sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::AppInstall)) }
def app_install; end
sig {
params(_app_install: T.nilable(::Stripe::AccountSession::CreateParams::Components::AppInstall)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::AppInstall))
}
def app_install=(_app_install); end
# Configuration for the [app viewport](/connect/supported-embedded-components/app-viewport/) embedded component.
sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::AppViewport)) }
def app_viewport; end
sig {
params(_app_viewport: T.nilable(::Stripe::AccountSession::CreateParams::Components::AppViewport)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::AppViewport))
}
def app_viewport=(_app_viewport); end
# Configuration for the [balance report](/connect/supported-embedded-components/financial-reports#balance-report) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::BalanceReport))
}
def balance_report; end
sig {
params(_balance_report: T.nilable(::Stripe::AccountSession::CreateParams::Components::BalanceReport)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::BalanceReport))
}
def balance_report=(_balance_report); end
# Configuration for the [balances](/connect/supported-embedded-components/balances/) embedded component.
sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Balances)) }
def balances; end
sig {
params(_balances: T.nilable(::Stripe::AccountSession::CreateParams::Components::Balances)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Balances))
}
def balances=(_balances); end
# Configuration for the [Capital financing](/connect/supported-embedded-components/capital-financing/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancing))
}
def capital_financing; end
sig {
params(_capital_financing: T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancing)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancing))
}
def capital_financing=(_capital_financing); end
# Configuration for the [Capital financing application](/connect/supported-embedded-components/capital-financing-application/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancingApplication))
}
def capital_financing_application; end
sig {
params(_capital_financing_application: T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancingApplication)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancingApplication))
}
def capital_financing_application=(_capital_financing_application); end
# Configuration for the [Capital financing promotion](/connect/supported-embedded-components/capital-financing-promotion/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancingPromotion))
}
def capital_financing_promotion; end
sig {
params(_capital_financing_promotion: T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancingPromotion)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancingPromotion))
}
def capital_financing_promotion=(_capital_financing_promotion); end
# Configuration for the [Capital overview](/connect/supported-embedded-components/capital-overview/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalOverview))
}
def capital_overview; end
sig {
params(_capital_overview: T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalOverview)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalOverview))
}
def capital_overview=(_capital_overview); end
# Configuration for the [disputes list](/connect/supported-embedded-components/disputes-list/) embedded component.
sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::DisputesList)) }
def disputes_list; end
sig {
params(_disputes_list: T.nilable(::Stripe::AccountSession::CreateParams::Components::DisputesList)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::DisputesList))
}
def disputes_list=(_disputes_list); end
# Configuration for the [documents](/connect/supported-embedded-components/documents/) embedded component.
sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Documents)) }
def documents; end
sig {
params(_documents: T.nilable(::Stripe::AccountSession::CreateParams::Components::Documents)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Documents))
}
def documents=(_documents); end
# Configuration for the [export tax transactions](/connect/supported-embedded-components/export-tax-transactions/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::ExportTaxTransactions))
}
def export_tax_transactions; end
sig {
params(_export_tax_transactions: T.nilable(::Stripe::AccountSession::CreateParams::Components::ExportTaxTransactions)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::ExportTaxTransactions))
}
def export_tax_transactions=(_export_tax_transactions); end
# Configuration for the [financial account](/connect/supported-embedded-components/financial-account/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccount))
}
def financial_account; end
sig {
params(_financial_account: T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccount)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccount))
}
def financial_account=(_financial_account); end
# Configuration for the [financial account transactions](/connect/supported-embedded-components/financial-account-transactions/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccountTransactions))
}
def financial_account_transactions; end
sig {
params(_financial_account_transactions: T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccountTransactions)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccountTransactions))
}
def financial_account_transactions=(_financial_account_transactions); end
# Configuration for the [instant payouts promotion](/connect/supported-embedded-components/instant-payouts-promotion/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::InstantPayoutsPromotion))
}
def instant_payouts_promotion; end
sig {
params(_instant_payouts_promotion: T.nilable(::Stripe::AccountSession::CreateParams::Components::InstantPayoutsPromotion)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::InstantPayoutsPromotion))
}
def instant_payouts_promotion=(_instant_payouts_promotion); end
# Configuration for the [issuing card](/connect/supported-embedded-components/issuing-card/) embedded component.
sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCard)) }
def issuing_card; end
sig {
params(_issuing_card: T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCard)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCard))
}
def issuing_card=(_issuing_card); end
# Configuration for the [issuing cards list](/connect/supported-embedded-components/issuing-cards-list/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCardsList))
}
def issuing_cards_list; end
sig {
params(_issuing_cards_list: T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCardsList)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCardsList))
}
def issuing_cards_list=(_issuing_cards_list); end
# Configuration for the [notification banner](/connect/supported-embedded-components/notification-banner/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::NotificationBanner))
}
def notification_banner; end
sig {
params(_notification_banner: T.nilable(::Stripe::AccountSession::CreateParams::Components::NotificationBanner)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::NotificationBanner))
}
def notification_banner=(_notification_banner); end
# Configuration for the [payment details](/connect/supported-embedded-components/payment-details/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDetails))
}
def payment_details; end
sig {
params(_payment_details: T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDetails)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDetails))
}
def payment_details=(_payment_details); end
# Configuration for the [payment disputes](/connect/supported-embedded-components/payment-disputes/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDisputes))
}
def payment_disputes; end
sig {
params(_payment_disputes: T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDisputes)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDisputes))
}
def payment_disputes=(_payment_disputes); end
# Configuration for the [payment method settings](/connect/supported-embedded-components/payment-method-settings/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentMethodSettings))
}
def payment_method_settings; end
sig {
params(_payment_method_settings: T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentMethodSettings)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentMethodSettings))
}
def payment_method_settings=(_payment_method_settings); end
# Configuration for the [payments](/connect/supported-embedded-components/payments/) embedded component.
sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Payments)) }
def payments; end
sig {
params(_payments: T.nilable(::Stripe::AccountSession::CreateParams::Components::Payments)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Payments))
}
def payments=(_payments); end
# Configuration for the [payout details](/connect/supported-embedded-components/payout-details/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutDetails))
}
def payout_details; end
sig {
params(_payout_details: T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutDetails)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutDetails))
}
def payout_details=(_payout_details); end
# Configuration for the [payout reconciliation report](/connect/supported-embedded-components/financial-reports#payout-reconciliation-report) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutReconciliationReport))
}
def payout_reconciliation_report; end
sig {
params(_payout_reconciliation_report: T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutReconciliationReport)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutReconciliationReport))
}
def payout_reconciliation_report=(_payout_reconciliation_report); end
# Configuration for the [payouts](/connect/supported-embedded-components/payouts/) embedded component.
sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Payouts)) }
def payouts; end
sig {
params(_payouts: T.nilable(::Stripe::AccountSession::CreateParams::Components::Payouts)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Payouts))
}
def payouts=(_payouts); end
# Configuration for the [payouts list](/connect/supported-embedded-components/payouts-list/) embedded component.
sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutsList)) }
def payouts_list; end
sig {
params(_payouts_list: T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutsList)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutsList))
}
def payouts_list=(_payouts_list); end
# Configuration for the [product tax code selector](/connect/supported-embedded-components/product-tax-code-selector/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::ProductTaxCodeSelector))
}
def product_tax_code_selector; end
sig {
params(_product_tax_code_selector: T.nilable(::Stripe::AccountSession::CreateParams::Components::ProductTaxCodeSelector)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::ProductTaxCodeSelector))
}
def product_tax_code_selector=(_product_tax_code_selector); end
# Configuration for the [recipients](/connect/supported-embedded-components/recipients/) embedded component.
sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Recipients)) }
def recipients; end
sig {
params(_recipients: T.nilable(::Stripe::AccountSession::CreateParams::Components::Recipients)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Recipients))
}
def recipients=(_recipients); end
# Configuration for the [reporting chart](/connect/supported-embedded-components/reporting-chart/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::ReportingChart))
}
def reporting_chart; end
sig {
params(_reporting_chart: T.nilable(::Stripe::AccountSession::CreateParams::Components::ReportingChart)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::ReportingChart))
}
def reporting_chart=(_reporting_chart); end
# Configuration for the [tax registrations](/connect/supported-embedded-components/tax-registrations/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxRegistrations))
}
def tax_registrations; end
sig {
params(_tax_registrations: T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxRegistrations)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxRegistrations))
}
def tax_registrations=(_tax_registrations); end
# Configuration for the [tax settings](/connect/supported-embedded-components/tax-settings/) embedded component.
sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxSettings)) }
def tax_settings; end
sig {
params(_tax_settings: T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxSettings)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxSettings))
}
def tax_settings=(_tax_settings); end
# Configuration for the [tax threshold monitoring](/connect/supported-embedded-components/tax-threshold-monitoring/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxThresholdMonitoring))
}
def tax_threshold_monitoring; end
sig {
params(_tax_threshold_monitoring: T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxThresholdMonitoring)).returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxThresholdMonitoring))
}
def tax_threshold_monitoring=(_tax_threshold_monitoring); end
sig {
params(account_management: T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountManagement), account_onboarding: T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountOnboarding), app_install: T.nilable(::Stripe::AccountSession::CreateParams::Components::AppInstall), app_viewport: T.nilable(::Stripe::AccountSession::CreateParams::Components::AppViewport), balance_report: T.nilable(::Stripe::AccountSession::CreateParams::Components::BalanceReport), balances: T.nilable(::Stripe::AccountSession::CreateParams::Components::Balances), capital_financing: T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancing), capital_financing_application: T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancingApplication), capital_financing_promotion: T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalFinancingPromotion), capital_overview: T.nilable(::Stripe::AccountSession::CreateParams::Components::CapitalOverview), disputes_list: T.nilable(::Stripe::AccountSession::CreateParams::Components::DisputesList), documents: T.nilable(::Stripe::AccountSession::CreateParams::Components::Documents), export_tax_transactions: T.nilable(::Stripe::AccountSession::CreateParams::Components::ExportTaxTransactions), financial_account: T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccount), financial_account_transactions: T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccountTransactions), instant_payouts_promotion: T.nilable(::Stripe::AccountSession::CreateParams::Components::InstantPayoutsPromotion), issuing_card: T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCard), issuing_cards_list: T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCardsList), notification_banner: T.nilable(::Stripe::AccountSession::CreateParams::Components::NotificationBanner), payment_details: T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDetails), payment_disputes: T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDisputes), payment_method_settings: T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentMethodSettings), payments: T.nilable(::Stripe::AccountSession::CreateParams::Components::Payments), payout_details: T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutDetails), payout_reconciliation_report: T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutReconciliationReport), payouts: T.nilable(::Stripe::AccountSession::CreateParams::Components::Payouts), payouts_list: T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutsList), product_tax_code_selector: T.nilable(::Stripe::AccountSession::CreateParams::Components::ProductTaxCodeSelector), recipients: T.nilable(::Stripe::AccountSession::CreateParams::Components::Recipients), reporting_chart: T.nilable(::Stripe::AccountSession::CreateParams::Components::ReportingChart), tax_registrations: T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxRegistrations), tax_settings: T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxSettings), tax_threshold_monitoring: T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxThresholdMonitoring)).void
}
def initialize(
account_management: nil,
account_onboarding: nil,
app_install: nil,
app_viewport: nil,
balance_report: nil,
balances: nil,
capital_financing: nil,
capital_financing_application: nil,
capital_financing_promotion: nil,
capital_overview: nil,
disputes_list: nil,
documents: nil,
export_tax_transactions: nil,
financial_account: nil,
financial_account_transactions: nil,
instant_payouts_promotion: nil,
issuing_card: nil,
issuing_cards_list: nil,
notification_banner: nil,
payment_details: nil,
payment_disputes: nil,
payment_method_settings: nil,
payments: nil,
payout_details: nil,
payout_reconciliation_report: nil,
payouts: nil,
payouts_list: nil,
product_tax_code_selector: nil,
recipients: nil,
reporting_chart: nil,
tax_registrations: nil,
tax_settings: nil,
tax_threshold_monitoring: nil
); end
end
# The identifier of the account to create an Account Session for.
sig { returns(String) }
def account; end
sig { params(_account: String).returns(String) }
def account=(_account); end
# Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).
sig { returns(::Stripe::AccountSession::CreateParams::Components) }
def components; end
sig {
params(_components: ::Stripe::AccountSession::CreateParams::Components).returns(::Stripe::AccountSession::CreateParams::Components)
}
def components=(_components); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(account: String, components: ::Stripe::AccountSession::CreateParams::Components, expand: T.nilable(T::Array[String])).void
}
def initialize(account: nil, components: nil, expand: nil); end
end
# Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
sig {
params(params: T.any(::Stripe::AccountSession::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::AccountSession)
}
def self.create(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# This is an object representing a Stripe account. You can retrieve it to see
# properties on the account like its current requirements or if the account is
# enabled to make live charges or receive payouts.
#
# For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection)
# is `application`, which includes Custom accounts, the properties below are always
# returned.
#
# For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection)
# is `stripe`, which includes Standard and Express accounts, some properties are only returned
# until you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions)
# to start Connect Onboarding. Learn about the [differences between accounts](https://docs.stripe.com/connect/accounts).
class Account < APIResource
class BusinessProfile < Stripe::StripeObject
class AnnualRevenue < Stripe::StripeObject
# A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).
sig { returns(T.nilable(Integer)) }
def amount; end
# 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(T.nilable(String)) }
def currency; end
# The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
sig { returns(T.nilable(String)) }
def fiscal_year_end; end
end
class MonthlyEstimatedRevenue < Stripe::StripeObject
# A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
end
class SupportAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# The applicant's gross annual revenue for its preceding fiscal year.
sig { returns(T.nilable(AnnualRevenue)) }
def annual_revenue; end
# An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
sig { returns(T.nilable(Integer)) }
def estimated_worker_count; end
# [The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
sig { returns(T.nilable(String)) }
def mcc; end
# Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business.
sig { returns(T.nilable(T::Array[String])) }
def minority_owned_business_designation; end
# Attribute for field monthly_estimated_revenue
sig { returns(T.nilable(MonthlyEstimatedRevenue)) }
def monthly_estimated_revenue; end
# The customer-facing business name.
sig { returns(T.nilable(String)) }
def name; end
# Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes.
sig { returns(T.nilable(String)) }
def product_description; end
# A publicly available mailing address for sending support issues to.
sig { returns(T.nilable(SupportAddress)) }
def support_address; end
# A publicly available email address for sending support issues to.
sig { returns(T.nilable(String)) }
def support_email; end
# A publicly available phone number to call with support issues.
sig { returns(T.nilable(String)) }
def support_phone; end
# A publicly available website for handling support issues.
sig { returns(T.nilable(String)) }
def support_url; end
# The business's publicly available website.
sig { returns(T.nilable(String)) }
def url; end
end
class Capabilities < Stripe::StripeObject
# The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges.
sig { returns(T.nilable(String)) }
def acss_debit_payments; end
# The status of the Affirm capability of the account, or whether the account can directly process Affirm charges.
sig { returns(T.nilable(String)) }
def affirm_payments; end
# The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges.
sig { returns(T.nilable(String)) }
def afterpay_clearpay_payments; end
# The status of the Alma capability of the account, or whether the account can directly process Alma payments.
sig { returns(T.nilable(String)) }
def alma_payments; end
# The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments.
sig { returns(T.nilable(String)) }
def amazon_pay_payments; end
# The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges.
sig { returns(T.nilable(String)) }
def au_becs_debit_payments; end
# The status of the automatic_indirect_tax capability of the account.
sig { returns(T.nilable(String)) }
def automatic_indirect_tax; end
# The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges.
sig { returns(T.nilable(String)) }
def bacs_debit_payments; end
# The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges.
sig { returns(T.nilable(String)) }
def bancontact_payments; end
# The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges.
sig { returns(T.nilable(String)) }
def bank_transfer_payments; end
# The status of the Billie capability of the account, or whether the account can directly process Billie payments.
sig { returns(T.nilable(String)) }
def billie_payments; end
# The status of the blik payments capability of the account, or whether the account can directly process blik charges.
sig { returns(T.nilable(String)) }
def blik_payments; end
# The status of the boleto payments capability of the account, or whether the account can directly process boleto charges.
sig { returns(T.nilable(String)) }
def boleto_payments; end
# The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards
sig { returns(T.nilable(String)) }
def card_issuing; end
# The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges.
sig { returns(T.nilable(String)) }
def card_payments; end
# The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency.
sig { returns(T.nilable(String)) }
def cartes_bancaires_payments; end
# The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments.
sig { returns(T.nilable(String)) }
def cashapp_payments; end
# The status of the Crypto capability of the account, or whether the account can directly process Crypto payments.
sig { returns(T.nilable(String)) }
def crypto_payments; end
# The status of the EPS payments capability of the account, or whether the account can directly process EPS charges.
sig { returns(T.nilable(String)) }
def eps_payments; end
# The status of the FPX payments capability of the account, or whether the account can directly process FPX charges.
sig { returns(T.nilable(String)) }
def fpx_payments; end
# The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges.
sig { returns(T.nilable(String)) }
def gb_bank_transfer_payments; end
# The status of the giropay payments capability of the account, or whether the account can directly process giropay charges.
sig { returns(T.nilable(String)) }
def giropay_payments; end
# The status of the Gopay capability of the account, or whether the account can directly process Gopay payments.
sig { returns(T.nilable(String)) }
def gopay_payments; end
# The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges.
sig { returns(T.nilable(String)) }
def grabpay_payments; end
# The status of the Indonesia Bank Transfer payments capability of the account, or whether the account can directly process Indonesia Bank Transfer charges.
sig { returns(T.nilable(String)) }
def id_bank_transfer_payments; end
# The status of Bank BCA onboarding of the account.
sig { returns(T.nilable(String)) }
def id_bank_transfer_payments_bca; end
# The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges.
sig { returns(T.nilable(String)) }
def ideal_payments; end
# The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India.
sig { returns(T.nilable(String)) }
def india_international_payments; end
# The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency.
sig { returns(T.nilable(String)) }
def jcb_payments; end
# The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges.
sig { returns(T.nilable(String)) }
def jp_bank_transfer_payments; end
# The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments.
sig { returns(T.nilable(String)) }
def kakao_pay_payments; end
# The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges.
sig { returns(T.nilable(String)) }
def klarna_payments; end
# The status of the konbini payments capability of the account, or whether the account can directly process konbini charges.
sig { returns(T.nilable(String)) }
def konbini_payments; end
# The status of the KrCard capability of the account, or whether the account can directly process KrCard payments.
sig { returns(T.nilable(String)) }
def kr_card_payments; end
# The status of the legacy payments capability of the account.
sig { returns(T.nilable(String)) }
def legacy_payments; end
# The status of the link_payments capability of the account, or whether the account can directly process Link charges.
sig { returns(T.nilable(String)) }
def link_payments; end
# The status of the MB WAY payments capability of the account, or whether the account can directly process MB WAY charges.
sig { returns(T.nilable(String)) }
def mb_way_payments; end
# The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges.
sig { returns(T.nilable(String)) }
def mobilepay_payments; end
# The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges.
sig { returns(T.nilable(String)) }
def multibanco_payments; end
# The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges.
sig { returns(T.nilable(String)) }
def mx_bank_transfer_payments; end
# The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments.
sig { returns(T.nilable(String)) }
def naver_pay_payments; end
# The status of the New Zealand BECS Direct Debit payments capability of the account, or whether the account can directly process New Zealand BECS Direct Debit charges.
sig { returns(T.nilable(String)) }
def nz_bank_account_becs_debit_payments; end
# The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges.
sig { returns(T.nilable(String)) }
def oxxo_payments; end
# The status of the P24 payments capability of the account, or whether the account can directly process P24 charges.
sig { returns(T.nilable(String)) }
def p24_payments; end
# The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges.
sig { returns(T.nilable(String)) }
def pay_by_bank_payments; end
# The status of the Payco capability of the account, or whether the account can directly process Payco payments.
sig { returns(T.nilable(String)) }
def payco_payments; end
# The status of the paynow payments capability of the account, or whether the account can directly process paynow charges.
sig { returns(T.nilable(String)) }
def paynow_payments; end
# The status of the PayPal payments capability of the account, or whether the account can directly process PayPal charges.
sig { returns(T.nilable(String)) }
def paypal_payments; end
# The status of the Paypay capability of the account, or whether the account can directly process Paypay payments.
sig { returns(T.nilable(String)) }
def paypay_payments; end
# The status of the PayTo capability of the account, or whether the account can directly process PayTo charges.
sig { returns(T.nilable(String)) }
def payto_payments; end
# The status of the pix payments capability of the account, or whether the account can directly process pix charges.
sig { returns(T.nilable(String)) }
def pix_payments; end
# The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges.
sig { returns(T.nilable(String)) }
def promptpay_payments; end
# The status of the Qris capability of the account, or whether the account can directly process Qris payments.
sig { returns(T.nilable(String)) }
def qris_payments; end
# The status of the Rechnung capability of the account, or whether the account can directly process Rechnung payments.
sig { returns(T.nilable(String)) }
def rechnung_payments; end
# The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments.
sig { returns(T.nilable(String)) }
def revolut_pay_payments; end
# The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments.
sig { returns(T.nilable(String)) }
def samsung_pay_payments; end
# The status of the Satispay capability of the account, or whether the account can directly process Satispay payments.
sig { returns(T.nilable(String)) }
def satispay_payments; end
# The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges.
sig { returns(T.nilable(String)) }
def sepa_bank_transfer_payments; end
# The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges.
sig { returns(T.nilable(String)) }
def sepa_debit_payments; end
# The status of the ShopeePay capability of the account, or whether the account can directly process ShopeePay payments.
sig { returns(T.nilable(String)) }
def shopeepay_payments; end
# The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges.
sig { returns(T.nilable(String)) }
def sofort_payments; end
# The status of the stripe_balance payments capability of the account, or whether the account can directly process stripe_balance charges.
sig { returns(T.nilable(String)) }
def stripe_balance_payments; end
# The status of the Swish capability of the account, or whether the account can directly process Swish payments.
sig { returns(T.nilable(String)) }
def swish_payments; end
# The status of the tax reporting 1099-K (US) capability of the account.
sig { returns(T.nilable(String)) }
def tax_reporting_us_1099_k; end
# The status of the tax reporting 1099-MISC (US) capability of the account.
sig { returns(T.nilable(String)) }
def tax_reporting_us_1099_misc; end
# The status of the transfers capability of the account, or whether your platform can transfer funds to the account.
sig { returns(T.nilable(String)) }
def transfers; end
# The status of the banking capability, or whether the account can have bank accounts.
sig { returns(T.nilable(String)) }
def treasury; end
# The status of the treasury_evolve capability of the account.
sig { returns(T.nilable(String)) }
def treasury_evolve; end
# The status of the treasury_fifth_third capability of the account.
sig { returns(T.nilable(String)) }
def treasury_fifth_third; end
# The status of the treasury_goldman_sachs capability of the account.
sig { returns(T.nilable(String)) }
def treasury_goldman_sachs; end
# The status of the TWINT capability of the account, or whether the account can directly process TWINT charges.
sig { returns(T.nilable(String)) }
def twint_payments; end
# The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges.
sig { returns(T.nilable(String)) }
def us_bank_account_ach_payments; end
# The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges.
sig { returns(T.nilable(String)) }
def us_bank_transfer_payments; end
# The status of the Zip capability of the account, or whether the account can directly process Zip charges.
sig { returns(T.nilable(String)) }
def zip_payments; end
end
class Company < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class AddressKana < Stripe::StripeObject
# City/Ward.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Block/Building number.
sig { returns(T.nilable(String)) }
def line1; end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
# Town/cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
class AddressKanji < Stripe::StripeObject
# City/Ward.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Block/Building number.
sig { returns(T.nilable(String)) }
def line1; end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
# Town/cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
class DirectorshipDeclaration < Stripe::StripeObject
# The Unix timestamp marking when the directorship declaration attestation was made.
sig { returns(T.nilable(Integer)) }
def date; end
# The IP address from which the directorship declaration attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
# The user-agent string from the browser where the directorship declaration attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
end
class OwnershipDeclaration < Stripe::StripeObject
# The Unix timestamp marking when the beneficial owner attestation was made.
sig { returns(T.nilable(Integer)) }
def date; end
# The IP address from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
# The user-agent string from the browser where the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
end
class RegistrationDate < Stripe::StripeObject
# The day of registration, between 1 and 31.
sig { returns(T.nilable(Integer)) }
def day; end
# The month of registration, between 1 and 12.
sig { returns(T.nilable(Integer)) }
def month; end
# The four-digit year of registration.
sig { returns(T.nilable(Integer)) }
def year; end
end
class Verification < Stripe::StripeObject
class Document < Stripe::StripeObject
# The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](/file-upload#uploading-a-file).
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def back; end
# A user-displayable string describing the verification state of this document.
sig { returns(T.nilable(String)) }
def details; end
# One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document.
sig { returns(T.nilable(String)) }
def details_code; end
# The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](/file-upload#uploading-a-file).
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def front; end
end
# Attribute for field document
sig { returns(Document) }
def document; end
end
# Attribute for field address
sig { returns(T.nilable(Address)) }
def address; end
# The Kana variation of the company's primary address (Japan only).
sig { returns(T.nilable(AddressKana)) }
def address_kana; end
# The Kanji variation of the company's primary address (Japan only).
sig { returns(T.nilable(AddressKanji)) }
def address_kanji; end
# Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided).
sig { returns(T.nilable(T::Boolean)) }
def directors_provided; end
# This hash is used to attest that the director information provided to Stripe is both current and correct.
sig { returns(T.nilable(DirectorshipDeclaration)) }
def directorship_declaration; end
# Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided.
sig { returns(T.nilable(T::Boolean)) }
def executives_provided; end
# The export license ID number of the company, also referred as Import Export Code (India only).
sig { returns(T.nilable(String)) }
def export_license_id; end
# The purpose code to use for export transactions (India only).
sig { returns(T.nilable(String)) }
def export_purpose_code; end
# The company's legal name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
sig { returns(T.nilable(String)) }
def name; end
# The Kana variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
sig { returns(T.nilable(String)) }
def name_kana; end
# The Kanji variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
sig { returns(T.nilable(String)) }
def name_kanji; end
# Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together).
sig { returns(T.nilable(T::Boolean)) }
def owners_provided; end
# This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
sig { returns(T.nilable(OwnershipDeclaration)) }
def ownership_declaration; end
# This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.
sig { returns(T.nilable(String)) }
def ownership_exemption_reason; end
# The company's phone number (used for verification).
sig { returns(T.nilable(String)) }
def phone; end
# Attribute for field registration_date
sig { returns(T.nilable(RegistrationDate)) }
def registration_date; end
# The category identifying the legal structure of the company or legal entity. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details.
sig { returns(T.nilable(String)) }
def structure; end
# Whether the company's business ID number was provided.
sig { returns(T.nilable(T::Boolean)) }
def tax_id_provided; end
# The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
sig { returns(T.nilable(String)) }
def tax_id_registrar; end
# Whether the company's business VAT number was provided.
sig { returns(T.nilable(T::Boolean)) }
def vat_id_provided; end
# Information on the verification state of the company.
sig { returns(T.nilable(Verification)) }
def verification; end
end
class Controller < Stripe::StripeObject
class Application < Stripe::StripeObject
# `true` if the Connect application is responsible for negative balances and should manage credit and fraud risk on the account.
sig { returns(T::Boolean) }
def loss_liable; end
# `true` if the Connect application is responsible for onboarding the account.
sig { returns(T::Boolean) }
def onboarding_owner; end
# `true` if the Connect application is responsible for paying Stripe fees on pricing-control eligible products.
sig { returns(T::Boolean) }
def pricing_controls; end
end
class Dashboard < Stripe::StripeObject
# Whether this account has access to the full Stripe dashboard (`full`), to the Express dashboard (`express`), or to no dashboard (`none`).
sig { returns(String) }
def type; end
end
class Fees < Stripe::StripeObject
# A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).
sig { returns(String) }
def payer; end
end
class Losses < Stripe::StripeObject
# A value indicating who is liable when this account can't pay back negative balances from payments.
sig { returns(String) }
def payments; end
end
class StripeDashboard < Stripe::StripeObject
# A value indicating the Stripe dashboard this account has access to independent of the Connect application.
sig { returns(String) }
def type; end
end
# Attribute for field application
sig { returns(T.nilable(Application)) }
def application; end
# Attribute for field dashboard
sig { returns(T.nilable(Dashboard)) }
def dashboard; end
# Attribute for field fees
sig { returns(T.nilable(Fees)) }
def fees; end
# `true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null.
sig { returns(T.nilable(T::Boolean)) }
def is_controller; end
# Attribute for field losses
sig { returns(T.nilable(Losses)) }
def losses; end
# A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account.
sig { returns(T.nilable(String)) }
def requirement_collection; end
# Attribute for field stripe_dashboard
sig { returns(T.nilable(StripeDashboard)) }
def stripe_dashboard; end
# The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself.
sig { returns(String) }
def type; end
end
class FutureRequirements < Stripe::StripeObject
class Alternative < Stripe::StripeObject
# Fields that can be provided to satisfy all fields in `original_fields_due`.
sig { returns(T::Array[String]) }
def alternative_fields_due; end
# Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
sig { returns(T::Array[String]) }
def original_fields_due; end
end
class Error < Stripe::StripeObject
# The code for the type of error.
sig { returns(String) }
def code; end
# An informative message that indicates the error type and provides additional details about the error.
sig { returns(String) }
def reason; end
# The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
sig { returns(String) }
def requirement; end
end
# Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
sig { returns(T.nilable(T::Array[Alternative])) }
def alternatives; end
# Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning.
sig { returns(T.nilable(Integer)) }
def current_deadline; end
# Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
sig { returns(T.nilable(T::Array[String])) }
def currently_due; end
# This is typed as an enum for consistency with `requirements.disabled_reason`.
sig { returns(T.nilable(String)) }
def disabled_reason; end
# Fields that are `currently_due` and need to be collected again because validation or verification failed.
sig { returns(T.nilable(T::Array[Error])) }
def errors; end
# Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
sig { returns(T.nilable(T::Array[String])) }
def eventually_due; end
# Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.
sig { returns(T.nilable(T::Array[String])) }
def past_due; end
# Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.
sig { returns(T.nilable(T::Array[String])) }
def pending_verification; end
end
class Groups < Stripe::StripeObject
# The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details.
sig { returns(T.nilable(String)) }
def payments_pricing; end
end
class Requirements < Stripe::StripeObject
class Alternative < Stripe::StripeObject
# Fields that can be provided to satisfy all fields in `original_fields_due`.
sig { returns(T::Array[String]) }
def alternative_fields_due; end
# Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
sig { returns(T::Array[String]) }
def original_fields_due; end
end
class Error < Stripe::StripeObject
# The code for the type of error.
sig { returns(String) }
def code; end
# An informative message that indicates the error type and provides additional details about the error.
sig { returns(String) }
def reason; end
# The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
sig { returns(String) }
def requirement; end
end
# Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
sig { returns(T.nilable(T::Array[Alternative])) }
def alternatives; end
# Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected.
sig { returns(T.nilable(Integer)) }
def current_deadline; end
# Fields that need to be collected to keep the account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
sig { returns(T.nilable(T::Array[String])) }
def currently_due; end
# If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).
sig { returns(T.nilable(String)) }
def disabled_reason; end
# Fields that are `currently_due` and need to be collected again because validation or verification failed.
sig { returns(T.nilable(T::Array[Error])) }
def errors; end
# Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
sig { returns(T.nilable(T::Array[String])) }
def eventually_due; end
# Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account.
sig { returns(T.nilable(T::Array[String])) }
def past_due; end
# Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
sig { returns(T.nilable(T::Array[String])) }
def pending_verification; end
end
class RiskControls < Stripe::StripeObject
class Charges < Stripe::StripeObject
# Whether a pause of the risk control has been requested.
sig { returns(T::Boolean) }
def pause_requested; end
end
class Payouts < Stripe::StripeObject
# Whether a pause of the risk control has been requested.
sig { returns(T::Boolean) }
def pause_requested; end
end
# Attribute for field charges
sig { returns(Charges) }
def charges; end
# Attribute for field payouts
sig { returns(Payouts) }
def payouts; end
# Represents the rejected reason of the account. Empty if account is not rejected, or rejected by Stripe. Please see [this page for more details](https://stripe.com/docs/connect/)
sig { returns(T.nilable(String)) }
def rejected_reason; end
end
class Settings < Stripe::StripeObject
class BacsDebitPayments < Stripe::StripeObject
# The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free.
sig { returns(T.nilable(String)) }
def display_name; end
# The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners.
sig { returns(T.nilable(String)) }
def service_user_number; end
end
class BankBcaOnboarding < Stripe::StripeObject
# Bank BCA business account holder name.
sig { returns(T.nilable(String)) }
def account_holder_name; end
# Bank BCA business account number.
sig { returns(T.nilable(String)) }
def business_account_number; end
end
class Branding < Stripe::StripeObject
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def icon; end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def logo; end
# A CSS hex color value representing the primary branding color for this account
sig { returns(T.nilable(String)) }
def primary_color; end
# A CSS hex color value representing the secondary branding color for this account
sig { returns(T.nilable(String)) }
def secondary_color; end
end
class Capital < Stripe::StripeObject
# Per-currency mapping of user-selected destination accounts used to pay out loans.
sig { returns(T.nilable(T::Hash[String, String])) }
def payout_destination; end
# Per-currency mapping of all destination accounts eligible to receive loan payouts.
sig { returns(T.nilable(T::Hash[String, T::Array[String]])) }
def payout_destination_selector; end
end
class CardIssuing < Stripe::StripeObject
class TosAcceptance < Stripe::StripeObject
# The Unix timestamp marking when the account representative accepted the service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
# The IP address from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def ip; end
# The user agent of the browser from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
end
# Attribute for field tos_acceptance
sig { returns(T.nilable(TosAcceptance)) }
def tos_acceptance; end
end
class CardPayments < Stripe::StripeObject
class DeclineOn < Stripe::StripeObject
# Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.
sig { returns(T::Boolean) }
def avs_failure; end
# Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.
sig { returns(T::Boolean) }
def cvc_failure; end
end
# Attribute for field decline_on
sig { returns(T.nilable(DeclineOn)) }
def decline_on; end
# The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix; end
# The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion.
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix_kana; end
# The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion.
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix_kanji; end
end
class Dashboard < Stripe::StripeObject
# The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts.
sig { returns(T.nilable(String)) }
def display_name; end
# The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones).
sig { returns(T.nilable(String)) }
def timezone; end
end
class Invoices < Stripe::StripeObject
# The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
def default_account_tax_ids; end
# Whether payment methods should be saved when a payment is completed for a one-time invoices on a hosted invoice page.
sig { returns(T.nilable(String)) }
def hosted_payment_method_save; end
end
class Payments < Stripe::StripeObject
# The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
# The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor_kana; end
# The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor_kanji; end
# The Kana variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix_kana; end
# The Kanji variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix_kanji; end
end
class Payouts < Stripe::StripeObject
class Schedule < Stripe::StripeObject
# The number of days charges for the account will be held before being paid out.
sig { returns(Integer) }
def delay_days; end
# How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.
sig { returns(String) }
def interval; end
# The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
sig { returns(T.nilable(Integer)) }
def monthly_anchor; end
# The days of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
sig { returns(T.nilable(T::Array[Integer])) }
def monthly_payout_days; end
# The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly.
sig { returns(T.nilable(String)) }
def weekly_anchor; end
# The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly.
sig { returns(T.nilable(T::Array[String])) }
def weekly_payout_days; end
end
# A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`.
sig { returns(T::Boolean) }
def debit_negative_balances; end
# Attribute for field schedule
sig { returns(Schedule) }
def schedule; end
# The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
end
class SepaDebitPayments < Stripe::StripeObject
# SEPA creditor identifier that identifies the company making the payment.
sig { returns(T.nilable(String)) }
def creditor_id; end
end
class TaxForms < Stripe::StripeObject
# Whether the account opted out of receiving their tax forms by postal delivery.
sig { returns(T::Boolean) }
def consented_to_paperless_delivery; end
end
class Treasury < Stripe::StripeObject
class TosAcceptance < Stripe::StripeObject
# The Unix timestamp marking when the account representative accepted the service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
# The IP address from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def ip; end
# The user agent of the browser from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
end
# Attribute for field tos_acceptance
sig { returns(T.nilable(TosAcceptance)) }
def tos_acceptance; end
end
# Attribute for field bacs_debit_payments
sig { returns(T.nilable(BacsDebitPayments)) }
def bacs_debit_payments; end
# Attribute for field bank_bca_onboarding
sig { returns(T.nilable(BankBcaOnboarding)) }
def bank_bca_onboarding; end
# Attribute for field branding
sig { returns(Branding) }
def branding; end
# Attribute for field capital
sig { returns(T.nilable(Capital)) }
def capital; end
# Attribute for field card_issuing
sig { returns(T.nilable(CardIssuing)) }
def card_issuing; end
# Attribute for field card_payments
sig { returns(CardPayments) }
def card_payments; end
# Attribute for field dashboard
sig { returns(Dashboard) }
def dashboard; end
# Attribute for field invoices
sig { returns(T.nilable(Invoices)) }
def invoices; end
# Attribute for field payments
sig { returns(Payments) }
def payments; end
# Attribute for field payouts
sig { returns(T.nilable(Payouts)) }
def payouts; end
# Attribute for field sepa_debit_payments
sig { returns(T.nilable(SepaDebitPayments)) }
def sepa_debit_payments; end
# Attribute for field tax_forms
sig { returns(T.nilable(TaxForms)) }
def tax_forms; end
# Attribute for field treasury
sig { returns(T.nilable(Treasury)) }
def treasury; end
end
class TosAcceptance < Stripe::StripeObject
# The Unix timestamp marking when the account representative accepted their service agreement
sig { returns(T.nilable(Integer)) }
def date; end
# The IP address from which the account representative accepted their service agreement
sig { returns(T.nilable(String)) }
def ip; end
# The user's service agreement type
sig { returns(T.nilable(String)) }
def service_agreement; end
# The user agent of the browser from which the account representative accepted their service agreement
sig { returns(T.nilable(String)) }
def user_agent; end
end
# Business information about the account.
sig { returns(T.nilable(BusinessProfile)) }
def business_profile; end
# The business type.
sig { returns(T.nilable(String)) }
def business_type; end
# Attribute for field capabilities
sig { returns(T.nilable(Capabilities)) }
def capabilities; end
# Whether the account can process charges.
sig { returns(T.nilable(T::Boolean)) }
def charges_enabled; end
# Attribute for field company
sig { returns(T.nilable(Company)) }
def company; end
# Attribute for field controller
sig { returns(T.nilable(Controller)) }
def controller; end
# The account's country.
sig { returns(T.nilable(String)) }
def country; end
# Time at which the account was connected. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def created; end
# Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).
sig { returns(T.nilable(String)) }
def default_currency; end
# Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details.
sig { returns(T.nilable(T::Boolean)) }
def details_submitted; end
# An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform.
sig { returns(T.nilable(String)) }
def email; end
# External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true.
sig { returns(T.nilable(Stripe::ListObject)) }
def external_accounts; end
# Attribute for field future_requirements
sig { returns(T.nilable(FutureRequirements)) }
def future_requirements; end
# The groups associated with the account.
sig { returns(T.nilable(Groups)) }
def groups; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# This is an object representing a person associated with a Stripe account.
#
# A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](/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](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information).
sig { returns(T.nilable(Stripe::Person)) }
def individual; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Whether the funds in this account can be paid out.
sig { returns(T.nilable(T::Boolean)) }
def payouts_enabled; end
# Attribute for field requirements
sig { returns(T.nilable(Requirements)) }
def requirements; end
# Attribute for field risk_controls
sig { returns(T.nilable(RiskControls)) }
def risk_controls; end
# Options for customizing how the account functions within Stripe.
sig { returns(T.nilable(Settings)) }
def settings; end
# Attribute for field tos_acceptance
sig { returns(T.nilable(TosAcceptance)) }
def tos_acceptance; end
# The Stripe account type. Can be `standard`, `express`, `custom`, or `none`.
sig { returns(T.nilable(String)) }
def type; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams; end
class UpdateParams < Stripe::RequestParams
class BankAccount < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The account number for the bank account, in string form. Must be a checking account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The country in which the bank account is located.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts)
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(object: String, account_holder_name: T.nilable(String), account_holder_type: T.nilable(String), account_number: String, country: String, currency: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
object: nil,
account_holder_name: nil,
account_holder_type: nil,
account_number: nil,
country: nil,
currency: nil,
routing_number: nil
); end
end
class BusinessProfile < Stripe::RequestParams
class AnnualRevenue < Stripe::RequestParams
# A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
sig { returns(String) }
def fiscal_year_end; end
sig { params(_fiscal_year_end: String).returns(String) }
def fiscal_year_end=(_fiscal_year_end); end
sig { params(amount: Integer, currency: String, fiscal_year_end: String).void }
def initialize(amount: nil, currency: nil, fiscal_year_end: nil); end
end
class MonthlyEstimatedRevenue < Stripe::RequestParams
# A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
sig { params(amount: Integer, currency: String).void }
def initialize(amount: nil, currency: nil); end
end
class SupportAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The applicant's gross annual revenue for its preceding fiscal year.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::BusinessProfile::AnnualRevenue)) }
def annual_revenue; end
sig {
params(_annual_revenue: T.nilable(::Stripe::Account::UpdateParams::BusinessProfile::AnnualRevenue)).returns(T.nilable(::Stripe::Account::UpdateParams::BusinessProfile::AnnualRevenue))
}
def annual_revenue=(_annual_revenue); end
# An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
sig { returns(T.nilable(Integer)) }
def estimated_worker_count; end
sig { params(_estimated_worker_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def estimated_worker_count=(_estimated_worker_count); end
# [The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
sig { returns(T.nilable(String)) }
def mcc; end
sig { params(_mcc: T.nilable(String)).returns(T.nilable(String)) }
def mcc=(_mcc); end
# Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business.
sig { returns(T.nilable(T::Array[String])) }
def minority_owned_business_designation; end
sig {
params(_minority_owned_business_designation: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def minority_owned_business_designation=(_minority_owned_business_designation); end
# An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::BusinessProfile::MonthlyEstimatedRevenue))
}
def monthly_estimated_revenue; end
sig {
params(_monthly_estimated_revenue: T.nilable(::Stripe::Account::UpdateParams::BusinessProfile::MonthlyEstimatedRevenue)).returns(T.nilable(::Stripe::Account::UpdateParams::BusinessProfile::MonthlyEstimatedRevenue))
}
def monthly_estimated_revenue=(_monthly_estimated_revenue); end
# The customer-facing business name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# A publicly available mailing address for sending support issues to.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::BusinessProfile::SupportAddress)) }
def support_address; end
sig {
params(_support_address: T.nilable(::Stripe::Account::UpdateParams::BusinessProfile::SupportAddress)).returns(T.nilable(::Stripe::Account::UpdateParams::BusinessProfile::SupportAddress))
}
def support_address=(_support_address); end
# A publicly available email address for sending support issues to.
sig { returns(T.nilable(String)) }
def support_email; end
sig { params(_support_email: T.nilable(String)).returns(T.nilable(String)) }
def support_email=(_support_email); end
# A publicly available phone number to call with support issues.
sig { returns(T.nilable(String)) }
def support_phone; end
sig { params(_support_phone: T.nilable(String)).returns(T.nilable(String)) }
def support_phone=(_support_phone); end
# A publicly available website for handling support issues.
sig { returns(T.nilable(String)) }
def support_url; end
sig { params(_support_url: T.nilable(String)).returns(T.nilable(String)) }
def support_url=(_support_url); end
# The business's publicly available website.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(annual_revenue: T.nilable(::Stripe::Account::UpdateParams::BusinessProfile::AnnualRevenue), estimated_worker_count: T.nilable(Integer), mcc: T.nilable(String), minority_owned_business_designation: T.nilable(T::Array[String]), monthly_estimated_revenue: T.nilable(::Stripe::Account::UpdateParams::BusinessProfile::MonthlyEstimatedRevenue), name: T.nilable(String), product_description: T.nilable(String), support_address: T.nilable(::Stripe::Account::UpdateParams::BusinessProfile::SupportAddress), support_email: T.nilable(String), support_phone: T.nilable(String), support_url: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
annual_revenue: nil,
estimated_worker_count: nil,
mcc: nil,
minority_owned_business_designation: nil,
monthly_estimated_revenue: nil,
name: nil,
product_description: nil,
support_address: nil,
support_email: nil,
support_phone: nil,
support_url: nil,
url: nil
); end
end
class Capabilities < Stripe::RequestParams
class AcssDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AffirmPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AfterpayClearpayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AlmaPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AmazonPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AuBecsDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AutomaticIndirectTax < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BacsDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BancontactPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BilliePayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BlikPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BoletoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CardIssuing < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CardPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CartesBancairesPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CashappPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CryptoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class EpsPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class FpxPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GbBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GiropayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GopayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GrabpayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IdBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IdBankTransferPaymentsBca < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IdealPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IndiaInternationalPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class JcbPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class JpBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KakaoPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KlarnaPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KonbiniPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KrCardPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class LegacyPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class LinkPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MbWayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MobilepayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MultibancoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MxBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class NaverPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class NzBankAccountBecsDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class OxxoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class P24Payments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PayByBankPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaycoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaynowPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaypalPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaypayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaytoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PixPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PromptpayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class QrisPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class RechnungPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class RevolutPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SamsungPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SatispayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SepaBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SepaDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class ShopeepayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SofortPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class StripeBalancePayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SwishPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TaxReportingUs1099K < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TaxReportingUs1099Misc < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class Transfers < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class Treasury < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TreasuryEvolve < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TreasuryFifthThird < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TreasuryGoldmanSachs < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TwintPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class UsBankAccountAchPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class UsBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class ZipPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
# The acss_debit_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::AcssDebitPayments)) }
def acss_debit_payments; end
sig {
params(_acss_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AcssDebitPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::AcssDebitPayments))
}
def acss_debit_payments=(_acss_debit_payments); end
# The affirm_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::AffirmPayments)) }
def affirm_payments; end
sig {
params(_affirm_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AffirmPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::AffirmPayments))
}
def affirm_payments=(_affirm_payments); end
# The afterpay_clearpay_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::AfterpayClearpayPayments))
}
def afterpay_clearpay_payments; end
sig {
params(_afterpay_clearpay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AfterpayClearpayPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::AfterpayClearpayPayments))
}
def afterpay_clearpay_payments=(_afterpay_clearpay_payments); end
# The alma_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::AlmaPayments)) }
def alma_payments; end
sig {
params(_alma_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AlmaPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::AlmaPayments))
}
def alma_payments=(_alma_payments); end
# The amazon_pay_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::AmazonPayPayments)) }
def amazon_pay_payments; end
sig {
params(_amazon_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AmazonPayPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::AmazonPayPayments))
}
def amazon_pay_payments=(_amazon_pay_payments); end
# The au_becs_debit_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::AuBecsDebitPayments))
}
def au_becs_debit_payments; end
sig {
params(_au_becs_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AuBecsDebitPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::AuBecsDebitPayments))
}
def au_becs_debit_payments=(_au_becs_debit_payments); end
# The automatic_indirect_tax capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::AutomaticIndirectTax))
}
def automatic_indirect_tax; end
sig {
params(_automatic_indirect_tax: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AutomaticIndirectTax)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::AutomaticIndirectTax))
}
def automatic_indirect_tax=(_automatic_indirect_tax); end
# The bacs_debit_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::BacsDebitPayments)) }
def bacs_debit_payments; end
sig {
params(_bacs_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BacsDebitPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::BacsDebitPayments))
}
def bacs_debit_payments=(_bacs_debit_payments); end
# The bancontact_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::BancontactPayments))
}
def bancontact_payments; end
sig {
params(_bancontact_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BancontactPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::BancontactPayments))
}
def bancontact_payments=(_bancontact_payments); end
# The bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::BankTransferPayments))
}
def bank_transfer_payments; end
sig {
params(_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BankTransferPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::BankTransferPayments))
}
def bank_transfer_payments=(_bank_transfer_payments); end
# The billie_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::BilliePayments)) }
def billie_payments; end
sig {
params(_billie_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BilliePayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::BilliePayments))
}
def billie_payments=(_billie_payments); end
# The blik_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::BlikPayments)) }
def blik_payments; end
sig {
params(_blik_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BlikPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::BlikPayments))
}
def blik_payments=(_blik_payments); end
# The boleto_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::BoletoPayments)) }
def boleto_payments; end
sig {
params(_boleto_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BoletoPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::BoletoPayments))
}
def boleto_payments=(_boleto_payments); end
# The card_issuing capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::CardIssuing)) }
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CardIssuing)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::CardIssuing))
}
def card_issuing=(_card_issuing); end
# The card_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::CardPayments)) }
def card_payments; end
sig {
params(_card_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CardPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::CardPayments))
}
def card_payments=(_card_payments); end
# The cartes_bancaires_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::CartesBancairesPayments))
}
def cartes_bancaires_payments; end
sig {
params(_cartes_bancaires_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CartesBancairesPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::CartesBancairesPayments))
}
def cartes_bancaires_payments=(_cartes_bancaires_payments); end
# The cashapp_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::CashappPayments)) }
def cashapp_payments; end
sig {
params(_cashapp_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CashappPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::CashappPayments))
}
def cashapp_payments=(_cashapp_payments); end
# The crypto_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::CryptoPayments)) }
def crypto_payments; end
sig {
params(_crypto_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CryptoPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::CryptoPayments))
}
def crypto_payments=(_crypto_payments); end
# The eps_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::EpsPayments)) }
def eps_payments; end
sig {
params(_eps_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::EpsPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::EpsPayments))
}
def eps_payments=(_eps_payments); end
# The fpx_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::FpxPayments)) }
def fpx_payments; end
sig {
params(_fpx_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::FpxPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::FpxPayments))
}
def fpx_payments=(_fpx_payments); end
# The gb_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::GbBankTransferPayments))
}
def gb_bank_transfer_payments; end
sig {
params(_gb_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::GbBankTransferPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::GbBankTransferPayments))
}
def gb_bank_transfer_payments=(_gb_bank_transfer_payments); end
# The giropay_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::GiropayPayments)) }
def giropay_payments; end
sig {
params(_giropay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::GiropayPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::GiropayPayments))
}
def giropay_payments=(_giropay_payments); end
# The gopay_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::GopayPayments)) }
def gopay_payments; end
sig {
params(_gopay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::GopayPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::GopayPayments))
}
def gopay_payments=(_gopay_payments); end
# The grabpay_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::GrabpayPayments)) }
def grabpay_payments; end
sig {
params(_grabpay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::GrabpayPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::GrabpayPayments))
}
def grabpay_payments=(_grabpay_payments); end
# The id_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::IdBankTransferPayments))
}
def id_bank_transfer_payments; end
sig {
params(_id_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::IdBankTransferPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::IdBankTransferPayments))
}
def id_bank_transfer_payments=(_id_bank_transfer_payments); end
# The id_bank_transfer_payments_bca capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::IdBankTransferPaymentsBca))
}
def id_bank_transfer_payments_bca; end
sig {
params(_id_bank_transfer_payments_bca: T.nilable(::Stripe::Account::UpdateParams::Capabilities::IdBankTransferPaymentsBca)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::IdBankTransferPaymentsBca))
}
def id_bank_transfer_payments_bca=(_id_bank_transfer_payments_bca); end
# The ideal_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::IdealPayments)) }
def ideal_payments; end
sig {
params(_ideal_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::IdealPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::IdealPayments))
}
def ideal_payments=(_ideal_payments); end
# The india_international_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::IndiaInternationalPayments))
}
def india_international_payments; end
sig {
params(_india_international_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::IndiaInternationalPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::IndiaInternationalPayments))
}
def india_international_payments=(_india_international_payments); end
# The jcb_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::JcbPayments)) }
def jcb_payments; end
sig {
params(_jcb_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::JcbPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::JcbPayments))
}
def jcb_payments=(_jcb_payments); end
# The jp_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::JpBankTransferPayments))
}
def jp_bank_transfer_payments; end
sig {
params(_jp_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::JpBankTransferPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::JpBankTransferPayments))
}
def jp_bank_transfer_payments=(_jp_bank_transfer_payments); end
# The kakao_pay_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::KakaoPayPayments)) }
def kakao_pay_payments; end
sig {
params(_kakao_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::KakaoPayPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::KakaoPayPayments))
}
def kakao_pay_payments=(_kakao_pay_payments); end
# The klarna_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::KlarnaPayments)) }
def klarna_payments; end
sig {
params(_klarna_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::KlarnaPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::KlarnaPayments))
}
def klarna_payments=(_klarna_payments); end
# The konbini_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::KonbiniPayments)) }
def konbini_payments; end
sig {
params(_konbini_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::KonbiniPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::KonbiniPayments))
}
def konbini_payments=(_konbini_payments); end
# The kr_card_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::KrCardPayments)) }
def kr_card_payments; end
sig {
params(_kr_card_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::KrCardPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::KrCardPayments))
}
def kr_card_payments=(_kr_card_payments); end
# The legacy_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::LegacyPayments)) }
def legacy_payments; end
sig {
params(_legacy_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::LegacyPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::LegacyPayments))
}
def legacy_payments=(_legacy_payments); end
# The link_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::LinkPayments)) }
def link_payments; end
sig {
params(_link_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::LinkPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::LinkPayments))
}
def link_payments=(_link_payments); end
# The mb_way_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::MbWayPayments)) }
def mb_way_payments; end
sig {
params(_mb_way_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::MbWayPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::MbWayPayments))
}
def mb_way_payments=(_mb_way_payments); end
# The mobilepay_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::MobilepayPayments)) }
def mobilepay_payments; end
sig {
params(_mobilepay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::MobilepayPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::MobilepayPayments))
}
def mobilepay_payments=(_mobilepay_payments); end
# The multibanco_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::MultibancoPayments))
}
def multibanco_payments; end
sig {
params(_multibanco_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::MultibancoPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::MultibancoPayments))
}
def multibanco_payments=(_multibanco_payments); end
# The mx_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::MxBankTransferPayments))
}
def mx_bank_transfer_payments; end
sig {
params(_mx_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::MxBankTransferPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::MxBankTransferPayments))
}
def mx_bank_transfer_payments=(_mx_bank_transfer_payments); end
# The naver_pay_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::NaverPayPayments)) }
def naver_pay_payments; end
sig {
params(_naver_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::NaverPayPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::NaverPayPayments))
}
def naver_pay_payments=(_naver_pay_payments); end
# The nz_bank_account_becs_debit_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::NzBankAccountBecsDebitPayments))
}
def nz_bank_account_becs_debit_payments; end
sig {
params(_nz_bank_account_becs_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::NzBankAccountBecsDebitPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::NzBankAccountBecsDebitPayments))
}
def nz_bank_account_becs_debit_payments=(_nz_bank_account_becs_debit_payments); end
# The oxxo_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::OxxoPayments)) }
def oxxo_payments; end
sig {
params(_oxxo_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::OxxoPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::OxxoPayments))
}
def oxxo_payments=(_oxxo_payments); end
# The p24_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::P24Payments)) }
def p24_payments; end
sig {
params(_p24_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::P24Payments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::P24Payments))
}
def p24_payments=(_p24_payments); end
# The pay_by_bank_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PayByBankPayments)) }
def pay_by_bank_payments; end
sig {
params(_pay_by_bank_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PayByBankPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PayByBankPayments))
}
def pay_by_bank_payments=(_pay_by_bank_payments); end
# The payco_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaycoPayments)) }
def payco_payments; end
sig {
params(_payco_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaycoPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaycoPayments))
}
def payco_payments=(_payco_payments); end
# The paynow_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaynowPayments)) }
def paynow_payments; end
sig {
params(_paynow_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaynowPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaynowPayments))
}
def paynow_payments=(_paynow_payments); end
# The paypal_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaypalPayments)) }
def paypal_payments; end
sig {
params(_paypal_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaypalPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaypalPayments))
}
def paypal_payments=(_paypal_payments); end
# The paypay_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaypayPayments)) }
def paypay_payments; end
sig {
params(_paypay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaypayPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaypayPayments))
}
def paypay_payments=(_paypay_payments); end
# The payto_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaytoPayments)) }
def payto_payments; end
sig {
params(_payto_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaytoPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaytoPayments))
}
def payto_payments=(_payto_payments); end
# The pix_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PixPayments)) }
def pix_payments; end
sig {
params(_pix_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PixPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PixPayments))
}
def pix_payments=(_pix_payments); end
# The promptpay_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PromptpayPayments)) }
def promptpay_payments; end
sig {
params(_promptpay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PromptpayPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PromptpayPayments))
}
def promptpay_payments=(_promptpay_payments); end
# The qris_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::QrisPayments)) }
def qris_payments; end
sig {
params(_qris_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::QrisPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::QrisPayments))
}
def qris_payments=(_qris_payments); end
# The rechnung_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::RechnungPayments)) }
def rechnung_payments; end
sig {
params(_rechnung_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::RechnungPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::RechnungPayments))
}
def rechnung_payments=(_rechnung_payments); end
# The revolut_pay_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::RevolutPayPayments))
}
def revolut_pay_payments; end
sig {
params(_revolut_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::RevolutPayPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::RevolutPayPayments))
}
def revolut_pay_payments=(_revolut_pay_payments); end
# The samsung_pay_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::SamsungPayPayments))
}
def samsung_pay_payments; end
sig {
params(_samsung_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SamsungPayPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::SamsungPayPayments))
}
def samsung_pay_payments=(_samsung_pay_payments); end
# The satispay_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::SatispayPayments)) }
def satispay_payments; end
sig {
params(_satispay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SatispayPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::SatispayPayments))
}
def satispay_payments=(_satispay_payments); end
# The sepa_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::SepaBankTransferPayments))
}
def sepa_bank_transfer_payments; end
sig {
params(_sepa_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SepaBankTransferPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::SepaBankTransferPayments))
}
def sepa_bank_transfer_payments=(_sepa_bank_transfer_payments); end
# The sepa_debit_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::SepaDebitPayments)) }
def sepa_debit_payments; end
sig {
params(_sepa_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SepaDebitPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::SepaDebitPayments))
}
def sepa_debit_payments=(_sepa_debit_payments); end
# The shopeepay_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::ShopeepayPayments)) }
def shopeepay_payments; end
sig {
params(_shopeepay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::ShopeepayPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::ShopeepayPayments))
}
def shopeepay_payments=(_shopeepay_payments); end
# The sofort_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::SofortPayments)) }
def sofort_payments; end
sig {
params(_sofort_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SofortPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::SofortPayments))
}
def sofort_payments=(_sofort_payments); end
# The stripe_balance_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::StripeBalancePayments))
}
def stripe_balance_payments; end
sig {
params(_stripe_balance_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::StripeBalancePayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::StripeBalancePayments))
}
def stripe_balance_payments=(_stripe_balance_payments); end
# The swish_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::SwishPayments)) }
def swish_payments; end
sig {
params(_swish_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SwishPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::SwishPayments))
}
def swish_payments=(_swish_payments); end
# The tax_reporting_us_1099_k capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::TaxReportingUs1099K))
}
def tax_reporting_us_1099_k; end
sig {
params(_tax_reporting_us_1099_k: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TaxReportingUs1099K)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::TaxReportingUs1099K))
}
def tax_reporting_us_1099_k=(_tax_reporting_us_1099_k); end
# The tax_reporting_us_1099_misc capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::TaxReportingUs1099Misc))
}
def tax_reporting_us_1099_misc; end
sig {
params(_tax_reporting_us_1099_misc: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TaxReportingUs1099Misc)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::TaxReportingUs1099Misc))
}
def tax_reporting_us_1099_misc=(_tax_reporting_us_1099_misc); end
# The transfers capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::Transfers)) }
def transfers; end
sig {
params(_transfers: T.nilable(::Stripe::Account::UpdateParams::Capabilities::Transfers)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::Transfers))
}
def transfers=(_transfers); end
# The treasury capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::Treasury)) }
def treasury; end
sig {
params(_treasury: T.nilable(::Stripe::Account::UpdateParams::Capabilities::Treasury)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::Treasury))
}
def treasury=(_treasury); end
# The treasury_evolve capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::TreasuryEvolve)) }
def treasury_evolve; end
sig {
params(_treasury_evolve: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TreasuryEvolve)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::TreasuryEvolve))
}
def treasury_evolve=(_treasury_evolve); end
# The treasury_fifth_third capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::TreasuryFifthThird))
}
def treasury_fifth_third; end
sig {
params(_treasury_fifth_third: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TreasuryFifthThird)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::TreasuryFifthThird))
}
def treasury_fifth_third=(_treasury_fifth_third); end
# The treasury_goldman_sachs capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::TreasuryGoldmanSachs))
}
def treasury_goldman_sachs; end
sig {
params(_treasury_goldman_sachs: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TreasuryGoldmanSachs)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::TreasuryGoldmanSachs))
}
def treasury_goldman_sachs=(_treasury_goldman_sachs); end
# The twint_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::TwintPayments)) }
def twint_payments; end
sig {
params(_twint_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TwintPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::TwintPayments))
}
def twint_payments=(_twint_payments); end
# The us_bank_account_ach_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::UsBankAccountAchPayments))
}
def us_bank_account_ach_payments; end
sig {
params(_us_bank_account_ach_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::UsBankAccountAchPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::UsBankAccountAchPayments))
}
def us_bank_account_ach_payments=(_us_bank_account_ach_payments); end
# The us_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::UsBankTransferPayments))
}
def us_bank_transfer_payments; end
sig {
params(_us_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::UsBankTransferPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::UsBankTransferPayments))
}
def us_bank_transfer_payments=(_us_bank_transfer_payments); end
# The zip_payments capability.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::ZipPayments)) }
def zip_payments; end
sig {
params(_zip_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::ZipPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::ZipPayments))
}
def zip_payments=(_zip_payments); end
sig {
params(acss_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AcssDebitPayments), affirm_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AffirmPayments), afterpay_clearpay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AfterpayClearpayPayments), alma_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AlmaPayments), amazon_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AmazonPayPayments), au_becs_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AuBecsDebitPayments), automatic_indirect_tax: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AutomaticIndirectTax), bacs_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BacsDebitPayments), bancontact_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BancontactPayments), bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BankTransferPayments), billie_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BilliePayments), blik_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BlikPayments), boleto_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BoletoPayments), card_issuing: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CardIssuing), card_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CardPayments), cartes_bancaires_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CartesBancairesPayments), cashapp_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CashappPayments), crypto_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CryptoPayments), eps_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::EpsPayments), fpx_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::FpxPayments), gb_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::GbBankTransferPayments), giropay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::GiropayPayments), gopay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::GopayPayments), grabpay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::GrabpayPayments), id_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::IdBankTransferPayments), id_bank_transfer_payments_bca: T.nilable(::Stripe::Account::UpdateParams::Capabilities::IdBankTransferPaymentsBca), ideal_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::IdealPayments), india_international_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::IndiaInternationalPayments), jcb_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::JcbPayments), jp_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::JpBankTransferPayments), kakao_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::KakaoPayPayments), klarna_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::KlarnaPayments), konbini_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::KonbiniPayments), kr_card_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::KrCardPayments), legacy_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::LegacyPayments), link_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::LinkPayments), mb_way_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::MbWayPayments), mobilepay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::MobilepayPayments), multibanco_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::MultibancoPayments), mx_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::MxBankTransferPayments), naver_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::NaverPayPayments), nz_bank_account_becs_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::NzBankAccountBecsDebitPayments), oxxo_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::OxxoPayments), p24_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::P24Payments), pay_by_bank_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PayByBankPayments), payco_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaycoPayments), paynow_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaynowPayments), paypal_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaypalPayments), paypay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaypayPayments), payto_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaytoPayments), pix_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PixPayments), promptpay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PromptpayPayments), qris_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::QrisPayments), rechnung_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::RechnungPayments), revolut_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::RevolutPayPayments), samsung_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SamsungPayPayments), satispay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SatispayPayments), sepa_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SepaBankTransferPayments), sepa_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SepaDebitPayments), shopeepay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::ShopeepayPayments), sofort_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SofortPayments), stripe_balance_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::StripeBalancePayments), swish_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SwishPayments), tax_reporting_us_1099_k: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TaxReportingUs1099K), tax_reporting_us_1099_misc: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TaxReportingUs1099Misc), transfers: T.nilable(::Stripe::Account::UpdateParams::Capabilities::Transfers), treasury: T.nilable(::Stripe::Account::UpdateParams::Capabilities::Treasury), treasury_evolve: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TreasuryEvolve), treasury_fifth_third: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TreasuryFifthThird), treasury_goldman_sachs: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TreasuryGoldmanSachs), twint_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TwintPayments), us_bank_account_ach_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::UsBankAccountAchPayments), us_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::UsBankTransferPayments), zip_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::ZipPayments)).void
}
def initialize(
acss_debit_payments: nil,
affirm_payments: nil,
afterpay_clearpay_payments: nil,
alma_payments: nil,
amazon_pay_payments: nil,
au_becs_debit_payments: nil,
automatic_indirect_tax: nil,
bacs_debit_payments: nil,
bancontact_payments: nil,
bank_transfer_payments: nil,
billie_payments: nil,
blik_payments: nil,
boleto_payments: nil,
card_issuing: nil,
card_payments: nil,
cartes_bancaires_payments: nil,
cashapp_payments: nil,
crypto_payments: nil,
eps_payments: nil,
fpx_payments: nil,
gb_bank_transfer_payments: nil,
giropay_payments: nil,
gopay_payments: nil,
grabpay_payments: nil,
id_bank_transfer_payments: nil,
id_bank_transfer_payments_bca: nil,
ideal_payments: nil,
india_international_payments: nil,
jcb_payments: nil,
jp_bank_transfer_payments: nil,
kakao_pay_payments: nil,
klarna_payments: nil,
konbini_payments: nil,
kr_card_payments: nil,
legacy_payments: nil,
link_payments: nil,
mb_way_payments: nil,
mobilepay_payments: nil,
multibanco_payments: nil,
mx_bank_transfer_payments: nil,
naver_pay_payments: nil,
nz_bank_account_becs_debit_payments: nil,
oxxo_payments: nil,
p24_payments: nil,
pay_by_bank_payments: nil,
payco_payments: nil,
paynow_payments: nil,
paypal_payments: nil,
paypay_payments: nil,
payto_payments: nil,
pix_payments: nil,
promptpay_payments: nil,
qris_payments: nil,
rechnung_payments: nil,
revolut_pay_payments: nil,
samsung_pay_payments: nil,
satispay_payments: nil,
sepa_bank_transfer_payments: nil,
sepa_debit_payments: nil,
shopeepay_payments: nil,
sofort_payments: nil,
stripe_balance_payments: nil,
swish_payments: nil,
tax_reporting_us_1099_k: nil,
tax_reporting_us_1099_misc: nil,
transfers: nil,
treasury: nil,
treasury_evolve: nil,
treasury_fifth_third: nil,
treasury_goldman_sachs: nil,
twint_payments: nil,
us_bank_account_ach_payments: nil,
us_bank_transfer_payments: nil,
zip_payments: nil
); end
end
class Card < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# Attribute for param field address_city
sig { returns(T.nilable(String)) }
def address_city; end
sig { params(_address_city: T.nilable(String)).returns(T.nilable(String)) }
def address_city=(_address_city); end
# Attribute for param field address_country
sig { returns(T.nilable(String)) }
def address_country; end
sig { params(_address_country: T.nilable(String)).returns(T.nilable(String)) }
def address_country=(_address_country); end
# Attribute for param field address_line1
sig { returns(T.nilable(String)) }
def address_line1; end
sig { params(_address_line1: T.nilable(String)).returns(T.nilable(String)) }
def address_line1=(_address_line1); end
# Attribute for param field address_line2
sig { returns(T.nilable(String)) }
def address_line2; end
sig { params(_address_line2: T.nilable(String)).returns(T.nilable(String)) }
def address_line2=(_address_line2); end
# Attribute for param field address_state
sig { returns(T.nilable(String)) }
def address_state; end
sig { params(_address_state: T.nilable(String)).returns(T.nilable(String)) }
def address_state=(_address_state); end
# Attribute for param field address_zip
sig { returns(T.nilable(String)) }
def address_zip; end
sig { params(_address_zip: T.nilable(String)).returns(T.nilable(String)) }
def address_zip=(_address_zip); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Attribute for param field cvc
sig { returns(T.nilable(String)) }
def cvc; end
sig { params(_cvc: T.nilable(String)).returns(T.nilable(String)) }
def cvc=(_cvc); end
# Attribute for param field exp_month
sig { returns(Integer) }
def exp_month; end
sig { params(_exp_month: Integer).returns(Integer) }
def exp_month=(_exp_month); end
# Attribute for param field exp_year
sig { returns(Integer) }
def exp_year; end
sig { params(_exp_year: Integer).returns(Integer) }
def exp_year=(_exp_year); end
# Attribute for param field name
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Attribute for param field number
sig { returns(String) }
def number; end
sig { params(_number: String).returns(String) }
def number=(_number); end
# 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Attribute for param field default_for_currency
sig { returns(T.nilable(T::Boolean)) }
def default_for_currency; end
sig { params(_default_for_currency: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def default_for_currency=(_default_for_currency); end
sig {
params(object: String, address_city: T.nilable(String), address_country: T.nilable(String), address_line1: T.nilable(String), address_line2: T.nilable(String), address_state: T.nilable(String), address_zip: T.nilable(String), currency: T.nilable(String), cvc: T.nilable(String), exp_month: Integer, exp_year: Integer, name: T.nilable(String), number: String, metadata: T.nilable(T::Hash[String, String]), default_for_currency: T.nilable(T::Boolean)).void
}
def initialize(
object: nil,
address_city: nil,
address_country: nil,
address_line1: nil,
address_line2: nil,
address_state: nil,
address_zip: nil,
currency: nil,
cvc: nil,
exp_month: nil,
exp_year: nil,
name: nil,
number: nil,
metadata: nil,
default_for_currency: nil
); end
end
class CardToken < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Attribute for param field token
sig { returns(String) }
def token; end
sig { params(_token: String).returns(String) }
def token=(_token); end
sig { params(object: String, currency: T.nilable(String), token: String).void }
def initialize(object: nil, currency: nil, token: nil); end
end
class Company < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class DirectorshipDeclaration < Stripe::RequestParams
# The Unix timestamp marking when the directorship declaration attestation was made.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the directorship declaration attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the directorship declaration attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class OwnershipDeclaration < Stripe::RequestParams
# The Unix timestamp marking when the beneficial owner attestation was made.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class RegistrationDate < Stripe::RequestParams
# The day of registration, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of registration, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of registration.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Verification < Stripe::RequestParams
class Document < Stripe::RequestParams
# The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# A document verifying the business.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Company::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::Account::UpdateParams::Company::Verification::Document)).returns(T.nilable(::Stripe::Account::UpdateParams::Company::Verification::Document))
}
def document=(_document); end
sig {
params(document: T.nilable(::Stripe::Account::UpdateParams::Company::Verification::Document)).void
}
def initialize(document: nil); end
end
# The company's primary address.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Company::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::Account::UpdateParams::Company::Address)).returns(T.nilable(::Stripe::Account::UpdateParams::Company::Address))
}
def address=(_address); end
# The Kana variation of the company's primary address (Japan only).
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Company::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::Account::UpdateParams::Company::AddressKana)).returns(T.nilable(::Stripe::Account::UpdateParams::Company::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the company's primary address (Japan only).
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Company::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::Account::UpdateParams::Company::AddressKanji)).returns(T.nilable(::Stripe::Account::UpdateParams::Company::AddressKanji))
}
def address_kanji=(_address_kanji); end
# Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.
sig { returns(T.nilable(T::Boolean)) }
def directors_provided; end
sig { params(_directors_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def directors_provided=(_directors_provided); end
# This hash is used to attest that the directors information provided to Stripe is both current and correct.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Company::DirectorshipDeclaration))
}
def directorship_declaration; end
sig {
params(_directorship_declaration: T.nilable(::Stripe::Account::UpdateParams::Company::DirectorshipDeclaration)).returns(T.nilable(::Stripe::Account::UpdateParams::Company::DirectorshipDeclaration))
}
def directorship_declaration=(_directorship_declaration); end
# Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](/api/persons) for accounts with a `relationship.executive` requirement.
sig { returns(T.nilable(T::Boolean)) }
def executives_provided; end
sig { params(_executives_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executives_provided=(_executives_provided); end
# The export license ID number of the company, also referred as Import Export Code (India only).
sig { returns(T.nilable(String)) }
def export_license_id; end
sig { params(_export_license_id: T.nilable(String)).returns(T.nilable(String)) }
def export_license_id=(_export_license_id); end
# The purpose code to use for export transactions (India only).
sig { returns(T.nilable(String)) }
def export_purpose_code; end
sig { params(_export_purpose_code: T.nilable(String)).returns(T.nilable(String)) }
def export_purpose_code=(_export_purpose_code); end
# The company's legal name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The Kana variation of the company's legal name (Japan only).
sig { returns(T.nilable(String)) }
def name_kana; end
sig { params(_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def name_kana=(_name_kana); end
# The Kanji variation of the company's legal name (Japan only).
sig { returns(T.nilable(String)) }
def name_kanji; end
sig { params(_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def name_kanji=(_name_kanji); end
# Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](/api/persons) for accounts with a `relationship.owner` requirement.
sig { returns(T.nilable(T::Boolean)) }
def owners_provided; end
sig { params(_owners_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owners_provided=(_owners_provided); end
# This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Company::OwnershipDeclaration)) }
def ownership_declaration; end
sig {
params(_ownership_declaration: T.nilable(::Stripe::Account::UpdateParams::Company::OwnershipDeclaration)).returns(T.nilable(::Stripe::Account::UpdateParams::Company::OwnershipDeclaration))
}
def ownership_declaration=(_ownership_declaration); end
# This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.
sig { returns(T.nilable(T.any(String, String))) }
def ownership_exemption_reason; end
sig {
params(_ownership_exemption_reason: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def ownership_exemption_reason=(_ownership_exemption_reason); end
# The company's phone number (used for verification).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Attribute for param field registration_date
sig {
returns(T.nilable(T.any(String, ::Stripe::Account::UpdateParams::Company::RegistrationDate)))
}
def registration_date; end
sig {
params(_registration_date: T.nilable(T.any(String, ::Stripe::Account::UpdateParams::Company::RegistrationDate))).returns(T.nilable(T.any(String, ::Stripe::Account::UpdateParams::Company::RegistrationDate)))
}
def registration_date=(_registration_date); end
# The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).
sig { returns(T.nilable(String)) }
def registration_number; end
sig { params(_registration_number: T.nilable(String)).returns(T.nilable(String)) }
def registration_number=(_registration_number); end
# The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
sig { returns(T.nilable(T.any(String, String))) }
def structure; end
sig {
params(_structure: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def structure=(_structure); end
# The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
# The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
sig { returns(T.nilable(String)) }
def tax_id_registrar; end
sig { params(_tax_id_registrar: T.nilable(String)).returns(T.nilable(String)) }
def tax_id_registrar=(_tax_id_registrar); end
# The VAT number of the company.
sig { returns(T.nilable(String)) }
def vat_id; end
sig { params(_vat_id: T.nilable(String)).returns(T.nilable(String)) }
def vat_id=(_vat_id); end
# Information on the verification state of the company.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Company::Verification)) }
def verification; end
sig {
params(_verification: T.nilable(::Stripe::Account::UpdateParams::Company::Verification)).returns(T.nilable(::Stripe::Account::UpdateParams::Company::Verification))
}
def verification=(_verification); end
sig {
params(address: T.nilable(::Stripe::Account::UpdateParams::Company::Address), address_kana: T.nilable(::Stripe::Account::UpdateParams::Company::AddressKana), address_kanji: T.nilable(::Stripe::Account::UpdateParams::Company::AddressKanji), directors_provided: T.nilable(T::Boolean), directorship_declaration: T.nilable(::Stripe::Account::UpdateParams::Company::DirectorshipDeclaration), executives_provided: T.nilable(T::Boolean), export_license_id: T.nilable(String), export_purpose_code: T.nilable(String), name: T.nilable(String), name_kana: T.nilable(String), name_kanji: T.nilable(String), owners_provided: T.nilable(T::Boolean), ownership_declaration: T.nilable(::Stripe::Account::UpdateParams::Company::OwnershipDeclaration), ownership_exemption_reason: T.nilable(T.any(String, String)), phone: T.nilable(String), registration_date: T.nilable(T.any(String, ::Stripe::Account::UpdateParams::Company::RegistrationDate)), registration_number: T.nilable(String), structure: T.nilable(T.any(String, String)), tax_id: T.nilable(String), tax_id_registrar: T.nilable(String), vat_id: T.nilable(String), verification: T.nilable(::Stripe::Account::UpdateParams::Company::Verification)).void
}
def initialize(
address: nil,
address_kana: nil,
address_kanji: nil,
directors_provided: nil,
directorship_declaration: nil,
executives_provided: nil,
export_license_id: nil,
export_purpose_code: nil,
name: nil,
name_kana: nil,
name_kanji: nil,
owners_provided: nil,
ownership_declaration: nil,
ownership_exemption_reason: nil,
phone: nil,
registration_date: nil,
registration_number: nil,
structure: nil,
tax_id: nil,
tax_id_registrar: nil,
vat_id: nil,
verification: nil
); end
end
class Documents < Stripe::RequestParams
class BankAccountOwnershipVerification < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyLicense < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyMemorandumOfAssociation < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyMinisterialDecree < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyRegistrationVerification < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyTaxIdVerification < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class ProofOfAddress < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class ProofOfRegistration < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class ProofOfUltimateBeneficialOwnership < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
# One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Documents::BankAccountOwnershipVerification))
}
def bank_account_ownership_verification; end
sig {
params(_bank_account_ownership_verification: T.nilable(::Stripe::Account::UpdateParams::Documents::BankAccountOwnershipVerification)).returns(T.nilable(::Stripe::Account::UpdateParams::Documents::BankAccountOwnershipVerification))
}
def bank_account_ownership_verification=(_bank_account_ownership_verification); end
# One or more documents that demonstrate proof of a company's license to operate.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyLicense)) }
def company_license; end
sig {
params(_company_license: T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyLicense)).returns(T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyLicense))
}
def company_license=(_company_license); end
# One or more documents showing the company's Memorandum of Association.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyMemorandumOfAssociation))
}
def company_memorandum_of_association; end
sig {
params(_company_memorandum_of_association: T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyMemorandumOfAssociation)).returns(T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyMemorandumOfAssociation))
}
def company_memorandum_of_association=(_company_memorandum_of_association); end
# (Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyMinisterialDecree))
}
def company_ministerial_decree; end
sig {
params(_company_ministerial_decree: T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyMinisterialDecree)).returns(T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyMinisterialDecree))
}
def company_ministerial_decree=(_company_ministerial_decree); end
# One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyRegistrationVerification))
}
def company_registration_verification; end
sig {
params(_company_registration_verification: T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyRegistrationVerification)).returns(T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyRegistrationVerification))
}
def company_registration_verification=(_company_registration_verification); end
# One or more documents that demonstrate proof of a company's tax ID.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyTaxIdVerification))
}
def company_tax_id_verification; end
sig {
params(_company_tax_id_verification: T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyTaxIdVerification)).returns(T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyTaxIdVerification))
}
def company_tax_id_verification=(_company_tax_id_verification); end
# One or more documents that demonstrate proof of address.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Documents::ProofOfAddress)) }
def proof_of_address; end
sig {
params(_proof_of_address: T.nilable(::Stripe::Account::UpdateParams::Documents::ProofOfAddress)).returns(T.nilable(::Stripe::Account::UpdateParams::Documents::ProofOfAddress))
}
def proof_of_address=(_proof_of_address); end
# One or more documents showing the company’s proof of registration with the national business registry.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Documents::ProofOfRegistration)) }
def proof_of_registration; end
sig {
params(_proof_of_registration: T.nilable(::Stripe::Account::UpdateParams::Documents::ProofOfRegistration)).returns(T.nilable(::Stripe::Account::UpdateParams::Documents::ProofOfRegistration))
}
def proof_of_registration=(_proof_of_registration); end
# One or more documents that demonstrate proof of ultimate beneficial ownership.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Documents::ProofOfUltimateBeneficialOwnership))
}
def proof_of_ultimate_beneficial_ownership; end
sig {
params(_proof_of_ultimate_beneficial_ownership: T.nilable(::Stripe::Account::UpdateParams::Documents::ProofOfUltimateBeneficialOwnership)).returns(T.nilable(::Stripe::Account::UpdateParams::Documents::ProofOfUltimateBeneficialOwnership))
}
def proof_of_ultimate_beneficial_ownership=(_proof_of_ultimate_beneficial_ownership); end
sig {
params(bank_account_ownership_verification: T.nilable(::Stripe::Account::UpdateParams::Documents::BankAccountOwnershipVerification), company_license: T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyLicense), company_memorandum_of_association: T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyMemorandumOfAssociation), company_ministerial_decree: T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyMinisterialDecree), company_registration_verification: T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyRegistrationVerification), company_tax_id_verification: T.nilable(::Stripe::Account::UpdateParams::Documents::CompanyTaxIdVerification), proof_of_address: T.nilable(::Stripe::Account::UpdateParams::Documents::ProofOfAddress), proof_of_registration: T.nilable(::Stripe::Account::UpdateParams::Documents::ProofOfRegistration), proof_of_ultimate_beneficial_ownership: T.nilable(::Stripe::Account::UpdateParams::Documents::ProofOfUltimateBeneficialOwnership)).void
}
def initialize(
bank_account_ownership_verification: nil,
company_license: nil,
company_memorandum_of_association: nil,
company_ministerial_decree: nil,
company_registration_verification: nil,
company_tax_id_verification: nil,
proof_of_address: nil,
proof_of_registration: nil,
proof_of_ultimate_beneficial_ownership: nil
); end
end
class Groups < Stripe::RequestParams
# The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details.
sig { returns(T.nilable(String)) }
def payments_pricing; end
sig { params(_payments_pricing: T.nilable(String)).returns(T.nilable(String)) }
def payments_pricing=(_payments_pricing); end
sig { params(payments_pricing: T.nilable(String)).void }
def initialize(payments_pricing: nil); end
end
class Individual < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class RegisteredAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Relationship < Stripe::RequestParams
# Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
sig { returns(T.nilable(T::Boolean)) }
def director; end
sig { params(_director: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def director=(_director); end
# Whether the person has significant responsibility to control, manage, or direct the organization.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
sig { params(_executive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executive=(_executive); end
# Whether the person is an owner of the account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
sig { params(_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owner=(_owner); end
# The percent owned by the person of the account's legal entity.
sig { returns(T.nilable(T.any(String, Float))) }
def percent_ownership; end
sig {
params(_percent_ownership: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def percent_ownership=(_percent_ownership); end
# The person's title (e.g., CEO, Support Engineer).
sig { returns(T.nilable(String)) }
def title; end
sig { params(_title: T.nilable(String)).returns(T.nilable(String)) }
def title=(_title); end
sig {
params(director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), percent_ownership: T.nilable(T.any(String, Float)), title: T.nilable(String)).void
}
def initialize(
director: nil,
executive: nil,
owner: nil,
percent_ownership: nil,
title: nil
); end
end
class Verification < Stripe::RequestParams
class AdditionalDocument < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
class Document < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Individual::Verification::AdditionalDocument))
}
def additional_document; end
sig {
params(_additional_document: T.nilable(::Stripe::Account::UpdateParams::Individual::Verification::AdditionalDocument)).returns(T.nilable(::Stripe::Account::UpdateParams::Individual::Verification::AdditionalDocument))
}
def additional_document=(_additional_document); end
# An identifying document, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Individual::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::Account::UpdateParams::Individual::Verification::Document)).returns(T.nilable(::Stripe::Account::UpdateParams::Individual::Verification::Document))
}
def document=(_document); end
sig {
params(additional_document: T.nilable(::Stripe::Account::UpdateParams::Individual::Verification::AdditionalDocument), document: T.nilable(::Stripe::Account::UpdateParams::Individual::Verification::Document)).void
}
def initialize(additional_document: nil, document: nil); end
end
# The individual's primary address.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Individual::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::Account::UpdateParams::Individual::Address)).returns(T.nilable(::Stripe::Account::UpdateParams::Individual::Address))
}
def address=(_address); end
# The Kana variation of the individual's primary address (Japan only).
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Individual::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::Account::UpdateParams::Individual::AddressKana)).returns(T.nilable(::Stripe::Account::UpdateParams::Individual::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the individual's primary address (Japan only).
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Individual::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::Account::UpdateParams::Individual::AddressKanji)).returns(T.nilable(::Stripe::Account::UpdateParams::Individual::AddressKanji))
}
def address_kanji=(_address_kanji); end
# The individual's date of birth.
sig { returns(T.nilable(T.any(String, ::Stripe::Account::UpdateParams::Individual::Dob))) }
def dob; end
sig {
params(_dob: T.nilable(T.any(String, ::Stripe::Account::UpdateParams::Individual::Dob))).returns(T.nilable(T.any(String, ::Stripe::Account::UpdateParams::Individual::Dob)))
}
def dob=(_dob); end
# The individual's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The individual's first name.
sig { returns(T.nilable(String)) }
def first_name; end
sig { params(_first_name: T.nilable(String)).returns(T.nilable(String)) }
def first_name=(_first_name); end
# The Kana variation of the individual's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kana; end
sig { params(_first_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kana=(_first_name_kana); end
# The Kanji variation of the individual's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kanji; end
sig { params(_first_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kanji=(_first_name_kanji); end
# A list of alternate names or aliases that the individual is known by.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def full_name_aliases; end
sig {
params(_full_name_aliases: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def full_name_aliases=(_full_name_aliases); end
# The individual's gender
sig { returns(T.nilable(String)) }
def gender; end
sig { params(_gender: T.nilable(String)).returns(T.nilable(String)) }
def gender=(_gender); end
# The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number; end
sig { params(_id_number: T.nilable(String)).returns(T.nilable(String)) }
def id_number=(_id_number); end
# The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number_secondary; end
sig { params(_id_number_secondary: T.nilable(String)).returns(T.nilable(String)) }
def id_number_secondary=(_id_number_secondary); end
# The individual's last name.
sig { returns(T.nilable(String)) }
def last_name; end
sig { params(_last_name: T.nilable(String)).returns(T.nilable(String)) }
def last_name=(_last_name); end
# The Kana variation of the individual's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kana; end
sig { params(_last_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kana=(_last_name_kana); end
# The Kanji variation of the individual's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kanji; end
sig { params(_last_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kanji=(_last_name_kanji); end
# The individual's maiden name.
sig { returns(T.nilable(String)) }
def maiden_name; end
sig { params(_maiden_name: T.nilable(String)).returns(T.nilable(String)) }
def maiden_name=(_maiden_name); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The individual's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
sig { returns(T.nilable(String)) }
def political_exposure; end
sig { params(_political_exposure: T.nilable(String)).returns(T.nilable(String)) }
def political_exposure=(_political_exposure); end
# The individual's registered address.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Individual::RegisteredAddress)) }
def registered_address; end
sig {
params(_registered_address: T.nilable(::Stripe::Account::UpdateParams::Individual::RegisteredAddress)).returns(T.nilable(::Stripe::Account::UpdateParams::Individual::RegisteredAddress))
}
def registered_address=(_registered_address); end
# Describes the person’s relationship to the account.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Individual::Relationship)) }
def relationship; end
sig {
params(_relationship: T.nilable(::Stripe::Account::UpdateParams::Individual::Relationship)).returns(T.nilable(::Stripe::Account::UpdateParams::Individual::Relationship))
}
def relationship=(_relationship); end
# The last four digits of the individual's Social Security Number (U.S. only).
sig { returns(T.nilable(String)) }
def ssn_last_4; end
sig { params(_ssn_last_4: T.nilable(String)).returns(T.nilable(String)) }
def ssn_last_4=(_ssn_last_4); end
# The individual's verification document information.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Individual::Verification)) }
def verification; end
sig {
params(_verification: T.nilable(::Stripe::Account::UpdateParams::Individual::Verification)).returns(T.nilable(::Stripe::Account::UpdateParams::Individual::Verification))
}
def verification=(_verification); end
sig {
params(address: T.nilable(::Stripe::Account::UpdateParams::Individual::Address), address_kana: T.nilable(::Stripe::Account::UpdateParams::Individual::AddressKana), address_kanji: T.nilable(::Stripe::Account::UpdateParams::Individual::AddressKanji), dob: T.nilable(T.any(String, ::Stripe::Account::UpdateParams::Individual::Dob)), email: T.nilable(String), first_name: T.nilable(String), first_name_kana: T.nilable(String), first_name_kanji: T.nilable(String), full_name_aliases: T.nilable(T.any(String, T::Array[String])), gender: T.nilable(String), id_number: T.nilable(String), id_number_secondary: T.nilable(String), last_name: T.nilable(String), last_name_kana: T.nilable(String), last_name_kanji: T.nilable(String), maiden_name: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), phone: T.nilable(String), political_exposure: T.nilable(String), registered_address: T.nilable(::Stripe::Account::UpdateParams::Individual::RegisteredAddress), relationship: T.nilable(::Stripe::Account::UpdateParams::Individual::Relationship), ssn_last_4: T.nilable(String), verification: T.nilable(::Stripe::Account::UpdateParams::Individual::Verification)).void
}
def initialize(
address: nil,
address_kana: nil,
address_kanji: nil,
dob: nil,
email: nil,
first_name: nil,
first_name_kana: nil,
first_name_kanji: nil,
full_name_aliases: nil,
gender: nil,
id_number: nil,
id_number_secondary: nil,
last_name: nil,
last_name_kana: nil,
last_name_kanji: nil,
maiden_name: nil,
metadata: nil,
phone: nil,
political_exposure: nil,
registered_address: nil,
relationship: nil,
ssn_last_4: nil,
verification: nil
); end
end
class RiskControls < Stripe::RequestParams
class Charges < Stripe::RequestParams
# To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.
# There can be a delay before the risk control is paused or unpaused.
sig { returns(T.nilable(T::Boolean)) }
def pause_requested; end
sig { params(_pause_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def pause_requested=(_pause_requested); end
sig { params(pause_requested: T.nilable(T::Boolean)).void }
def initialize(pause_requested: nil); end
end
class Payouts < Stripe::RequestParams
# To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.
# There can be a delay before the risk control is paused or unpaused.
sig { returns(T.nilable(T::Boolean)) }
def pause_requested; end
sig { params(_pause_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def pause_requested=(_pause_requested); end
sig { params(pause_requested: T.nilable(T::Boolean)).void }
def initialize(pause_requested: nil); end
end
# Represents the risk control status of charges. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).
sig { returns(T.nilable(::Stripe::Account::UpdateParams::RiskControls::Charges)) }
def charges; end
sig {
params(_charges: T.nilable(::Stripe::Account::UpdateParams::RiskControls::Charges)).returns(T.nilable(::Stripe::Account::UpdateParams::RiskControls::Charges))
}
def charges=(_charges); end
# Represents the risk control status of payouts. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).
sig { returns(T.nilable(::Stripe::Account::UpdateParams::RiskControls::Payouts)) }
def payouts; end
sig {
params(_payouts: T.nilable(::Stripe::Account::UpdateParams::RiskControls::Payouts)).returns(T.nilable(::Stripe::Account::UpdateParams::RiskControls::Payouts))
}
def payouts=(_payouts); end
sig {
params(charges: T.nilable(::Stripe::Account::UpdateParams::RiskControls::Charges), payouts: T.nilable(::Stripe::Account::UpdateParams::RiskControls::Payouts)).void
}
def initialize(charges: nil, payouts: nil); end
end
class Settings < Stripe::RequestParams
class BacsDebitPayments < Stripe::RequestParams
# The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
sig { params(display_name: T.nilable(String)).void }
def initialize(display_name: nil); end
end
class BankBcaOnboarding < Stripe::RequestParams
# Bank BCA business account holder name
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# Bank BCA business account number
sig { returns(T.nilable(String)) }
def business_account_number; end
sig { params(_business_account_number: T.nilable(String)).returns(T.nilable(String)) }
def business_account_number=(_business_account_number); end
sig {
params(account_holder_name: T.nilable(String), business_account_number: T.nilable(String)).void
}
def initialize(account_holder_name: nil, business_account_number: nil); end
end
class Branding < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.
sig { returns(T.nilable(String)) }
def icon; end
sig { params(_icon: T.nilable(String)).returns(T.nilable(String)) }
def icon=(_icon); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.
sig { returns(T.nilable(String)) }
def logo; end
sig { params(_logo: T.nilable(String)).returns(T.nilable(String)) }
def logo=(_logo); end
# A CSS hex color value representing the primary branding color for this account.
sig { returns(T.nilable(String)) }
def primary_color; end
sig { params(_primary_color: T.nilable(String)).returns(T.nilable(String)) }
def primary_color=(_primary_color); end
# A CSS hex color value representing the secondary branding color for this account.
sig { returns(T.nilable(String)) }
def secondary_color; end
sig { params(_secondary_color: T.nilable(String)).returns(T.nilable(String)) }
def secondary_color=(_secondary_color); end
sig {
params(icon: T.nilable(String), logo: T.nilable(String), primary_color: T.nilable(String), secondary_color: T.nilable(String)).void
}
def initialize(icon: nil, logo: nil, primary_color: nil, secondary_color: nil); end
end
class Capital < Stripe::RequestParams
# Per-currency mapping of user-selected destination accounts used to pay out loans.
sig { returns(T.nilable(T::Hash[String, String])) }
def payout_destination; end
sig {
params(_payout_destination: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def payout_destination=(_payout_destination); end
# Per-currency mapping of all destination accounts eligible to receive Capital financing payouts.
sig { returns(T.nilable(T::Hash[String, T::Array[String]])) }
def payout_destination_selector; end
sig {
params(_payout_destination_selector: T.nilable(T::Hash[String, T::Array[String]])).returns(T.nilable(T::Hash[String, T::Array[String]]))
}
def payout_destination_selector=(_payout_destination_selector); end
sig {
params(payout_destination: T.nilable(T::Hash[String, String]), payout_destination_selector: T.nilable(T::Hash[String, T::Array[String]])).void
}
def initialize(payout_destination: nil, payout_destination_selector: nil); end
end
class CardIssuing < Stripe::RequestParams
class TosAcceptance < Stripe::RequestParams
# The Unix timestamp marking when the account representative accepted the service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](/issuing/connect/tos_acceptance).
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Settings::CardIssuing::TosAcceptance))
}
def tos_acceptance; end
sig {
params(_tos_acceptance: T.nilable(::Stripe::Account::UpdateParams::Settings::CardIssuing::TosAcceptance)).returns(T.nilable(::Stripe::Account::UpdateParams::Settings::CardIssuing::TosAcceptance))
}
def tos_acceptance=(_tos_acceptance); end
sig {
params(tos_acceptance: T.nilable(::Stripe::Account::UpdateParams::Settings::CardIssuing::TosAcceptance)).void
}
def initialize(tos_acceptance: nil); end
end
class CardPayments < Stripe::RequestParams
class DeclineOn < Stripe::RequestParams
# Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.
sig { returns(T.nilable(T::Boolean)) }
def avs_failure; end
sig { params(_avs_failure: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def avs_failure=(_avs_failure); end
# Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.
sig { returns(T.nilable(T::Boolean)) }
def cvc_failure; end
sig { params(_cvc_failure: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def cvc_failure=(_cvc_failure); end
sig {
params(avs_failure: T.nilable(T::Boolean), cvc_failure: T.nilable(T::Boolean)).void
}
def initialize(avs_failure: nil, cvc_failure: nil); end
end
# Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Settings::CardPayments::DeclineOn))
}
def decline_on; end
sig {
params(_decline_on: T.nilable(::Stripe::Account::UpdateParams::Settings::CardPayments::DeclineOn)).returns(T.nilable(::Stripe::Account::UpdateParams::Settings::CardPayments::DeclineOn))
}
def decline_on=(_decline_on); end
# The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix; end
sig { params(_statement_descriptor_prefix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_prefix=(_statement_descriptor_prefix); end
# The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion.
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix_kana; end
sig {
params(_statement_descriptor_prefix_kana: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_prefix_kana=(_statement_descriptor_prefix_kana); end
# The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion.
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix_kanji; end
sig {
params(_statement_descriptor_prefix_kanji: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_prefix_kanji=(_statement_descriptor_prefix_kanji); end
sig {
params(decline_on: T.nilable(::Stripe::Account::UpdateParams::Settings::CardPayments::DeclineOn), statement_descriptor_prefix: T.nilable(String), statement_descriptor_prefix_kana: T.nilable(String), statement_descriptor_prefix_kanji: T.nilable(String)).void
}
def initialize(
decline_on: nil,
statement_descriptor_prefix: nil,
statement_descriptor_prefix_kana: nil,
statement_descriptor_prefix_kanji: nil
); end
end
class Invoices < Stripe::RequestParams
# The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_account_tax_ids; end
sig {
params(_default_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_account_tax_ids=(_default_account_tax_ids); end
# Whether payment methods should be saved when a payment is completed for a one-time invoices on a hosted invoice page.
sig { returns(T.nilable(String)) }
def hosted_payment_method_save; end
sig { params(_hosted_payment_method_save: T.nilable(String)).returns(T.nilable(String)) }
def hosted_payment_method_save=(_hosted_payment_method_save); end
sig {
params(default_account_tax_ids: T.nilable(T.any(String, T::Array[String])), hosted_payment_method_save: T.nilable(String)).void
}
def initialize(default_account_tax_ids: nil, hosted_payment_method_save: nil); end
end
class Payments < Stripe::RequestParams
# The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a `statement_descriptor_prefix`, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the `statement_descriptor` text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the [account settings documentation](https://docs.stripe.com/get-started/account/statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor_kana; end
sig { params(_statement_descriptor_kana: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_kana=(_statement_descriptor_kana); end
# The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor_kanji; end
sig { params(_statement_descriptor_kanji: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_kanji=(_statement_descriptor_kanji); end
sig {
params(statement_descriptor: T.nilable(String), statement_descriptor_kana: T.nilable(String), statement_descriptor_kanji: T.nilable(String)).void
}
def initialize(
statement_descriptor: nil,
statement_descriptor_kana: nil,
statement_descriptor_kanji: nil
); end
end
class Payouts < Stripe::RequestParams
class Schedule < Stripe::RequestParams
# The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](/connect/manage-payout-schedule).
sig { returns(T.nilable(T.any(String, Integer))) }
def delay_days; end
sig {
params(_delay_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def delay_days=(_delay_days); end
# How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# The day of the month when available funds are paid out, specified as a number between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`.
sig { returns(T.nilable(Integer)) }
def monthly_anchor; end
sig { params(_monthly_anchor: T.nilable(Integer)).returns(T.nilable(Integer)) }
def monthly_anchor=(_monthly_anchor); end
# The days of the month when available funds are paid out, specified as an array of numbers between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly` and `monthly_anchor` is not set.
sig { returns(T.nilable(T::Array[Integer])) }
def monthly_payout_days; end
sig {
params(_monthly_payout_days: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def monthly_payout_days=(_monthly_payout_days); end
# The day of the week when available funds are paid out, specified as `monday`, `tuesday`, etc. Required and applicable only if `interval` is `weekly`.
sig { returns(T.nilable(String)) }
def weekly_anchor; end
sig { params(_weekly_anchor: T.nilable(String)).returns(T.nilable(String)) }
def weekly_anchor=(_weekly_anchor); end
# The days of the week when available funds are paid out, specified as an array, e.g., [`monday`, `tuesday`]. Required and applicable only if `interval` is `weekly`.
sig { returns(T.nilable(T::Array[String])) }
def weekly_payout_days; end
sig {
params(_weekly_payout_days: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def weekly_payout_days=(_weekly_payout_days); end
sig {
params(delay_days: T.nilable(T.any(String, Integer)), interval: T.nilable(String), monthly_anchor: T.nilable(Integer), monthly_payout_days: T.nilable(T::Array[Integer]), weekly_anchor: T.nilable(String), weekly_payout_days: T.nilable(T::Array[String])).void
}
def initialize(
delay_days: nil,
interval: nil,
monthly_anchor: nil,
monthly_payout_days: nil,
weekly_anchor: nil,
weekly_payout_days: nil
); end
end
# A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/connect/account-balances).
sig { returns(T.nilable(T::Boolean)) }
def debit_negative_balances; end
sig {
params(_debit_negative_balances: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def debit_negative_balances=(_debit_negative_balances); end
# Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](/connect/bank-transfers#payout-information) documentation.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Settings::Payouts::Schedule)) }
def schedule; end
sig {
params(_schedule: T.nilable(::Stripe::Account::UpdateParams::Settings::Payouts::Schedule)).returns(T.nilable(::Stripe::Account::UpdateParams::Settings::Payouts::Schedule))
}
def schedule=(_schedule); end
# The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
sig {
params(debit_negative_balances: T.nilable(T::Boolean), schedule: T.nilable(::Stripe::Account::UpdateParams::Settings::Payouts::Schedule), statement_descriptor: T.nilable(String)).void
}
def initialize(
debit_negative_balances: nil,
schedule: nil,
statement_descriptor: nil
); end
end
class TaxForms < Stripe::RequestParams
# Whether the account opted out of receiving their tax forms by postal delivery.
sig { returns(T.nilable(T::Boolean)) }
def consented_to_paperless_delivery; end
sig {
params(_consented_to_paperless_delivery: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consented_to_paperless_delivery=(_consented_to_paperless_delivery); end
sig { params(consented_to_paperless_delivery: T.nilable(T::Boolean)).void }
def initialize(consented_to_paperless_delivery: nil); end
end
class Treasury < Stripe::RequestParams
class TosAcceptance < Stripe::RequestParams
# The Unix timestamp marking when the account representative accepted the service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Details on the account's acceptance of the Stripe Treasury Services Agreement.
sig {
returns(T.nilable(::Stripe::Account::UpdateParams::Settings::Treasury::TosAcceptance))
}
def tos_acceptance; end
sig {
params(_tos_acceptance: T.nilable(::Stripe::Account::UpdateParams::Settings::Treasury::TosAcceptance)).returns(T.nilable(::Stripe::Account::UpdateParams::Settings::Treasury::TosAcceptance))
}
def tos_acceptance=(_tos_acceptance); end
sig {
params(tos_acceptance: T.nilable(::Stripe::Account::UpdateParams::Settings::Treasury::TosAcceptance)).void
}
def initialize(tos_acceptance: nil); end
end
# Settings specific to Bacs Direct Debit payments.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Settings::BacsDebitPayments)) }
def bacs_debit_payments; end
sig {
params(_bacs_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Settings::BacsDebitPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Settings::BacsDebitPayments))
}
def bacs_debit_payments=(_bacs_debit_payments); end
# Settings specific to bank BCA onboarding for Indonesia bank transfers payments method.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Settings::BankBcaOnboarding)) }
def bank_bca_onboarding; end
sig {
params(_bank_bca_onboarding: T.nilable(::Stripe::Account::UpdateParams::Settings::BankBcaOnboarding)).returns(T.nilable(::Stripe::Account::UpdateParams::Settings::BankBcaOnboarding))
}
def bank_bca_onboarding=(_bank_bca_onboarding); end
# Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Settings::Branding)) }
def branding; end
sig {
params(_branding: T.nilable(::Stripe::Account::UpdateParams::Settings::Branding)).returns(T.nilable(::Stripe::Account::UpdateParams::Settings::Branding))
}
def branding=(_branding); end
# Settings specific to the account's use of the Capital product.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Settings::Capital)) }
def capital; end
sig {
params(_capital: T.nilable(::Stripe::Account::UpdateParams::Settings::Capital)).returns(T.nilable(::Stripe::Account::UpdateParams::Settings::Capital))
}
def capital=(_capital); end
# Settings specific to the account's use of the Card Issuing product.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Settings::CardIssuing)) }
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::Account::UpdateParams::Settings::CardIssuing)).returns(T.nilable(::Stripe::Account::UpdateParams::Settings::CardIssuing))
}
def card_issuing=(_card_issuing); end
# Settings specific to card charging on the account.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Settings::CardPayments)) }
def card_payments; end
sig {
params(_card_payments: T.nilable(::Stripe::Account::UpdateParams::Settings::CardPayments)).returns(T.nilable(::Stripe::Account::UpdateParams::Settings::CardPayments))
}
def card_payments=(_card_payments); end
# Settings specific to the account's use of Invoices.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Settings::Invoices)) }
def invoices; end
sig {
params(_invoices: T.nilable(::Stripe::Account::UpdateParams::Settings::Invoices)).returns(T.nilable(::Stripe::Account::UpdateParams::Settings::Invoices))
}
def invoices=(_invoices); end
# Settings that apply across payment methods for charging on the account.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Settings::Payments)) }
def payments; end
sig {
params(_payments: T.nilable(::Stripe::Account::UpdateParams::Settings::Payments)).returns(T.nilable(::Stripe::Account::UpdateParams::Settings::Payments))
}
def payments=(_payments); end
# Settings specific to the account's payouts.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Settings::Payouts)) }
def payouts; end
sig {
params(_payouts: T.nilable(::Stripe::Account::UpdateParams::Settings::Payouts)).returns(T.nilable(::Stripe::Account::UpdateParams::Settings::Payouts))
}
def payouts=(_payouts); end
# Settings specific to the account's tax forms.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Settings::TaxForms)) }
def tax_forms; end
sig {
params(_tax_forms: T.nilable(::Stripe::Account::UpdateParams::Settings::TaxForms)).returns(T.nilable(::Stripe::Account::UpdateParams::Settings::TaxForms))
}
def tax_forms=(_tax_forms); end
# Settings specific to the account's Treasury FinancialAccounts.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Settings::Treasury)) }
def treasury; end
sig {
params(_treasury: T.nilable(::Stripe::Account::UpdateParams::Settings::Treasury)).returns(T.nilable(::Stripe::Account::UpdateParams::Settings::Treasury))
}
def treasury=(_treasury); end
sig {
params(bacs_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Settings::BacsDebitPayments), bank_bca_onboarding: T.nilable(::Stripe::Account::UpdateParams::Settings::BankBcaOnboarding), branding: T.nilable(::Stripe::Account::UpdateParams::Settings::Branding), capital: T.nilable(::Stripe::Account::UpdateParams::Settings::Capital), card_issuing: T.nilable(::Stripe::Account::UpdateParams::Settings::CardIssuing), card_payments: T.nilable(::Stripe::Account::UpdateParams::Settings::CardPayments), invoices: T.nilable(::Stripe::Account::UpdateParams::Settings::Invoices), payments: T.nilable(::Stripe::Account::UpdateParams::Settings::Payments), payouts: T.nilable(::Stripe::Account::UpdateParams::Settings::Payouts), tax_forms: T.nilable(::Stripe::Account::UpdateParams::Settings::TaxForms), treasury: T.nilable(::Stripe::Account::UpdateParams::Settings::Treasury)).void
}
def initialize(
bacs_debit_payments: nil,
bank_bca_onboarding: nil,
branding: nil,
capital: nil,
card_issuing: nil,
card_payments: nil,
invoices: nil,
payments: nil,
payouts: nil,
tax_forms: nil,
treasury: nil
); end
end
class TosAcceptance < Stripe::RequestParams
# The Unix timestamp marking when the account representative accepted their service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the account representative accepted their service agreement.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user's service agreement type.
sig { returns(T.nilable(String)) }
def service_agreement; end
sig { params(_service_agreement: T.nilable(String)).returns(T.nilable(String)) }
def service_agreement=(_service_agreement); end
# The user agent of the browser from which the account representative accepted their service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), service_agreement: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, service_agreement: nil, user_agent: nil); end
end
# An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.
sig { returns(T.nilable(String)) }
def account_token; end
sig { params(_account_token: T.nilable(String)).returns(T.nilable(String)) }
def account_token=(_account_token); end
# Business information about the account.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::BusinessProfile)) }
def business_profile; end
sig {
params(_business_profile: T.nilable(::Stripe::Account::UpdateParams::BusinessProfile)).returns(T.nilable(::Stripe::Account::UpdateParams::BusinessProfile))
}
def business_profile=(_business_profile); end
# The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig { returns(T.nilable(String)) }
def business_type; end
sig { params(_business_type: T.nilable(String)).returns(T.nilable(String)) }
def business_type=(_business_type); end
# Each key of the dictionary represents a capability, and each capability
# maps to its settings (for example, whether it has been requested or not). Each
# capability is inactive until you have provided its specific
# requirements and Stripe has verified them. An account might have some
# of its requested capabilities be active and some be inactive.
#
# Required when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type)
# is `none`, which includes Custom accounts.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities)) }
def capabilities; end
sig {
params(_capabilities: T.nilable(::Stripe::Account::UpdateParams::Capabilities)).returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities))
}
def capabilities=(_capabilities); end
# Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Company)) }
def company; end
sig {
params(_company: T.nilable(::Stripe::Account::UpdateParams::Company)).returns(T.nilable(::Stripe::Account::UpdateParams::Company))
}
def company=(_company); end
# Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).
sig { returns(T.nilable(String)) }
def default_currency; end
sig { params(_default_currency: T.nilable(String)).returns(T.nilable(String)) }
def default_currency=(_default_currency); end
# Documents that may be submitted to satisfy various informational requests.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Documents)) }
def documents; end
sig {
params(_documents: T.nilable(::Stripe::Account::UpdateParams::Documents)).returns(T.nilable(::Stripe::Account::UpdateParams::Documents))
}
def documents=(_documents); end
# The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.
By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig {
returns(T.nilable(T.any(String, T.any(String, ::Stripe::Account::UpdateParams::BankAccount, ::Stripe::Account::UpdateParams::Card, ::Stripe::Account::UpdateParams::CardToken))))
}
def external_account; end
sig {
params(_external_account: T.nilable(T.any(String, T.any(String, ::Stripe::Account::UpdateParams::BankAccount, ::Stripe::Account::UpdateParams::Card, ::Stripe::Account::UpdateParams::CardToken)))).returns(T.nilable(T.any(String, T.any(String, ::Stripe::Account::UpdateParams::BankAccount, ::Stripe::Account::UpdateParams::Card, ::Stripe::Account::UpdateParams::CardToken))))
}
def external_account=(_external_account); end
# A hash of account group type to tokens. These are account groups this account should be added to.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Groups)) }
def groups; end
sig {
params(_groups: T.nilable(::Stripe::Account::UpdateParams::Groups)).returns(T.nilable(::Stripe::Account::UpdateParams::Groups))
}
def groups=(_groups); end
# Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Individual)) }
def individual; end
sig {
params(_individual: T.nilable(::Stripe::Account::UpdateParams::Individual)).returns(T.nilable(::Stripe::Account::UpdateParams::Individual))
}
def individual=(_individual); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# A hash to configure risk controls on the account. Please see [this page for more details](/connect/pausing-payments-or-payouts-on-connected-accounts).
sig { returns(T.nilable(::Stripe::Account::UpdateParams::RiskControls)) }
def risk_controls; end
sig {
params(_risk_controls: T.nilable(::Stripe::Account::UpdateParams::RiskControls)).returns(T.nilable(::Stripe::Account::UpdateParams::RiskControls))
}
def risk_controls=(_risk_controls); end
# Options for customizing how the account functions within Stripe.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::Settings)) }
def settings; end
sig {
params(_settings: T.nilable(::Stripe::Account::UpdateParams::Settings)).returns(T.nilable(::Stripe::Account::UpdateParams::Settings))
}
def settings=(_settings); end
# Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.
sig { returns(T.nilable(::Stripe::Account::UpdateParams::TosAcceptance)) }
def tos_acceptance; end
sig {
params(_tos_acceptance: T.nilable(::Stripe::Account::UpdateParams::TosAcceptance)).returns(T.nilable(::Stripe::Account::UpdateParams::TosAcceptance))
}
def tos_acceptance=(_tos_acceptance); end
sig {
params(account_token: T.nilable(String), business_profile: T.nilable(::Stripe::Account::UpdateParams::BusinessProfile), business_type: T.nilable(String), capabilities: T.nilable(::Stripe::Account::UpdateParams::Capabilities), company: T.nilable(::Stripe::Account::UpdateParams::Company), default_currency: T.nilable(String), documents: T.nilable(::Stripe::Account::UpdateParams::Documents), email: T.nilable(String), expand: T.nilable(T::Array[String]), external_account: T.nilable(T.any(String, T.any(String, ::Stripe::Account::UpdateParams::BankAccount, ::Stripe::Account::UpdateParams::Card, ::Stripe::Account::UpdateParams::CardToken))), groups: T.nilable(::Stripe::Account::UpdateParams::Groups), individual: T.nilable(::Stripe::Account::UpdateParams::Individual), metadata: T.nilable(T.any(String, T::Hash[String, String])), risk_controls: T.nilable(::Stripe::Account::UpdateParams::RiskControls), settings: T.nilable(::Stripe::Account::UpdateParams::Settings), tos_acceptance: T.nilable(::Stripe::Account::UpdateParams::TosAcceptance)).void
}
def initialize(
account_token: nil,
business_profile: nil,
business_type: nil,
capabilities: nil,
company: nil,
default_currency: nil,
documents: nil,
email: nil,
expand: nil,
external_account: nil,
groups: nil,
individual: nil,
metadata: nil,
risk_controls: nil,
settings: nil,
tos_acceptance: nil
); end
end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return connected accounts that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Account::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Account::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Account::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::Account::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class BankAccount < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The account number for the bank account, in string form. Must be a checking account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The country in which the bank account is located.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts)
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(object: String, account_holder_name: T.nilable(String), account_holder_type: T.nilable(String), account_number: String, country: String, currency: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
object: nil,
account_holder_name: nil,
account_holder_type: nil,
account_number: nil,
country: nil,
currency: nil,
routing_number: nil
); end
end
class BusinessProfile < Stripe::RequestParams
class AnnualRevenue < Stripe::RequestParams
# A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
sig { returns(String) }
def fiscal_year_end; end
sig { params(_fiscal_year_end: String).returns(String) }
def fiscal_year_end=(_fiscal_year_end); end
sig { params(amount: Integer, currency: String, fiscal_year_end: String).void }
def initialize(amount: nil, currency: nil, fiscal_year_end: nil); end
end
class MonthlyEstimatedRevenue < Stripe::RequestParams
# A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
sig { params(amount: Integer, currency: String).void }
def initialize(amount: nil, currency: nil); end
end
class SupportAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The applicant's gross annual revenue for its preceding fiscal year.
sig { returns(T.nilable(::Stripe::Account::CreateParams::BusinessProfile::AnnualRevenue)) }
def annual_revenue; end
sig {
params(_annual_revenue: T.nilable(::Stripe::Account::CreateParams::BusinessProfile::AnnualRevenue)).returns(T.nilable(::Stripe::Account::CreateParams::BusinessProfile::AnnualRevenue))
}
def annual_revenue=(_annual_revenue); end
# An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
sig { returns(T.nilable(Integer)) }
def estimated_worker_count; end
sig { params(_estimated_worker_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def estimated_worker_count=(_estimated_worker_count); end
# [The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
sig { returns(T.nilable(String)) }
def mcc; end
sig { params(_mcc: T.nilable(String)).returns(T.nilable(String)) }
def mcc=(_mcc); end
# Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business.
sig { returns(T.nilable(T::Array[String])) }
def minority_owned_business_designation; end
sig {
params(_minority_owned_business_designation: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def minority_owned_business_designation=(_minority_owned_business_designation); end
# An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::BusinessProfile::MonthlyEstimatedRevenue))
}
def monthly_estimated_revenue; end
sig {
params(_monthly_estimated_revenue: T.nilable(::Stripe::Account::CreateParams::BusinessProfile::MonthlyEstimatedRevenue)).returns(T.nilable(::Stripe::Account::CreateParams::BusinessProfile::MonthlyEstimatedRevenue))
}
def monthly_estimated_revenue=(_monthly_estimated_revenue); end
# The customer-facing business name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# A publicly available mailing address for sending support issues to.
sig { returns(T.nilable(::Stripe::Account::CreateParams::BusinessProfile::SupportAddress)) }
def support_address; end
sig {
params(_support_address: T.nilable(::Stripe::Account::CreateParams::BusinessProfile::SupportAddress)).returns(T.nilable(::Stripe::Account::CreateParams::BusinessProfile::SupportAddress))
}
def support_address=(_support_address); end
# A publicly available email address for sending support issues to.
sig { returns(T.nilable(String)) }
def support_email; end
sig { params(_support_email: T.nilable(String)).returns(T.nilable(String)) }
def support_email=(_support_email); end
# A publicly available phone number to call with support issues.
sig { returns(T.nilable(String)) }
def support_phone; end
sig { params(_support_phone: T.nilable(String)).returns(T.nilable(String)) }
def support_phone=(_support_phone); end
# A publicly available website for handling support issues.
sig { returns(T.nilable(String)) }
def support_url; end
sig { params(_support_url: T.nilable(String)).returns(T.nilable(String)) }
def support_url=(_support_url); end
# The business's publicly available website.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(annual_revenue: T.nilable(::Stripe::Account::CreateParams::BusinessProfile::AnnualRevenue), estimated_worker_count: T.nilable(Integer), mcc: T.nilable(String), minority_owned_business_designation: T.nilable(T::Array[String]), monthly_estimated_revenue: T.nilable(::Stripe::Account::CreateParams::BusinessProfile::MonthlyEstimatedRevenue), name: T.nilable(String), product_description: T.nilable(String), support_address: T.nilable(::Stripe::Account::CreateParams::BusinessProfile::SupportAddress), support_email: T.nilable(String), support_phone: T.nilable(String), support_url: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
annual_revenue: nil,
estimated_worker_count: nil,
mcc: nil,
minority_owned_business_designation: nil,
monthly_estimated_revenue: nil,
name: nil,
product_description: nil,
support_address: nil,
support_email: nil,
support_phone: nil,
support_url: nil,
url: nil
); end
end
class Capabilities < Stripe::RequestParams
class AcssDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AffirmPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AfterpayClearpayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AlmaPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AmazonPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AuBecsDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AutomaticIndirectTax < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BacsDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BancontactPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BilliePayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BlikPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BoletoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CardIssuing < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CardPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CartesBancairesPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CashappPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CryptoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class EpsPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class FpxPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GbBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GiropayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GopayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GrabpayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IdBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IdBankTransferPaymentsBca < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IdealPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IndiaInternationalPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class JcbPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class JpBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KakaoPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KlarnaPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KonbiniPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KrCardPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class LegacyPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class LinkPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MbWayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MobilepayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MultibancoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MxBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class NaverPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class NzBankAccountBecsDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class OxxoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class P24Payments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PayByBankPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaycoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaynowPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaypalPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaypayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaytoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PixPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PromptpayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class QrisPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class RechnungPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class RevolutPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SamsungPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SatispayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SepaBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SepaDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class ShopeepayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SofortPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class StripeBalancePayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SwishPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TaxReportingUs1099K < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TaxReportingUs1099Misc < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class Transfers < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class Treasury < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TreasuryEvolve < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TreasuryFifthThird < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TreasuryGoldmanSachs < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TwintPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class UsBankAccountAchPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class UsBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class ZipPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
# The acss_debit_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::AcssDebitPayments)) }
def acss_debit_payments; end
sig {
params(_acss_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AcssDebitPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::AcssDebitPayments))
}
def acss_debit_payments=(_acss_debit_payments); end
# The affirm_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::AffirmPayments)) }
def affirm_payments; end
sig {
params(_affirm_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AffirmPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::AffirmPayments))
}
def affirm_payments=(_affirm_payments); end
# The afterpay_clearpay_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::AfterpayClearpayPayments))
}
def afterpay_clearpay_payments; end
sig {
params(_afterpay_clearpay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AfterpayClearpayPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::AfterpayClearpayPayments))
}
def afterpay_clearpay_payments=(_afterpay_clearpay_payments); end
# The alma_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::AlmaPayments)) }
def alma_payments; end
sig {
params(_alma_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AlmaPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::AlmaPayments))
}
def alma_payments=(_alma_payments); end
# The amazon_pay_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::AmazonPayPayments)) }
def amazon_pay_payments; end
sig {
params(_amazon_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AmazonPayPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::AmazonPayPayments))
}
def amazon_pay_payments=(_amazon_pay_payments); end
# The au_becs_debit_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::AuBecsDebitPayments))
}
def au_becs_debit_payments; end
sig {
params(_au_becs_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AuBecsDebitPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::AuBecsDebitPayments))
}
def au_becs_debit_payments=(_au_becs_debit_payments); end
# The automatic_indirect_tax capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::AutomaticIndirectTax))
}
def automatic_indirect_tax; end
sig {
params(_automatic_indirect_tax: T.nilable(::Stripe::Account::CreateParams::Capabilities::AutomaticIndirectTax)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::AutomaticIndirectTax))
}
def automatic_indirect_tax=(_automatic_indirect_tax); end
# The bacs_debit_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::BacsDebitPayments)) }
def bacs_debit_payments; end
sig {
params(_bacs_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BacsDebitPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::BacsDebitPayments))
}
def bacs_debit_payments=(_bacs_debit_payments); end
# The bancontact_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::BancontactPayments))
}
def bancontact_payments; end
sig {
params(_bancontact_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BancontactPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::BancontactPayments))
}
def bancontact_payments=(_bancontact_payments); end
# The bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::BankTransferPayments))
}
def bank_transfer_payments; end
sig {
params(_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BankTransferPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::BankTransferPayments))
}
def bank_transfer_payments=(_bank_transfer_payments); end
# The billie_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::BilliePayments)) }
def billie_payments; end
sig {
params(_billie_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BilliePayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::BilliePayments))
}
def billie_payments=(_billie_payments); end
# The blik_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::BlikPayments)) }
def blik_payments; end
sig {
params(_blik_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BlikPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::BlikPayments))
}
def blik_payments=(_blik_payments); end
# The boleto_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::BoletoPayments)) }
def boleto_payments; end
sig {
params(_boleto_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BoletoPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::BoletoPayments))
}
def boleto_payments=(_boleto_payments); end
# The card_issuing capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::CardIssuing)) }
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::Account::CreateParams::Capabilities::CardIssuing)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::CardIssuing))
}
def card_issuing=(_card_issuing); end
# The card_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::CardPayments)) }
def card_payments; end
sig {
params(_card_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::CardPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::CardPayments))
}
def card_payments=(_card_payments); end
# The cartes_bancaires_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::CartesBancairesPayments))
}
def cartes_bancaires_payments; end
sig {
params(_cartes_bancaires_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::CartesBancairesPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::CartesBancairesPayments))
}
def cartes_bancaires_payments=(_cartes_bancaires_payments); end
# The cashapp_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::CashappPayments)) }
def cashapp_payments; end
sig {
params(_cashapp_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::CashappPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::CashappPayments))
}
def cashapp_payments=(_cashapp_payments); end
# The crypto_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::CryptoPayments)) }
def crypto_payments; end
sig {
params(_crypto_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::CryptoPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::CryptoPayments))
}
def crypto_payments=(_crypto_payments); end
# The eps_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::EpsPayments)) }
def eps_payments; end
sig {
params(_eps_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::EpsPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::EpsPayments))
}
def eps_payments=(_eps_payments); end
# The fpx_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::FpxPayments)) }
def fpx_payments; end
sig {
params(_fpx_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::FpxPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::FpxPayments))
}
def fpx_payments=(_fpx_payments); end
# The gb_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::GbBankTransferPayments))
}
def gb_bank_transfer_payments; end
sig {
params(_gb_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::GbBankTransferPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::GbBankTransferPayments))
}
def gb_bank_transfer_payments=(_gb_bank_transfer_payments); end
# The giropay_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::GiropayPayments)) }
def giropay_payments; end
sig {
params(_giropay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::GiropayPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::GiropayPayments))
}
def giropay_payments=(_giropay_payments); end
# The gopay_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::GopayPayments)) }
def gopay_payments; end
sig {
params(_gopay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::GopayPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::GopayPayments))
}
def gopay_payments=(_gopay_payments); end
# The grabpay_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::GrabpayPayments)) }
def grabpay_payments; end
sig {
params(_grabpay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::GrabpayPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::GrabpayPayments))
}
def grabpay_payments=(_grabpay_payments); end
# The id_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::IdBankTransferPayments))
}
def id_bank_transfer_payments; end
sig {
params(_id_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::IdBankTransferPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::IdBankTransferPayments))
}
def id_bank_transfer_payments=(_id_bank_transfer_payments); end
# The id_bank_transfer_payments_bca capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::IdBankTransferPaymentsBca))
}
def id_bank_transfer_payments_bca; end
sig {
params(_id_bank_transfer_payments_bca: T.nilable(::Stripe::Account::CreateParams::Capabilities::IdBankTransferPaymentsBca)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::IdBankTransferPaymentsBca))
}
def id_bank_transfer_payments_bca=(_id_bank_transfer_payments_bca); end
# The ideal_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::IdealPayments)) }
def ideal_payments; end
sig {
params(_ideal_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::IdealPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::IdealPayments))
}
def ideal_payments=(_ideal_payments); end
# The india_international_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::IndiaInternationalPayments))
}
def india_international_payments; end
sig {
params(_india_international_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::IndiaInternationalPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::IndiaInternationalPayments))
}
def india_international_payments=(_india_international_payments); end
# The jcb_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::JcbPayments)) }
def jcb_payments; end
sig {
params(_jcb_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::JcbPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::JcbPayments))
}
def jcb_payments=(_jcb_payments); end
# The jp_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::JpBankTransferPayments))
}
def jp_bank_transfer_payments; end
sig {
params(_jp_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::JpBankTransferPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::JpBankTransferPayments))
}
def jp_bank_transfer_payments=(_jp_bank_transfer_payments); end
# The kakao_pay_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::KakaoPayPayments)) }
def kakao_pay_payments; end
sig {
params(_kakao_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::KakaoPayPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::KakaoPayPayments))
}
def kakao_pay_payments=(_kakao_pay_payments); end
# The klarna_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::KlarnaPayments)) }
def klarna_payments; end
sig {
params(_klarna_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::KlarnaPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::KlarnaPayments))
}
def klarna_payments=(_klarna_payments); end
# The konbini_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::KonbiniPayments)) }
def konbini_payments; end
sig {
params(_konbini_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::KonbiniPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::KonbiniPayments))
}
def konbini_payments=(_konbini_payments); end
# The kr_card_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::KrCardPayments)) }
def kr_card_payments; end
sig {
params(_kr_card_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::KrCardPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::KrCardPayments))
}
def kr_card_payments=(_kr_card_payments); end
# The legacy_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::LegacyPayments)) }
def legacy_payments; end
sig {
params(_legacy_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::LegacyPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::LegacyPayments))
}
def legacy_payments=(_legacy_payments); end
# The link_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::LinkPayments)) }
def link_payments; end
sig {
params(_link_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::LinkPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::LinkPayments))
}
def link_payments=(_link_payments); end
# The mb_way_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::MbWayPayments)) }
def mb_way_payments; end
sig {
params(_mb_way_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::MbWayPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::MbWayPayments))
}
def mb_way_payments=(_mb_way_payments); end
# The mobilepay_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::MobilepayPayments)) }
def mobilepay_payments; end
sig {
params(_mobilepay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::MobilepayPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::MobilepayPayments))
}
def mobilepay_payments=(_mobilepay_payments); end
# The multibanco_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::MultibancoPayments))
}
def multibanco_payments; end
sig {
params(_multibanco_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::MultibancoPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::MultibancoPayments))
}
def multibanco_payments=(_multibanco_payments); end
# The mx_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::MxBankTransferPayments))
}
def mx_bank_transfer_payments; end
sig {
params(_mx_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::MxBankTransferPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::MxBankTransferPayments))
}
def mx_bank_transfer_payments=(_mx_bank_transfer_payments); end
# The naver_pay_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::NaverPayPayments)) }
def naver_pay_payments; end
sig {
params(_naver_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::NaverPayPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::NaverPayPayments))
}
def naver_pay_payments=(_naver_pay_payments); end
# The nz_bank_account_becs_debit_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::NzBankAccountBecsDebitPayments))
}
def nz_bank_account_becs_debit_payments; end
sig {
params(_nz_bank_account_becs_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::NzBankAccountBecsDebitPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::NzBankAccountBecsDebitPayments))
}
def nz_bank_account_becs_debit_payments=(_nz_bank_account_becs_debit_payments); end
# The oxxo_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::OxxoPayments)) }
def oxxo_payments; end
sig {
params(_oxxo_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::OxxoPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::OxxoPayments))
}
def oxxo_payments=(_oxxo_payments); end
# The p24_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::P24Payments)) }
def p24_payments; end
sig {
params(_p24_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::P24Payments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::P24Payments))
}
def p24_payments=(_p24_payments); end
# The pay_by_bank_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PayByBankPayments)) }
def pay_by_bank_payments; end
sig {
params(_pay_by_bank_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PayByBankPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PayByBankPayments))
}
def pay_by_bank_payments=(_pay_by_bank_payments); end
# The payco_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PaycoPayments)) }
def payco_payments; end
sig {
params(_payco_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PaycoPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PaycoPayments))
}
def payco_payments=(_payco_payments); end
# The paynow_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PaynowPayments)) }
def paynow_payments; end
sig {
params(_paynow_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PaynowPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PaynowPayments))
}
def paynow_payments=(_paynow_payments); end
# The paypal_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PaypalPayments)) }
def paypal_payments; end
sig {
params(_paypal_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PaypalPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PaypalPayments))
}
def paypal_payments=(_paypal_payments); end
# The paypay_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PaypayPayments)) }
def paypay_payments; end
sig {
params(_paypay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PaypayPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PaypayPayments))
}
def paypay_payments=(_paypay_payments); end
# The payto_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PaytoPayments)) }
def payto_payments; end
sig {
params(_payto_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PaytoPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PaytoPayments))
}
def payto_payments=(_payto_payments); end
# The pix_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PixPayments)) }
def pix_payments; end
sig {
params(_pix_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PixPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PixPayments))
}
def pix_payments=(_pix_payments); end
# The promptpay_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PromptpayPayments)) }
def promptpay_payments; end
sig {
params(_promptpay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PromptpayPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PromptpayPayments))
}
def promptpay_payments=(_promptpay_payments); end
# The qris_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::QrisPayments)) }
def qris_payments; end
sig {
params(_qris_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::QrisPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::QrisPayments))
}
def qris_payments=(_qris_payments); end
# The rechnung_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::RechnungPayments)) }
def rechnung_payments; end
sig {
params(_rechnung_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::RechnungPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::RechnungPayments))
}
def rechnung_payments=(_rechnung_payments); end
# The revolut_pay_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::RevolutPayPayments))
}
def revolut_pay_payments; end
sig {
params(_revolut_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::RevolutPayPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::RevolutPayPayments))
}
def revolut_pay_payments=(_revolut_pay_payments); end
# The samsung_pay_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::SamsungPayPayments))
}
def samsung_pay_payments; end
sig {
params(_samsung_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SamsungPayPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::SamsungPayPayments))
}
def samsung_pay_payments=(_samsung_pay_payments); end
# The satispay_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::SatispayPayments)) }
def satispay_payments; end
sig {
params(_satispay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SatispayPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::SatispayPayments))
}
def satispay_payments=(_satispay_payments); end
# The sepa_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::SepaBankTransferPayments))
}
def sepa_bank_transfer_payments; end
sig {
params(_sepa_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SepaBankTransferPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::SepaBankTransferPayments))
}
def sepa_bank_transfer_payments=(_sepa_bank_transfer_payments); end
# The sepa_debit_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::SepaDebitPayments)) }
def sepa_debit_payments; end
sig {
params(_sepa_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SepaDebitPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::SepaDebitPayments))
}
def sepa_debit_payments=(_sepa_debit_payments); end
# The shopeepay_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::ShopeepayPayments)) }
def shopeepay_payments; end
sig {
params(_shopeepay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::ShopeepayPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::ShopeepayPayments))
}
def shopeepay_payments=(_shopeepay_payments); end
# The sofort_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::SofortPayments)) }
def sofort_payments; end
sig {
params(_sofort_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SofortPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::SofortPayments))
}
def sofort_payments=(_sofort_payments); end
# The stripe_balance_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::StripeBalancePayments))
}
def stripe_balance_payments; end
sig {
params(_stripe_balance_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::StripeBalancePayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::StripeBalancePayments))
}
def stripe_balance_payments=(_stripe_balance_payments); end
# The swish_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::SwishPayments)) }
def swish_payments; end
sig {
params(_swish_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SwishPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::SwishPayments))
}
def swish_payments=(_swish_payments); end
# The tax_reporting_us_1099_k capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::TaxReportingUs1099K))
}
def tax_reporting_us_1099_k; end
sig {
params(_tax_reporting_us_1099_k: T.nilable(::Stripe::Account::CreateParams::Capabilities::TaxReportingUs1099K)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::TaxReportingUs1099K))
}
def tax_reporting_us_1099_k=(_tax_reporting_us_1099_k); end
# The tax_reporting_us_1099_misc capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::TaxReportingUs1099Misc))
}
def tax_reporting_us_1099_misc; end
sig {
params(_tax_reporting_us_1099_misc: T.nilable(::Stripe::Account::CreateParams::Capabilities::TaxReportingUs1099Misc)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::TaxReportingUs1099Misc))
}
def tax_reporting_us_1099_misc=(_tax_reporting_us_1099_misc); end
# The transfers capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::Transfers)) }
def transfers; end
sig {
params(_transfers: T.nilable(::Stripe::Account::CreateParams::Capabilities::Transfers)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::Transfers))
}
def transfers=(_transfers); end
# The treasury capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::Treasury)) }
def treasury; end
sig {
params(_treasury: T.nilable(::Stripe::Account::CreateParams::Capabilities::Treasury)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::Treasury))
}
def treasury=(_treasury); end
# The treasury_evolve capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::TreasuryEvolve)) }
def treasury_evolve; end
sig {
params(_treasury_evolve: T.nilable(::Stripe::Account::CreateParams::Capabilities::TreasuryEvolve)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::TreasuryEvolve))
}
def treasury_evolve=(_treasury_evolve); end
# The treasury_fifth_third capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::TreasuryFifthThird))
}
def treasury_fifth_third; end
sig {
params(_treasury_fifth_third: T.nilable(::Stripe::Account::CreateParams::Capabilities::TreasuryFifthThird)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::TreasuryFifthThird))
}
def treasury_fifth_third=(_treasury_fifth_third); end
# The treasury_goldman_sachs capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::TreasuryGoldmanSachs))
}
def treasury_goldman_sachs; end
sig {
params(_treasury_goldman_sachs: T.nilable(::Stripe::Account::CreateParams::Capabilities::TreasuryGoldmanSachs)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::TreasuryGoldmanSachs))
}
def treasury_goldman_sachs=(_treasury_goldman_sachs); end
# The twint_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::TwintPayments)) }
def twint_payments; end
sig {
params(_twint_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::TwintPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::TwintPayments))
}
def twint_payments=(_twint_payments); end
# The us_bank_account_ach_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::UsBankAccountAchPayments))
}
def us_bank_account_ach_payments; end
sig {
params(_us_bank_account_ach_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::UsBankAccountAchPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::UsBankAccountAchPayments))
}
def us_bank_account_ach_payments=(_us_bank_account_ach_payments); end
# The us_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::UsBankTransferPayments))
}
def us_bank_transfer_payments; end
sig {
params(_us_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::UsBankTransferPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::UsBankTransferPayments))
}
def us_bank_transfer_payments=(_us_bank_transfer_payments); end
# The zip_payments capability.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::ZipPayments)) }
def zip_payments; end
sig {
params(_zip_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::ZipPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::ZipPayments))
}
def zip_payments=(_zip_payments); end
sig {
params(acss_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AcssDebitPayments), affirm_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AffirmPayments), afterpay_clearpay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AfterpayClearpayPayments), alma_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AlmaPayments), amazon_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AmazonPayPayments), au_becs_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AuBecsDebitPayments), automatic_indirect_tax: T.nilable(::Stripe::Account::CreateParams::Capabilities::AutomaticIndirectTax), bacs_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BacsDebitPayments), bancontact_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BancontactPayments), bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BankTransferPayments), billie_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BilliePayments), blik_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BlikPayments), boleto_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BoletoPayments), card_issuing: T.nilable(::Stripe::Account::CreateParams::Capabilities::CardIssuing), card_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::CardPayments), cartes_bancaires_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::CartesBancairesPayments), cashapp_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::CashappPayments), crypto_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::CryptoPayments), eps_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::EpsPayments), fpx_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::FpxPayments), gb_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::GbBankTransferPayments), giropay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::GiropayPayments), gopay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::GopayPayments), grabpay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::GrabpayPayments), id_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::IdBankTransferPayments), id_bank_transfer_payments_bca: T.nilable(::Stripe::Account::CreateParams::Capabilities::IdBankTransferPaymentsBca), ideal_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::IdealPayments), india_international_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::IndiaInternationalPayments), jcb_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::JcbPayments), jp_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::JpBankTransferPayments), kakao_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::KakaoPayPayments), klarna_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::KlarnaPayments), konbini_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::KonbiniPayments), kr_card_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::KrCardPayments), legacy_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::LegacyPayments), link_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::LinkPayments), mb_way_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::MbWayPayments), mobilepay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::MobilepayPayments), multibanco_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::MultibancoPayments), mx_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::MxBankTransferPayments), naver_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::NaverPayPayments), nz_bank_account_becs_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::NzBankAccountBecsDebitPayments), oxxo_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::OxxoPayments), p24_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::P24Payments), pay_by_bank_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PayByBankPayments), payco_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PaycoPayments), paynow_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PaynowPayments), paypal_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PaypalPayments), paypay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PaypayPayments), payto_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PaytoPayments), pix_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PixPayments), promptpay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PromptpayPayments), qris_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::QrisPayments), rechnung_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::RechnungPayments), revolut_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::RevolutPayPayments), samsung_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SamsungPayPayments), satispay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SatispayPayments), sepa_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SepaBankTransferPayments), sepa_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SepaDebitPayments), shopeepay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::ShopeepayPayments), sofort_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SofortPayments), stripe_balance_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::StripeBalancePayments), swish_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SwishPayments), tax_reporting_us_1099_k: T.nilable(::Stripe::Account::CreateParams::Capabilities::TaxReportingUs1099K), tax_reporting_us_1099_misc: T.nilable(::Stripe::Account::CreateParams::Capabilities::TaxReportingUs1099Misc), transfers: T.nilable(::Stripe::Account::CreateParams::Capabilities::Transfers), treasury: T.nilable(::Stripe::Account::CreateParams::Capabilities::Treasury), treasury_evolve: T.nilable(::Stripe::Account::CreateParams::Capabilities::TreasuryEvolve), treasury_fifth_third: T.nilable(::Stripe::Account::CreateParams::Capabilities::TreasuryFifthThird), treasury_goldman_sachs: T.nilable(::Stripe::Account::CreateParams::Capabilities::TreasuryGoldmanSachs), twint_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::TwintPayments), us_bank_account_ach_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::UsBankAccountAchPayments), us_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::UsBankTransferPayments), zip_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::ZipPayments)).void
}
def initialize(
acss_debit_payments: nil,
affirm_payments: nil,
afterpay_clearpay_payments: nil,
alma_payments: nil,
amazon_pay_payments: nil,
au_becs_debit_payments: nil,
automatic_indirect_tax: nil,
bacs_debit_payments: nil,
bancontact_payments: nil,
bank_transfer_payments: nil,
billie_payments: nil,
blik_payments: nil,
boleto_payments: nil,
card_issuing: nil,
card_payments: nil,
cartes_bancaires_payments: nil,
cashapp_payments: nil,
crypto_payments: nil,
eps_payments: nil,
fpx_payments: nil,
gb_bank_transfer_payments: nil,
giropay_payments: nil,
gopay_payments: nil,
grabpay_payments: nil,
id_bank_transfer_payments: nil,
id_bank_transfer_payments_bca: nil,
ideal_payments: nil,
india_international_payments: nil,
jcb_payments: nil,
jp_bank_transfer_payments: nil,
kakao_pay_payments: nil,
klarna_payments: nil,
konbini_payments: nil,
kr_card_payments: nil,
legacy_payments: nil,
link_payments: nil,
mb_way_payments: nil,
mobilepay_payments: nil,
multibanco_payments: nil,
mx_bank_transfer_payments: nil,
naver_pay_payments: nil,
nz_bank_account_becs_debit_payments: nil,
oxxo_payments: nil,
p24_payments: nil,
pay_by_bank_payments: nil,
payco_payments: nil,
paynow_payments: nil,
paypal_payments: nil,
paypay_payments: nil,
payto_payments: nil,
pix_payments: nil,
promptpay_payments: nil,
qris_payments: nil,
rechnung_payments: nil,
revolut_pay_payments: nil,
samsung_pay_payments: nil,
satispay_payments: nil,
sepa_bank_transfer_payments: nil,
sepa_debit_payments: nil,
shopeepay_payments: nil,
sofort_payments: nil,
stripe_balance_payments: nil,
swish_payments: nil,
tax_reporting_us_1099_k: nil,
tax_reporting_us_1099_misc: nil,
transfers: nil,
treasury: nil,
treasury_evolve: nil,
treasury_fifth_third: nil,
treasury_goldman_sachs: nil,
twint_payments: nil,
us_bank_account_ach_payments: nil,
us_bank_transfer_payments: nil,
zip_payments: nil
); end
end
class Card < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# Attribute for param field address_city
sig { returns(T.nilable(String)) }
def address_city; end
sig { params(_address_city: T.nilable(String)).returns(T.nilable(String)) }
def address_city=(_address_city); end
# Attribute for param field address_country
sig { returns(T.nilable(String)) }
def address_country; end
sig { params(_address_country: T.nilable(String)).returns(T.nilable(String)) }
def address_country=(_address_country); end
# Attribute for param field address_line1
sig { returns(T.nilable(String)) }
def address_line1; end
sig { params(_address_line1: T.nilable(String)).returns(T.nilable(String)) }
def address_line1=(_address_line1); end
# Attribute for param field address_line2
sig { returns(T.nilable(String)) }
def address_line2; end
sig { params(_address_line2: T.nilable(String)).returns(T.nilable(String)) }
def address_line2=(_address_line2); end
# Attribute for param field address_state
sig { returns(T.nilable(String)) }
def address_state; end
sig { params(_address_state: T.nilable(String)).returns(T.nilable(String)) }
def address_state=(_address_state); end
# Attribute for param field address_zip
sig { returns(T.nilable(String)) }
def address_zip; end
sig { params(_address_zip: T.nilable(String)).returns(T.nilable(String)) }
def address_zip=(_address_zip); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Attribute for param field cvc
sig { returns(T.nilable(String)) }
def cvc; end
sig { params(_cvc: T.nilable(String)).returns(T.nilable(String)) }
def cvc=(_cvc); end
# Attribute for param field exp_month
sig { returns(Integer) }
def exp_month; end
sig { params(_exp_month: Integer).returns(Integer) }
def exp_month=(_exp_month); end
# Attribute for param field exp_year
sig { returns(Integer) }
def exp_year; end
sig { params(_exp_year: Integer).returns(Integer) }
def exp_year=(_exp_year); end
# Attribute for param field name
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Attribute for param field number
sig { returns(String) }
def number; end
sig { params(_number: String).returns(String) }
def number=(_number); end
# 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Attribute for param field default_for_currency
sig { returns(T.nilable(T::Boolean)) }
def default_for_currency; end
sig { params(_default_for_currency: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def default_for_currency=(_default_for_currency); end
sig {
params(object: String, address_city: T.nilable(String), address_country: T.nilable(String), address_line1: T.nilable(String), address_line2: T.nilable(String), address_state: T.nilable(String), address_zip: T.nilable(String), currency: T.nilable(String), cvc: T.nilable(String), exp_month: Integer, exp_year: Integer, name: T.nilable(String), number: String, metadata: T.nilable(T::Hash[String, String]), default_for_currency: T.nilable(T::Boolean)).void
}
def initialize(
object: nil,
address_city: nil,
address_country: nil,
address_line1: nil,
address_line2: nil,
address_state: nil,
address_zip: nil,
currency: nil,
cvc: nil,
exp_month: nil,
exp_year: nil,
name: nil,
number: nil,
metadata: nil,
default_for_currency: nil
); end
end
class CardToken < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Attribute for param field token
sig { returns(String) }
def token; end
sig { params(_token: String).returns(String) }
def token=(_token); end
sig { params(object: String, currency: T.nilable(String), token: String).void }
def initialize(object: nil, currency: nil, token: nil); end
end
class Company < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class DirectorshipDeclaration < Stripe::RequestParams
# The Unix timestamp marking when the directorship declaration attestation was made.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the directorship declaration attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the directorship declaration attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class OwnershipDeclaration < Stripe::RequestParams
# The Unix timestamp marking when the beneficial owner attestation was made.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class RegistrationDate < Stripe::RequestParams
# The day of registration, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of registration, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of registration.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Verification < Stripe::RequestParams
class Document < Stripe::RequestParams
# The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# A document verifying the business.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Company::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::Account::CreateParams::Company::Verification::Document)).returns(T.nilable(::Stripe::Account::CreateParams::Company::Verification::Document))
}
def document=(_document); end
sig {
params(document: T.nilable(::Stripe::Account::CreateParams::Company::Verification::Document)).void
}
def initialize(document: nil); end
end
# The company's primary address.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Company::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::Account::CreateParams::Company::Address)).returns(T.nilable(::Stripe::Account::CreateParams::Company::Address))
}
def address=(_address); end
# The Kana variation of the company's primary address (Japan only).
sig { returns(T.nilable(::Stripe::Account::CreateParams::Company::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::Account::CreateParams::Company::AddressKana)).returns(T.nilable(::Stripe::Account::CreateParams::Company::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the company's primary address (Japan only).
sig { returns(T.nilable(::Stripe::Account::CreateParams::Company::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::Account::CreateParams::Company::AddressKanji)).returns(T.nilable(::Stripe::Account::CreateParams::Company::AddressKanji))
}
def address_kanji=(_address_kanji); end
# Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.
sig { returns(T.nilable(T::Boolean)) }
def directors_provided; end
sig { params(_directors_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def directors_provided=(_directors_provided); end
# This hash is used to attest that the directors information provided to Stripe is both current and correct.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Company::DirectorshipDeclaration))
}
def directorship_declaration; end
sig {
params(_directorship_declaration: T.nilable(::Stripe::Account::CreateParams::Company::DirectorshipDeclaration)).returns(T.nilable(::Stripe::Account::CreateParams::Company::DirectorshipDeclaration))
}
def directorship_declaration=(_directorship_declaration); end
# Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](/api/persons) for accounts with a `relationship.executive` requirement.
sig { returns(T.nilable(T::Boolean)) }
def executives_provided; end
sig { params(_executives_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executives_provided=(_executives_provided); end
# The export license ID number of the company, also referred as Import Export Code (India only).
sig { returns(T.nilable(String)) }
def export_license_id; end
sig { params(_export_license_id: T.nilable(String)).returns(T.nilable(String)) }
def export_license_id=(_export_license_id); end
# The purpose code to use for export transactions (India only).
sig { returns(T.nilable(String)) }
def export_purpose_code; end
sig { params(_export_purpose_code: T.nilable(String)).returns(T.nilable(String)) }
def export_purpose_code=(_export_purpose_code); end
# The company's legal name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The Kana variation of the company's legal name (Japan only).
sig { returns(T.nilable(String)) }
def name_kana; end
sig { params(_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def name_kana=(_name_kana); end
# The Kanji variation of the company's legal name (Japan only).
sig { returns(T.nilable(String)) }
def name_kanji; end
sig { params(_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def name_kanji=(_name_kanji); end
# Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](/api/persons) for accounts with a `relationship.owner` requirement.
sig { returns(T.nilable(T::Boolean)) }
def owners_provided; end
sig { params(_owners_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owners_provided=(_owners_provided); end
# This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Company::OwnershipDeclaration)) }
def ownership_declaration; end
sig {
params(_ownership_declaration: T.nilable(::Stripe::Account::CreateParams::Company::OwnershipDeclaration)).returns(T.nilable(::Stripe::Account::CreateParams::Company::OwnershipDeclaration))
}
def ownership_declaration=(_ownership_declaration); end
# This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.
sig { returns(T.nilable(T.any(String, String))) }
def ownership_exemption_reason; end
sig {
params(_ownership_exemption_reason: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def ownership_exemption_reason=(_ownership_exemption_reason); end
# The company's phone number (used for verification).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# When the business was incorporated or registered.
sig {
returns(T.nilable(T.any(String, ::Stripe::Account::CreateParams::Company::RegistrationDate)))
}
def registration_date; end
sig {
params(_registration_date: T.nilable(T.any(String, ::Stripe::Account::CreateParams::Company::RegistrationDate))).returns(T.nilable(T.any(String, ::Stripe::Account::CreateParams::Company::RegistrationDate)))
}
def registration_date=(_registration_date); end
# The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).
sig { returns(T.nilable(String)) }
def registration_number; end
sig { params(_registration_number: T.nilable(String)).returns(T.nilable(String)) }
def registration_number=(_registration_number); end
# The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
sig { returns(T.nilable(T.any(String, String))) }
def structure; end
sig {
params(_structure: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def structure=(_structure); end
# The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
# The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
sig { returns(T.nilable(String)) }
def tax_id_registrar; end
sig { params(_tax_id_registrar: T.nilable(String)).returns(T.nilable(String)) }
def tax_id_registrar=(_tax_id_registrar); end
# The VAT number of the company.
sig { returns(T.nilable(String)) }
def vat_id; end
sig { params(_vat_id: T.nilable(String)).returns(T.nilable(String)) }
def vat_id=(_vat_id); end
# Information on the verification state of the company.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Company::Verification)) }
def verification; end
sig {
params(_verification: T.nilable(::Stripe::Account::CreateParams::Company::Verification)).returns(T.nilable(::Stripe::Account::CreateParams::Company::Verification))
}
def verification=(_verification); end
sig {
params(address: T.nilable(::Stripe::Account::CreateParams::Company::Address), address_kana: T.nilable(::Stripe::Account::CreateParams::Company::AddressKana), address_kanji: T.nilable(::Stripe::Account::CreateParams::Company::AddressKanji), directors_provided: T.nilable(T::Boolean), directorship_declaration: T.nilable(::Stripe::Account::CreateParams::Company::DirectorshipDeclaration), executives_provided: T.nilable(T::Boolean), export_license_id: T.nilable(String), export_purpose_code: T.nilable(String), name: T.nilable(String), name_kana: T.nilable(String), name_kanji: T.nilable(String), owners_provided: T.nilable(T::Boolean), ownership_declaration: T.nilable(::Stripe::Account::CreateParams::Company::OwnershipDeclaration), ownership_exemption_reason: T.nilable(T.any(String, String)), phone: T.nilable(String), registration_date: T.nilable(T.any(String, ::Stripe::Account::CreateParams::Company::RegistrationDate)), registration_number: T.nilable(String), structure: T.nilable(T.any(String, String)), tax_id: T.nilable(String), tax_id_registrar: T.nilable(String), vat_id: T.nilable(String), verification: T.nilable(::Stripe::Account::CreateParams::Company::Verification)).void
}
def initialize(
address: nil,
address_kana: nil,
address_kanji: nil,
directors_provided: nil,
directorship_declaration: nil,
executives_provided: nil,
export_license_id: nil,
export_purpose_code: nil,
name: nil,
name_kana: nil,
name_kanji: nil,
owners_provided: nil,
ownership_declaration: nil,
ownership_exemption_reason: nil,
phone: nil,
registration_date: nil,
registration_number: nil,
structure: nil,
tax_id: nil,
tax_id_registrar: nil,
vat_id: nil,
verification: nil
); end
end
class Controller < Stripe::RequestParams
class Application < Stripe::RequestParams
# Whether the controller is liable for losses on this account. For details, see [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances).
sig { returns(T::Boolean) }
def loss_liable; end
sig { params(_loss_liable: T::Boolean).returns(T::Boolean) }
def loss_liable=(_loss_liable); end
# Whether the controller owns onboarding for this account.
sig { returns(T.nilable(T::Boolean)) }
def onboarding_owner; end
sig { params(_onboarding_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def onboarding_owner=(_onboarding_owner); end
# Whether the controller has pricing controls for this account.
sig { returns(T.nilable(T::Boolean)) }
def pricing_controls; end
sig { params(_pricing_controls: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def pricing_controls=(_pricing_controls); end
sig {
params(loss_liable: T::Boolean, onboarding_owner: T.nilable(T::Boolean), pricing_controls: T.nilable(T::Boolean)).void
}
def initialize(loss_liable: nil, onboarding_owner: nil, pricing_controls: nil); end
end
class Dashboard < Stripe::RequestParams
# Whether this account should have access to the full Stripe Dashboard (`full`), to the Express Dashboard (`express`), or to no Stripe-hosted dashboard (`none`). Defaults to `full`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig { params(type: T.nilable(String)).void }
def initialize(type: nil); end
end
class Fees < Stripe::RequestParams
# A value indicating the responsible payer of Stripe fees on this account. Defaults to `account`. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).
sig { returns(T.nilable(String)) }
def payer; end
sig { params(_payer: T.nilable(String)).returns(T.nilable(String)) }
def payer=(_payer); end
sig { params(payer: T.nilable(String)).void }
def initialize(payer: nil); end
end
class Losses < Stripe::RequestParams
# A value indicating who is liable when this account can't pay back negative balances resulting from payments. Defaults to `stripe`.
sig { returns(T.nilable(String)) }
def payments; end
sig { params(_payments: T.nilable(String)).returns(T.nilable(String)) }
def payments=(_payments); end
sig { params(payments: T.nilable(String)).void }
def initialize(payments: nil); end
end
class StripeDashboard < Stripe::RequestParams
# Whether this account should have access to the full Stripe Dashboard (`full`), to the Express Dashboard (`express`), or to no Stripe-hosted dashboard (`none`). Defaults to `full`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig { params(type: T.nilable(String)).void }
def initialize(type: nil); end
end
# A hash of configuration describing the Connect application that controls the account.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Controller::Application)) }
def application; end
sig {
params(_application: T.nilable(::Stripe::Account::CreateParams::Controller::Application)).returns(T.nilable(::Stripe::Account::CreateParams::Controller::Application))
}
def application=(_application); end
# Properties of the account's dashboard.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Controller::Dashboard)) }
def dashboard; end
sig {
params(_dashboard: T.nilable(::Stripe::Account::CreateParams::Controller::Dashboard)).returns(T.nilable(::Stripe::Account::CreateParams::Controller::Dashboard))
}
def dashboard=(_dashboard); end
# A hash of configuration for who pays Stripe fees for product usage on this account.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Controller::Fees)) }
def fees; end
sig {
params(_fees: T.nilable(::Stripe::Account::CreateParams::Controller::Fees)).returns(T.nilable(::Stripe::Account::CreateParams::Controller::Fees))
}
def fees=(_fees); end
# A hash of configuration for products that have negative balance liability, and whether Stripe or a Connect application is responsible for them.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Controller::Losses)) }
def losses; end
sig {
params(_losses: T.nilable(::Stripe::Account::CreateParams::Controller::Losses)).returns(T.nilable(::Stripe::Account::CreateParams::Controller::Losses))
}
def losses=(_losses); end
# A value indicating responsibility for collecting updated information when requirements on the account are due or change. Defaults to `stripe`.
sig { returns(T.nilable(String)) }
def requirement_collection; end
sig { params(_requirement_collection: T.nilable(String)).returns(T.nilable(String)) }
def requirement_collection=(_requirement_collection); end
# A hash of configuration for Stripe-hosted dashboards.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Controller::StripeDashboard)) }
def stripe_dashboard; end
sig {
params(_stripe_dashboard: T.nilable(::Stripe::Account::CreateParams::Controller::StripeDashboard)).returns(T.nilable(::Stripe::Account::CreateParams::Controller::StripeDashboard))
}
def stripe_dashboard=(_stripe_dashboard); end
sig {
params(application: T.nilable(::Stripe::Account::CreateParams::Controller::Application), dashboard: T.nilable(::Stripe::Account::CreateParams::Controller::Dashboard), fees: T.nilable(::Stripe::Account::CreateParams::Controller::Fees), losses: T.nilable(::Stripe::Account::CreateParams::Controller::Losses), requirement_collection: T.nilable(String), stripe_dashboard: T.nilable(::Stripe::Account::CreateParams::Controller::StripeDashboard)).void
}
def initialize(
application: nil,
dashboard: nil,
fees: nil,
losses: nil,
requirement_collection: nil,
stripe_dashboard: nil
); end
end
class Documents < Stripe::RequestParams
class BankAccountOwnershipVerification < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyLicense < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyMemorandumOfAssociation < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyMinisterialDecree < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyRegistrationVerification < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyTaxIdVerification < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class ProofOfAddress < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class ProofOfRegistration < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class ProofOfUltimateBeneficialOwnership < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
# One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Documents::BankAccountOwnershipVerification))
}
def bank_account_ownership_verification; end
sig {
params(_bank_account_ownership_verification: T.nilable(::Stripe::Account::CreateParams::Documents::BankAccountOwnershipVerification)).returns(T.nilable(::Stripe::Account::CreateParams::Documents::BankAccountOwnershipVerification))
}
def bank_account_ownership_verification=(_bank_account_ownership_verification); end
# One or more documents that demonstrate proof of a company's license to operate.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Documents::CompanyLicense)) }
def company_license; end
sig {
params(_company_license: T.nilable(::Stripe::Account::CreateParams::Documents::CompanyLicense)).returns(T.nilable(::Stripe::Account::CreateParams::Documents::CompanyLicense))
}
def company_license=(_company_license); end
# One or more documents showing the company's Memorandum of Association.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Documents::CompanyMemorandumOfAssociation))
}
def company_memorandum_of_association; end
sig {
params(_company_memorandum_of_association: T.nilable(::Stripe::Account::CreateParams::Documents::CompanyMemorandumOfAssociation)).returns(T.nilable(::Stripe::Account::CreateParams::Documents::CompanyMemorandumOfAssociation))
}
def company_memorandum_of_association=(_company_memorandum_of_association); end
# (Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Documents::CompanyMinisterialDecree))
}
def company_ministerial_decree; end
sig {
params(_company_ministerial_decree: T.nilable(::Stripe::Account::CreateParams::Documents::CompanyMinisterialDecree)).returns(T.nilable(::Stripe::Account::CreateParams::Documents::CompanyMinisterialDecree))
}
def company_ministerial_decree=(_company_ministerial_decree); end
# One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Documents::CompanyRegistrationVerification))
}
def company_registration_verification; end
sig {
params(_company_registration_verification: T.nilable(::Stripe::Account::CreateParams::Documents::CompanyRegistrationVerification)).returns(T.nilable(::Stripe::Account::CreateParams::Documents::CompanyRegistrationVerification))
}
def company_registration_verification=(_company_registration_verification); end
# One or more documents that demonstrate proof of a company's tax ID.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Documents::CompanyTaxIdVerification))
}
def company_tax_id_verification; end
sig {
params(_company_tax_id_verification: T.nilable(::Stripe::Account::CreateParams::Documents::CompanyTaxIdVerification)).returns(T.nilable(::Stripe::Account::CreateParams::Documents::CompanyTaxIdVerification))
}
def company_tax_id_verification=(_company_tax_id_verification); end
# One or more documents that demonstrate proof of address.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Documents::ProofOfAddress)) }
def proof_of_address; end
sig {
params(_proof_of_address: T.nilable(::Stripe::Account::CreateParams::Documents::ProofOfAddress)).returns(T.nilable(::Stripe::Account::CreateParams::Documents::ProofOfAddress))
}
def proof_of_address=(_proof_of_address); end
# One or more documents showing the company’s proof of registration with the national business registry.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Documents::ProofOfRegistration)) }
def proof_of_registration; end
sig {
params(_proof_of_registration: T.nilable(::Stripe::Account::CreateParams::Documents::ProofOfRegistration)).returns(T.nilable(::Stripe::Account::CreateParams::Documents::ProofOfRegistration))
}
def proof_of_registration=(_proof_of_registration); end
# One or more documents that demonstrate proof of ultimate beneficial ownership.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Documents::ProofOfUltimateBeneficialOwnership))
}
def proof_of_ultimate_beneficial_ownership; end
sig {
params(_proof_of_ultimate_beneficial_ownership: T.nilable(::Stripe::Account::CreateParams::Documents::ProofOfUltimateBeneficialOwnership)).returns(T.nilable(::Stripe::Account::CreateParams::Documents::ProofOfUltimateBeneficialOwnership))
}
def proof_of_ultimate_beneficial_ownership=(_proof_of_ultimate_beneficial_ownership); end
sig {
params(bank_account_ownership_verification: T.nilable(::Stripe::Account::CreateParams::Documents::BankAccountOwnershipVerification), company_license: T.nilable(::Stripe::Account::CreateParams::Documents::CompanyLicense), company_memorandum_of_association: T.nilable(::Stripe::Account::CreateParams::Documents::CompanyMemorandumOfAssociation), company_ministerial_decree: T.nilable(::Stripe::Account::CreateParams::Documents::CompanyMinisterialDecree), company_registration_verification: T.nilable(::Stripe::Account::CreateParams::Documents::CompanyRegistrationVerification), company_tax_id_verification: T.nilable(::Stripe::Account::CreateParams::Documents::CompanyTaxIdVerification), proof_of_address: T.nilable(::Stripe::Account::CreateParams::Documents::ProofOfAddress), proof_of_registration: T.nilable(::Stripe::Account::CreateParams::Documents::ProofOfRegistration), proof_of_ultimate_beneficial_ownership: T.nilable(::Stripe::Account::CreateParams::Documents::ProofOfUltimateBeneficialOwnership)).void
}
def initialize(
bank_account_ownership_verification: nil,
company_license: nil,
company_memorandum_of_association: nil,
company_ministerial_decree: nil,
company_registration_verification: nil,
company_tax_id_verification: nil,
proof_of_address: nil,
proof_of_registration: nil,
proof_of_ultimate_beneficial_ownership: nil
); end
end
class Groups < Stripe::RequestParams
# The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details.
sig { returns(T.nilable(String)) }
def payments_pricing; end
sig { params(_payments_pricing: T.nilable(String)).returns(T.nilable(String)) }
def payments_pricing=(_payments_pricing); end
sig { params(payments_pricing: T.nilable(String)).void }
def initialize(payments_pricing: nil); end
end
class Individual < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class RegisteredAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Relationship < Stripe::RequestParams
# Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
sig { returns(T.nilable(T::Boolean)) }
def director; end
sig { params(_director: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def director=(_director); end
# Whether the person has significant responsibility to control, manage, or direct the organization.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
sig { params(_executive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executive=(_executive); end
# Whether the person is an owner of the account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
sig { params(_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owner=(_owner); end
# The percent owned by the person of the account's legal entity.
sig { returns(T.nilable(T.any(String, Float))) }
def percent_ownership; end
sig {
params(_percent_ownership: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def percent_ownership=(_percent_ownership); end
# The person's title (e.g., CEO, Support Engineer).
sig { returns(T.nilable(String)) }
def title; end
sig { params(_title: T.nilable(String)).returns(T.nilable(String)) }
def title=(_title); end
sig {
params(director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), percent_ownership: T.nilable(T.any(String, Float)), title: T.nilable(String)).void
}
def initialize(
director: nil,
executive: nil,
owner: nil,
percent_ownership: nil,
title: nil
); end
end
class Verification < Stripe::RequestParams
class AdditionalDocument < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
class Document < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Individual::Verification::AdditionalDocument))
}
def additional_document; end
sig {
params(_additional_document: T.nilable(::Stripe::Account::CreateParams::Individual::Verification::AdditionalDocument)).returns(T.nilable(::Stripe::Account::CreateParams::Individual::Verification::AdditionalDocument))
}
def additional_document=(_additional_document); end
# An identifying document, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Individual::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::Account::CreateParams::Individual::Verification::Document)).returns(T.nilable(::Stripe::Account::CreateParams::Individual::Verification::Document))
}
def document=(_document); end
sig {
params(additional_document: T.nilable(::Stripe::Account::CreateParams::Individual::Verification::AdditionalDocument), document: T.nilable(::Stripe::Account::CreateParams::Individual::Verification::Document)).void
}
def initialize(additional_document: nil, document: nil); end
end
# The individual's primary address.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Individual::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::Account::CreateParams::Individual::Address)).returns(T.nilable(::Stripe::Account::CreateParams::Individual::Address))
}
def address=(_address); end
# The Kana variation of the individual's primary address (Japan only).
sig { returns(T.nilable(::Stripe::Account::CreateParams::Individual::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::Account::CreateParams::Individual::AddressKana)).returns(T.nilable(::Stripe::Account::CreateParams::Individual::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the individual's primary address (Japan only).
sig { returns(T.nilable(::Stripe::Account::CreateParams::Individual::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::Account::CreateParams::Individual::AddressKanji)).returns(T.nilable(::Stripe::Account::CreateParams::Individual::AddressKanji))
}
def address_kanji=(_address_kanji); end
# The individual's date of birth.
sig { returns(T.nilable(T.any(String, ::Stripe::Account::CreateParams::Individual::Dob))) }
def dob; end
sig {
params(_dob: T.nilable(T.any(String, ::Stripe::Account::CreateParams::Individual::Dob))).returns(T.nilable(T.any(String, ::Stripe::Account::CreateParams::Individual::Dob)))
}
def dob=(_dob); end
# The individual's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The individual's first name.
sig { returns(T.nilable(String)) }
def first_name; end
sig { params(_first_name: T.nilable(String)).returns(T.nilable(String)) }
def first_name=(_first_name); end
# The Kana variation of the individual's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kana; end
sig { params(_first_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kana=(_first_name_kana); end
# The Kanji variation of the individual's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kanji; end
sig { params(_first_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kanji=(_first_name_kanji); end
# A list of alternate names or aliases that the individual is known by.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def full_name_aliases; end
sig {
params(_full_name_aliases: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def full_name_aliases=(_full_name_aliases); end
# The individual's gender
sig { returns(T.nilable(String)) }
def gender; end
sig { params(_gender: T.nilable(String)).returns(T.nilable(String)) }
def gender=(_gender); end
# The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number; end
sig { params(_id_number: T.nilable(String)).returns(T.nilable(String)) }
def id_number=(_id_number); end
# The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number_secondary; end
sig { params(_id_number_secondary: T.nilable(String)).returns(T.nilable(String)) }
def id_number_secondary=(_id_number_secondary); end
# The individual's last name.
sig { returns(T.nilable(String)) }
def last_name; end
sig { params(_last_name: T.nilable(String)).returns(T.nilable(String)) }
def last_name=(_last_name); end
# The Kana variation of the individual's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kana; end
sig { params(_last_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kana=(_last_name_kana); end
# The Kanji variation of the individual's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kanji; end
sig { params(_last_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kanji=(_last_name_kanji); end
# The individual's maiden name.
sig { returns(T.nilable(String)) }
def maiden_name; end
sig { params(_maiden_name: T.nilable(String)).returns(T.nilable(String)) }
def maiden_name=(_maiden_name); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The individual's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
sig { returns(T.nilable(String)) }
def political_exposure; end
sig { params(_political_exposure: T.nilable(String)).returns(T.nilable(String)) }
def political_exposure=(_political_exposure); end
# The individual's registered address.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Individual::RegisteredAddress)) }
def registered_address; end
sig {
params(_registered_address: T.nilable(::Stripe::Account::CreateParams::Individual::RegisteredAddress)).returns(T.nilable(::Stripe::Account::CreateParams::Individual::RegisteredAddress))
}
def registered_address=(_registered_address); end
# Describes the person’s relationship to the account.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Individual::Relationship)) }
def relationship; end
sig {
params(_relationship: T.nilable(::Stripe::Account::CreateParams::Individual::Relationship)).returns(T.nilable(::Stripe::Account::CreateParams::Individual::Relationship))
}
def relationship=(_relationship); end
# The last four digits of the individual's Social Security Number (U.S. only).
sig { returns(T.nilable(String)) }
def ssn_last_4; end
sig { params(_ssn_last_4: T.nilable(String)).returns(T.nilable(String)) }
def ssn_last_4=(_ssn_last_4); end
# The individual's verification document information.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Individual::Verification)) }
def verification; end
sig {
params(_verification: T.nilable(::Stripe::Account::CreateParams::Individual::Verification)).returns(T.nilable(::Stripe::Account::CreateParams::Individual::Verification))
}
def verification=(_verification); end
sig {
params(address: T.nilable(::Stripe::Account::CreateParams::Individual::Address), address_kana: T.nilable(::Stripe::Account::CreateParams::Individual::AddressKana), address_kanji: T.nilable(::Stripe::Account::CreateParams::Individual::AddressKanji), dob: T.nilable(T.any(String, ::Stripe::Account::CreateParams::Individual::Dob)), email: T.nilable(String), first_name: T.nilable(String), first_name_kana: T.nilable(String), first_name_kanji: T.nilable(String), full_name_aliases: T.nilable(T.any(String, T::Array[String])), gender: T.nilable(String), id_number: T.nilable(String), id_number_secondary: T.nilable(String), last_name: T.nilable(String), last_name_kana: T.nilable(String), last_name_kanji: T.nilable(String), maiden_name: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), phone: T.nilable(String), political_exposure: T.nilable(String), registered_address: T.nilable(::Stripe::Account::CreateParams::Individual::RegisteredAddress), relationship: T.nilable(::Stripe::Account::CreateParams::Individual::Relationship), ssn_last_4: T.nilable(String), verification: T.nilable(::Stripe::Account::CreateParams::Individual::Verification)).void
}
def initialize(
address: nil,
address_kana: nil,
address_kanji: nil,
dob: nil,
email: nil,
first_name: nil,
first_name_kana: nil,
first_name_kanji: nil,
full_name_aliases: nil,
gender: nil,
id_number: nil,
id_number_secondary: nil,
last_name: nil,
last_name_kana: nil,
last_name_kanji: nil,
maiden_name: nil,
metadata: nil,
phone: nil,
political_exposure: nil,
registered_address: nil,
relationship: nil,
ssn_last_4: nil,
verification: nil
); end
end
class RiskControls < Stripe::RequestParams
class Charges < Stripe::RequestParams
# To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.
# There can be a delay before the risk control is paused or unpaused.
sig { returns(T.nilable(T::Boolean)) }
def pause_requested; end
sig { params(_pause_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def pause_requested=(_pause_requested); end
sig { params(pause_requested: T.nilable(T::Boolean)).void }
def initialize(pause_requested: nil); end
end
class Payouts < Stripe::RequestParams
# To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.
# There can be a delay before the risk control is paused or unpaused.
sig { returns(T.nilable(T::Boolean)) }
def pause_requested; end
sig { params(_pause_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def pause_requested=(_pause_requested); end
sig { params(pause_requested: T.nilable(T::Boolean)).void }
def initialize(pause_requested: nil); end
end
# Represents the risk control status of charges. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).
sig { returns(T.nilable(::Stripe::Account::CreateParams::RiskControls::Charges)) }
def charges; end
sig {
params(_charges: T.nilable(::Stripe::Account::CreateParams::RiskControls::Charges)).returns(T.nilable(::Stripe::Account::CreateParams::RiskControls::Charges))
}
def charges=(_charges); end
# Represents the risk control status of payouts. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).
sig { returns(T.nilable(::Stripe::Account::CreateParams::RiskControls::Payouts)) }
def payouts; end
sig {
params(_payouts: T.nilable(::Stripe::Account::CreateParams::RiskControls::Payouts)).returns(T.nilable(::Stripe::Account::CreateParams::RiskControls::Payouts))
}
def payouts=(_payouts); end
sig {
params(charges: T.nilable(::Stripe::Account::CreateParams::RiskControls::Charges), payouts: T.nilable(::Stripe::Account::CreateParams::RiskControls::Payouts)).void
}
def initialize(charges: nil, payouts: nil); end
end
class Settings < Stripe::RequestParams
class BacsDebitPayments < Stripe::RequestParams
# The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
sig { params(display_name: T.nilable(String)).void }
def initialize(display_name: nil); end
end
class BankBcaOnboarding < Stripe::RequestParams
# Bank BCA business account holder name
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# Bank BCA business account number
sig { returns(T.nilable(String)) }
def business_account_number; end
sig { params(_business_account_number: T.nilable(String)).returns(T.nilable(String)) }
def business_account_number=(_business_account_number); end
sig {
params(account_holder_name: T.nilable(String), business_account_number: T.nilable(String)).void
}
def initialize(account_holder_name: nil, business_account_number: nil); end
end
class Branding < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.
sig { returns(T.nilable(String)) }
def icon; end
sig { params(_icon: T.nilable(String)).returns(T.nilable(String)) }
def icon=(_icon); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.
sig { returns(T.nilable(String)) }
def logo; end
sig { params(_logo: T.nilable(String)).returns(T.nilable(String)) }
def logo=(_logo); end
# A CSS hex color value representing the primary branding color for this account.
sig { returns(T.nilable(String)) }
def primary_color; end
sig { params(_primary_color: T.nilable(String)).returns(T.nilable(String)) }
def primary_color=(_primary_color); end
# A CSS hex color value representing the secondary branding color for this account.
sig { returns(T.nilable(String)) }
def secondary_color; end
sig { params(_secondary_color: T.nilable(String)).returns(T.nilable(String)) }
def secondary_color=(_secondary_color); end
sig {
params(icon: T.nilable(String), logo: T.nilable(String), primary_color: T.nilable(String), secondary_color: T.nilable(String)).void
}
def initialize(icon: nil, logo: nil, primary_color: nil, secondary_color: nil); end
end
class Capital < Stripe::RequestParams
# Per-currency mapping of user-selected destination accounts used to pay out loans.
sig { returns(T.nilable(T::Hash[String, String])) }
def payout_destination; end
sig {
params(_payout_destination: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def payout_destination=(_payout_destination); end
# Per-currency mapping of all destination accounts eligible to receive Capital financing payouts.
sig { returns(T.nilable(T::Hash[String, T::Array[String]])) }
def payout_destination_selector; end
sig {
params(_payout_destination_selector: T.nilable(T::Hash[String, T::Array[String]])).returns(T.nilable(T::Hash[String, T::Array[String]]))
}
def payout_destination_selector=(_payout_destination_selector); end
sig {
params(payout_destination: T.nilable(T::Hash[String, String]), payout_destination_selector: T.nilable(T::Hash[String, T::Array[String]])).void
}
def initialize(payout_destination: nil, payout_destination_selector: nil); end
end
class CardIssuing < Stripe::RequestParams
class TosAcceptance < Stripe::RequestParams
# The Unix timestamp marking when the account representative accepted the service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](/issuing/connect/tos_acceptance).
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Settings::CardIssuing::TosAcceptance))
}
def tos_acceptance; end
sig {
params(_tos_acceptance: T.nilable(::Stripe::Account::CreateParams::Settings::CardIssuing::TosAcceptance)).returns(T.nilable(::Stripe::Account::CreateParams::Settings::CardIssuing::TosAcceptance))
}
def tos_acceptance=(_tos_acceptance); end
sig {
params(tos_acceptance: T.nilable(::Stripe::Account::CreateParams::Settings::CardIssuing::TosAcceptance)).void
}
def initialize(tos_acceptance: nil); end
end
class CardPayments < Stripe::RequestParams
class DeclineOn < Stripe::RequestParams
# Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.
sig { returns(T.nilable(T::Boolean)) }
def avs_failure; end
sig { params(_avs_failure: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def avs_failure=(_avs_failure); end
# Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.
sig { returns(T.nilable(T::Boolean)) }
def cvc_failure; end
sig { params(_cvc_failure: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def cvc_failure=(_cvc_failure); end
sig {
params(avs_failure: T.nilable(T::Boolean), cvc_failure: T.nilable(T::Boolean)).void
}
def initialize(avs_failure: nil, cvc_failure: nil); end
end
# Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Settings::CardPayments::DeclineOn))
}
def decline_on; end
sig {
params(_decline_on: T.nilable(::Stripe::Account::CreateParams::Settings::CardPayments::DeclineOn)).returns(T.nilable(::Stripe::Account::CreateParams::Settings::CardPayments::DeclineOn))
}
def decline_on=(_decline_on); end
# The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix; end
sig { params(_statement_descriptor_prefix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_prefix=(_statement_descriptor_prefix); end
# The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion.
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix_kana; end
sig {
params(_statement_descriptor_prefix_kana: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_prefix_kana=(_statement_descriptor_prefix_kana); end
# The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion.
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix_kanji; end
sig {
params(_statement_descriptor_prefix_kanji: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_prefix_kanji=(_statement_descriptor_prefix_kanji); end
sig {
params(decline_on: T.nilable(::Stripe::Account::CreateParams::Settings::CardPayments::DeclineOn), statement_descriptor_prefix: T.nilable(String), statement_descriptor_prefix_kana: T.nilable(String), statement_descriptor_prefix_kanji: T.nilable(String)).void
}
def initialize(
decline_on: nil,
statement_descriptor_prefix: nil,
statement_descriptor_prefix_kana: nil,
statement_descriptor_prefix_kanji: nil
); end
end
class Invoices < Stripe::RequestParams
# Whether payment methods should be saved when a payment is completed for a one-time invoices on a hosted invoice page.
sig { returns(T.nilable(String)) }
def hosted_payment_method_save; end
sig { params(_hosted_payment_method_save: T.nilable(String)).returns(T.nilable(String)) }
def hosted_payment_method_save=(_hosted_payment_method_save); end
sig { params(hosted_payment_method_save: T.nilable(String)).void }
def initialize(hosted_payment_method_save: nil); end
end
class Payments < Stripe::RequestParams
# The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a `statement_descriptor_prefix`, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the `statement_descriptor` text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the [account settings documentation](https://docs.stripe.com/get-started/account/statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor_kana; end
sig { params(_statement_descriptor_kana: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_kana=(_statement_descriptor_kana); end
# The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor_kanji; end
sig { params(_statement_descriptor_kanji: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_kanji=(_statement_descriptor_kanji); end
sig {
params(statement_descriptor: T.nilable(String), statement_descriptor_kana: T.nilable(String), statement_descriptor_kanji: T.nilable(String)).void
}
def initialize(
statement_descriptor: nil,
statement_descriptor_kana: nil,
statement_descriptor_kanji: nil
); end
end
class Payouts < Stripe::RequestParams
class Schedule < Stripe::RequestParams
# The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](/connect/manage-payout-schedule).
sig { returns(T.nilable(T.any(String, Integer))) }
def delay_days; end
sig {
params(_delay_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def delay_days=(_delay_days); end
# How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# The day of the month when available funds are paid out, specified as a number between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`.
sig { returns(T.nilable(Integer)) }
def monthly_anchor; end
sig { params(_monthly_anchor: T.nilable(Integer)).returns(T.nilable(Integer)) }
def monthly_anchor=(_monthly_anchor); end
# The days of the month when available funds are paid out, specified as an array of numbers between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly` and `monthly_anchor` is not set.
sig { returns(T.nilable(T::Array[Integer])) }
def monthly_payout_days; end
sig {
params(_monthly_payout_days: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def monthly_payout_days=(_monthly_payout_days); end
# The day of the week when available funds are paid out, specified as `monday`, `tuesday`, etc. Required and applicable only if `interval` is `weekly`.
sig { returns(T.nilable(String)) }
def weekly_anchor; end
sig { params(_weekly_anchor: T.nilable(String)).returns(T.nilable(String)) }
def weekly_anchor=(_weekly_anchor); end
# The days of the week when available funds are paid out, specified as an array, e.g., [`monday`, `tuesday`]. Required and applicable only if `interval` is `weekly`.
sig { returns(T.nilable(T::Array[String])) }
def weekly_payout_days; end
sig {
params(_weekly_payout_days: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def weekly_payout_days=(_weekly_payout_days); end
sig {
params(delay_days: T.nilable(T.any(String, Integer)), interval: T.nilable(String), monthly_anchor: T.nilable(Integer), monthly_payout_days: T.nilable(T::Array[Integer]), weekly_anchor: T.nilable(String), weekly_payout_days: T.nilable(T::Array[String])).void
}
def initialize(
delay_days: nil,
interval: nil,
monthly_anchor: nil,
monthly_payout_days: nil,
weekly_anchor: nil,
weekly_payout_days: nil
); end
end
# A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/connect/account-balances).
sig { returns(T.nilable(T::Boolean)) }
def debit_negative_balances; end
sig {
params(_debit_negative_balances: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def debit_negative_balances=(_debit_negative_balances); end
# Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](/connect/bank-transfers#payout-information) documentation.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Settings::Payouts::Schedule)) }
def schedule; end
sig {
params(_schedule: T.nilable(::Stripe::Account::CreateParams::Settings::Payouts::Schedule)).returns(T.nilable(::Stripe::Account::CreateParams::Settings::Payouts::Schedule))
}
def schedule=(_schedule); end
# The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
sig {
params(debit_negative_balances: T.nilable(T::Boolean), schedule: T.nilable(::Stripe::Account::CreateParams::Settings::Payouts::Schedule), statement_descriptor: T.nilable(String)).void
}
def initialize(
debit_negative_balances: nil,
schedule: nil,
statement_descriptor: nil
); end
end
class TaxForms < Stripe::RequestParams
# Whether the account opted out of receiving their tax forms by postal delivery.
sig { returns(T.nilable(T::Boolean)) }
def consented_to_paperless_delivery; end
sig {
params(_consented_to_paperless_delivery: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consented_to_paperless_delivery=(_consented_to_paperless_delivery); end
sig { params(consented_to_paperless_delivery: T.nilable(T::Boolean)).void }
def initialize(consented_to_paperless_delivery: nil); end
end
class Treasury < Stripe::RequestParams
class TosAcceptance < Stripe::RequestParams
# The Unix timestamp marking when the account representative accepted the service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Details on the account's acceptance of the Stripe Treasury Services Agreement.
sig {
returns(T.nilable(::Stripe::Account::CreateParams::Settings::Treasury::TosAcceptance))
}
def tos_acceptance; end
sig {
params(_tos_acceptance: T.nilable(::Stripe::Account::CreateParams::Settings::Treasury::TosAcceptance)).returns(T.nilable(::Stripe::Account::CreateParams::Settings::Treasury::TosAcceptance))
}
def tos_acceptance=(_tos_acceptance); end
sig {
params(tos_acceptance: T.nilable(::Stripe::Account::CreateParams::Settings::Treasury::TosAcceptance)).void
}
def initialize(tos_acceptance: nil); end
end
# Settings specific to Bacs Direct Debit.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Settings::BacsDebitPayments)) }
def bacs_debit_payments; end
sig {
params(_bacs_debit_payments: T.nilable(::Stripe::Account::CreateParams::Settings::BacsDebitPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Settings::BacsDebitPayments))
}
def bacs_debit_payments=(_bacs_debit_payments); end
# Settings specific to bank BCA onboarding for Indonesia bank transfers payments method.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Settings::BankBcaOnboarding)) }
def bank_bca_onboarding; end
sig {
params(_bank_bca_onboarding: T.nilable(::Stripe::Account::CreateParams::Settings::BankBcaOnboarding)).returns(T.nilable(::Stripe::Account::CreateParams::Settings::BankBcaOnboarding))
}
def bank_bca_onboarding=(_bank_bca_onboarding); end
# Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Settings::Branding)) }
def branding; end
sig {
params(_branding: T.nilable(::Stripe::Account::CreateParams::Settings::Branding)).returns(T.nilable(::Stripe::Account::CreateParams::Settings::Branding))
}
def branding=(_branding); end
# Settings specific to the account's use of the Capital product.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Settings::Capital)) }
def capital; end
sig {
params(_capital: T.nilable(::Stripe::Account::CreateParams::Settings::Capital)).returns(T.nilable(::Stripe::Account::CreateParams::Settings::Capital))
}
def capital=(_capital); end
# Settings specific to the account's use of the Card Issuing product.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Settings::CardIssuing)) }
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::Account::CreateParams::Settings::CardIssuing)).returns(T.nilable(::Stripe::Account::CreateParams::Settings::CardIssuing))
}
def card_issuing=(_card_issuing); end
# Settings specific to card charging on the account.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Settings::CardPayments)) }
def card_payments; end
sig {
params(_card_payments: T.nilable(::Stripe::Account::CreateParams::Settings::CardPayments)).returns(T.nilable(::Stripe::Account::CreateParams::Settings::CardPayments))
}
def card_payments=(_card_payments); end
# Settings specific to the account’s use of Invoices.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Settings::Invoices)) }
def invoices; end
sig {
params(_invoices: T.nilable(::Stripe::Account::CreateParams::Settings::Invoices)).returns(T.nilable(::Stripe::Account::CreateParams::Settings::Invoices))
}
def invoices=(_invoices); end
# Settings that apply across payment methods for charging on the account.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Settings::Payments)) }
def payments; end
sig {
params(_payments: T.nilable(::Stripe::Account::CreateParams::Settings::Payments)).returns(T.nilable(::Stripe::Account::CreateParams::Settings::Payments))
}
def payments=(_payments); end
# Settings specific to the account's payouts.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Settings::Payouts)) }
def payouts; end
sig {
params(_payouts: T.nilable(::Stripe::Account::CreateParams::Settings::Payouts)).returns(T.nilable(::Stripe::Account::CreateParams::Settings::Payouts))
}
def payouts=(_payouts); end
# Settings specific to the account's tax forms.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Settings::TaxForms)) }
def tax_forms; end
sig {
params(_tax_forms: T.nilable(::Stripe::Account::CreateParams::Settings::TaxForms)).returns(T.nilable(::Stripe::Account::CreateParams::Settings::TaxForms))
}
def tax_forms=(_tax_forms); end
# Settings specific to the account's Treasury FinancialAccounts.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Settings::Treasury)) }
def treasury; end
sig {
params(_treasury: T.nilable(::Stripe::Account::CreateParams::Settings::Treasury)).returns(T.nilable(::Stripe::Account::CreateParams::Settings::Treasury))
}
def treasury=(_treasury); end
sig {
params(bacs_debit_payments: T.nilable(::Stripe::Account::CreateParams::Settings::BacsDebitPayments), bank_bca_onboarding: T.nilable(::Stripe::Account::CreateParams::Settings::BankBcaOnboarding), branding: T.nilable(::Stripe::Account::CreateParams::Settings::Branding), capital: T.nilable(::Stripe::Account::CreateParams::Settings::Capital), card_issuing: T.nilable(::Stripe::Account::CreateParams::Settings::CardIssuing), card_payments: T.nilable(::Stripe::Account::CreateParams::Settings::CardPayments), invoices: T.nilable(::Stripe::Account::CreateParams::Settings::Invoices), payments: T.nilable(::Stripe::Account::CreateParams::Settings::Payments), payouts: T.nilable(::Stripe::Account::CreateParams::Settings::Payouts), tax_forms: T.nilable(::Stripe::Account::CreateParams::Settings::TaxForms), treasury: T.nilable(::Stripe::Account::CreateParams::Settings::Treasury)).void
}
def initialize(
bacs_debit_payments: nil,
bank_bca_onboarding: nil,
branding: nil,
capital: nil,
card_issuing: nil,
card_payments: nil,
invoices: nil,
payments: nil,
payouts: nil,
tax_forms: nil,
treasury: nil
); end
end
class TosAcceptance < Stripe::RequestParams
# The Unix timestamp marking when the account representative accepted their service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the account representative accepted their service agreement.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user's service agreement type.
sig { returns(T.nilable(String)) }
def service_agreement; end
sig { params(_service_agreement: T.nilable(String)).returns(T.nilable(String)) }
def service_agreement=(_service_agreement); end
# The user agent of the browser from which the account representative accepted their service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), service_agreement: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, service_agreement: nil, user_agent: nil); end
end
# An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.
sig { returns(T.nilable(String)) }
def account_token; end
sig { params(_account_token: T.nilable(String)).returns(T.nilable(String)) }
def account_token=(_account_token); end
# Business information about the account.
sig { returns(T.nilable(::Stripe::Account::CreateParams::BusinessProfile)) }
def business_profile; end
sig {
params(_business_profile: T.nilable(::Stripe::Account::CreateParams::BusinessProfile)).returns(T.nilable(::Stripe::Account::CreateParams::BusinessProfile))
}
def business_profile=(_business_profile); end
# The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig { returns(T.nilable(String)) }
def business_type; end
sig { params(_business_type: T.nilable(String)).returns(T.nilable(String)) }
def business_type=(_business_type); end
# Each key of the dictionary represents a capability, and each capability
# maps to its settings (for example, whether it has been requested or not). Each
# capability is inactive until you have provided its specific
# requirements and Stripe has verified them. An account might have some
# of its requested capabilities be active and some be inactive.
#
# Required when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type)
# is `none`, which includes Custom accounts.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities)) }
def capabilities; end
sig {
params(_capabilities: T.nilable(::Stripe::Account::CreateParams::Capabilities)).returns(T.nilable(::Stripe::Account::CreateParams::Capabilities))
}
def capabilities=(_capabilities); end
# Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Company)) }
def company; end
sig {
params(_company: T.nilable(::Stripe::Account::CreateParams::Company)).returns(T.nilable(::Stripe::Account::CreateParams::Company))
}
def company=(_company); end
# A hash of configuration describing the account controller's attributes.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Controller)) }
def controller; end
sig {
params(_controller: T.nilable(::Stripe::Account::CreateParams::Controller)).returns(T.nilable(::Stripe::Account::CreateParams::Controller))
}
def controller=(_controller); end
# The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported.
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).
sig { returns(T.nilable(String)) }
def default_currency; end
sig { params(_default_currency: T.nilable(String)).returns(T.nilable(String)) }
def default_currency=(_default_currency); end
# Documents that may be submitted to satisfy various informational requests.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Documents)) }
def documents; end
sig {
params(_documents: T.nilable(::Stripe::Account::CreateParams::Documents)).returns(T.nilable(::Stripe::Account::CreateParams::Documents))
}
def documents=(_documents); end
# The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.
By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig {
returns(T.nilable(T.any(String, ::Stripe::Account::CreateParams::BankAccount, ::Stripe::Account::CreateParams::Card, ::Stripe::Account::CreateParams::CardToken)))
}
def external_account; end
sig {
params(_external_account: T.nilable(T.any(String, ::Stripe::Account::CreateParams::BankAccount, ::Stripe::Account::CreateParams::Card, ::Stripe::Account::CreateParams::CardToken))).returns(T.nilable(T.any(String, ::Stripe::Account::CreateParams::BankAccount, ::Stripe::Account::CreateParams::Card, ::Stripe::Account::CreateParams::CardToken)))
}
def external_account=(_external_account); end
# A hash of account group type to tokens. These are account groups this account should be added to.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Groups)) }
def groups; end
sig {
params(_groups: T.nilable(::Stripe::Account::CreateParams::Groups)).returns(T.nilable(::Stripe::Account::CreateParams::Groups))
}
def groups=(_groups); end
# Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Individual)) }
def individual; end
sig {
params(_individual: T.nilable(::Stripe::Account::CreateParams::Individual)).returns(T.nilable(::Stripe::Account::CreateParams::Individual))
}
def individual=(_individual); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# A hash to configure risk controls on the account. Please see [this page for more details](/connect/pausing-payments-or-payouts-on-connected-accounts).
sig { returns(T.nilable(::Stripe::Account::CreateParams::RiskControls)) }
def risk_controls; end
sig {
params(_risk_controls: T.nilable(::Stripe::Account::CreateParams::RiskControls)).returns(T.nilable(::Stripe::Account::CreateParams::RiskControls))
}
def risk_controls=(_risk_controls); end
# Options for customizing how the account functions within Stripe.
sig { returns(T.nilable(::Stripe::Account::CreateParams::Settings)) }
def settings; end
sig {
params(_settings: T.nilable(::Stripe::Account::CreateParams::Settings)).returns(T.nilable(::Stripe::Account::CreateParams::Settings))
}
def settings=(_settings); end
# Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.
sig { returns(T.nilable(::Stripe::Account::CreateParams::TosAcceptance)) }
def tos_acceptance; end
sig {
params(_tos_acceptance: T.nilable(::Stripe::Account::CreateParams::TosAcceptance)).returns(T.nilable(::Stripe::Account::CreateParams::TosAcceptance))
}
def tos_acceptance=(_tos_acceptance); end
# The type of Stripe account to create. May be one of `custom`, `express` or `standard`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(account_token: T.nilable(String), business_profile: T.nilable(::Stripe::Account::CreateParams::BusinessProfile), business_type: T.nilable(String), capabilities: T.nilable(::Stripe::Account::CreateParams::Capabilities), company: T.nilable(::Stripe::Account::CreateParams::Company), controller: T.nilable(::Stripe::Account::CreateParams::Controller), country: T.nilable(String), default_currency: T.nilable(String), documents: T.nilable(::Stripe::Account::CreateParams::Documents), email: T.nilable(String), expand: T.nilable(T::Array[String]), external_account: T.nilable(T.any(String, ::Stripe::Account::CreateParams::BankAccount, ::Stripe::Account::CreateParams::Card, ::Stripe::Account::CreateParams::CardToken)), groups: T.nilable(::Stripe::Account::CreateParams::Groups), individual: T.nilable(::Stripe::Account::CreateParams::Individual), metadata: T.nilable(T.any(String, T::Hash[String, String])), risk_controls: T.nilable(::Stripe::Account::CreateParams::RiskControls), settings: T.nilable(::Stripe::Account::CreateParams::Settings), tos_acceptance: T.nilable(::Stripe::Account::CreateParams::TosAcceptance), type: T.nilable(String)).void
}
def initialize(
account_token: nil,
business_profile: nil,
business_type: nil,
capabilities: nil,
company: nil,
controller: nil,
country: nil,
default_currency: nil,
documents: nil,
email: nil,
expand: nil,
external_account: nil,
groups: nil,
individual: nil,
metadata: nil,
risk_controls: nil,
settings: nil,
tos_acceptance: nil,
type: nil
); end
end
class PersonsParams < Stripe::RequestParams
class Relationship < Stripe::RequestParams
# A filter on the list of people returned based on whether these people are authorizers of the account's representative.
sig { returns(T.nilable(T::Boolean)) }
def authorizer; end
sig { params(_authorizer: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def authorizer=(_authorizer); end
# A filter on the list of people returned based on whether these people are directors of the account's company.
sig { returns(T.nilable(T::Boolean)) }
def director; end
sig { params(_director: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def director=(_director); end
# A filter on the list of people returned based on whether these people are executives of the account's company.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
sig { params(_executive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executive=(_executive); end
# A filter on the list of people returned based on whether these people are legal guardians of the account's representative.
sig { returns(T.nilable(T::Boolean)) }
def legal_guardian; end
sig { params(_legal_guardian: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def legal_guardian=(_legal_guardian); end
# A filter on the list of people returned based on whether these people are owners of the account's company.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
sig { params(_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owner=(_owner); end
# A filter on the list of people returned based on whether these people are the representative of the account's company.
sig { returns(T.nilable(T::Boolean)) }
def representative; end
sig { params(_representative: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def representative=(_representative); end
sig {
params(authorizer: T.nilable(T::Boolean), director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), legal_guardian: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), representative: T.nilable(T::Boolean)).void
}
def initialize(
authorizer: nil,
director: nil,
executive: nil,
legal_guardian: nil,
owner: nil,
representative: nil
); end
end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Filters on the list of people returned based on the person's relationship to the account's company.
sig { returns(T.nilable(::Stripe::Account::PersonsParams::Relationship)) }
def relationship; end
sig {
params(_relationship: T.nilable(::Stripe::Account::PersonsParams::Relationship)).returns(T.nilable(::Stripe::Account::PersonsParams::Relationship))
}
def relationship=(_relationship); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), relationship: T.nilable(::Stripe::Account::PersonsParams::Relationship), starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
relationship: nil,
starting_after: nil
); end
end
class RejectParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`.
sig { returns(String) }
def reason; end
sig { params(_reason: String).returns(String) }
def reason=(_reason); end
sig { params(expand: T.nilable(T::Array[String]), reason: String).void }
def initialize(expand: nil, reason: nil); end
end
# With [Connect](https://docs.stripe.com/docs/connect), you can create Stripe accounts for your users.
# To do this, you'll first need to [register your platform](https://dashboard.stripe.com/account/applications/settings).
#
# If you've already collected information for your connected accounts, you [can prefill that information](https://docs.stripe.com/docs/connect/best-practices#onboarding) when
# creating the account. Connect Onboarding won't ask for the prefilled information during account onboarding.
# You can prefill any information on the account.
sig {
params(params: T.any(::Stripe::Account::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Account)
}
def self.create(params = {}, opts = {}); end
# With [Connect](https://docs.stripe.com/connect), you can delete accounts you manage.
#
# Test-mode accounts can be deleted at any time.
#
# Live-mode accounts that have access to the standard dashboard and Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. All other Live-mode accounts, can be deleted when all [balances](https://docs.stripe.com/api/balance/balance_object) are zero.
#
# If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead.
sig {
params(account: String, params: T.any(::Stripe::Account::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Account)
}
def self.delete(account, params = {}, opts = {}); end
# With [Connect](https://docs.stripe.com/connect), you can delete accounts you manage.
#
# Test-mode accounts can be deleted at any time.
#
# Live-mode accounts that have access to the standard dashboard and Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. All other Live-mode accounts, can be deleted when all [balances](https://docs.stripe.com/api/balance/balance_object) are zero.
#
# If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead.
sig {
params(params: T.any(::Stripe::Account::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Account)
}
def delete(params = {}, opts = {}); end
# Returns a list of accounts connected to your platform via [Connect](https://docs.stripe.com/docs/connect). If you're not a platform, the list is empty.
sig {
params(params: T.any(::Stripe::Account::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
sig {
params(params: T.any(::Stripe::Account::PersonsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def persons(params = {}, opts = {}); end
# Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
sig {
params(account: String, params: T.any(::Stripe::Account::PersonsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.persons(account, params = {}, opts = {}); end
# With [Connect](https://docs.stripe.com/connect), you can reject accounts that you have flagged as suspicious.
#
# Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.
sig {
params(params: T.any(::Stripe::Account::RejectParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Account)
}
def reject(params = {}, opts = {}); end
# With [Connect](https://docs.stripe.com/connect), you can reject accounts that you have flagged as suspicious.
#
# Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.
sig {
params(account: String, params: T.any(::Stripe::Account::RejectParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Account)
}
def self.reject(account, params = {}, opts = {}); end
# Updates a [connected account](https://docs.stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are
# left unchanged.
#
# For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection)
# is application, which includes Custom accounts, you can update any information on the account.
#
# For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection)
# is stripe, which includes Standard and Express accounts, you can update all information until you create
# an [Account Link or Account Session](https://docs.stripe.com/api/account_links) to start Connect onboarding,
# after which some properties can no longer be updated.
#
# To update your own account, use the [Dashboard](https://dashboard.stripe.com/settings/account). Refer to our
# [Connect](https://docs.stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts.
sig {
params(account: String, params: T.any(::Stripe::Account::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Account)
}
def self.update(account, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# This is an object representing a capability for a Stripe account.
#
# Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)
class Capability < APIResource
class FutureRequirements < Stripe::StripeObject
class Alternative < Stripe::StripeObject
# Fields that can be provided to satisfy all fields in `original_fields_due`.
sig { returns(T::Array[String]) }
def alternative_fields_due; end
# Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
sig { returns(T::Array[String]) }
def original_fields_due; end
end
class Error < Stripe::StripeObject
# The code for the type of error.
sig { returns(String) }
def code; end
# An informative message that indicates the error type and provides additional details about the error.
sig { returns(String) }
def reason; end
# The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
sig { returns(String) }
def requirement; end
end
# Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
sig { returns(T.nilable(T::Array[Alternative])) }
def alternatives; end
# Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.
sig { returns(T.nilable(Integer)) }
def current_deadline; end
# Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
sig { returns(T::Array[String]) }
def currently_due; end
# This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.
sig { returns(T.nilable(String)) }
def disabled_reason; end
# Fields that are `currently_due` and need to be collected again because validation or verification failed.
sig { returns(T::Array[Error]) }
def errors; end
# Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
sig { returns(T::Array[String]) }
def eventually_due; end
# Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.
sig { returns(T::Array[String]) }
def past_due; end
# Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.
sig { returns(T::Array[String]) }
def pending_verification; end
end
class Requirements < Stripe::StripeObject
class Alternative < Stripe::StripeObject
# Fields that can be provided to satisfy all fields in `original_fields_due`.
sig { returns(T::Array[String]) }
def alternative_fields_due; end
# Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
sig { returns(T::Array[String]) }
def original_fields_due; end
end
class Error < Stripe::StripeObject
# The code for the type of error.
sig { returns(String) }
def code; end
# An informative message that indicates the error type and provides additional details about the error.
sig { returns(String) }
def reason; end
# The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
sig { returns(String) }
def requirement; end
end
# Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
sig { returns(T.nilable(T::Array[Alternative])) }
def alternatives; end
# The date by which all required account information must be both submitted and verified. This includes fields listed in `currently_due` as well as those in `pending_verification`. If any required information is missing or unverified by this date, the account may be disabled. Note that `current_deadline` may change if additional `currently_due` requirements are requested.
sig { returns(T.nilable(Integer)) }
def current_deadline; end
# Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.
sig { returns(T::Array[String]) }
def currently_due; end
# Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).
sig { returns(T.nilable(String)) }
def disabled_reason; end
# Fields that are `currently_due` and need to be collected again because validation or verification failed.
sig { returns(T::Array[Error]) }
def errors; end
# Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
sig { returns(T::Array[String]) }
def eventually_due; end
# Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account.
sig { returns(T::Array[String]) }
def past_due; end
# Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
sig { returns(T::Array[String]) }
def pending_verification; end
end
# The account for which the capability enables functionality.
sig { returns(T.any(String, Stripe::Account)) }
def account; end
# Attribute for field future_requirements
sig { returns(T.nilable(FutureRequirements)) }
def future_requirements; end
# The identifier for the capability.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Whether the capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# Time at which the capability was requested. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def requested_at; end
# Attribute for field requirements
sig { returns(T.nilable(Requirements)) }
def requirements; end
# The status of the capability.
sig { returns(String) }
def status; end
end
end
# typed: true
module Stripe
# Login Links are single-use URLs that takes an Express account to the login page for their Stripe dashboard.
# A Login Link differs from an [Account Link](https://stripe.com/docs/api/account_links) in that it takes the user directly to their [Express dashboard for the specified account](https://stripe.com/docs/connect/integrate-express-dashboard#create-login-link)
class LoginLink < APIResource
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The URL for the login link.
sig { returns(String) }
def url; end
end
end
# typed: true
module Stripe
# This is an object representing a person associated with a Stripe account.
#
# A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](https://docs.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://docs.stripe.com/connect/standard-accounts) or [Express onboarding](https://docs.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://docs.stripe.com/connect/handling-api-verification#person-information).
class Person < APIResource
class AdditionalTosAcceptances < Stripe::StripeObject
class Account < Stripe::StripeObject
# The Unix timestamp marking when the legal guardian accepted the service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
# The IP address from which the legal guardian accepted the service agreement.
sig { returns(T.nilable(String)) }
def ip; end
# The user agent of the browser from which the legal guardian accepted the service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
end
# Details on the legal guardian's acceptance of the main Stripe service agreement.
sig { returns(T.nilable(Account)) }
def account; end
end
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class AddressKana < Stripe::StripeObject
# City/Ward.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Block/Building number.
sig { returns(T.nilable(String)) }
def line1; end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
# Town/cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
class AddressKanji < Stripe::StripeObject
# City/Ward.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Block/Building number.
sig { returns(T.nilable(String)) }
def line1; end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
# Town/cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
class Dob < Stripe::StripeObject
# The day of birth, between 1 and 31.
sig { returns(T.nilable(Integer)) }
def day; end
# The month of birth, between 1 and 12.
sig { returns(T.nilable(Integer)) }
def month; end
# The four-digit year of birth.
sig { returns(T.nilable(Integer)) }
def year; end
end
class FutureRequirements < Stripe::StripeObject
class Alternative < Stripe::StripeObject
# Fields that can be provided to satisfy all fields in `original_fields_due`.
sig { returns(T::Array[String]) }
def alternative_fields_due; end
# Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
sig { returns(T::Array[String]) }
def original_fields_due; end
end
class Error < Stripe::StripeObject
# The code for the type of error.
sig { returns(String) }
def code; end
# An informative message that indicates the error type and provides additional details about the error.
sig { returns(String) }
def reason; end
# The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
sig { returns(String) }
def requirement; end
end
# Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
sig { returns(T.nilable(T::Array[Alternative])) }
def alternatives; end
# Fields that need to be collected to keep the person's account enabled. If not collected by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition.
sig { returns(T::Array[String]) }
def currently_due; end
# Fields that are `currently_due` and need to be collected again because validation or verification failed.
sig { returns(T::Array[Error]) }
def errors; end
# Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set.
sig { returns(T::Array[String]) }
def eventually_due; end
# Fields that weren't collected by the account's `requirements.current_deadline`. These fields need to be collected to enable the person's account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.
sig { returns(T::Array[String]) }
def past_due; end
# Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.
sig { returns(T::Array[String]) }
def pending_verification; end
end
class RegisteredAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class Relationship < Stripe::StripeObject
# Whether the person is the authorizer of the account's representative.
sig { returns(T.nilable(T::Boolean)) }
def authorizer; end
# Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
sig { returns(T.nilable(T::Boolean)) }
def director; end
# Whether the person has significant responsibility to control, manage, or direct the organization.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
# Whether the person is the legal guardian of the account's representative.
sig { returns(T.nilable(T::Boolean)) }
def legal_guardian; end
# Whether the person is an owner of the account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
# The percent owned by the person of the account's legal entity.
sig { returns(T.nilable(Float)) }
def percent_ownership; end
# Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
sig { returns(T.nilable(T::Boolean)) }
def representative; end
# The person's title (e.g., CEO, Support Engineer).
sig { returns(T.nilable(String)) }
def title; end
end
class Requirements < Stripe::StripeObject
class Alternative < Stripe::StripeObject
# Fields that can be provided to satisfy all fields in `original_fields_due`.
sig { returns(T::Array[String]) }
def alternative_fields_due; end
# Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
sig { returns(T::Array[String]) }
def original_fields_due; end
end
class Error < Stripe::StripeObject
# The code for the type of error.
sig { returns(String) }
def code; end
# An informative message that indicates the error type and provides additional details about the error.
sig { returns(String) }
def reason; end
# The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
sig { returns(String) }
def requirement; end
end
# Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
sig { returns(T.nilable(T::Array[Alternative])) }
def alternatives; end
# Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
sig { returns(T::Array[String]) }
def currently_due; end
# Fields that are `currently_due` and need to be collected again because validation or verification failed.
sig { returns(T::Array[Error]) }
def errors; end
# Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set.
sig { returns(T::Array[String]) }
def eventually_due; end
# Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account.
sig { returns(T::Array[String]) }
def past_due; end
# Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
sig { returns(T::Array[String]) }
def pending_verification; end
end
class UsCfpbData < Stripe::StripeObject
class EthnicityDetails < Stripe::StripeObject
# The persons ethnicity
sig { returns(T.nilable(T::Array[String])) }
def ethnicity; end
# Please specify your origin, when other is selected.
sig { returns(T.nilable(String)) }
def ethnicity_other; end
end
class RaceDetails < Stripe::StripeObject
# The persons race.
sig { returns(T.nilable(T::Array[String])) }
def race; end
# Please specify your race, when other is selected.
sig { returns(T.nilable(String)) }
def race_other; end
end
# The persons ethnicity details
sig { returns(T.nilable(EthnicityDetails)) }
def ethnicity_details; end
# The persons race details
sig { returns(T.nilable(RaceDetails)) }
def race_details; end
# The persons self-identified gender
sig { returns(T.nilable(String)) }
def self_identified_gender; end
end
class Verification < Stripe::StripeObject
class AdditionalDocument < Stripe::StripeObject
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def back; end
# A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
sig { returns(T.nilable(String)) }
def details; end
# One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document.
sig { returns(T.nilable(String)) }
def details_code; end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def front; end
end
class Document < Stripe::StripeObject
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def back; end
# A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
sig { returns(T.nilable(String)) }
def details; end
# One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document.
sig { returns(T.nilable(String)) }
def details_code; end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def front; end
end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig { returns(T.nilable(AdditionalDocument)) }
def additional_document; end
# A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified".
sig { returns(T.nilable(String)) }
def details; end
# One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person.
sig { returns(T.nilable(String)) }
def details_code; end
# Attribute for field document
sig { returns(T.nilable(Document)) }
def document; end
# The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. Please refer [guide](https://stripe.com/docs/connect/handling-api-verification) to handle verification updates.
sig { returns(String) }
def status; end
end
# The account the person is associated with.
sig { returns(T.nilable(String)) }
def account; end
# Attribute for field additional_tos_acceptances
sig { returns(T.nilable(AdditionalTosAcceptances)) }
def additional_tos_acceptances; end
# Attribute for field address
sig { returns(T.nilable(Address)) }
def address; end
# The Kana variation of the person's address (Japan only).
sig { returns(T.nilable(AddressKana)) }
def address_kana; end
# The Kanji variation of the person's address (Japan only).
sig { returns(T.nilable(AddressKanji)) }
def address_kanji; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Attribute for field dob
sig { returns(T.nilable(Dob)) }
def dob; end
# The person's email address. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
sig { returns(T.nilable(String)) }
def email; end
# The person's first name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
sig { returns(T.nilable(String)) }
def first_name; end
# The Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
sig { returns(T.nilable(String)) }
def first_name_kana; end
# The Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
sig { returns(T.nilable(String)) }
def first_name_kanji; end
# A list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
sig { returns(T.nilable(T::Array[String])) }
def full_name_aliases; end
# Information about the [upcoming new requirements for this person](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
sig { returns(T.nilable(FutureRequirements)) }
def future_requirements; end
# The person's gender.
sig { returns(T.nilable(String)) }
def gender; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`).
sig { returns(T.nilable(T::Boolean)) }
def id_number_provided; end
# Whether the person's `id_number_secondary` was provided.
sig { returns(T.nilable(T::Boolean)) }
def id_number_secondary_provided; end
# The person's last name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
sig { returns(T.nilable(String)) }
def last_name; end
# The Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
sig { returns(T.nilable(String)) }
def last_name_kana; end
# The Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
sig { returns(T.nilable(String)) }
def last_name_kanji; end
# The person's maiden name.
sig { returns(T.nilable(String)) }
def maiden_name; end
# 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])) }
def metadata; end
# The country where the person is a national.
sig { returns(T.nilable(String)) }
def nationality; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The person's phone number.
sig { returns(T.nilable(String)) }
def phone; end
# Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
sig { returns(T.nilable(String)) }
def political_exposure; end
# Attribute for field registered_address
sig { returns(T.nilable(RegisteredAddress)) }
def registered_address; end
# Attribute for field relationship
sig { returns(T.nilable(Relationship)) }
def relationship; end
# Information about the requirements for this person, including what information needs to be collected, and by when.
sig { returns(T.nilable(Requirements)) }
def requirements; end
# Whether the last four digits of the person's Social Security number have been provided (U.S. only).
sig { returns(T.nilable(T::Boolean)) }
def ssn_last_4_provided; end
# Demographic data related to the person.
sig { returns(T.nilable(UsCfpbData)) }
def us_cfpb_data; end
# Attribute for field verification
sig { returns(T.nilable(Verification)) }
def verification; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
end
end
# typed: true
module Stripe
# Domains registered for Apple Pay on the Web
class ApplePayDomain < APIResource
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Attribute for field domain_name
sig { returns(String) }
def domain_name; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams; end
class ListParams < Stripe::RequestParams
# Attribute for param field domain_name
sig { returns(T.nilable(String)) }
def domain_name; end
sig { params(_domain_name: T.nilable(String)).returns(T.nilable(String)) }
def domain_name=(_domain_name); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(domain_name: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
domain_name: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# Attribute for param field domain_name
sig { returns(String) }
def domain_name; end
sig { params(_domain_name: String).returns(String) }
def domain_name=(_domain_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(domain_name: String, expand: T.nilable(T::Array[String])).void }
def initialize(domain_name: nil, expand: nil); end
end
# Create an apple pay domain.
sig {
params(params: T.any(::Stripe::ApplePayDomain::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ApplePayDomain)
}
def self.create(params = {}, opts = {}); end
# Delete an apple pay domain.
sig {
params(domain: String, params: T.any(::Stripe::ApplePayDomain::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ApplePayDomain)
}
def self.delete(domain, params = {}, opts = {}); end
# Delete an apple pay domain.
sig {
params(params: T.any(::Stripe::ApplePayDomain::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ApplePayDomain)
}
def delete(params = {}, opts = {}); end
# List apple pay domains.
sig {
params(params: T.any(::Stripe::ApplePayDomain::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class ApplicationFee < APIResource
class FeeSource < Stripe::StripeObject
# Charge ID that created this application fee.
sig { returns(T.nilable(String)) }
def charge; end
# Payout ID that created this application fee.
sig { returns(T.nilable(String)) }
def payout; end
# Type of object that created the application fee.
sig { returns(String) }
def type; end
end
# ID of the Stripe account this fee was taken from.
sig { returns(T.any(String, Stripe::Account)) }
def account; end
# Amount earned, in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
# Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)
sig { returns(Integer) }
def amount_refunded; end
# ID of the Connect application that earned the fee.
sig { returns(T.any(String, Stripe::Application)) }
def application; end
# Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).
sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
def balance_transaction; end
# ID of the charge that the application fee was taken from.
sig { returns(T.any(String, Stripe::Charge)) }
def charge; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.
sig { returns(T.nilable(FeeSource)) }
def fee_source; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.
sig { returns(T.nilable(T.any(String, Stripe::Charge))) }
def originating_transaction; end
# Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.
sig { returns(T::Boolean) }
def refunded; end
# A list of refunds that have been applied to the fee.
sig { returns(Stripe::ListObject) }
def refunds; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return application fees for the charge specified by this charge ID.
sig { returns(T.nilable(String)) }
def charge; end
sig { params(_charge: T.nilable(String)).returns(T.nilable(String)) }
def charge=(_charge); end
# Only return applications fees that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::ApplicationFee::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::ApplicationFee::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::ApplicationFee::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(charge: T.nilable(String), created: T.nilable(T.any(::Stripe::ApplicationFee::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
charge: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
# Returns a list of application fees you've previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.
sig {
params(params: T.any(::Stripe::ApplicationFee::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# `Application Fee Refund` objects allow you to refund an application fee that
# has previously been created but not yet refunded. Funds will be refunded to
# the Stripe account from which the fee was originally collected.
#
# Related guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee)
class ApplicationFeeRefund < APIResource
# Amount, in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
# Balance transaction that describes the impact on your account balance.
sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
def balance_transaction; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# ID of the application fee that was refunded.
sig { returns(T.any(String, Stripe::ApplicationFee)) }
def fee; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
end
end
# typed: true
module Stripe
module Apps
# Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.
#
# The primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.
#
# All Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.
#
# A `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.
#
# Related guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects)
class Secret < APIResource
class Scope < Stripe::StripeObject
# The secret scope type.
sig { returns(String) }
def type; end
# The user ID, if type is set to "user"
sig { returns(T.nilable(String)) }
def user; end
end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# If true, indicates that this secret has been deleted
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
# The Unix timestamp for the expiry time of the secret, after which the secret deletes.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# A name for the secret that's unique within the scope.
sig { returns(String) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The plaintext secret value to be stored.
sig { returns(T.nilable(String)) }
def payload; end
# Attribute for field scope
sig { returns(Scope) }
def scope; end
class ListParams < Stripe::RequestParams
class Scope < Stripe::RequestParams
# The secret scope type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
sig { returns(T.nilable(String)) }
def user; end
sig { params(_user: T.nilable(String)).returns(T.nilable(String)) }
def user=(_user); end
sig { params(type: String, user: T.nilable(String)).void }
def initialize(type: nil, user: nil); end
end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
sig { returns(::Stripe::Apps::Secret::ListParams::Scope) }
def scope; end
sig {
params(_scope: ::Stripe::Apps::Secret::ListParams::Scope).returns(::Stripe::Apps::Secret::ListParams::Scope)
}
def scope=(_scope); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), scope: ::Stripe::Apps::Secret::ListParams::Scope, starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
scope: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Scope < Stripe::RequestParams
# The secret scope type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
sig { returns(T.nilable(String)) }
def user; end
sig { params(_user: T.nilable(String)).returns(T.nilable(String)) }
def user=(_user); end
sig { params(type: String, user: T.nilable(String)).void }
def initialize(type: nil, user: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The Unix timestamp for the expiry time of the secret, after which the secret deletes.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# A name for the secret that's unique within the scope.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The plaintext secret value to be stored.
sig { returns(String) }
def payload; end
sig { params(_payload: String).returns(String) }
def payload=(_payload); end
# Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
sig { returns(::Stripe::Apps::Secret::CreateParams::Scope) }
def scope; end
sig {
params(_scope: ::Stripe::Apps::Secret::CreateParams::Scope).returns(::Stripe::Apps::Secret::CreateParams::Scope)
}
def scope=(_scope); end
sig {
params(expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), name: String, payload: String, scope: ::Stripe::Apps::Secret::CreateParams::Scope).void
}
def initialize(expand: nil, expires_at: nil, name: nil, payload: nil, scope: nil); end
end
class FindParams < Stripe::RequestParams
class Scope < Stripe::RequestParams
# The secret scope type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
sig { returns(T.nilable(String)) }
def user; end
sig { params(_user: T.nilable(String)).returns(T.nilable(String)) }
def user=(_user); end
sig { params(type: String, user: T.nilable(String)).void }
def initialize(type: nil, user: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A name for the secret that's unique within the scope.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
sig { returns(::Stripe::Apps::Secret::FindParams::Scope) }
def scope; end
sig {
params(_scope: ::Stripe::Apps::Secret::FindParams::Scope).returns(::Stripe::Apps::Secret::FindParams::Scope)
}
def scope=(_scope); end
sig {
params(expand: T.nilable(T::Array[String]), name: String, scope: ::Stripe::Apps::Secret::FindParams::Scope).void
}
def initialize(expand: nil, name: nil, scope: nil); end
end
class DeleteWhereParams < Stripe::RequestParams
class Scope < Stripe::RequestParams
# The secret scope type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
sig { returns(T.nilable(String)) }
def user; end
sig { params(_user: T.nilable(String)).returns(T.nilable(String)) }
def user=(_user); end
sig { params(type: String, user: T.nilable(String)).void }
def initialize(type: nil, user: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A name for the secret that's unique within the scope.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
sig { returns(::Stripe::Apps::Secret::DeleteWhereParams::Scope) }
def scope; end
sig {
params(_scope: ::Stripe::Apps::Secret::DeleteWhereParams::Scope).returns(::Stripe::Apps::Secret::DeleteWhereParams::Scope)
}
def scope=(_scope); end
sig {
params(expand: T.nilable(T::Array[String]), name: String, scope: ::Stripe::Apps::Secret::DeleteWhereParams::Scope).void
}
def initialize(expand: nil, name: nil, scope: nil); end
end
# Create or replace a secret in the secret store.
sig {
params(params: T.any(::Stripe::Apps::Secret::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Apps::Secret)
}
def self.create(params = {}, opts = {}); end
# Deletes a secret from the secret store by name and scope.
sig {
params(params: T.any(::Stripe::Apps::Secret::DeleteWhereParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Apps::Secret)
}
def self.delete_where(params = {}, opts = {}); end
# Finds a secret in the secret store by name and scope.
sig {
params(params: T.any(::Stripe::Apps::Secret::FindParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Apps::Secret)
}
def self.find(params = {}, opts = {}); end
# List all secrets stored on the given scope.
sig {
params(params: T.any(::Stripe::Apps::Secret::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
# This is an object representing your Stripe balance. You can retrieve it to see
# the balance currently on your Stripe account.
#
# The top-level `available` and `pending` comprise your "payments balance."
#
# Related guide: [Balances and settlement time](https://stripe.com/docs/payments/balances), [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)
class Balance < SingletonAPIResource
class Available < Stripe::StripeObject
class SourceTypes < Stripe::StripeObject
# Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
sig { returns(T.nilable(Integer)) }
def bank_account; end
# Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
sig { returns(T.nilable(Integer)) }
def card; end
# Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
sig { returns(T.nilable(Integer)) }
def fpx; end
end
# Balance amount.
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
# Attribute for field source_types
sig { returns(T.nilable(SourceTypes)) }
def source_types; end
end
class ConnectReserved < Stripe::StripeObject
class SourceTypes < Stripe::StripeObject
# Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
sig { returns(T.nilable(Integer)) }
def bank_account; end
# Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
sig { returns(T.nilable(Integer)) }
def card; end
# Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
sig { returns(T.nilable(Integer)) }
def fpx; end
end
# Balance amount.
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
# Attribute for field source_types
sig { returns(T.nilable(SourceTypes)) }
def source_types; end
end
class InstantAvailable < Stripe::StripeObject
class NetAvailable < Stripe::StripeObject
class SourceTypes < Stripe::StripeObject
# Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
sig { returns(T.nilable(Integer)) }
def bank_account; end
# Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
sig { returns(T.nilable(Integer)) }
def card; end
# Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
sig { returns(T.nilable(Integer)) }
def fpx; end
end
# Net balance amount, subtracting fees from platform-set pricing.
sig { returns(Integer) }
def amount; end
# ID of the external account for this net balance (not expandable).
sig { returns(String) }
def destination; end
# Attribute for field source_types
sig { returns(T.nilable(SourceTypes)) }
def source_types; end
end
class SourceTypes < Stripe::StripeObject
# Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
sig { returns(T.nilable(Integer)) }
def bank_account; end
# Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
sig { returns(T.nilable(Integer)) }
def card; end
# Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
sig { returns(T.nilable(Integer)) }
def fpx; end
end
# Balance amount.
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
# Breakdown of balance by destination.
sig { returns(T.nilable(T::Array[NetAvailable])) }
def net_available; end
# Attribute for field source_types
sig { returns(T.nilable(SourceTypes)) }
def source_types; end
end
class Issuing < Stripe::StripeObject
class Available < Stripe::StripeObject
class SourceTypes < Stripe::StripeObject
# Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
sig { returns(T.nilable(Integer)) }
def bank_account; end
# Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
sig { returns(T.nilable(Integer)) }
def card; end
# Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
sig { returns(T.nilable(Integer)) }
def fpx; end
end
# Balance amount.
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
# Attribute for field source_types
sig { returns(T.nilable(SourceTypes)) }
def source_types; end
end
# Funds that are available for use.
sig { returns(T::Array[Available]) }
def available; end
end
class Pending < Stripe::StripeObject
class SourceTypes < Stripe::StripeObject
# Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
sig { returns(T.nilable(Integer)) }
def bank_account; end
# Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
sig { returns(T.nilable(Integer)) }
def card; end
# Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
sig { returns(T.nilable(Integer)) }
def fpx; end
end
# Balance amount.
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
# Attribute for field source_types
sig { returns(T.nilable(SourceTypes)) }
def source_types; end
end
class RefundAndDisputePrefunding < Stripe::StripeObject
class Available < Stripe::StripeObject
class SourceTypes < Stripe::StripeObject
# Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
sig { returns(T.nilable(Integer)) }
def bank_account; end
# Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
sig { returns(T.nilable(Integer)) }
def card; end
# Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
sig { returns(T.nilable(Integer)) }
def fpx; end
end
# Balance amount.
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
# Attribute for field source_types
sig { returns(T.nilable(SourceTypes)) }
def source_types; end
end
class Pending < Stripe::StripeObject
class SourceTypes < Stripe::StripeObject
# Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
sig { returns(T.nilable(Integer)) }
def bank_account; end
# Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
sig { returns(T.nilable(Integer)) }
def card; end
# Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
sig { returns(T.nilable(Integer)) }
def fpx; end
end
# Balance amount.
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
# Attribute for field source_types
sig { returns(T.nilable(SourceTypes)) }
def source_types; end
end
# Funds that are available for use.
sig { returns(T::Array[Available]) }
def available; end
# Funds that are pending
sig { returns(T::Array[Pending]) }
def pending; end
end
# Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property.
sig { returns(T::Array[Available]) }
def available; end
# Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.
sig { returns(T.nilable(T::Array[ConnectReserved])) }
def connect_reserved; end
# Funds that you can pay out using Instant Payouts.
sig { returns(T.nilable(T::Array[InstantAvailable])) }
def instant_available; end
# Attribute for field issuing
sig { returns(T.nilable(Issuing)) }
def issuing; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property.
sig { returns(T::Array[Pending]) }
def pending; end
# Attribute for field refund_and_dispute_prefunding
sig { returns(T.nilable(RefundAndDisputePrefunding)) }
def refund_and_dispute_prefunding; end
end
end
# typed: true
module Stripe
# Options for customizing account balances and payout settings for a Stripe platform's connected accounts.
#
# This API is only available for users enrolled in the public preview for Accounts v2 on Stripe Connect.
# If you are not in this preview, please use the [Accounts v1 API](https://docs.stripe.com/api/accounts?api-version=2025-03-31.basil)
# to manage your connected accounts' balance settings instead.
class BalanceSettings < SingletonAPIResource
class Payments < Stripe::StripeObject
class Payouts < Stripe::StripeObject
class Schedule < Stripe::StripeObject
# How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.
sig { returns(T.nilable(String)) }
def interval; end
# The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
sig { returns(T.nilable(T::Array[Integer])) }
def monthly_payout_days; end
# The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly.
sig { returns(T.nilable(T::Array[String])) }
def weekly_payout_days; end
end
# The minimum balance amount to retain per currency after automatic payouts. Only funds that exceed these amounts are paid out. Learn more about the [minimum balances for automatic payouts](/payouts/minimum-balances-for-automatic-payouts).
sig { returns(T.nilable(T::Hash[String, Integer])) }
def minimum_balance_by_currency; end
# Details on when funds from charges are available, and when they are paid out to an external account. See our [Setting Bank and Debit Card Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation for details.
sig { returns(T.nilable(Schedule)) }
def schedule; end
# The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
# Whether the funds in this account can be paid out.
sig { returns(String) }
def status; end
end
class SettlementTiming < Stripe::StripeObject
# The number of days charge funds are held before becoming available.
sig { returns(Integer) }
def delay_days; end
# The number of days charge funds are held before becoming available. If present, overrides the default, or minimum available, for the account.
sig { returns(T.nilable(Integer)) }
def delay_days_override; end
end
# A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`.
sig { returns(T.nilable(T::Boolean)) }
def debit_negative_balances; end
# Settings specific to the account's payouts.
sig { returns(T.nilable(Payouts)) }
def payouts; end
# Attribute for field settlement_timing
sig { returns(SettlementTiming) }
def settlement_timing; end
end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Attribute for field payments
sig { returns(Payments) }
def payments; end
class UpdateParams < Stripe::RequestParams
class Payments < Stripe::RequestParams
class Payouts < Stripe::RequestParams
class Schedule < Stripe::RequestParams
# How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# The days of the month when available funds are paid out, specified as an array of numbers between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`.
sig { returns(T.nilable(T::Array[Integer])) }
def monthly_payout_days; end
sig {
params(_monthly_payout_days: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def monthly_payout_days=(_monthly_payout_days); end
# The days of the week when available funds are paid out, specified as an array, e.g., [`monday`, `tuesday`]. Required and applicable only if `interval` is `weekly`.
sig { returns(T.nilable(T::Array[String])) }
def weekly_payout_days; end
sig {
params(_weekly_payout_days: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def weekly_payout_days=(_weekly_payout_days); end
sig {
params(interval: T.nilable(String), monthly_payout_days: T.nilable(T::Array[Integer]), weekly_payout_days: T.nilable(T::Array[String])).void
}
def initialize(interval: nil, monthly_payout_days: nil, weekly_payout_days: nil); end
end
# The minimum balance amount to retain per currency after automatic payouts. Only funds that exceed these amounts are paid out. Learn more about the [minimum balances for automatic payouts](/payouts/minimum-balances-for-automatic-payouts).
sig { returns(T.nilable(T.any(String, T::Hash[String, T.any(String, Integer)]))) }
def minimum_balance_by_currency; end
sig {
params(_minimum_balance_by_currency: T.nilable(T.any(String, T::Hash[String, T.any(String, Integer)]))).returns(T.nilable(T.any(String, T::Hash[String, T.any(String, Integer)])))
}
def minimum_balance_by_currency=(_minimum_balance_by_currency); end
# Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](/connect/bank-transfers#payout-information) documentation.
sig {
returns(T.nilable(::Stripe::BalanceSettings::UpdateParams::Payments::Payouts::Schedule))
}
def schedule; end
sig {
params(_schedule: T.nilable(::Stripe::BalanceSettings::UpdateParams::Payments::Payouts::Schedule)).returns(T.nilable(::Stripe::BalanceSettings::UpdateParams::Payments::Payouts::Schedule))
}
def schedule=(_schedule); end
# The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
sig {
params(minimum_balance_by_currency: T.nilable(T.any(String, T::Hash[String, T.any(String, Integer)])), schedule: T.nilable(::Stripe::BalanceSettings::UpdateParams::Payments::Payouts::Schedule), statement_descriptor: T.nilable(String)).void
}
def initialize(
minimum_balance_by_currency: nil,
schedule: nil,
statement_descriptor: nil
); end
end
class SettlementTiming < Stripe::RequestParams
# Change `delay_days` for this account, which determines the number of days charge funds are held before becoming available. The maximum value is 31. Passing an empty string to `delay_days_override` will return `delay_days` to the default, which is the lowest available value for the account. [Learn more about controlling delay days](/connect/manage-payout-schedule).
sig { returns(T.nilable(T.any(String, Integer))) }
def delay_days_override; end
sig {
params(_delay_days_override: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def delay_days_override=(_delay_days_override); end
sig { params(delay_days_override: T.nilable(T.any(String, Integer))).void }
def initialize(delay_days_override: nil); end
end
# A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/connect/account-balances).
sig { returns(T.nilable(T::Boolean)) }
def debit_negative_balances; end
sig {
params(_debit_negative_balances: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def debit_negative_balances=(_debit_negative_balances); end
# Settings specific to the account's payouts.
sig { returns(T.nilable(::Stripe::BalanceSettings::UpdateParams::Payments::Payouts)) }
def payouts; end
sig {
params(_payouts: T.nilable(::Stripe::BalanceSettings::UpdateParams::Payments::Payouts)).returns(T.nilable(::Stripe::BalanceSettings::UpdateParams::Payments::Payouts))
}
def payouts=(_payouts); end
# Settings related to the account's balance settlement timing.
sig {
returns(T.nilable(::Stripe::BalanceSettings::UpdateParams::Payments::SettlementTiming))
}
def settlement_timing; end
sig {
params(_settlement_timing: T.nilable(::Stripe::BalanceSettings::UpdateParams::Payments::SettlementTiming)).returns(T.nilable(::Stripe::BalanceSettings::UpdateParams::Payments::SettlementTiming))
}
def settlement_timing=(_settlement_timing); end
sig {
params(debit_negative_balances: T.nilable(T::Boolean), payouts: T.nilable(::Stripe::BalanceSettings::UpdateParams::Payments::Payouts), settlement_timing: T.nilable(::Stripe::BalanceSettings::UpdateParams::Payments::SettlementTiming)).void
}
def initialize(debit_negative_balances: nil, payouts: nil, settlement_timing: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Settings that apply to the [Payments Balance](https://docs.stripe.com/api/balance).
sig { returns(T.nilable(::Stripe::BalanceSettings::UpdateParams::Payments)) }
def payments; end
sig {
params(_payments: T.nilable(::Stripe::BalanceSettings::UpdateParams::Payments)).returns(T.nilable(::Stripe::BalanceSettings::UpdateParams::Payments))
}
def payments=(_payments); end
sig {
params(expand: T.nilable(T::Array[String]), payments: T.nilable(::Stripe::BalanceSettings::UpdateParams::Payments)).void
}
def initialize(expand: nil, payments: nil); end
end
end
end
# typed: true
module Stripe
# Balance transactions represent funds moving through your Stripe account.
# Stripe creates them for every type of transaction that enters or leaves your Stripe account balance.
#
# Related guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types)
class BalanceTransaction < APIResource
class FeeDetail < Stripe::StripeObject
# Amount of the fee, in cents.
sig { returns(Integer) }
def amount; end
# ID of the Connect application that earned the fee.
sig { returns(T.nilable(String)) }
def application; end
# 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) }
def currency; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`.
sig { returns(String) }
def type; end
end
# Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.
sig { returns(Integer) }
def amount; end
# The date that the transaction's net funds become available in the Stripe balance.
sig { returns(Integer) }
def available_on; end
# The balance that this transaction impacts.
sig { returns(String) }
def balance_type; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`.
sig { returns(T.nilable(Float)) }
def exchange_rate; end
# Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.
sig { returns(Integer) }
def fee; end
# Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.
sig { returns(T::Array[FeeDetail]) }
def fee_details; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee`
sig { returns(Integer) }
def net; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective.
sig { returns(String) }
def reporting_category; end
# This transaction relates to the Stripe object.
sig {
returns(T.nilable(T.any(String, T.any(Stripe::ApplicationFee, Stripe::Charge, Stripe::ConnectCollectionTransfer, Stripe::CustomerCashBalanceTransaction, Stripe::Dispute, Stripe::ApplicationFeeRefund, Stripe::Issuing::Authorization, Stripe::Issuing::Dispute, Stripe::Issuing::Transaction, Stripe::Payout, Stripe::Refund, Stripe::ReserveTransaction, Stripe::TaxDeductedAtSource, Stripe::Topup, Stripe::Transfer, Stripe::Reversal))))
}
def source; end
# The transaction's net funds status in the Stripe balance, which are either `available` or `pending`.
sig { returns(String) }
def status; end
# Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.
sig { returns(String) }
def type; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return transactions that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::BalanceTransaction::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::BalanceTransaction::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::BalanceTransaction::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return transactions in a certain currency. 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
sig { returns(T.nilable(String)) }
def payout; end
sig { params(_payout: T.nilable(String)).returns(T.nilable(String)) }
def payout=(_payout); end
# Only returns the original transaction.
sig { returns(T.nilable(String)) }
def source; end
sig { params(_source: T.nilable(String)).returns(T.nilable(String)) }
def source=(_source); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(created: T.nilable(T.any(::Stripe::BalanceTransaction::ListParams::Created, Integer)), currency: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payout: T.nilable(String), source: T.nilable(String), starting_after: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
created: nil,
currency: nil,
ending_before: nil,
expand: nil,
limit: nil,
payout: nil,
source: nil,
starting_after: nil,
type: nil
); end
end
# Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
#
# Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
sig {
params(params: T.any(::Stripe::BalanceTransaction::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
module Billing
# A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.
class Alert < APIResource
class UsageThreshold < Stripe::StripeObject
class Filter < Stripe::StripeObject
# Limit the scope of the alert to this customer ID
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# Attribute for field type
sig { returns(String) }
def type; end
end
# The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time.
sig { returns(T.nilable(T::Array[Filter])) }
def filters; end
# The value at which this alert will trigger.
sig { returns(Integer) }
def gte; end
# The [Billing Meter](/api/billing/meter) ID whose usage is monitored.
sig { returns(T.any(String, Stripe::Billing::Meter)) }
def meter; end
# Defines how the alert will behave.
sig { returns(String) }
def recurrence; end
end
# Defines the type of the alert.
sig { returns(String) }
def alert_type; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Status of the alert. This can be active, inactive or archived.
sig { returns(T.nilable(String)) }
def status; end
# Title of the alert.
sig { returns(String) }
def title; end
# Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).
sig { returns(T.nilable(UsageThreshold)) }
def usage_threshold; end
class ListParams < Stripe::RequestParams
# Filter results to only include this type of alert.
sig { returns(T.nilable(String)) }
def alert_type; end
sig { params(_alert_type: T.nilable(String)).returns(T.nilable(String)) }
def alert_type=(_alert_type); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Filter results to only include alerts with the given meter.
sig { returns(T.nilable(String)) }
def meter; end
sig { params(_meter: T.nilable(String)).returns(T.nilable(String)) }
def meter=(_meter); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(alert_type: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), meter: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
alert_type: nil,
ending_before: nil,
expand: nil,
limit: nil,
meter: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class UsageThreshold < Stripe::RequestParams
class Filter < Stripe::RequestParams
# Limit the scope to this usage alert only to this customer.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# What type of filter is being applied to this usage alert.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(customer: T.nilable(String), type: String).void }
def initialize(customer: nil, type: nil); end
end
# The filters allows limiting the scope of this usage alert. You can only specify up to one filter at this time.
sig {
returns(T.nilable(T::Array[::Stripe::Billing::Alert::CreateParams::UsageThreshold::Filter]))
}
def filters; end
sig {
params(_filters: T.nilable(T::Array[::Stripe::Billing::Alert::CreateParams::UsageThreshold::Filter])).returns(T.nilable(T::Array[::Stripe::Billing::Alert::CreateParams::UsageThreshold::Filter]))
}
def filters=(_filters); end
# Defines at which value the alert will fire.
sig { returns(Integer) }
def gte; end
sig { params(_gte: Integer).returns(Integer) }
def gte=(_gte); end
# The [Billing Meter](/api/billing/meter) ID whose usage is monitored.
sig { returns(String) }
def meter; end
sig { params(_meter: String).returns(String) }
def meter=(_meter); end
# Defines how the alert will behave.
sig { returns(String) }
def recurrence; end
sig { params(_recurrence: String).returns(String) }
def recurrence=(_recurrence); end
sig {
params(filters: T.nilable(T::Array[::Stripe::Billing::Alert::CreateParams::UsageThreshold::Filter]), gte: Integer, meter: String, recurrence: String).void
}
def initialize(filters: nil, gte: nil, meter: nil, recurrence: nil); end
end
# The type of alert to create.
sig { returns(String) }
def alert_type; end
sig { params(_alert_type: String).returns(String) }
def alert_type=(_alert_type); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The title of the alert.
sig { returns(String) }
def title; end
sig { params(_title: String).returns(String) }
def title=(_title); end
# The configuration of the usage threshold.
sig { returns(T.nilable(::Stripe::Billing::Alert::CreateParams::UsageThreshold)) }
def usage_threshold; end
sig {
params(_usage_threshold: T.nilable(::Stripe::Billing::Alert::CreateParams::UsageThreshold)).returns(T.nilable(::Stripe::Billing::Alert::CreateParams::UsageThreshold))
}
def usage_threshold=(_usage_threshold); end
sig {
params(alert_type: String, expand: T.nilable(T::Array[String]), title: String, usage_threshold: T.nilable(::Stripe::Billing::Alert::CreateParams::UsageThreshold)).void
}
def initialize(alert_type: nil, expand: nil, title: nil, usage_threshold: nil); end
end
class ActivateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ArchiveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class DeactivateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Reactivates this alert, allowing it to trigger again.
sig {
params(params: T.any(::Stripe::Billing::Alert::ActivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
}
def activate(params = {}, opts = {}); end
# Reactivates this alert, allowing it to trigger again.
sig {
params(id: String, params: T.any(::Stripe::Billing::Alert::ActivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
}
def self.activate(id, params = {}, opts = {}); end
# Archives this alert, removing it from the list view and APIs. This is non-reversible.
sig {
params(params: T.any(::Stripe::Billing::Alert::ArchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
}
def archive(params = {}, opts = {}); end
# Archives this alert, removing it from the list view and APIs. This is non-reversible.
sig {
params(id: String, params: T.any(::Stripe::Billing::Alert::ArchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
}
def self.archive(id, params = {}, opts = {}); end
# Creates a billing alert
sig {
params(params: T.any(::Stripe::Billing::Alert::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
}
def self.create(params = {}, opts = {}); end
# Deactivates this alert, preventing it from triggering.
sig {
params(params: T.any(::Stripe::Billing::Alert::DeactivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
}
def deactivate(params = {}, opts = {}); end
# Deactivates this alert, preventing it from triggering.
sig {
params(id: String, params: T.any(::Stripe::Billing::Alert::DeactivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
}
def self.deactivate(id, params = {}, opts = {}); end
# Lists billing active and inactive alerts
sig {
params(params: T.any(::Stripe::Billing::Alert::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Billing
module Analytics
# A billing meter usage event represents an aggregated view of a customer's billing meter events within a specified timeframe.
class MeterUsage < SingletonAPIResource
# The aggregated meter usage data for the specified customer and time range.
sig { returns(T::Array[Stripe::Billing::Analytics::MeterUsageRow]) }
def data; end
# Timestamp indicating how fresh the data is. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def data_refreshed_at; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
end
end
end
end
# typed: true
module Stripe
module Billing
# Indicates the billing credit balance for billing credits granted to a customer.
class CreditBalanceSummary < SingletonAPIResource
class Balance < Stripe::StripeObject
class AvailableBalance < Stripe::StripeObject
class Monetary < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount.
sig { returns(Integer) }
def value; end
end
# The monetary amount.
sig { returns(T.nilable(Monetary)) }
def monetary; end
# The type of this amount. We currently only support `monetary` billing credits.
sig { returns(String) }
def type; end
end
class LedgerBalance < Stripe::StripeObject
class Monetary < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount.
sig { returns(Integer) }
def value; end
end
# The monetary amount.
sig { returns(T.nilable(Monetary)) }
def monetary; end
# The type of this amount. We currently only support `monetary` billing credits.
sig { returns(String) }
def type; end
end
# Attribute for field available_balance
sig { returns(AvailableBalance) }
def available_balance; end
# Attribute for field ledger_balance
sig { returns(LedgerBalance) }
def ledger_balance; end
end
# The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.
sig { returns(T::Array[Balance]) }
def balances; end
# The customer the balance is for.
sig { returns(T.any(String, Stripe::Customer)) }
def customer; end
# The account the balance is for.
sig { returns(T.nilable(String)) }
def customer_account; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
end
end
end
# typed: true
module Stripe
module Billing
# A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.
class CreditBalanceTransaction < APIResource
class Credit < Stripe::StripeObject
class Amount < Stripe::StripeObject
class Monetary < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount.
sig { returns(Integer) }
def value; end
end
# The monetary amount.
sig { returns(T.nilable(Monetary)) }
def monetary; end
# The type of this amount. We currently only support `monetary` billing credits.
sig { returns(String) }
def type; end
end
class CreditsApplicationInvoiceVoided < Stripe::StripeObject
# The invoice to which the reinstated billing credits were originally applied.
sig { returns(T.any(String, Stripe::Invoice)) }
def invoice; end
# The invoice line item to which the reinstated billing credits were originally applied.
sig { returns(String) }
def invoice_line_item; end
end
# Attribute for field amount
sig { returns(Amount) }
def amount; end
# Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`.
sig { returns(T.nilable(CreditsApplicationInvoiceVoided)) }
def credits_application_invoice_voided; end
# The type of credit transaction.
sig { returns(String) }
def type; end
end
class Debit < Stripe::StripeObject
class Amount < Stripe::StripeObject
class Monetary < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount.
sig { returns(Integer) }
def value; end
end
# The monetary amount.
sig { returns(T.nilable(Monetary)) }
def monetary; end
# The type of this amount. We currently only support `monetary` billing credits.
sig { returns(String) }
def type; end
end
class CreditsApplied < Stripe::StripeObject
# The invoice to which the billing credits were applied.
sig { returns(T.any(String, Stripe::Invoice)) }
def invoice; end
# The invoice line item to which the billing credits were applied.
sig { returns(String) }
def invoice_line_item; end
end
# Attribute for field amount
sig { returns(Amount) }
def amount; end
# Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`.
sig { returns(T.nilable(CreditsApplied)) }
def credits_applied; end
# The type of debit transaction.
sig { returns(String) }
def type; end
end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Credit details for this credit balance transaction. Only present if type is `credit`.
sig { returns(T.nilable(Credit)) }
def credit; end
# The credit grant associated with this credit balance transaction.
sig { returns(T.any(String, Stripe::Billing::CreditGrant)) }
def credit_grant; end
# Debit details for this credit balance transaction. Only present if type is `debit`.
sig { returns(T.nilable(Debit)) }
def debit; end
# The effective time of this credit balance transaction.
sig { returns(Integer) }
def effective_at; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# ID of the test clock this credit balance transaction belongs to.
sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
def test_clock; end
# The type of credit balance transaction (credit or debit).
sig { returns(T.nilable(String)) }
def type; end
class ListParams < Stripe::RequestParams
# The credit grant for which to fetch credit balance transactions.
sig { returns(T.nilable(String)) }
def credit_grant; end
sig { params(_credit_grant: T.nilable(String)).returns(T.nilable(String)) }
def credit_grant=(_credit_grant); end
# The customer for which to fetch credit balance transactions.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The account for which to fetch credit balance transactions.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(credit_grant: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
credit_grant: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
# Retrieve a list of credit balance transactions.
sig {
params(params: T.any(::Stripe::Billing::CreditBalanceTransaction::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Billing
# A credit grant is an API resource that documents the allocation of some billing credits to a customer.
#
# Related guide: [Billing credits](https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits)
class CreditGrant < APIResource
class Amount < Stripe::StripeObject
class Monetary < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount.
sig { returns(Integer) }
def value; end
end
# The monetary amount.
sig { returns(T.nilable(Monetary)) }
def monetary; end
# The type of this amount. We currently only support `monetary` billing credits.
sig { returns(String) }
def type; end
end
class ApplicabilityConfig < Stripe::StripeObject
class Scope < Stripe::StripeObject
class Price < Stripe::StripeObject
# Unique identifier for the object.
sig { returns(T.nilable(String)) }
def id; end
end
# The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `prices`.
sig { returns(T.nilable(String)) }
def price_type; end
# The prices that credit grants can apply to. We currently only support `metered` prices. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `price_type`.
sig { returns(T.nilable(T::Array[Price])) }
def prices; end
end
# Attribute for field scope
sig { returns(Scope) }
def scope; end
end
# Attribute for field amount
sig { returns(Amount) }
def amount; end
# Attribute for field applicability_config
sig { returns(ApplicabilityConfig) }
def applicability_config; end
# The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
sig { returns(String) }
def category; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# ID of the customer receiving the billing credits.
sig { returns(T.any(String, Stripe::Customer)) }
def customer; end
# ID of the account receiving the billing credits
sig { returns(T.nilable(String)) }
def customer_account; end
# The time when the billing credits become effective-when they're eligible for use.
sig { returns(T.nilable(Integer)) }
def effective_at; end
# The time when the billing credits expire. If not present, the billing credits don't expire.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# A descriptive name shown in dashboard.
sig { returns(T.nilable(String)) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
sig { returns(T.nilable(Integer)) }
def priority; end
# ID of the test clock this credit grant belongs to.
sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
def test_clock; end
# Time at which the object was last updated. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def updated; end
# The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
sig { returns(T.nilable(Integer)) }
def voided_at; end
class ListParams < Stripe::RequestParams
# Only return credit grants for this customer.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Only return credit grants for this account.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Amount < Stripe::RequestParams
class Monetary < Stripe::RequestParams
# Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `value` parameter.
sig { returns(String) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# A positive integer representing the amount of the credit grant.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(currency: String, value: Integer).void }
def initialize(currency: nil, value: nil); end
end
# The monetary amount.
sig { returns(T.nilable(::Stripe::Billing::CreditGrant::CreateParams::Amount::Monetary)) }
def monetary; end
sig {
params(_monetary: T.nilable(::Stripe::Billing::CreditGrant::CreateParams::Amount::Monetary)).returns(T.nilable(::Stripe::Billing::CreditGrant::CreateParams::Amount::Monetary))
}
def monetary=(_monetary); end
# The type of this amount. We currently only support `monetary` billing credits.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(monetary: T.nilable(::Stripe::Billing::CreditGrant::CreateParams::Amount::Monetary), type: String).void
}
def initialize(monetary: nil, type: nil); end
end
class ApplicabilityConfig < Stripe::RequestParams
class Scope < Stripe::RequestParams
class Price < Stripe::RequestParams
# The price ID this credit grant should apply to.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
sig { params(id: String).void }
def initialize(id: nil); end
end
# The price type that credit grants can apply to. We currently only support the `metered` price type. Cannot be used in combination with `prices`.
sig { returns(T.nilable(String)) }
def price_type; end
sig { params(_price_type: T.nilable(String)).returns(T.nilable(String)) }
def price_type=(_price_type); end
# A list of prices that the credit grant can apply to. We currently only support the `metered` prices. Cannot be used in combination with `price_type`.
sig {
returns(T.nilable(T::Array[::Stripe::Billing::CreditGrant::CreateParams::ApplicabilityConfig::Scope::Price]))
}
def prices; end
sig {
params(_prices: T.nilable(T::Array[::Stripe::Billing::CreditGrant::CreateParams::ApplicabilityConfig::Scope::Price])).returns(T.nilable(T::Array[::Stripe::Billing::CreditGrant::CreateParams::ApplicabilityConfig::Scope::Price]))
}
def prices=(_prices); end
sig {
params(price_type: T.nilable(String), prices: T.nilable(T::Array[::Stripe::Billing::CreditGrant::CreateParams::ApplicabilityConfig::Scope::Price])).void
}
def initialize(price_type: nil, prices: nil); end
end
# Specify the scope of this applicability config.
sig { returns(::Stripe::Billing::CreditGrant::CreateParams::ApplicabilityConfig::Scope) }
def scope; end
sig {
params(_scope: ::Stripe::Billing::CreditGrant::CreateParams::ApplicabilityConfig::Scope).returns(::Stripe::Billing::CreditGrant::CreateParams::ApplicabilityConfig::Scope)
}
def scope=(_scope); end
sig {
params(scope: ::Stripe::Billing::CreditGrant::CreateParams::ApplicabilityConfig::Scope).void
}
def initialize(scope: nil); end
end
# Amount of this credit grant.
sig { returns(::Stripe::Billing::CreditGrant::CreateParams::Amount) }
def amount; end
sig {
params(_amount: ::Stripe::Billing::CreditGrant::CreateParams::Amount).returns(::Stripe::Billing::CreditGrant::CreateParams::Amount)
}
def amount=(_amount); end
# Configuration specifying what this credit grant applies to. We currently only support `metered` prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.
sig { returns(::Stripe::Billing::CreditGrant::CreateParams::ApplicabilityConfig) }
def applicability_config; end
sig {
params(_applicability_config: ::Stripe::Billing::CreditGrant::CreateParams::ApplicabilityConfig).returns(::Stripe::Billing::CreditGrant::CreateParams::ApplicabilityConfig)
}
def applicability_config=(_applicability_config); end
# The category of this credit grant.
sig { returns(String) }
def category; end
sig { params(_category: String).returns(String) }
def category=(_category); end
# ID of the customer to receive the billing credits.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# ID of the account to receive the billing credits.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.
sig { returns(T.nilable(Integer)) }
def effective_at; end
sig { params(_effective_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def effective_at=(_effective_at); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The time when the billing credits expire. If not specified, the billing credits don't expire.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# A descriptive name shown in the Dashboard.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.
sig { returns(T.nilable(Integer)) }
def priority; end
sig { params(_priority: T.nilable(Integer)).returns(T.nilable(Integer)) }
def priority=(_priority); end
sig {
params(amount: ::Stripe::Billing::CreditGrant::CreateParams::Amount, applicability_config: ::Stripe::Billing::CreditGrant::CreateParams::ApplicabilityConfig, category: String, customer: T.nilable(String), customer_account: T.nilable(String), effective_at: T.nilable(Integer), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), name: T.nilable(String), priority: T.nilable(Integer)).void
}
def initialize(
amount: nil,
applicability_config: nil,
category: nil,
customer: nil,
customer_account: nil,
effective_at: nil,
expand: nil,
expires_at: nil,
metadata: nil,
name: nil,
priority: nil
); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The time when the billing credits created by this credit grant expire. If set to empty, the billing credits never expire.
sig { returns(T.nilable(T.any(String, Integer))) }
def expires_at; end
sig {
params(_expires_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expires_at=(_expires_at); end
# Set of key-value pairs you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), expires_at: T.nilable(T.any(String, Integer)), metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(expand: nil, expires_at: nil, metadata: nil); end
end
class ExpireParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class VoidGrantParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Creates a credit grant.
sig {
params(params: T.any(::Stripe::Billing::CreditGrant::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::CreditGrant)
}
def self.create(params = {}, opts = {}); end
# Expires a credit grant.
sig {
params(params: T.any(::Stripe::Billing::CreditGrant::ExpireParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::CreditGrant)
}
def expire(params = {}, opts = {}); end
# Expires a credit grant.
sig {
params(id: String, params: T.any(::Stripe::Billing::CreditGrant::ExpireParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::CreditGrant)
}
def self.expire(id, params = {}, opts = {}); end
# Retrieve a list of credit grants.
sig {
params(params: T.any(::Stripe::Billing::CreditGrant::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates a credit grant.
sig {
params(id: String, params: T.any(::Stripe::Billing::CreditGrant::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::CreditGrant)
}
def self.update(id, params = {}, opts = {}); end
# Voids a credit grant.
sig {
params(params: T.any(::Stripe::Billing::CreditGrant::VoidGrantParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::CreditGrant)
}
def void_grant(params = {}, opts = {}); end
# Voids a credit grant.
sig {
params(id: String, params: T.any(::Stripe::Billing::CreditGrant::VoidGrantParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::CreditGrant)
}
def self.void_grant(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
# A (partner) margin represents a specific discount distributed in partner reseller programs to business partners who
# resell products and services and earn a discount (margin) for doing so.
class Margin < APIResource
# Whether the margin can be applied to invoices, invoice items, or invoice line items. Defaults to `true`.
sig { returns(T::Boolean) }
def active; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# Name of the margin that's displayed on, for example, invoices.
sig { returns(T.nilable(String)) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.
sig { returns(Float) }
def percent_off; end
# Time at which the object was last updated. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def updated; end
class ListParams < Stripe::RequestParams
# Only return margins that are active or inactive. For example, pass `true` to only list active margins.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(active: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
active: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# Whether the margin can be applied to invoices, invoice items, or invoice line items or not. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Name of the margin, which is displayed to customers, such as on invoices.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.
sig { returns(Float) }
def percent_off; end
sig { params(_percent_off: Float).returns(Float) }
def percent_off=(_percent_off); end
sig {
params(active: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: T.nilable(String), percent_off: Float).void
}
def initialize(active: nil, expand: nil, metadata: nil, name: nil, percent_off: nil); end
end
class UpdateParams < Stripe::RequestParams
# Whether the margin can be applied to invoices, invoice items, or invoice line items or not.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Name of the margin, which is displayed to customers, such as on invoices.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(active: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: T.nilable(String)).void
}
def initialize(active: nil, expand: nil, metadata: nil, name: nil); end
end
# Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount. A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer. Calculation of prorations do not include any partner margins applied on the original invoice item.
sig {
params(params: T.any(::Stripe::Margin::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Margin)
}
def self.create(params = {}, opts = {}); end
# Retrieve a list of your margins.
sig {
params(params: T.any(::Stripe::Margin::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Update the specified margin object. Certain fields of the margin object are not editable.
sig {
params(margin: String, params: T.any(::Stripe::Margin::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Margin)
}
def self.update(margin, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
module Billing
# A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.
class MeterEventAdjustment < APIResource
class Cancel < Stripe::StripeObject
# Unique identifier for the event.
sig { returns(T.nilable(String)) }
def identifier; end
end
# Specifies which event to cancel.
sig { returns(T.nilable(Cancel)) }
def cancel; end
# The name of the meter event. Corresponds with the `event_name` field on a meter.
sig { returns(String) }
def event_name; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The meter event adjustment's status.
sig { returns(String) }
def status; end
# Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
sig { returns(String) }
def type; end
class CreateParams < Stripe::RequestParams
class Cancel < Stripe::RequestParams
# Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.
sig { returns(T.nilable(String)) }
def identifier; end
sig { params(_identifier: T.nilable(String)).returns(T.nilable(String)) }
def identifier=(_identifier); end
sig { params(identifier: T.nilable(String)).void }
def initialize(identifier: nil); end
end
# Specifies which event to cancel.
sig { returns(T.nilable(::Stripe::Billing::MeterEventAdjustment::CreateParams::Cancel)) }
def cancel; end
sig {
params(_cancel: T.nilable(::Stripe::Billing::MeterEventAdjustment::CreateParams::Cancel)).returns(T.nilable(::Stripe::Billing::MeterEventAdjustment::CreateParams::Cancel))
}
def cancel=(_cancel); end
# The name of the meter event. Corresponds with the `event_name` field on a meter.
sig { returns(String) }
def event_name; end
sig { params(_event_name: String).returns(String) }
def event_name=(_event_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(cancel: T.nilable(::Stripe::Billing::MeterEventAdjustment::CreateParams::Cancel), event_name: String, expand: T.nilable(T::Array[String]), type: String).void
}
def initialize(cancel: nil, event_name: nil, expand: nil, type: nil); end
end
# Creates a billing meter event adjustment.
sig {
params(params: T.any(::Stripe::Billing::MeterEventAdjustment::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::MeterEventAdjustment)
}
def self.create(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Billing
# Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event's payload and how to aggregate those events.
class MeterEvent < APIResource
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The name of the meter event. Corresponds with the `event_name` field on a meter.
sig { returns(String) }
def event_name; end
# A unique identifier for the event.
sig { returns(String) }
def identifier; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
sig { returns(T::Hash[String, String]) }
def payload; end
# The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def timestamp; end
class CreateParams < Stripe::RequestParams
# The name of the meter event. Corresponds with the `event_name` field on a meter.
sig { returns(String) }
def event_name; end
sig { params(_event_name: String).returns(String) }
def event_name=(_event_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.
sig { returns(T.nilable(String)) }
def identifier; end
sig { params(_identifier: T.nilable(String)).returns(T.nilable(String)) }
def identifier=(_identifier); end
# The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
sig { returns(T::Hash[String, String]) }
def payload; end
sig { params(_payload: T::Hash[String, String]).returns(T::Hash[String, String]) }
def payload=(_payload); end
# The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
sig {
params(event_name: String, expand: T.nilable(T::Array[String]), identifier: T.nilable(String), payload: T::Hash[String, String], timestamp: T.nilable(Integer)).void
}
def initialize(
event_name: nil,
expand: nil,
identifier: nil,
payload: nil,
timestamp: nil
); end
end
# Creates a billing meter event.
sig {
params(params: T.any(::Stripe::Billing::MeterEvent::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::MeterEvent)
}
def self.create(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Billing
# Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.
#
# Related guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)
class Meter < APIResource
class CustomerMapping < Stripe::StripeObject
# The key in the meter event payload to use for mapping the event to a customer.
sig { returns(String) }
def event_payload_key; end
# The method for mapping a meter event to a customer.
sig { returns(String) }
def type; end
end
class DefaultAggregation < Stripe::StripeObject
# Specifies how events are aggregated.
sig { returns(String) }
def formula; end
end
class StatusTransitions < Stripe::StripeObject
# The time the meter was deactivated, if any. Measured in seconds since Unix epoch.
sig { returns(T.nilable(Integer)) }
def deactivated_at; end
end
class ValueSettings < Stripe::StripeObject
# The key in the meter event payload to use as the value for this meter.
sig { returns(String) }
def event_payload_key; end
end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Attribute for field customer_mapping
sig { returns(CustomerMapping) }
def customer_mapping; end
# Attribute for field default_aggregation
sig { returns(DefaultAggregation) }
def default_aggregation; end
# The meter's name.
sig { returns(String) }
def display_name; end
# The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.
sig { returns(String) }
def event_name; end
# The time window which meter events have been pre-aggregated for, if any.
sig { returns(T.nilable(String)) }
def event_time_window; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The meter's status.
sig { returns(String) }
def status; end
# Attribute for field status_transitions
sig { returns(StatusTransitions) }
def status_transitions; end
# Time at which the object was last updated. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def updated; end
# Attribute for field value_settings
sig { returns(ValueSettings) }
def value_settings; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Filter results to only include meters with the given status.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class CustomerMapping < Stripe::RequestParams
# The key in the meter event payload to use for mapping the event to a customer.
sig { returns(String) }
def event_payload_key; end
sig { params(_event_payload_key: String).returns(String) }
def event_payload_key=(_event_payload_key); end
# The method for mapping a meter event to a customer. Must be `by_id`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(event_payload_key: String, type: String).void }
def initialize(event_payload_key: nil, type: nil); end
end
class DefaultAggregation < Stripe::RequestParams
# Specifies how events are aggregated. Allowed values are `count` to count the number of events, `sum` to sum each event's value and `last` to take the last event's value in the window.
sig { returns(String) }
def formula; end
sig { params(_formula: String).returns(String) }
def formula=(_formula); end
sig { params(formula: String).void }
def initialize(formula: nil); end
end
class ValueSettings < Stripe::RequestParams
# The key in the usage event payload to use as the value for this meter. For example, if the event payload contains usage on a `bytes_used` field, then set the event_payload_key to "bytes_used".
sig { returns(String) }
def event_payload_key; end
sig { params(_event_payload_key: String).returns(String) }
def event_payload_key=(_event_payload_key); end
sig { params(event_payload_key: String).void }
def initialize(event_payload_key: nil); end
end
# Fields that specify how to map a meter event to a customer.
sig { returns(T.nilable(::Stripe::Billing::Meter::CreateParams::CustomerMapping)) }
def customer_mapping; end
sig {
params(_customer_mapping: T.nilable(::Stripe::Billing::Meter::CreateParams::CustomerMapping)).returns(T.nilable(::Stripe::Billing::Meter::CreateParams::CustomerMapping))
}
def customer_mapping=(_customer_mapping); end
# The default settings to aggregate a meter's events with.
sig { returns(::Stripe::Billing::Meter::CreateParams::DefaultAggregation) }
def default_aggregation; end
sig {
params(_default_aggregation: ::Stripe::Billing::Meter::CreateParams::DefaultAggregation).returns(::Stripe::Billing::Meter::CreateParams::DefaultAggregation)
}
def default_aggregation=(_default_aggregation); end
# The meter’s name. Not visible to the customer.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.
sig { returns(String) }
def event_name; end
sig { params(_event_name: String).returns(String) }
def event_name=(_event_name); end
# The time window which meter events have been pre-aggregated for, if any.
sig { returns(T.nilable(String)) }
def event_time_window; end
sig { params(_event_time_window: T.nilable(String)).returns(T.nilable(String)) }
def event_time_window=(_event_time_window); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Fields that specify how to calculate a meter event's value.
sig { returns(T.nilable(::Stripe::Billing::Meter::CreateParams::ValueSettings)) }
def value_settings; end
sig {
params(_value_settings: T.nilable(::Stripe::Billing::Meter::CreateParams::ValueSettings)).returns(T.nilable(::Stripe::Billing::Meter::CreateParams::ValueSettings))
}
def value_settings=(_value_settings); end
sig {
params(customer_mapping: T.nilable(::Stripe::Billing::Meter::CreateParams::CustomerMapping), default_aggregation: ::Stripe::Billing::Meter::CreateParams::DefaultAggregation, display_name: String, event_name: String, event_time_window: T.nilable(String), expand: T.nilable(T::Array[String]), value_settings: T.nilable(::Stripe::Billing::Meter::CreateParams::ValueSettings)).void
}
def initialize(
customer_mapping: nil,
default_aggregation: nil,
display_name: nil,
event_name: nil,
event_time_window: nil,
expand: nil,
value_settings: nil
); end
end
class UpdateParams < Stripe::RequestParams
# The meter’s name. Not visible to the customer.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(display_name: T.nilable(String), expand: T.nilable(T::Array[String])).void }
def initialize(display_name: nil, expand: nil); end
end
class DeactivateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ReactivateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Creates a billing meter.
sig {
params(params: T.any(::Stripe::Billing::Meter::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Meter)
}
def self.create(params = {}, opts = {}); end
# When a meter is deactivated, no more meter events will be accepted for this meter. You can't attach a deactivated meter to a price.
sig {
params(params: T.any(::Stripe::Billing::Meter::DeactivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Meter)
}
def deactivate(params = {}, opts = {}); end
# When a meter is deactivated, no more meter events will be accepted for this meter. You can't attach a deactivated meter to a price.
sig {
params(id: String, params: T.any(::Stripe::Billing::Meter::DeactivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Meter)
}
def self.deactivate(id, params = {}, opts = {}); end
# Retrieve a list of billing meters.
sig {
params(params: T.any(::Stripe::Billing::Meter::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
sig {
params(params: T.any(::Stripe::Billing::Meter::ReactivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Meter)
}
def reactivate(params = {}, opts = {}); end
# When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
sig {
params(id: String, params: T.any(::Stripe::Billing::Meter::ReactivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Meter)
}
def self.reactivate(id, params = {}, opts = {}); end
# Updates a billing meter.
sig {
params(id: String, params: T.any(::Stripe::Billing::Meter::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Meter)
}
def self.update(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Billing
# A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much
# usage was accrued by a customer for that period.
#
# Note: Meters events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage.
class MeterEventSummary < APIResource
# Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.
sig { returns(Float) }
def aggregated_value; end
# End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.
sig { returns(Integer) }
def end_time; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# The meter associated with this event summary.
sig { returns(String) }
def meter; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.
sig { returns(Integer) }
def start_time; end
end
end
end
# typed: true
module Stripe
module BillingPortal
# A portal configuration describes the functionality and behavior of a portal session.
class Configuration < APIResource
class BusinessProfile < Stripe::StripeObject
# The messaging shown to customers in the portal.
sig { returns(T.nilable(String)) }
def headline; end
# A link to the business’s publicly available privacy policy.
sig { returns(T.nilable(String)) }
def privacy_policy_url; end
# A link to the business’s publicly available terms of service.
sig { returns(T.nilable(String)) }
def terms_of_service_url; end
end
class Features < Stripe::StripeObject
class CustomerUpdate < Stripe::StripeObject
# The types of customer updates that are supported. When empty, customers are not updateable.
sig { returns(T::Array[String]) }
def allowed_updates; end
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
end
class InvoiceHistory < Stripe::StripeObject
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
end
class PaymentMethodUpdate < Stripe::StripeObject
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
end
class SubscriptionCancel < Stripe::StripeObject
class CancellationReason < Stripe::StripeObject
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Which cancellation reasons will be given as options to the customer.
sig { returns(T::Array[String]) }
def options; end
end
# Attribute for field cancellation_reason
sig { returns(CancellationReason) }
def cancellation_reason; end
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
# Whether to cancel subscriptions immediately or at the end of the billing period.
sig { returns(String) }
def mode; end
# Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`.
sig { returns(String) }
def proration_behavior; end
end
class SubscriptionUpdate < Stripe::StripeObject
class Product < Stripe::StripeObject
class AdjustableQuantity < Stripe::StripeObject
# If true, the quantity can be adjusted to any non-negative integer.
sig { returns(T::Boolean) }
def enabled; end
# The maximum quantity that can be set for the product.
sig { returns(T.nilable(Integer)) }
def maximum; end
# The minimum quantity that can be set for the product.
sig { returns(Integer) }
def minimum; end
end
# Attribute for field adjustable_quantity
sig { returns(AdjustableQuantity) }
def adjustable_quantity; end
# The list of price IDs which, when subscribed to, a subscription can be updated.
sig { returns(T::Array[String]) }
def prices; end
# The product ID.
sig { returns(String) }
def product; end
end
class ScheduleAtPeriodEnd < Stripe::StripeObject
class Condition < Stripe::StripeObject
# The type of condition.
sig { returns(String) }
def type; end
end
# List of conditions. When any condition is true, an update will be scheduled at the end of the current period.
sig { returns(T::Array[Condition]) }
def conditions; end
end
# The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable.
sig { returns(T::Array[String]) }
def default_allowed_updates; end
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
# The list of up to 10 products that support subscription updates.
sig { returns(T.nilable(T::Array[Product])) }
def products; end
# Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. Defaults to a value of `none` if you don't set it during creation.
sig { returns(String) }
def proration_behavior; end
# Attribute for field schedule_at_period_end
sig { returns(ScheduleAtPeriodEnd) }
def schedule_at_period_end; end
# Determines how handle updates to trialing subscriptions. Valid values are `end_trial` and `continue_trial`. Defaults to a value of `end_trial` if you don't set it during creation.
sig { returns(String) }
def trial_update_behavior; end
end
# Attribute for field customer_update
sig { returns(CustomerUpdate) }
def customer_update; end
# Attribute for field invoice_history
sig { returns(InvoiceHistory) }
def invoice_history; end
# Attribute for field payment_method_update
sig { returns(PaymentMethodUpdate) }
def payment_method_update; end
# Attribute for field subscription_cancel
sig { returns(SubscriptionCancel) }
def subscription_cancel; end
# Attribute for field subscription_update
sig { returns(SubscriptionUpdate) }
def subscription_update; end
end
class LoginPage < Stripe::StripeObject
# If `true`, a shareable `url` will be generated that will take your customers to a hosted login page for the customer portal.
#
# If `false`, the previously generated `url`, if any, will be deactivated.
sig { returns(T::Boolean) }
def enabled; end
# A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal.
sig { returns(T.nilable(String)) }
def url; end
end
# Whether the configuration is active and can be used to create portal sessions.
sig { returns(T::Boolean) }
def active; end
# ID of the Connect Application that created the configuration.
sig { returns(T.nilable(T.any(String, Stripe::Application))) }
def application; end
# Attribute for field business_profile
sig { returns(BusinessProfile) }
def business_profile; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
sig { returns(T.nilable(String)) }
def default_return_url; end
# Attribute for field features
sig { returns(Features) }
def features; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
sig { returns(T::Boolean) }
def is_default; end
# 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) }
def livemode; end
# Attribute for field login_page
sig { returns(LoginPage) }
def login_page; end
# 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])) }
def metadata; end
# The name of the configuration.
sig { returns(T.nilable(String)) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Time at which the object was last updated. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def updated; end
class ListParams < Stripe::RequestParams
# Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).
sig { returns(T.nilable(T::Boolean)) }
def is_default; end
sig { params(_is_default: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def is_default=(_is_default); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(active: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), is_default: T.nilable(T::Boolean), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
active: nil,
ending_before: nil,
expand: nil,
is_default: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class BusinessProfile < Stripe::RequestParams
# The messaging shown to customers in the portal.
sig { returns(T.nilable(String)) }
def headline; end
sig { params(_headline: T.nilable(String)).returns(T.nilable(String)) }
def headline=(_headline); end
# A link to the business’s publicly available privacy policy.
sig { returns(T.nilable(String)) }
def privacy_policy_url; end
sig { params(_privacy_policy_url: T.nilable(String)).returns(T.nilable(String)) }
def privacy_policy_url=(_privacy_policy_url); end
# A link to the business’s publicly available terms of service.
sig { returns(T.nilable(String)) }
def terms_of_service_url; end
sig { params(_terms_of_service_url: T.nilable(String)).returns(T.nilable(String)) }
def terms_of_service_url=(_terms_of_service_url); end
sig {
params(headline: T.nilable(String), privacy_policy_url: T.nilable(String), terms_of_service_url: T.nilable(String)).void
}
def initialize(headline: nil, privacy_policy_url: nil, terms_of_service_url: nil); end
end
class Features < Stripe::RequestParams
class CustomerUpdate < Stripe::RequestParams
# The types of customer updates that are supported. When empty, customers are not updateable.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def allowed_updates; end
sig {
params(_allowed_updates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def allowed_updates=(_allowed_updates); end
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig {
params(allowed_updates: T.nilable(T.any(String, T::Array[String])), enabled: T::Boolean).void
}
def initialize(allowed_updates: nil, enabled: nil); end
end
class InvoiceHistory < Stripe::RequestParams
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class PaymentMethodUpdate < Stripe::RequestParams
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class SubscriptionCancel < Stripe::RequestParams
class CancellationReason < Stripe::RequestParams
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Which cancellation reasons will be given as options to the customer.
sig { returns(T.any(String, T::Array[String])) }
def options; end
sig {
params(_options: T.any(String, T::Array[String])).returns(T.any(String, T::Array[String]))
}
def options=(_options); end
sig { params(enabled: T::Boolean, options: T.any(String, T::Array[String])).void }
def initialize(enabled: nil, options: nil); end
end
# Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel::CancellationReason))
}
def cancellation_reason; end
sig {
params(_cancellation_reason: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel::CancellationReason)).returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel::CancellationReason))
}
def cancellation_reason=(_cancellation_reason); end
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Whether to cancel subscriptions immediately or at the end of the billing period.
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
sig {
params(cancellation_reason: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel::CancellationReason), enabled: T::Boolean, mode: T.nilable(String), proration_behavior: T.nilable(String)).void
}
def initialize(
cancellation_reason: nil,
enabled: nil,
mode: nil,
proration_behavior: nil
); end
end
class SubscriptionUpdate < Stripe::RequestParams
class Product < Stripe::RequestParams
class AdjustableQuantity < Stripe::RequestParams
# Set to true if the quantity can be adjusted to any non-negative integer.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum quantity that can be set for the product.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum quantity that can be set for the product.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil); end
end
# Control whether the quantity of the product can be adjusted.
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity))
}
def adjustable_quantity; end
sig {
params(_adjustable_quantity: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity)).returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity))
}
def adjustable_quantity=(_adjustable_quantity); end
# The list of price IDs for the product that a subscription can be updated to.
sig { returns(T::Array[String]) }
def prices; end
sig { params(_prices: T::Array[String]).returns(T::Array[String]) }
def prices=(_prices); end
# The product id.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
sig {
params(adjustable_quantity: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity), prices: T::Array[String], product: String).void
}
def initialize(adjustable_quantity: nil, prices: nil, product: nil); end
end
class ScheduleAtPeriodEnd < Stripe::RequestParams
class Condition < Stripe::RequestParams
# The type of condition.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
# List of conditions. When any condition is true, the update will be scheduled at the end of the current period.
sig {
returns(T.nilable(T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))
}
def conditions; end
sig {
params(_conditions: T.nilable(T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])).returns(T.nilable(T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))
}
def conditions=(_conditions); end
sig {
params(conditions: T.nilable(T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])).void
}
def initialize(conditions: nil); end
end
# The types of subscription updates that are supported. When empty, subscriptions are not updateable.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_allowed_updates; end
sig {
params(_default_allowed_updates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_allowed_updates=(_default_allowed_updates); end
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of up to 10 products that support subscription updates.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::Product])))
}
def products; end
sig {
params(_products: T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::Product]))).returns(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::Product])))
}
def products=(_products); end
# Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd))
}
def schedule_at_period_end; end
sig {
params(_schedule_at_period_end: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd)).returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd))
}
def schedule_at_period_end=(_schedule_at_period_end); end
# The behavior when updating a subscription that is trialing.
sig { returns(T.nilable(String)) }
def trial_update_behavior; end
sig { params(_trial_update_behavior: T.nilable(String)).returns(T.nilable(String)) }
def trial_update_behavior=(_trial_update_behavior); end
sig {
params(default_allowed_updates: T.nilable(T.any(String, T::Array[String])), enabled: T::Boolean, products: T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::Product])), proration_behavior: T.nilable(String), schedule_at_period_end: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd), trial_update_behavior: T.nilable(String)).void
}
def initialize(
default_allowed_updates: nil,
enabled: nil,
products: nil,
proration_behavior: nil,
schedule_at_period_end: nil,
trial_update_behavior: nil
); end
end
# Information about updating the customer details in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::CustomerUpdate))
}
def customer_update; end
sig {
params(_customer_update: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::CustomerUpdate)).returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::CustomerUpdate))
}
def customer_update=(_customer_update); end
# Information about showing the billing history in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::InvoiceHistory))
}
def invoice_history; end
sig {
params(_invoice_history: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::InvoiceHistory)).returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::InvoiceHistory))
}
def invoice_history=(_invoice_history); end
# Information about updating payment methods in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::PaymentMethodUpdate))
}
def payment_method_update; end
sig {
params(_payment_method_update: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::PaymentMethodUpdate)).returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::PaymentMethodUpdate))
}
def payment_method_update=(_payment_method_update); end
# Information about canceling subscriptions in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel))
}
def subscription_cancel; end
sig {
params(_subscription_cancel: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel)).returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel))
}
def subscription_cancel=(_subscription_cancel); end
# Information about updating subscriptions in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate))
}
def subscription_update; end
sig {
params(_subscription_update: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate)).returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate))
}
def subscription_update=(_subscription_update); end
sig {
params(customer_update: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::CustomerUpdate), invoice_history: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::InvoiceHistory), payment_method_update: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::PaymentMethodUpdate), subscription_cancel: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate)).void
}
def initialize(
customer_update: nil,
invoice_history: nil,
payment_method_update: nil,
subscription_cancel: nil,
subscription_update: nil
); end
end
class LoginPage < Stripe::RequestParams
# Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
# The business information shown to customers in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::BusinessProfile))
}
def business_profile; end
sig {
params(_business_profile: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::BusinessProfile)).returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::BusinessProfile))
}
def business_profile=(_business_profile); end
# The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
sig { returns(T.nilable(String)) }
def default_return_url; end
sig { params(_default_return_url: T.nilable(String)).returns(T.nilable(String)) }
def default_return_url=(_default_return_url); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Information about the features available in the portal.
sig { returns(::Stripe::BillingPortal::Configuration::CreateParams::Features) }
def features; end
sig {
params(_features: ::Stripe::BillingPortal::Configuration::CreateParams::Features).returns(::Stripe::BillingPortal::Configuration::CreateParams::Features)
}
def features=(_features); end
# The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
sig { returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::LoginPage)) }
def login_page; end
sig {
params(_login_page: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::LoginPage)).returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::LoginPage))
}
def login_page=(_login_page); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The name of the configuration.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(business_profile: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::BusinessProfile), default_return_url: T.nilable(String), expand: T.nilable(T::Array[String]), features: ::Stripe::BillingPortal::Configuration::CreateParams::Features, login_page: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::LoginPage), metadata: T.nilable(T::Hash[String, String]), name: T.nilable(String)).void
}
def initialize(
business_profile: nil,
default_return_url: nil,
expand: nil,
features: nil,
login_page: nil,
metadata: nil,
name: nil
); end
end
class UpdateParams < Stripe::RequestParams
class BusinessProfile < Stripe::RequestParams
# The messaging shown to customers in the portal.
sig { returns(T.nilable(String)) }
def headline; end
sig { params(_headline: T.nilable(String)).returns(T.nilable(String)) }
def headline=(_headline); end
# A link to the business’s publicly available privacy policy.
sig { returns(T.nilable(String)) }
def privacy_policy_url; end
sig { params(_privacy_policy_url: T.nilable(String)).returns(T.nilable(String)) }
def privacy_policy_url=(_privacy_policy_url); end
# A link to the business’s publicly available terms of service.
sig { returns(T.nilable(String)) }
def terms_of_service_url; end
sig { params(_terms_of_service_url: T.nilable(String)).returns(T.nilable(String)) }
def terms_of_service_url=(_terms_of_service_url); end
sig {
params(headline: T.nilable(String), privacy_policy_url: T.nilable(String), terms_of_service_url: T.nilable(String)).void
}
def initialize(headline: nil, privacy_policy_url: nil, terms_of_service_url: nil); end
end
class Features < Stripe::RequestParams
class CustomerUpdate < Stripe::RequestParams
# The types of customer updates that are supported. When empty, customers are not updateable.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def allowed_updates; end
sig {
params(_allowed_updates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def allowed_updates=(_allowed_updates); end
# Whether the feature is enabled.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
sig {
params(allowed_updates: T.nilable(T.any(String, T::Array[String])), enabled: T.nilable(T::Boolean)).void
}
def initialize(allowed_updates: nil, enabled: nil); end
end
class InvoiceHistory < Stripe::RequestParams
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class PaymentMethodUpdate < Stripe::RequestParams
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class SubscriptionCancel < Stripe::RequestParams
class CancellationReason < Stripe::RequestParams
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Which cancellation reasons will be given as options to the customer.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def options; end
sig {
params(_options: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def options=(_options); end
sig {
params(enabled: T::Boolean, options: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(enabled: nil, options: nil); end
end
# Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel::CancellationReason))
}
def cancellation_reason; end
sig {
params(_cancellation_reason: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel::CancellationReason)).returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel::CancellationReason))
}
def cancellation_reason=(_cancellation_reason); end
# Whether the feature is enabled.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# Whether to cancel subscriptions immediately or at the end of the billing period.
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
sig {
params(cancellation_reason: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel::CancellationReason), enabled: T.nilable(T::Boolean), mode: T.nilable(String), proration_behavior: T.nilable(String)).void
}
def initialize(
cancellation_reason: nil,
enabled: nil,
mode: nil,
proration_behavior: nil
); end
end
class SubscriptionUpdate < Stripe::RequestParams
class Product < Stripe::RequestParams
class AdjustableQuantity < Stripe::RequestParams
# Set to true if the quantity can be adjusted to any non-negative integer.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum quantity that can be set for the product.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum quantity that can be set for the product.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil); end
end
# Control whether the quantity of the product can be adjusted.
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity))
}
def adjustable_quantity; end
sig {
params(_adjustable_quantity: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity)).returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity))
}
def adjustable_quantity=(_adjustable_quantity); end
# The list of price IDs for the product that a subscription can be updated to.
sig { returns(T::Array[String]) }
def prices; end
sig { params(_prices: T::Array[String]).returns(T::Array[String]) }
def prices=(_prices); end
# The product id.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
sig {
params(adjustable_quantity: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity), prices: T::Array[String], product: String).void
}
def initialize(adjustable_quantity: nil, prices: nil, product: nil); end
end
class ScheduleAtPeriodEnd < Stripe::RequestParams
class Condition < Stripe::RequestParams
# The type of condition.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
# List of conditions. When any condition is true, the update will be scheduled at the end of the current period.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])))
}
def conditions; end
sig {
params(_conditions: T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))).returns(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])))
}
def conditions=(_conditions); end
sig {
params(conditions: T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))).void
}
def initialize(conditions: nil); end
end
# The types of subscription updates that are supported. When empty, subscriptions are not updateable.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_allowed_updates; end
sig {
params(_default_allowed_updates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_allowed_updates=(_default_allowed_updates); end
# Whether the feature is enabled.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# The list of up to 10 products that support subscription updates.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::Product])))
}
def products; end
sig {
params(_products: T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::Product]))).returns(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::Product])))
}
def products=(_products); end
# Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd))
}
def schedule_at_period_end; end
sig {
params(_schedule_at_period_end: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd)).returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd))
}
def schedule_at_period_end=(_schedule_at_period_end); end
# The behavior when updating a subscription that is trialing.
sig { returns(T.nilable(String)) }
def trial_update_behavior; end
sig { params(_trial_update_behavior: T.nilable(String)).returns(T.nilable(String)) }
def trial_update_behavior=(_trial_update_behavior); end
sig {
params(default_allowed_updates: T.nilable(T.any(String, T::Array[String])), enabled: T.nilable(T::Boolean), products: T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::Product])), proration_behavior: T.nilable(String), schedule_at_period_end: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd), trial_update_behavior: T.nilable(String)).void
}
def initialize(
default_allowed_updates: nil,
enabled: nil,
products: nil,
proration_behavior: nil,
schedule_at_period_end: nil,
trial_update_behavior: nil
); end
end
# Information about updating the customer details in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::CustomerUpdate))
}
def customer_update; end
sig {
params(_customer_update: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::CustomerUpdate)).returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::CustomerUpdate))
}
def customer_update=(_customer_update); end
# Information about showing the billing history in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::InvoiceHistory))
}
def invoice_history; end
sig {
params(_invoice_history: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::InvoiceHistory)).returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::InvoiceHistory))
}
def invoice_history=(_invoice_history); end
# Information about updating payment methods in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::PaymentMethodUpdate))
}
def payment_method_update; end
sig {
params(_payment_method_update: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::PaymentMethodUpdate)).returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::PaymentMethodUpdate))
}
def payment_method_update=(_payment_method_update); end
# Information about canceling subscriptions in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel))
}
def subscription_cancel; end
sig {
params(_subscription_cancel: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel)).returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel))
}
def subscription_cancel=(_subscription_cancel); end
# Information about updating subscriptions in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate))
}
def subscription_update; end
sig {
params(_subscription_update: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate)).returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate))
}
def subscription_update=(_subscription_update); end
sig {
params(customer_update: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::CustomerUpdate), invoice_history: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::InvoiceHistory), payment_method_update: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::PaymentMethodUpdate), subscription_cancel: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate)).void
}
def initialize(
customer_update: nil,
invoice_history: nil,
payment_method_update: nil,
subscription_cancel: nil,
subscription_update: nil
); end
end
class LoginPage < Stripe::RequestParams
# Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.
#
# Set to `false` to deactivate the `login_page.url`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
# Whether the configuration is active and can be used to create portal sessions.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# The business information shown to customers in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::BusinessProfile))
}
def business_profile; end
sig {
params(_business_profile: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::BusinessProfile)).returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::BusinessProfile))
}
def business_profile=(_business_profile); end
# The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
sig { returns(T.nilable(String)) }
def default_return_url; end
sig { params(_default_return_url: T.nilable(String)).returns(T.nilable(String)) }
def default_return_url=(_default_return_url); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Information about the features available in the portal.
sig { returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features)) }
def features; end
sig {
params(_features: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features)).returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features))
}
def features=(_features); end
# The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
sig { returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::LoginPage)) }
def login_page; end
sig {
params(_login_page: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::LoginPage)).returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::LoginPage))
}
def login_page=(_login_page); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The name of the configuration.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(active: T.nilable(T::Boolean), business_profile: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::BusinessProfile), default_return_url: T.nilable(String), expand: T.nilable(T::Array[String]), features: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features), login_page: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::LoginPage), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String)).void
}
def initialize(
active: nil,
business_profile: nil,
default_return_url: nil,
expand: nil,
features: nil,
login_page: nil,
metadata: nil,
name: nil
); end
end
# Creates a configuration that describes the functionality and behavior of a PortalSession
sig {
params(params: T.any(::Stripe::BillingPortal::Configuration::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BillingPortal::Configuration)
}
def self.create(params = {}, opts = {}); end
# Returns a list of configurations that describe the functionality of the customer portal.
sig {
params(params: T.any(::Stripe::BillingPortal::Configuration::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates a configuration that describes the functionality of the customer portal.
sig {
params(configuration: String, params: T.any(::Stripe::BillingPortal::Configuration::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BillingPortal::Configuration)
}
def self.update(configuration, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module BillingPortal
# The Billing customer portal is a Stripe-hosted UI for subscription and
# billing management.
#
# A portal configuration describes the functionality and features that you
# want to provide to your customers through the portal.
#
# A portal session describes the instantiation of the customer portal for
# a particular customer. By visiting the session's URL, the customer
# can manage their subscriptions and billing details. For security reasons,
# sessions are short-lived and will expire if the customer does not visit the URL.
# Create sessions on-demand when customers intend to manage their subscriptions
# and billing details.
#
# Related guide: [Customer management](https://docs.stripe.com/customer-management)
class Session < APIResource
class Flow < Stripe::StripeObject
class AfterCompletion < Stripe::StripeObject
class HostedConfirmation < Stripe::StripeObject
# A custom message to display to the customer after the flow is completed.
sig { returns(T.nilable(String)) }
def custom_message; end
end
class Redirect < Stripe::StripeObject
# The URL the customer will be redirected to after the flow is completed.
sig { returns(String) }
def return_url; end
end
# Configuration when `after_completion.type=hosted_confirmation`.
sig { returns(T.nilable(HostedConfirmation)) }
def hosted_confirmation; end
# Configuration when `after_completion.type=redirect`.
sig { returns(T.nilable(Redirect)) }
def redirect; end
# The specified type of behavior after the flow is completed.
sig { returns(String) }
def type; end
end
class SubscriptionCancel < Stripe::StripeObject
class Retention < Stripe::StripeObject
class CouponOffer < Stripe::StripeObject
# The ID of the coupon to be offered.
sig { returns(String) }
def coupon; end
end
# Configuration when `retention.type=coupon_offer`.
sig { returns(T.nilable(CouponOffer)) }
def coupon_offer; end
# Type of retention strategy that will be used.
sig { returns(String) }
def type; end
end
# Specify a retention strategy to be used in the cancellation flow.
sig { returns(T.nilable(Retention)) }
def retention; end
# The ID of the subscription to be canceled.
sig { returns(String) }
def subscription; end
end
class SubscriptionUpdate < Stripe::StripeObject
# The ID of the subscription to be updated.
sig { returns(String) }
def subscription; end
end
class SubscriptionUpdateConfirm < Stripe::StripeObject
class Discount < Stripe::StripeObject
# The ID of the coupon to apply to this subscription update.
sig { returns(T.nilable(String)) }
def coupon; end
# The ID of a promotion code to apply to this subscription update.
sig { returns(T.nilable(String)) }
def promotion_code; end
end
class Item < Stripe::StripeObject
# The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.
sig { returns(T.nilable(String)) }
def id; end
# The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
sig { returns(T.nilable(String)) }
def price; end
# [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
sig { returns(T.nilable(Integer)) }
def quantity; end
end
# The coupon or promotion code to apply to this subscription update.
sig { returns(T.nilable(T::Array[Discount])) }
def discounts; end
# The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
sig { returns(T::Array[Item]) }
def items; end
# The ID of the subscription to be updated.
sig { returns(String) }
def subscription; end
end
# Attribute for field after_completion
sig { returns(AfterCompletion) }
def after_completion; end
# Configuration when `flow.type=subscription_cancel`.
sig { returns(T.nilable(SubscriptionCancel)) }
def subscription_cancel; end
# Configuration when `flow.type=subscription_update`.
sig { returns(T.nilable(SubscriptionUpdate)) }
def subscription_update; end
# Configuration when `flow.type=subscription_update_confirm`.
sig { returns(T.nilable(SubscriptionUpdateConfirm)) }
def subscription_update_confirm; end
# Type of flow that the customer will go through.
sig { returns(String) }
def type; end
end
# The configuration used by this session, describing the features available.
sig { returns(T.any(String, Stripe::BillingPortal::Configuration)) }
def configuration; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The ID of the customer for this session.
sig { returns(String) }
def customer; end
# The ID of the account for this session.
sig { returns(T.nilable(String)) }
def customer_account; end
# Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
sig { returns(T.nilable(Flow)) }
def flow; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
sig { returns(T.nilable(String)) }
def locale; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
# The URL to redirect customers to when they click on the portal's link to return to your website.
sig { returns(T.nilable(String)) }
def return_url; end
# The short-lived URL of the session that gives customers access to the customer portal.
sig { returns(String) }
def url; end
class CreateParams < Stripe::RequestParams
class FlowData < Stripe::RequestParams
class AfterCompletion < Stripe::RequestParams
class HostedConfirmation < Stripe::RequestParams
# A custom message to display to the customer after the flow is completed.
sig { returns(T.nilable(String)) }
def custom_message; end
sig { params(_custom_message: T.nilable(String)).returns(T.nilable(String)) }
def custom_message=(_custom_message); end
sig { params(custom_message: T.nilable(String)).void }
def initialize(custom_message: nil); end
end
class Redirect < Stripe::RequestParams
# The URL the customer will be redirected to after the flow is completed.
sig { returns(String) }
def return_url; end
sig { params(_return_url: String).returns(String) }
def return_url=(_return_url); end
sig { params(return_url: String).void }
def initialize(return_url: nil); end
end
# Configuration when `after_completion.type=hosted_confirmation`.
sig {
returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::HostedConfirmation))
}
def hosted_confirmation; end
sig {
params(_hosted_confirmation: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::HostedConfirmation)).returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::HostedConfirmation))
}
def hosted_confirmation=(_hosted_confirmation); end
# Configuration when `after_completion.type=redirect`.
sig {
returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::Redirect))
}
def redirect; end
sig {
params(_redirect: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::Redirect)).returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::Redirect))
}
def redirect=(_redirect); end
# The specified behavior after the flow is completed.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(hosted_confirmation: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::HostedConfirmation), redirect: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::Redirect), type: String).void
}
def initialize(hosted_confirmation: nil, redirect: nil, type: nil); end
end
class SubscriptionCancel < Stripe::RequestParams
class Retention < Stripe::RequestParams
class CouponOffer < Stripe::RequestParams
# The ID of the coupon to be offered.
sig { returns(String) }
def coupon; end
sig { params(_coupon: String).returns(String) }
def coupon=(_coupon); end
sig { params(coupon: String).void }
def initialize(coupon: nil); end
end
# Configuration when `retention.type=coupon_offer`.
sig {
returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention::CouponOffer)
}
def coupon_offer; end
sig {
params(_coupon_offer: ::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention::CouponOffer).returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention::CouponOffer)
}
def coupon_offer=(_coupon_offer); end
# Type of retention strategy to use with the customer.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(coupon_offer: ::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention::CouponOffer, type: String).void
}
def initialize(coupon_offer: nil, type: nil); end
end
# Specify a retention strategy to be used in the cancellation flow.
sig {
returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention))
}
def retention; end
sig {
params(_retention: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention)).returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention))
}
def retention=(_retention); end
# The ID of the subscription to be canceled.
sig { returns(String) }
def subscription; end
sig { params(_subscription: String).returns(String) }
def subscription=(_subscription); end
sig {
params(retention: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention), subscription: String).void
}
def initialize(retention: nil, subscription: nil); end
end
class SubscriptionUpdate < Stripe::RequestParams
# The ID of the subscription to be updated.
sig { returns(String) }
def subscription; end
sig { params(_subscription: String).returns(String) }
def subscription=(_subscription); end
sig { params(subscription: String).void }
def initialize(subscription: nil); end
end
class SubscriptionUpdateConfirm < Stripe::RequestParams
class Discount < Stripe::RequestParams
# The ID of the coupon to apply to this subscription update.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# The ID of a promotion code to apply to this subscription update.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig { params(coupon: T.nilable(String), promotion_code: T.nilable(String)).void }
def initialize(coupon: nil, promotion_code: nil); end
end
class Item < Stripe::RequestParams
# The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
# The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
sig {
params(id: String, price: T.nilable(String), quantity: T.nilable(Integer)).void
}
def initialize(id: nil, price: nil, quantity: nil); end
end
# The coupon or promotion code to apply to this subscription update.
sig {
returns(T.nilable(T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount])).returns(T.nilable(T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount]))
}
def discounts=(_discounts); end
# The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
sig {
returns(T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Item])
}
def items; end
sig {
params(_items: T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Item]).returns(T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Item])
}
def items=(_items); end
# The ID of the subscription to be updated.
sig { returns(String) }
def subscription; end
sig { params(_subscription: String).returns(String) }
def subscription=(_subscription); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount]), items: T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Item], subscription: String).void
}
def initialize(discounts: nil, items: nil, subscription: nil); end
end
# Behavior after the flow is completed.
sig {
returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion))
}
def after_completion; end
sig {
params(_after_completion: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion)).returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion))
}
def after_completion=(_after_completion); end
# Configuration when `flow_data.type=subscription_cancel`.
sig {
returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel))
}
def subscription_cancel; end
sig {
params(_subscription_cancel: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel)).returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel))
}
def subscription_cancel=(_subscription_cancel); end
# Configuration when `flow_data.type=subscription_update`.
sig {
returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdate))
}
def subscription_update; end
sig {
params(_subscription_update: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdate)).returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdate))
}
def subscription_update=(_subscription_update); end
# Configuration when `flow_data.type=subscription_update_confirm`.
sig {
returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm))
}
def subscription_update_confirm; end
sig {
params(_subscription_update_confirm: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm)).returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm))
}
def subscription_update_confirm=(_subscription_update_confirm); end
# Type of flow that the customer will go through.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(after_completion: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion), subscription_cancel: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdate), subscription_update_confirm: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm), type: String).void
}
def initialize(
after_completion: nil,
subscription_cancel: nil,
subscription_update: nil,
subscription_update_confirm: nil,
type: nil
); end
end
# The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
sig { returns(T.nilable(String)) }
def configuration; end
sig { params(_configuration: T.nilable(String)).returns(T.nilable(String)) }
def configuration=(_configuration); end
# The ID of an existing customer.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The ID of an existing account.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
sig { returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData)) }
def flow_data; end
sig {
params(_flow_data: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData)).returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData))
}
def flow_data=(_flow_data); end
# The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
sig { returns(T.nilable(String)) }
def locale; end
sig { params(_locale: T.nilable(String)).returns(T.nilable(String)) }
def locale=(_locale); end
# The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# The default URL to redirect customers to when they click on the portal's link to return to your website.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(configuration: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), expand: T.nilable(T::Array[String]), flow_data: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData), locale: T.nilable(String), on_behalf_of: T.nilable(String), return_url: T.nilable(String)).void
}
def initialize(
configuration: nil,
customer: nil,
customer_account: nil,
expand: nil,
flow_data: nil,
locale: nil,
on_behalf_of: nil,
return_url: nil
); end
end
# Creates a session of the customer portal.
sig {
params(params: T.any(::Stripe::BillingPortal::Session::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BillingPortal::Session)
}
def self.create(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Capital
# This is an object representing an offer of financing from
# Stripe Capital to a Connect subaccount.
class FinancingOffer < APIResource
class AcceptedTerms < Stripe::StripeObject
# Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.
sig { returns(Integer) }
def advance_amount; end
# Currency that the financing offer is transacted in. For example, `usd`.
sig { returns(String) }
def currency; end
# Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.
sig { returns(Integer) }
def fee_amount; end
# Populated when the `product_type` of the `financingoffer` is `refill`.
# Represents the discount amount on remaining premium for the existing loan at payout time.
sig { returns(T.nilable(Integer)) }
def previous_financing_fee_discount_amount; end
# Per-transaction rate at which Stripe will withhold funds to repay the financing.
sig { returns(Float) }
def withhold_rate; end
end
class OfferedTerms < Stripe::StripeObject
# Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.
sig { returns(Integer) }
def advance_amount; end
# Describes the type of user the offer is being extended to.
sig { returns(String) }
def campaign_type; end
# Currency that the financing offer is transacted in. For example, `usd`.
sig { returns(String) }
def currency; end
# Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.
sig { returns(Integer) }
def fee_amount; end
# Populated when the `product_type` of the `financingoffer` is `refill`.
# Represents the discount rate percentage on remaining fee on the existing loan. When the `financing_offer`
# is paid out, the `previous_financing_fee_discount_amount` will be computed as the multiple of this rate
# and the remaining fee.
sig { returns(T.nilable(Float)) }
def previous_financing_fee_discount_rate; end
# Per-transaction rate at which Stripe will withhold funds to repay the financing.
sig { returns(Float) }
def withhold_rate; end
end
# This is an object representing the terms of an offer of financing from
# Stripe Capital to a Connected account. This resource represents
# the terms accepted by the Connected account, which may differ from those
# offered.
sig { returns(T.nilable(AcceptedTerms)) }
def accepted_terms; end
# The ID of the merchant associated with this financing object.
sig { returns(String) }
def account; end
# The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.
sig { returns(T.nilable(Integer)) }
def charged_off_at; end
# Time at which the offer was created. Given in seconds since unix epoch.
sig { returns(Integer) }
def created; end
# Time at which the offer expires. Given in seconds since unix epoch.
sig { returns(Float) }
def expires_after; end
# The type of financing being offered.
sig { returns(T.nilable(String)) }
def financing_type; end
# A unique identifier for the financing object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# The object type: financing_offer.
sig { returns(String) }
def object; end
# This is an object representing the terms of an offer of financing from
# Stripe Capital to a Connected account. This resource represents
# both the terms offered to the Connected account.
sig { returns(T.nilable(OfferedTerms)) }
def offered_terms; end
# Financing product identifier.
sig { returns(T.nilable(String)) }
def product_type; end
# The ID of the financing offer that replaced this offer.
sig { returns(T.nilable(String)) }
def replacement; end
# The ID of the financing offer that this offer is a replacement for.
sig { returns(T.nilable(String)) }
def replacement_for; end
# The current status of the offer.
sig { returns(String) }
def status; end
# See [financing_type](https://stripe.com/docs/api/capital/connect_financing_object#financing_offer_object-financing_type).
sig { returns(T.nilable(String)) }
def type; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# limit list to offers belonging to given connected account
sig { returns(T.nilable(String)) }
def connected_account; end
sig { params(_connected_account: T.nilable(String)).returns(T.nilable(String)) }
def connected_account=(_connected_account); end
# Only return offers that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Capital::FinancingOffer::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Capital::FinancingOffer::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Capital::FinancingOffer::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# limit list to offers with given status
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(connected_account: T.nilable(String), created: T.nilable(T.any(::Stripe::Capital::FinancingOffer::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
connected_account: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class MarkDeliveredParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Retrieves the financing offers available for Connected accounts that belong to your platform.
sig {
params(params: T.any(::Stripe::Capital::FinancingOffer::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Acknowledges that platform has received and delivered the financing_offer to
# the intended merchant recipient.
sig {
params(params: T.any(::Stripe::Capital::FinancingOffer::MarkDeliveredParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Capital::FinancingOffer)
}
def mark_delivered(params = {}, opts = {}); end
# Acknowledges that platform has received and delivered the financing_offer to
# the intended merchant recipient.
sig {
params(financing_offer: String, params: T.any(::Stripe::Capital::FinancingOffer::MarkDeliveredParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Capital::FinancingOffer)
}
def self.mark_delivered(financing_offer, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Capital
# A financing object describes an account's current financing state. Used by Connect
# platforms to read the state of Capital offered to their connected accounts.
class FinancingSummary < SingletonAPIResource
class Details < Stripe::StripeObject
class CurrentRepaymentInterval < Stripe::StripeObject
# The time at which the minimum payment amount will be due. If not met through withholding, the Connected account's linked bank account or account balance will be debited.
# Given in seconds since unix epoch.
sig { returns(Float) }
def due_at; end
# The amount that has already been paid in the current repayment interval, in minor units. For example, $100 USD will be represented as 10000.
sig { returns(T.nilable(Integer)) }
def paid_amount; end
# The amount that is yet to be paid in the current repayment interval, in minor units. For example, $100 USD will be represented as 10000.
sig { returns(Integer) }
def remaining_amount; end
end
# Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.
sig { returns(Integer) }
def advance_amount; end
# The time at which the funds were paid out to the connected account's Stripe balance. Given in milliseconds since unix epoch.
sig { returns(T.nilable(Float)) }
def advance_paid_out_at; end
# Currency that the financing offer is transacted in. For example, `usd`.
sig { returns(String) }
def currency; end
# The chronologically current repayment interval for the financing offer.
sig { returns(T.nilable(CurrentRepaymentInterval)) }
def current_repayment_interval; end
# Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.
sig { returns(Integer) }
def fee_amount; end
# The amount the Connected account has paid toward the financing debt so far, in minor units. For example, $1,000 USD will be represented as 100000.
sig { returns(Integer) }
def paid_amount; end
# The balance remaining to be paid on the financing, in minor units. For example, $1,000 USD will be represented as 100000.
sig { returns(Integer) }
def remaining_amount; end
# The time at which Capital will begin withholding from payments. Given in seconds since unix epoch.
sig { returns(T.nilable(Float)) }
def repayments_begin_at; end
# Per-transaction rate at which Stripe will withhold funds to repay the financing.
sig { returns(Float) }
def withhold_rate; end
end
# Additional information about the financing summary. Describes currency, advance amount,
# fee amount, withhold rate, remaining amount, paid amount, current repayment interval,
# repayment start date, and advance payout date.
sig { returns(T.nilable(Details)) }
def details; end
# The Financing Offer ID this Financing Summary corresponds to
sig { returns(T.nilable(String)) }
def financing_offer; end
# The object type: financing_summary
sig { returns(String) }
def object; end
# Status of the Connected Account's financing. [/v1/capital/financing_summary](https://stripe.com/docs/api/capital/financing_summary) will only return `details` for `paid_out` financing.
sig { returns(T.nilable(String)) }
def status; end
end
end
end
# typed: true
module Stripe
module Capital
# This is an object representing the details of a transaction on a Capital financing object.
class FinancingTransaction < APIResource
class Details < Stripe::StripeObject
class Transaction < Stripe::StripeObject
# The linked payment ID.
sig { returns(T.nilable(String)) }
def charge; end
# The linked Treasury Financing Transaction ID.
sig { returns(T.nilable(String)) }
def treasury_transaction; end
end
# The advance amount being repaid, paid out, or reversed in minor units.
sig { returns(Integer) }
def advance_amount; end
# The currency of the financing transaction.
sig { returns(String) }
def currency; end
# The fee amount being repaid, paid out, or reversed in minor units.
sig { returns(Integer) }
def fee_amount; end
# The linked payment for the transaction. This field only applies to financing transactions of type `paydown` and reason `automatic_withholding`.
sig { returns(T.nilable(String)) }
def linked_payment; end
# The reason for the financing transaction (if applicable).
sig { returns(T.nilable(String)) }
def reason; end
# The reversed transaction. This field only applies to financing
# transactions of type `reversal`.
sig { returns(T.nilable(String)) }
def reversed_transaction; end
# The advance and fee amount being repaid, paid out, or reversed in minor units.
sig { returns(Integer) }
def total_amount; end
# This is an object representing a linked transaction on a Capital Financing Transaction.
sig { returns(T.nilable(Transaction)) }
def transaction; end
end
# The ID of the merchant associated with this financing transaction.
sig { returns(String) }
def account; end
# Time at which the financing transaction was created. Given in seconds since unix epoch.
sig { returns(Integer) }
def created_at; end
# This is an object representing a transaction on a Capital financing offer.
sig { returns(Details) }
def details; end
# The Capital financing offer for this financing transaction.
sig { returns(T.nilable(String)) }
def financing_offer; end
# A unique identifier for the financing transaction object.
sig { returns(String) }
def id; end
# The Capital transaction object that predates the Financing Transactions API and
# corresponds with the balance transaction that was created as a result of this
# financing transaction.
sig { returns(T.nilable(String)) }
def legacy_balance_transaction_source; end
# 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) }
def livemode; end
# The object type: financing_transaction
sig { returns(String) }
def object; end
# The type of the financing transaction.
sig { returns(String) }
def type; end
# A human-friendly description of the financing transaction.
sig { returns(T.nilable(String)) }
def user_facing_description; end
class ListParams < Stripe::RequestParams
# For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this charge.
sig { returns(T.nilable(String)) }
def charge; end
sig { params(_charge: T.nilable(String)).returns(T.nilable(String)) }
def charge=(_charge); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Returns transactions that were created that apply to this financing offer ID.
sig { returns(T.nilable(String)) }
def financing_offer; end
sig { params(_financing_offer: T.nilable(String)).returns(T.nilable(String)) }
def financing_offer=(_financing_offer); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only returns transactions that are responsible for reversing this financing transaction ID.
sig { returns(T.nilable(String)) }
def reversed_transaction; end
sig { params(_reversed_transaction: T.nilable(String)).returns(T.nilable(String)) }
def reversed_transaction=(_reversed_transaction); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this Treasury Transaction.
sig { returns(T.nilable(String)) }
def treasury_transaction; end
sig { params(_treasury_transaction: T.nilable(String)).returns(T.nilable(String)) }
def treasury_transaction=(_treasury_transaction); end
sig {
params(charge: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financing_offer: T.nilable(String), limit: T.nilable(Integer), reversed_transaction: T.nilable(String), starting_after: T.nilable(String), treasury_transaction: T.nilable(String)).void
}
def initialize(
charge: nil,
ending_before: nil,
expand: nil,
financing_offer: nil,
limit: nil,
reversed_transaction: nil,
starting_after: nil,
treasury_transaction: nil
); end
end
# Returns a list of financing transactions. The transactions are returned in sorted order,
# with the most recent transactions appearing first.
sig {
params(params: T.any(::Stripe::Capital::FinancingTransaction::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
# The `Charge` object represents a single attempt to move money into your Stripe account.
# PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://stripe.com/docs/connect/account-debits) may also create Charges.
# Some legacy payment flows create Charges directly, which is not recommended for new integrations.
class Charge < APIResource
class BillingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Billing address.
sig { returns(T.nilable(Address)) }
def address; end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
end
class FraudDetails < Stripe::StripeObject
# Assessments from Stripe. If set, the value is `fraudulent`.
sig { returns(T.nilable(String)) }
def stripe_report; end
# Assessments reported by you. If set, possible values of are `safe` and `fraudulent`.
sig { returns(T.nilable(String)) }
def user_report; end
end
class Level3 < Stripe::StripeObject
class LineItem < Stripe::StripeObject
# Attribute for field discount_amount
sig { returns(T.nilable(Integer)) }
def discount_amount; end
# Attribute for field product_code
sig { returns(String) }
def product_code; end
# Attribute for field product_description
sig { returns(String) }
def product_description; end
# Attribute for field quantity
sig { returns(T.nilable(Integer)) }
def quantity; end
# Attribute for field tax_amount
sig { returns(T.nilable(Integer)) }
def tax_amount; end
# Attribute for field unit_cost
sig { returns(T.nilable(Integer)) }
def unit_cost; end
end
# Attribute for field customer_reference
sig { returns(T.nilable(String)) }
def customer_reference; end
# Attribute for field line_items
sig { returns(T::Array[LineItem]) }
def line_items; end
# Attribute for field merchant_reference
sig { returns(String) }
def merchant_reference; end
# Attribute for field shipping_address_zip
sig { returns(T.nilable(String)) }
def shipping_address_zip; end
# Attribute for field shipping_amount
sig { returns(T.nilable(Integer)) }
def shipping_amount; end
# Attribute for field shipping_from_zip
sig { returns(T.nilable(String)) }
def shipping_from_zip; end
end
class Outcome < Stripe::StripeObject
class Rule < Stripe::StripeObject
# The action taken on the payment.
sig { returns(String) }
def action; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The predicate to evaluate the payment against.
sig { returns(String) }
def predicate; end
end
# An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines).
sig { returns(T.nilable(String)) }
def advice_code; end
# For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error.
sig { returns(T.nilable(String)) }
def network_advice_code; end
# For charges declined by the network, an alphanumeric code which indicates the reason the charge failed.
sig { returns(T.nilable(String)) }
def network_decline_code; end
# Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement.
sig { returns(T.nilable(String)) }
def network_status; end
# An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges blocked because the payment is unlikely to be authorized have the value `low_probability_of_authorization`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details.
sig { returns(T.nilable(String)) }
def reason; end
# Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar.
sig { returns(T.nilable(String)) }
def risk_level; end
# Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.
sig { returns(T.nilable(Integer)) }
def risk_score; end
# The ID of the Radar rule that matched the payment, if applicable.
sig { returns(T.nilable(T.any(String, Rule))) }
def rule; end
# A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.
sig { returns(T.nilable(String)) }
def seller_message; end
# Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details.
sig { returns(String) }
def type; end
end
class PaymentMethodDetails < Stripe::StripeObject
class AchCreditTransfer < Stripe::StripeObject
# Account number to transfer funds to.
sig { returns(T.nilable(String)) }
def account_number; end
# Name of the bank associated with the routing number.
sig { returns(T.nilable(String)) }
def bank_name; end
# Routing transit number for the bank account to transfer funds to.
sig { returns(T.nilable(String)) }
def routing_number; end
# SWIFT code of the bank associated with the routing number.
sig { returns(T.nilable(String)) }
def swift_code; end
end
class AchDebit < Stripe::StripeObject
# Type of entity that holds the account. This can be either `individual` or `company`.
sig { returns(T.nilable(String)) }
def account_holder_type; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(T.nilable(String)) }
def country; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# Routing transit number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
end
class AcssDebit < Stripe::StripeObject
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Institution number of the bank account
sig { returns(T.nilable(String)) }
def institution_number; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(String)) }
def mandate; end
# Transit number of the bank account.
sig { returns(T.nilable(String)) }
def transit_number; end
end
class Affirm < Stripe::StripeObject
# ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
sig { returns(T.nilable(String)) }
def location; end
# ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
sig { returns(T.nilable(String)) }
def reader; end
# The Affirm transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class AfterpayClearpay < Stripe::StripeObject
# The Afterpay order ID associated with this payment intent.
sig { returns(T.nilable(String)) }
def order_id; end
# Order identifier shown to the merchant in Afterpay’s online portal.
sig { returns(T.nilable(String)) }
def reference; end
end
class Alipay < Stripe::StripeObject
# Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
sig { returns(T.nilable(String)) }
def buyer_id; end
# Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Transaction ID of this particular Alipay transaction.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Alma < Stripe::StripeObject
class Installments < Stripe::StripeObject
# The number of installments.
sig { returns(Integer) }
def count; end
end
# Attribute for field installments
sig { returns(T.nilable(Installments)) }
def installments; end
# The Alma transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class AmazonPay < Stripe::StripeObject
class Funding < Stripe::StripeObject
class Card < Stripe::StripeObject
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(T.nilable(String)) }
def brand; end
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def brand_product; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# Two-digit number representing the card's expiration month.
sig { returns(T.nilable(Integer)) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(T.nilable(Integer)) }
def exp_year; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# funding type of the underlying payment method.
sig { returns(T.nilable(String)) }
def type; end
end
# Attribute for field funding
sig { returns(T.nilable(Funding)) }
def funding; end
# The Amazon Pay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class AuBecsDebit < Stripe::StripeObject
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(String)) }
def mandate; end
end
class BacsDebit < Stripe::StripeObject
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(String)) }
def mandate; end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
end
class Bancontact < Stripe::StripeObject
# Bank code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_code; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Bank Identifier Code of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bic; end
# The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def generated_sepa_debit; end
# The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def generated_sepa_debit_mandate; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def iban_last4; end
# Preferred language of the Bancontact authorization page that the customer is redirected to.
# Can be one of `en`, `de`, `fr`, or `nl`
sig { returns(T.nilable(String)) }
def preferred_language; end
# Owner's verified full name. Values are verified or provided by Bancontact directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class Billie < Stripe::StripeObject
# The Billie transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Blik < Stripe::StripeObject
# A unique and immutable identifier assigned by BLIK to every buyer.
sig { returns(T.nilable(String)) }
def buyer_id; end
end
class Boleto < Stripe::StripeObject
# The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
end
class Card < Stripe::StripeObject
class Checks < Stripe::StripeObject
# If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
sig { returns(T.nilable(String)) }
def address_line1_check; end
# If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
sig { returns(T.nilable(String)) }
def address_postal_code_check; end
# If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
sig { returns(T.nilable(String)) }
def cvc_check; end
end
class DecrementalAuthorization < Stripe::StripeObject
# Indicates whether or not the decremental authorization feature is supported.
sig { returns(String) }
def status; end
end
class ExtendedAuthorization < Stripe::StripeObject
# Indicates whether or not the capture window is extended beyond the standard authorization.
sig { returns(String) }
def status; end
end
class IncrementalAuthorization < Stripe::StripeObject
# Indicates whether or not the incremental authorization feature is supported.
sig { returns(String) }
def status; end
end
class Installments < Stripe::StripeObject
class Plan < Stripe::StripeObject
# For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.
sig { returns(T.nilable(Integer)) }
def count; end
# For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.
# One of `month`.
sig { returns(T.nilable(String)) }
def interval; end
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
sig { returns(String) }
def type; end
end
# Installment plan selected for the payment.
sig { returns(T.nilable(Plan)) }
def plan; end
end
class Multicapture < Stripe::StripeObject
# Indicates whether or not multiple captures are supported.
sig { returns(String) }
def status; end
end
class NetworkToken < Stripe::StripeObject
# Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction.
sig { returns(T::Boolean) }
def used; end
end
class Overcapture < Stripe::StripeObject
# The maximum amount that can be captured.
sig { returns(Integer) }
def maximum_amount_capturable; end
# Indicates whether or not the authorized amount can be over-captured.
sig { returns(String) }
def status; end
end
class PartialAuthorization < Stripe::StripeObject
# Indicates whether the transaction requested for partial authorization feature and the authorization outcome.
sig { returns(String) }
def status; end
end
class ThreeDSecure < Stripe::StripeObject
# For authenticated transactions: how the customer was authenticated by
# the issuing bank.
sig { returns(T.nilable(String)) }
def authentication_flow; end
# The Electronic Commerce Indicator (ECI). A protocol-level field
# indicating what degree of authentication was performed.
sig { returns(T.nilable(String)) }
def electronic_commerce_indicator; end
# The exemption requested via 3DS and accepted by the issuer at authentication time.
sig { returns(T.nilable(String)) }
def exemption_indicator; end
# Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on
# the outcome of Stripe's internal risk assessment.
sig { returns(T.nilable(T::Boolean)) }
def exemption_indicator_applied; end
# Indicates the outcome of 3D Secure authentication.
sig { returns(T.nilable(String)) }
def result; end
# Additional information about why 3D Secure succeeded or failed based
# on the `result`.
sig { returns(T.nilable(String)) }
def result_reason; end
# The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID
# (dsTransId) for this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
# The version of 3D Secure that was used.
sig { returns(T.nilable(String)) }
def version; end
end
class Wallet < Stripe::StripeObject
class AmexExpressCheckout < Stripe::StripeObject; end
class ApplePay < Stripe::StripeObject; end
class GooglePay < Stripe::StripeObject; end
class Link < Stripe::StripeObject; end
class Masterpass < Stripe::StripeObject
class BillingAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class ShippingAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(BillingAddress)) }
def billing_address; end
# Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def email; end
# Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def name; end
# Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(ShippingAddress)) }
def shipping_address; end
end
class SamsungPay < Stripe::StripeObject; end
class VisaCheckout < Stripe::StripeObject
class BillingAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class ShippingAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(BillingAddress)) }
def billing_address; end
# Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def email; end
# Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def name; end
# Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(ShippingAddress)) }
def shipping_address; end
end
# Attribute for field amex_express_checkout
sig { returns(T.nilable(AmexExpressCheckout)) }
def amex_express_checkout; end
# Attribute for field apple_pay
sig { returns(T.nilable(ApplePay)) }
def apple_pay; end
# (For tokenized numbers only.) The last four digits of the device account number.
sig { returns(T.nilable(String)) }
def dynamic_last4; end
# Attribute for field google_pay
sig { returns(T.nilable(GooglePay)) }
def google_pay; end
# Attribute for field link
sig { returns(T.nilable(Link)) }
def link; end
# Attribute for field masterpass
sig { returns(T.nilable(Masterpass)) }
def masterpass; end
# Attribute for field samsung_pay
sig { returns(T.nilable(SamsungPay)) }
def samsung_pay; end
# The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.
sig { returns(String) }
def type; end
# Attribute for field visa_checkout
sig { returns(T.nilable(VisaCheckout)) }
def visa_checkout; end
end
# The authorized amount.
sig { returns(T.nilable(Integer)) }
def amount_authorized; end
# The latest amount intended to be authorized by this charge.
sig { returns(T.nilable(Integer)) }
def amount_requested; end
# Authorization code on the charge.
sig { returns(T.nilable(String)) }
def authorization_code; end
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(T.nilable(String)) }
def brand; end
# When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.
sig { returns(T.nilable(Integer)) }
def capture_before; end
# Check results by Card networks on Card address and CVC at time of payment.
sig { returns(T.nilable(Checks)) }
def checks; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# Attribute for field decremental_authorization
sig { returns(T.nilable(DecrementalAuthorization)) }
def decremental_authorization; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Attribute for field extended_authorization
sig { returns(T.nilable(ExtendedAuthorization)) }
def extended_authorization; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# Attribute for field incremental_authorization
sig { returns(T.nilable(IncrementalAuthorization)) }
def incremental_authorization; end
# Installment details for this payment.
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
sig { returns(T.nilable(Installments)) }
def installments; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment or created by it.
sig { returns(T.nilable(String)) }
def mandate; end
# True if this payment was marked as MOTO and out of scope for SCA.
sig { returns(T.nilable(T::Boolean)) }
def moto; end
# Attribute for field multicapture
sig { returns(T.nilable(Multicapture)) }
def multicapture; end
# Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
sig { returns(T.nilable(String)) }
def network; end
# If this card has network token credentials, this contains the details of the network token credentials.
sig { returns(T.nilable(NetworkToken)) }
def network_token; end
# This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
sig { returns(T.nilable(String)) }
def network_transaction_id; end
# Attribute for field overcapture
sig { returns(T.nilable(Overcapture)) }
def overcapture; end
# Attribute for field partial_authorization
sig { returns(T.nilable(PartialAuthorization)) }
def partial_authorization; end
# Status of a card based on the card issuer.
sig { returns(T.nilable(String)) }
def regulated_status; end
# Populated if this transaction used 3D Secure authentication.
sig { returns(T.nilable(ThreeDSecure)) }
def three_d_secure; end
# If this Card is part of a card wallet, this contains the details of the card wallet.
sig { returns(T.nilable(Wallet)) }
def wallet; end
end
class CardPresent < Stripe::StripeObject
class Offline < Stripe::StripeObject
# Time at which the payment was collected while offline
sig { returns(T.nilable(Integer)) }
def stored_at; end
# The method used to process this payment method offline. Only deferred is allowed.
sig { returns(T.nilable(String)) }
def type; end
end
class Receipt < Stripe::StripeObject
# The type of account being debited or credited
sig { returns(T.nilable(String)) }
def account_type; end
# The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.
sig { returns(T.nilable(String)) }
def application_cryptogram; end
# The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip.
sig { returns(T.nilable(String)) }
def application_preferred_name; end
# Identifier for this transaction.
sig { returns(T.nilable(String)) }
def authorization_code; end
# EMV tag 8A. A code returned by the card issuer.
sig { returns(T.nilable(String)) }
def authorization_response_code; end
# Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.
sig { returns(T.nilable(String)) }
def cardholder_verification_method; end
# Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.
sig { returns(T.nilable(String)) }
def dedicated_file_name; end
# A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.
sig { returns(T.nilable(String)) }
def terminal_verification_results; end
# An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.
sig { returns(T.nilable(String)) }
def transaction_status_information; end
end
class Wallet < Stripe::StripeObject
# The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.
sig { returns(String) }
def type; end
end
# The authorized amount
sig { returns(T.nilable(Integer)) }
def amount_authorized; end
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(T.nilable(String)) }
def brand; end
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.
sig { returns(T.nilable(String)) }
def brand_product; end
# When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.
sig { returns(T.nilable(Integer)) }
def capture_before; end
# The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
sig { returns(T.nilable(String)) }
def cardholder_name; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# Authorization response cryptogram.
sig { returns(T.nilable(String)) }
def emv_auth_data; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
sig { returns(T.nilable(String)) }
def generated_card; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
sig { returns(T::Boolean) }
def incremental_authorization_supported; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
# Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
sig { returns(T.nilable(String)) }
def network; end
# This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
sig { returns(T.nilable(String)) }
def network_transaction_id; end
# Details about payments collected offline.
sig { returns(T.nilable(Offline)) }
def offline; end
# Defines whether the authorized amount can be over-captured or not
sig { returns(T::Boolean) }
def overcapture_supported; end
# The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
# How card details were read in this transaction.
sig { returns(T.nilable(String)) }
def read_method; end
# A collection of fields required to be displayed on receipts. Only required for EMV transactions.
sig { returns(T.nilable(Receipt)) }
def receipt; end
# Attribute for field wallet
sig { returns(T.nilable(Wallet)) }
def wallet; end
end
class Cashapp < Stripe::StripeObject
# A unique and immutable identifier assigned by Cash App to every buyer.
sig { returns(T.nilable(String)) }
def buyer_id; end
# A public identifier for buyers using Cash App.
sig { returns(T.nilable(String)) }
def cashtag; end
# A unique and immutable identifier of payments assigned by Cash App
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Crypto < Stripe::StripeObject
# The wallet address of the customer.
sig { returns(T.nilable(String)) }
def buyer_address; end
# The blockchain network that the transaction was sent on.
sig { returns(T.nilable(String)) }
def network; end
# The token currency that the transaction was sent with.
sig { returns(T.nilable(String)) }
def token_currency; end
# The blockchain transaction hash of the crypto payment.
sig { returns(T.nilable(String)) }
def transaction_hash; end
end
class CustomerBalance < Stripe::StripeObject; end
class Eps < Stripe::StripeObject
# The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.
sig { returns(T.nilable(String)) }
def bank; end
# Owner's verified full name. Values are verified or provided by EPS directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
# EPS rarely provides this information so the attribute is usually empty.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class Fpx < Stripe::StripeObject
# Account holder type, if provided. Can be one of `individual` or `company`.
sig { returns(T.nilable(String)) }
def account_holder_type; end
# The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
sig { returns(String) }
def bank; end
# Unique transaction id generated by FPX for every request from the merchant
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Giropay < Stripe::StripeObject
# Bank code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_code; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Bank Identifier Code of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bic; end
# Owner's verified full name. Values are verified or provided by Giropay directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
# Giropay rarely provides this information so the attribute is usually empty.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class Gopay < Stripe::StripeObject; end
class Grabpay < Stripe::StripeObject
# Unique transaction id generated by GrabPay
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class IdBankTransfer < Stripe::StripeObject
# Account number of the bank account to transfer funds to.
sig { returns(String) }
def account_number; end
# Bank where the account is located.
sig { returns(String) }
def bank; end
# Local bank code of the bank.
sig { returns(T.nilable(String)) }
def bank_code; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
sig { returns(T.nilable(String)) }
def display_name; end
end
class Ideal < Stripe::StripeObject
# The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
sig { returns(T.nilable(String)) }
def bank; end
# The Bank Identifier Code of the customer's bank.
sig { returns(T.nilable(String)) }
def bic; end
# The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def generated_sepa_debit; end
# The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def generated_sepa_debit_mandate; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def iban_last4; end
# Owner's verified full name. Values are verified or provided by iDEAL directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class InteracPresent < Stripe::StripeObject
class Receipt < Stripe::StripeObject
# The type of account being debited or credited
sig { returns(T.nilable(String)) }
def account_type; end
# The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.
sig { returns(T.nilable(String)) }
def application_cryptogram; end
# The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip.
sig { returns(T.nilable(String)) }
def application_preferred_name; end
# Identifier for this transaction.
sig { returns(T.nilable(String)) }
def authorization_code; end
# EMV tag 8A. A code returned by the card issuer.
sig { returns(T.nilable(String)) }
def authorization_response_code; end
# Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.
sig { returns(T.nilable(String)) }
def cardholder_verification_method; end
# Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.
sig { returns(T.nilable(String)) }
def dedicated_file_name; end
# A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.
sig { returns(T.nilable(String)) }
def terminal_verification_results; end
# An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.
sig { returns(T.nilable(String)) }
def transaction_status_information; end
end
# Card brand. Can be `interac`, `mastercard` or `visa`.
sig { returns(T.nilable(String)) }
def brand; end
# The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
sig { returns(T.nilable(String)) }
def cardholder_name; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# Authorization response cryptogram.
sig { returns(T.nilable(String)) }
def emv_auth_data; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
sig { returns(T.nilable(String)) }
def generated_card; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
# Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
sig { returns(T.nilable(String)) }
def network; end
# This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
sig { returns(T.nilable(String)) }
def network_transaction_id; end
# The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
# How card details were read in this transaction.
sig { returns(T.nilable(String)) }
def read_method; end
# A collection of fields required to be displayed on receipts. Only required for EMV transactions.
sig { returns(T.nilable(Receipt)) }
def receipt; end
end
class KakaoPay < Stripe::StripeObject
# A unique identifier for the buyer as determined by the local payment processor.
sig { returns(T.nilable(String)) }
def buyer_id; end
# The Kakao Pay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Klarna < Stripe::StripeObject
class PayerDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# The payer address country
sig { returns(T.nilable(String)) }
def country; end
end
# The payer's address
sig { returns(T.nilable(Address)) }
def address; end
end
# The payer details for this transaction.
sig { returns(T.nilable(PayerDetails)) }
def payer_details; end
# The Klarna payment method used for this transaction.
# Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`
sig { returns(T.nilable(String)) }
def payment_method_category; end
# Preferred language of the Klarna authorization page that the customer is redirected to.
# Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`
sig { returns(T.nilable(String)) }
def preferred_locale; end
end
class Konbini < Stripe::StripeObject
class Store < Stripe::StripeObject
# The name of the convenience store chain where the payment was completed.
sig { returns(T.nilable(String)) }
def chain; end
end
# If the payment succeeded, this contains the details of the convenience store where the payment was completed.
sig { returns(T.nilable(Store)) }
def store; end
end
class KrCard < Stripe::StripeObject
# The local credit or debit card brand.
sig { returns(T.nilable(String)) }
def brand; end
# A unique identifier for the buyer as determined by the local payment processor.
sig { returns(T.nilable(String)) }
def buyer_id; end
# The last four digits of the card. This may not be present for American Express cards.
sig { returns(T.nilable(String)) }
def last4; end
# The Korean Card transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Link < Stripe::StripeObject
# Two-letter ISO code representing the funding source country beneath the Link payment.
# You could use this attribute to get a sense of international fees.
sig { returns(T.nilable(String)) }
def country; end
end
class MbWay < Stripe::StripeObject; end
class Mobilepay < Stripe::StripeObject
class Card < Stripe::StripeObject
# Brand of the card used in the transaction
sig { returns(T.nilable(String)) }
def brand; end
# Two-letter ISO code representing the country of the card
sig { returns(T.nilable(String)) }
def country; end
# Two digit number representing the card's expiration month
sig { returns(T.nilable(Integer)) }
def exp_month; end
# Two digit number representing the card's expiration year
sig { returns(T.nilable(Integer)) }
def exp_year; end
# The last 4 digits of the card
sig { returns(T.nilable(String)) }
def last4; end
end
# Internal card details
sig { returns(T.nilable(Card)) }
def card; end
end
class Multibanco < Stripe::StripeObject
# Entity number associated with this Multibanco payment.
sig { returns(T.nilable(String)) }
def entity; end
# Reference number associated with this Multibanco payment.
sig { returns(T.nilable(String)) }
def reference; end
end
class NaverPay < Stripe::StripeObject
# A unique identifier for the buyer as determined by the local payment processor.
sig { returns(T.nilable(String)) }
def buyer_id; end
# The Naver Pay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class NzBankAccount < Stripe::StripeObject
# The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
# The name of the bank.
sig { returns(String) }
def bank_name; end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
# Last four digits of the bank account number.
sig { returns(String) }
def last4; end
# The suffix of the bank account number.
sig { returns(T.nilable(String)) }
def suffix; end
end
class Oxxo < Stripe::StripeObject
# OXXO reference number
sig { returns(T.nilable(String)) }
def number; end
end
class P24 < Stripe::StripeObject
# The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`.
sig { returns(T.nilable(String)) }
def bank; end
# Unique reference for this Przelewy24 payment.
sig { returns(T.nilable(String)) }
def reference; end
# Owner's verified full name. Values are verified or provided by Przelewy24 directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
# Przelewy24 rarely provides this information so the attribute is usually empty.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class PayByBank < Stripe::StripeObject; end
class Payco < Stripe::StripeObject
# A unique identifier for the buyer as determined by the local payment processor.
sig { returns(T.nilable(String)) }
def buyer_id; end
# The Payco transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Paynow < Stripe::StripeObject
# ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
sig { returns(T.nilable(String)) }
def location; end
# ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
sig { returns(T.nilable(String)) }
def reader; end
# Reference number associated with this PayNow payment
sig { returns(T.nilable(String)) }
def reference; end
end
class Paypal < Stripe::StripeObject
class SellerProtection < Stripe::StripeObject
# An array of conditions that are covered for the transaction, if applicable.
sig { returns(T.nilable(T::Array[String])) }
def dispute_categories; end
# Indicates whether the transaction is eligible for PayPal's seller protection.
sig { returns(String) }
def status; end
end
class Shipping < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class VerifiedAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def country; end
# Owner's email. Values are provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def payer_email; end
# PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
sig { returns(T.nilable(String)) }
def payer_id; end
# Owner's full name. Values provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def payer_name; end
# The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.
sig { returns(T.nilable(SellerProtection)) }
def seller_protection; end
# The shipping address for the customer, as supplied by the merchant at the point of payment
# execution. This shipping address will not be updated if the merchant updates the shipping
# address on the PaymentIntent after the PaymentIntent was successfully confirmed.
sig { returns(T.nilable(Shipping)) }
def shipping; end
# A unique ID generated by PayPal for this transaction.
sig { returns(T.nilable(String)) }
def transaction_id; end
# The shipping address for the customer, as supplied by the merchant at the point of payment
# execution. This shipping address will not be updated if the merchant updates the shipping
# address on the PaymentIntent after the PaymentIntent was successfully confirmed.
sig { returns(T.nilable(VerifiedAddress)) }
def verified_address; end
# Owner's verified email. Values are verified or provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_email; end
# Owner's verified full name. Values are verified or provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class Paypay < Stripe::StripeObject; end
class Payto < Stripe::StripeObject
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(String)) }
def mandate; end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
end
class Pix < Stripe::StripeObject
# Unique transaction id generated by BCB
sig { returns(T.nilable(String)) }
def bank_transaction_id; end
# ID of the multi use Mandate generated by the PaymentIntent
sig { returns(T.nilable(String)) }
def mandate; end
end
class Promptpay < Stripe::StripeObject
# Bill reference generated by PromptPay
sig { returns(T.nilable(String)) }
def reference; end
end
class Qris < Stripe::StripeObject; end
class Rechnung < Stripe::StripeObject; end
class RevolutPay < Stripe::StripeObject
class Funding < Stripe::StripeObject
class Card < Stripe::StripeObject
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(T.nilable(String)) }
def brand; end
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def brand_product; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# Two-digit number representing the card's expiration month.
sig { returns(T.nilable(Integer)) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(T.nilable(Integer)) }
def exp_year; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# funding type of the underlying payment method.
sig { returns(T.nilable(String)) }
def type; end
end
# Attribute for field funding
sig { returns(T.nilable(Funding)) }
def funding; end
# The Revolut Pay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class SamsungPay < Stripe::StripeObject
# A unique identifier for the buyer as determined by the local payment processor.
sig { returns(T.nilable(String)) }
def buyer_id; end
# The Samsung Pay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Satispay < Stripe::StripeObject
# The Satispay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class SepaCreditTransfer < Stripe::StripeObject
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Bank Identifier Code of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bic; end
# IBAN of the bank account to transfer funds to.
sig { returns(T.nilable(String)) }
def iban; end
end
class SepaDebit < Stripe::StripeObject
# Bank code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_code; end
# Branch code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def branch_code; end
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(T.nilable(String)) }
def country; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def last4; end
# Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve).
sig { returns(T.nilable(String)) }
def mandate; end
end
class Shopeepay < Stripe::StripeObject; end
class Sofort < Stripe::StripeObject
# Bank code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_code; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Bank Identifier Code of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bic; end
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(T.nilable(String)) }
def country; end
# The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def generated_sepa_debit; end
# The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def generated_sepa_debit_mandate; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def iban_last4; end
# Preferred language of the SOFORT authorization page that the customer is redirected to.
# Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`
sig { returns(T.nilable(String)) }
def preferred_language; end
# Owner's verified full name. Values are verified or provided by SOFORT directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class StripeAccount < Stripe::StripeObject; end
class StripeBalance < Stripe::StripeObject
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(String) }
def source_type; end
end
class Swish < Stripe::StripeObject
# Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer
sig { returns(T.nilable(String)) }
def fingerprint; end
# Payer bank reference number for the payment
sig { returns(T.nilable(String)) }
def payment_reference; end
# The last four digits of the Swish account phone number
sig { returns(T.nilable(String)) }
def verified_phone_last4; end
end
class Twint < Stripe::StripeObject; end
class UsBankAccount < Stripe::StripeObject
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def mandate; end
# Reference number to locate ACH payments with customer's bank.
sig { returns(T.nilable(String)) }
def payment_reference; end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
end
class Wechat < Stripe::StripeObject; end
class WechatPay < Stripe::StripeObject
# Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
sig { returns(T.nilable(String)) }
def location; end
# ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
sig { returns(T.nilable(String)) }
def reader; end
# Transaction ID of this particular WeChat Pay transaction.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Zip < Stripe::StripeObject; end
# Attribute for field ach_credit_transfer
sig { returns(T.nilable(AchCreditTransfer)) }
def ach_credit_transfer; end
# Attribute for field ach_debit
sig { returns(T.nilable(AchDebit)) }
def ach_debit; end
# Attribute for field acss_debit
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# Attribute for field affirm
sig { returns(T.nilable(Affirm)) }
def affirm; end
# Attribute for field afterpay_clearpay
sig { returns(T.nilable(AfterpayClearpay)) }
def afterpay_clearpay; end
# Attribute for field alipay
sig { returns(T.nilable(Alipay)) }
def alipay; end
# Attribute for field alma
sig { returns(T.nilable(Alma)) }
def alma; end
# Attribute for field amazon_pay
sig { returns(T.nilable(AmazonPay)) }
def amazon_pay; end
# Attribute for field au_becs_debit
sig { returns(T.nilable(AuBecsDebit)) }
def au_becs_debit; end
# Attribute for field bacs_debit
sig { returns(T.nilable(BacsDebit)) }
def bacs_debit; end
# Attribute for field bancontact
sig { returns(T.nilable(Bancontact)) }
def bancontact; end
# Attribute for field billie
sig { returns(T.nilable(Billie)) }
def billie; end
# Attribute for field blik
sig { returns(T.nilable(Blik)) }
def blik; end
# Attribute for field boleto
sig { returns(T.nilable(Boleto)) }
def boleto; end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# Attribute for field card_present
sig { returns(T.nilable(CardPresent)) }
def card_present; end
# Attribute for field cashapp
sig { returns(T.nilable(Cashapp)) }
def cashapp; end
# Attribute for field crypto
sig { returns(T.nilable(Crypto)) }
def crypto; end
# Attribute for field customer_balance
sig { returns(T.nilable(CustomerBalance)) }
def customer_balance; end
# Attribute for field eps
sig { returns(T.nilable(Eps)) }
def eps; end
# Attribute for field fpx
sig { returns(T.nilable(Fpx)) }
def fpx; end
# Attribute for field giropay
sig { returns(T.nilable(Giropay)) }
def giropay; end
# Attribute for field gopay
sig { returns(T.nilable(Gopay)) }
def gopay; end
# Attribute for field grabpay
sig { returns(T.nilable(Grabpay)) }
def grabpay; end
# Attribute for field id_bank_transfer
sig { returns(T.nilable(IdBankTransfer)) }
def id_bank_transfer; end
# Attribute for field ideal
sig { returns(T.nilable(Ideal)) }
def ideal; end
# Attribute for field interac_present
sig { returns(T.nilable(InteracPresent)) }
def interac_present; end
# Attribute for field kakao_pay
sig { returns(T.nilable(KakaoPay)) }
def kakao_pay; end
# Attribute for field klarna
sig { returns(T.nilable(Klarna)) }
def klarna; end
# Attribute for field konbini
sig { returns(T.nilable(Konbini)) }
def konbini; end
# Attribute for field kr_card
sig { returns(T.nilable(KrCard)) }
def kr_card; end
# Attribute for field link
sig { returns(T.nilable(Link)) }
def link; end
# Attribute for field mb_way
sig { returns(T.nilable(MbWay)) }
def mb_way; end
# Attribute for field mobilepay
sig { returns(T.nilable(Mobilepay)) }
def mobilepay; end
# Attribute for field multibanco
sig { returns(T.nilable(Multibanco)) }
def multibanco; end
# Attribute for field naver_pay
sig { returns(T.nilable(NaverPay)) }
def naver_pay; end
# Attribute for field nz_bank_account
sig { returns(T.nilable(NzBankAccount)) }
def nz_bank_account; end
# Attribute for field oxxo
sig { returns(T.nilable(Oxxo)) }
def oxxo; end
# Attribute for field p24
sig { returns(T.nilable(P24)) }
def p24; end
# Attribute for field pay_by_bank
sig { returns(T.nilable(PayByBank)) }
def pay_by_bank; end
# Attribute for field payco
sig { returns(T.nilable(Payco)) }
def payco; end
# Attribute for field paynow
sig { returns(T.nilable(Paynow)) }
def paynow; end
# Attribute for field paypal
sig { returns(T.nilable(Paypal)) }
def paypal; end
# Attribute for field paypay
sig { returns(T.nilable(Paypay)) }
def paypay; end
# Attribute for field payto
sig { returns(T.nilable(Payto)) }
def payto; end
# Attribute for field pix
sig { returns(T.nilable(Pix)) }
def pix; end
# Attribute for field promptpay
sig { returns(T.nilable(Promptpay)) }
def promptpay; end
# Attribute for field qris
sig { returns(T.nilable(Qris)) }
def qris; end
# Attribute for field rechnung
sig { returns(T.nilable(Rechnung)) }
def rechnung; end
# Attribute for field revolut_pay
sig { returns(T.nilable(RevolutPay)) }
def revolut_pay; end
# Attribute for field samsung_pay
sig { returns(T.nilable(SamsungPay)) }
def samsung_pay; end
# Attribute for field satispay
sig { returns(T.nilable(Satispay)) }
def satispay; end
# Attribute for field sepa_credit_transfer
sig { returns(T.nilable(SepaCreditTransfer)) }
def sepa_credit_transfer; end
# Attribute for field sepa_debit
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# Attribute for field shopeepay
sig { returns(T.nilable(Shopeepay)) }
def shopeepay; end
# Attribute for field sofort
sig { returns(T.nilable(Sofort)) }
def sofort; end
# Attribute for field stripe_account
sig { returns(T.nilable(StripeAccount)) }
def stripe_account; end
# Attribute for field stripe_balance
sig { returns(T.nilable(StripeBalance)) }
def stripe_balance; end
# Attribute for field swish
sig { returns(T.nilable(Swish)) }
def swish; end
# Attribute for field twint
sig { returns(T.nilable(Twint)) }
def twint; end
# The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type) for the full list of possible types.
# An additional hash is included on `payment_method_details` with a name matching this value.
# It contains information specific to the payment method.
sig { returns(String) }
def type; end
# Attribute for field us_bank_account
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
# Attribute for field wechat
sig { returns(T.nilable(Wechat)) }
def wechat; end
# Attribute for field wechat_pay
sig { returns(T.nilable(WechatPay)) }
def wechat_pay; end
# Attribute for field zip
sig { returns(T.nilable(Zip)) }
def zip; end
end
class PresentmentDetails < Stripe::StripeObject
# Amount intended to be collected by this payment, denominated in `presentment_currency`.
sig { returns(Integer) }
def presentment_amount; end
# Currency presented to the customer during payment.
sig { returns(String) }
def presentment_currency; end
end
class RadarOptions < Stripe::StripeObject
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
end
class Shipping < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(T.nilable(Address)) }
def address; end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
# Recipient name.
sig { returns(T.nilable(String)) }
def name; end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
end
class TransferData < Stripe::StripeObject
# The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
sig { returns(T.nilable(Integer)) }
def amount; end
# ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request.
sig { returns(T.any(String, Stripe::Account)) }
def destination; end
end
# Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
sig { returns(Integer) }
def amount; end
# Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).
sig { returns(Integer) }
def amount_captured; end
# Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).
sig { returns(Integer) }
def amount_refunded; end
# ID of the Connect application that created the charge.
sig { returns(T.nilable(T.any(String, Stripe::Application))) }
def application; end
# The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.
sig { returns(T.nilable(T.any(String, Stripe::ApplicationFee))) }
def application_fee; end
# The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
# Authorization code on the charge.
sig { returns(T.nilable(String)) }
def authorization_code; end
# ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
def balance_transaction; end
# Attribute for field billing_details
sig { returns(BillingDetails) }
def billing_details; end
# The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments.
sig { returns(T.nilable(String)) }
def calculated_statement_descriptor; end
# If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
sig { returns(T::Boolean) }
def captured; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# ID of the customer this charge is for if one exists.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# Whether the charge has been disputed.
sig { returns(T::Boolean) }
def disputed; end
# ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.
sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
def failure_balance_transaction; end
# Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes).
sig { returns(T.nilable(String)) }
def failure_code; end
# Message to user further explaining reason for charge failure if available.
sig { returns(T.nilable(String)) }
def failure_message; end
# Information on fraud assessments for the charge.
sig { returns(T.nilable(FraudDetails)) }
def fraud_details; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Attribute for field level3
sig { returns(T.nilable(Level3)) }
def level3; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def on_behalf_of; end
# Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.
sig { returns(T.nilable(Outcome)) }
def outcome; end
# `true` if the charge succeeded, or was successfully authorized for later capture.
sig { returns(T::Boolean) }
def paid; end
# ID of the PaymentIntent associated with this charge, if one exists.
sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
def payment_intent; end
# ID of the payment method used in this charge.
sig { returns(T.nilable(String)) }
def payment_method; end
# Details about the payment method at the time of the transaction.
sig { returns(T.nilable(PaymentMethodDetails)) }
def payment_method_details; end
# Attribute for field presentment_details
sig { returns(T.nilable(PresentmentDetails)) }
def presentment_details; end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig { returns(T.nilable(RadarOptions)) }
def radar_options; end
# This is the email address that the receipt for this charge was sent to.
sig { returns(T.nilable(String)) }
def receipt_email; end
# This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.
sig { returns(T.nilable(String)) }
def receipt_number; end
# This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.
sig { returns(T.nilable(String)) }
def receipt_url; end
# Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
sig { returns(T::Boolean) }
def refunded; end
# A list of refunds that have been applied to the charge.
sig { returns(T.nilable(Stripe::ListObject)) }
def refunds; end
# ID of the review associated with this charge if one exists.
sig { returns(T.nilable(T.any(String, Stripe::Review))) }
def review; end
# Shipping information for the charge.
sig { returns(T.nilable(Shipping)) }
def shipping; end
# This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to `payment_method` or `payment_method_details` instead.
sig {
returns(T.nilable(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source)))
}
def source; end
# The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.
sig { returns(T.nilable(T.any(String, Stripe::Transfer))) }
def source_transfer; end
# For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
# The status of the payment is either `succeeded`, `pending`, or `failed`.
sig { returns(String) }
def status; end
# ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).
sig { returns(T.nilable(T.any(String, Stripe::Transfer))) }
def transfer; end
# An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
sig { returns(T.nilable(TransferData)) }
def transfer_data; end
# A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
sig { returns(T.nilable(String)) }
def transfer_group; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return charges that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Charge::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Charge::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Charge::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return charges for the customer specified by this customer ID.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return charges for this transfer group, limited to 100.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(created: T.nilable(T.any(::Stripe::Charge::ListParams::Created, Integer)), customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_intent: T.nilable(String), starting_after: T.nilable(String), transfer_group: T.nilable(String)).void
}
def initialize(
created: nil,
customer: nil,
ending_before: nil,
expand: nil,
limit: nil,
payment_intent: nil,
starting_after: nil,
transfer_group: nil
); end
end
class CreateParams < Stripe::RequestParams
class Destination < Stripe::RequestParams
# ID of an existing, connected Stripe account.
sig { returns(String) }
def account; end
sig { params(_account: String).returns(String) }
def account=(_account); end
# The amount to transfer to the destination account without creating an `Application Fee` object. Cannot be combined with the `application_fee` parameter. Must be less than or equal to the charge amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
sig { params(account: String, amount: T.nilable(Integer)).void }
def initialize(account: nil, amount: nil); end
end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address.
sig { returns(::Stripe::Charge::CreateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::Charge::CreateParams::Shipping::Address).returns(::Stripe::Charge::CreateParams::Shipping::Address)
}
def address=(_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
sig { params(_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def tracking_number=(_tracking_number); end
sig {
params(address: ::Stripe::Charge::CreateParams::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
}
def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
end
class TransferData < Stripe::RequestParams
# The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Attribute for param field application_fee
sig { returns(T.nilable(Integer)) }
def application_fee; end
sig { params(_application_fee: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee=(_application_fee); end
# A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation.
sig { returns(T.nilable(T::Boolean)) }
def capture; end
sig { params(_capture: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def capture=(_capture); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The ID of an existing customer that will be charged in this request.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Attribute for param field destination
sig { returns(T.nilable(::Stripe::Charge::CreateParams::Destination)) }
def destination; end
sig {
params(_destination: T.nilable(::Stripe::Charge::CreateParams::Destination)).returns(T.nilable(::Stripe::Charge::CreateParams::Destination))
}
def destination=(_destination); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant).
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig { returns(T.nilable(::Stripe::Charge::CreateParams::RadarOptions)) }
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::Charge::CreateParams::RadarOptions)).returns(T.nilable(::Stripe::Charge::CreateParams::RadarOptions))
}
def radar_options=(_radar_options); end
# The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
sig { returns(T.nilable(String)) }
def receipt_email; end
sig { params(_receipt_email: T.nilable(String)).returns(T.nilable(String)) }
def receipt_email=(_receipt_email); end
# Shipping information for the charge. Helps prevent fraud on charges for physical goods.
sig { returns(T.nilable(::Stripe::Charge::CreateParams::Shipping)) }
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::Charge::CreateParams::Shipping)).returns(T.nilable(::Stripe::Charge::CreateParams::Shipping))
}
def shipping=(_shipping); end
# A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer.
sig { returns(T.nilable(String)) }
def source; end
sig { params(_source: T.nilable(String)).returns(T.nilable(String)) }
def source=(_source); end
# For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
sig { returns(T.nilable(::Stripe::Charge::CreateParams::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::Charge::CreateParams::TransferData)).returns(T.nilable(::Stripe::Charge::CreateParams::TransferData))
}
def transfer_data=(_transfer_data); end
# A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options).
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(amount: T.nilable(Integer), application_fee: T.nilable(Integer), application_fee_amount: T.nilable(Integer), capture: T.nilable(T::Boolean), currency: T.nilable(String), customer: T.nilable(String), description: T.nilable(String), destination: T.nilable(::Stripe::Charge::CreateParams::Destination), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), on_behalf_of: T.nilable(String), radar_options: T.nilable(::Stripe::Charge::CreateParams::RadarOptions), receipt_email: T.nilable(String), shipping: T.nilable(::Stripe::Charge::CreateParams::Shipping), source: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::Charge::CreateParams::TransferData), transfer_group: T.nilable(String)).void
}
def initialize(
amount: nil,
application_fee: nil,
application_fee_amount: nil,
capture: nil,
currency: nil,
customer: nil,
description: nil,
destination: nil,
expand: nil,
metadata: nil,
on_behalf_of: nil,
radar_options: nil,
receipt_email: nil,
shipping: nil,
source: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil,
transfer_group: nil
); end
end
class UpdateParams < Stripe::RequestParams
class FraudDetails < Stripe::RequestParams
# Either `safe` or `fraudulent`.
sig { returns(T.any(String, String)) }
def user_report; end
sig { params(_user_report: T.any(String, String)).returns(T.any(String, String)) }
def user_report=(_user_report); end
sig { params(user_report: T.any(String, String)).void }
def initialize(user_report: nil); end
end
class PaymentDetails < Stripe::RequestParams
class CarRental < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Distance < Stripe::RequestParams
# Distance traveled.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
sig { params(amount: T.nilable(Integer), unit: T.nilable(String)).void }
def initialize(amount: nil, unit: nil); end
end
class Driver < Stripe::RequestParams
# Driver's identification number.
sig { returns(T.nilable(String)) }
def driver_identification_number; end
sig {
params(_driver_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def driver_identification_number=(_driver_identification_number); end
# Driver's tax number.
sig { returns(T.nilable(String)) }
def driver_tax_number; end
sig { params(_driver_tax_number: T.nilable(String)).returns(T.nilable(String)) }
def driver_tax_number=(_driver_tax_number); end
# Full name of the person or entity on the car reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(driver_identification_number: T.nilable(String), driver_tax_number: T.nilable(String), name: String).void
}
def initialize(
driver_identification_number: nil,
driver_tax_number: nil,
name: nil
); end
end
class PickupAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class ReturnAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Affiliate)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the car rental.
sig { returns(String) }
def booking_number; end
sig { params(_booking_number: String).returns(String) }
def booking_number=(_booking_number); end
# Class code of the car.
sig { returns(T.nilable(String)) }
def car_class_code; end
sig { params(_car_class_code: T.nilable(String)).returns(T.nilable(String)) }
def car_class_code=(_car_class_code); end
# Make of the car.
sig { returns(T.nilable(String)) }
def car_make; end
sig { params(_car_make: T.nilable(String)).returns(T.nilable(String)) }
def car_make=(_car_make); end
# Model of the car.
sig { returns(T.nilable(String)) }
def car_model; end
sig { params(_car_model: T.nilable(String)).returns(T.nilable(String)) }
def car_model=(_car_model); end
# The name of the rental car company.
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# The customer service phone number of the car rental company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# Number of days the car is being rented.
sig { returns(Integer) }
def days_rented; end
sig { params(_days_rented: Integer).returns(Integer) }
def days_rented=(_days_rented); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Delivery)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Delivery))
}
def delivery=(_delivery); end
# The details of the distance traveled during the rental period.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Distance))
}
def distance; end
sig {
params(_distance: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Distance)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Distance))
}
def distance=(_distance); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Driver]))
}
def drivers; end
sig {
params(_drivers: T.nilable(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Driver])).returns(T.nilable(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Driver]))
}
def drivers=(_drivers); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates if the customer did not keep nor cancel their booking.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# Car pick-up address.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address; end
sig {
params(_pickup_address: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::PickupAddress)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address=(_pickup_address); end
# Car pick-up time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def pickup_at; end
sig { params(_pickup_at: Integer).returns(Integer) }
def pickup_at=(_pickup_at); end
# Name of the pickup location.
sig { returns(T.nilable(String)) }
def pickup_location_name; end
sig { params(_pickup_location_name: T.nilable(String)).returns(T.nilable(String)) }
def pickup_location_name=(_pickup_location_name); end
# Rental rate.
sig { returns(T.nilable(Integer)) }
def rate_amount; end
sig { params(_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def rate_amount=(_rate_amount); end
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
sig { returns(T.nilable(String)) }
def rate_interval; end
sig { params(_rate_interval: T.nilable(String)).returns(T.nilable(String)) }
def rate_interval=(_rate_interval); end
# The name of the person or entity renting the car.
sig { returns(T.nilable(String)) }
def renter_name; end
sig { params(_renter_name: T.nilable(String)).returns(T.nilable(String)) }
def renter_name=(_renter_name); end
# Car return address.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address; end
sig {
params(_return_address: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::ReturnAddress)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address=(_return_address); end
# Car return time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def return_at; end
sig { params(_return_at: Integer).returns(Integer) }
def return_at=(_return_at); end
# Name of the return location.
sig { returns(T.nilable(String)) }
def return_location_name; end
sig { params(_return_location_name: T.nilable(String)).returns(T.nilable(String)) }
def return_location_name=(_return_location_name); end
# Indicates whether the goods or services are tax-exempt or tax is not collected.
sig { returns(T.nilable(T::Boolean)) }
def tax_exempt; end
sig { params(_tax_exempt: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def tax_exempt=(_tax_exempt); end
# The vehicle identification number.
sig { returns(T.nilable(String)) }
def vehicle_identification_number; end
sig {
params(_vehicle_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def vehicle_identification_number=(_vehicle_identification_number); end
sig {
params(affiliate: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Affiliate), booking_number: String, car_class_code: T.nilable(String), car_make: T.nilable(String), car_model: T.nilable(String), company: T.nilable(String), customer_service_phone_number: T.nilable(String), days_rented: Integer, delivery: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Delivery), distance: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Distance), drivers: T.nilable(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Driver]), extra_charges: T.nilable(T::Array[String]), no_show: T.nilable(T::Boolean), pickup_address: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::PickupAddress), pickup_at: Integer, pickup_location_name: T.nilable(String), rate_amount: T.nilable(Integer), rate_interval: T.nilable(String), renter_name: T.nilable(String), return_address: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::ReturnAddress), return_at: Integer, return_location_name: T.nilable(String), tax_exempt: T.nilable(T::Boolean), vehicle_identification_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
booking_number: nil,
car_class_code: nil,
car_make: nil,
car_model: nil,
company: nil,
customer_service_phone_number: nil,
days_rented: nil,
delivery: nil,
distance: nil,
drivers: nil,
extra_charges: nil,
no_show: nil,
pickup_address: nil,
pickup_at: nil,
pickup_location_name: nil,
rate_amount: nil,
rate_interval: nil,
renter_name: nil,
return_address: nil,
return_at: nil,
return_location_name: nil,
tax_exempt: nil,
vehicle_identification_number: nil
); end
end
class EventDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
# Indicates if the tickets are digitally checked when entering the venue.
sig { returns(T.nilable(T::Boolean)) }
def access_controlled_venue; end
sig {
params(_access_controlled_venue: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def access_controlled_venue=(_access_controlled_venue); end
# The event location's address.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Address)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Address))
}
def address=(_address); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Affiliate)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate=(_affiliate); end
# The name of the company
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Delivery)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Delivery))
}
def delivery=(_delivery); end
# Event end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Type of the event entertainment (concert, sports event etc)
sig { returns(T.nilable(String)) }
def genre; end
sig { params(_genre: T.nilable(String)).returns(T.nilable(String)) }
def genre=(_genre); end
# The name of the event.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Event start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(access_controlled_venue: T.nilable(T::Boolean), address: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Address), affiliate: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Affiliate), company: T.nilable(String), delivery: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Delivery), ends_at: T.nilable(Integer), genre: T.nilable(String), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
access_controlled_venue: nil,
address: nil,
affiliate: nil,
company: nil,
delivery: nil,
ends_at: nil,
genre: nil,
name: nil,
starts_at: nil
); end
end
class Flight < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Delivery::Recipient)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the flight reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Segment < Stripe::RequestParams
# The flight segment amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The International Air Transport Association (IATA) airport code for the arrival airport.
sig { returns(T.nilable(String)) }
def arrival_airport; end
sig { params(_arrival_airport: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport=(_arrival_airport); end
# The arrival time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def arrives_at; end
sig { params(_arrives_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def arrives_at=(_arrives_at); end
# The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The departure time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def departs_at; end
sig { params(_departs_at: Integer).returns(Integer) }
def departs_at=(_departs_at); end
# The International Air Transport Association (IATA) airport code for the departure airport.
sig { returns(T.nilable(String)) }
def departure_airport; end
sig { params(_departure_airport: T.nilable(String)).returns(T.nilable(String)) }
def departure_airport=(_departure_airport); end
# The flight number associated with the segment
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The fare class for the segment.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
sig {
params(amount: T.nilable(Integer), arrival_airport: T.nilable(String), arrives_at: T.nilable(Integer), carrier: T.nilable(String), departs_at: Integer, departure_airport: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String)).void
}
def initialize(
amount: nil,
arrival_airport: nil,
arrives_at: nil,
carrier: nil,
departs_at: nil,
departure_airport: nil,
flight_number: nil,
service_class: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Affiliate)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Affiliate))
}
def affiliate=(_affiliate); end
# The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
sig { returns(T.nilable(String)) }
def agency_number; end
sig { params(_agency_number: T.nilable(String)).returns(T.nilable(String)) }
def agency_number=(_agency_number); end
# The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Delivery)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Delivery))
}
def delivery=(_delivery); end
# The name of the person or entity on the reservation.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# The details of the passengers in the travel reservation.
sig {
returns(T.nilable(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Passenger])).returns(T.nilable(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Passenger]))
}
def passengers=(_passengers); end
# The individual flight segments associated with the trip.
sig { returns(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Segment]) }
def segments; end
sig {
params(_segments: T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Segment]).returns(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Segment])
}
def segments=(_segments); end
# The ticket number associated with the travel reservation.
sig { returns(T.nilable(String)) }
def ticket_number; end
sig { params(_ticket_number: T.nilable(String)).returns(T.nilable(String)) }
def ticket_number=(_ticket_number); end
sig {
params(affiliate: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Affiliate), agency_number: T.nilable(String), carrier: T.nilable(String), delivery: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Delivery), passenger_name: T.nilable(String), passengers: T.nilable(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Passenger]), segments: T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Segment], ticket_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
agency_number: nil,
carrier: nil,
delivery: nil,
passenger_name: nil,
passengers: nil,
segments: nil,
ticket_number: nil
); end
end
class Lodging < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the lodging reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
# The lodging location's address.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Address)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Address))
}
def address=(_address); end
# The number of adults on the booking
sig { returns(T.nilable(Integer)) }
def adults; end
sig { params(_adults: T.nilable(Integer)).returns(T.nilable(Integer)) }
def adults=(_adults); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Affiliate)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the lodging reservation.
sig { returns(T.nilable(String)) }
def booking_number; end
sig { params(_booking_number: T.nilable(String)).returns(T.nilable(String)) }
def booking_number=(_booking_number); end
# The lodging category
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Lodging check-in time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkin_at; end
sig { params(_checkin_at: Integer).returns(Integer) }
def checkin_at=(_checkin_at); end
# Lodging check-out time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkout_at; end
sig { params(_checkout_at: Integer).returns(Integer) }
def checkout_at=(_checkout_at); end
# The customer service phone number of the lodging company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# The daily lodging room rate.
sig { returns(T.nilable(Integer)) }
def daily_room_rate_amount; end
sig { params(_daily_room_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def daily_room_rate_amount=(_daily_room_rate_amount); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Delivery)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Delivery))
}
def delivery=(_delivery); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates whether the lodging location is compliant with the Fire Safety Act.
sig { returns(T.nilable(T::Boolean)) }
def fire_safety_act_compliance; end
sig {
params(_fire_safety_act_compliance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def fire_safety_act_compliance=(_fire_safety_act_compliance); end
# The name of the lodging location.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Indicates if the customer did not keep their booking while failing to cancel the reservation.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# The number of rooms on the booking
sig { returns(T.nilable(Integer)) }
def number_of_rooms; end
sig { params(_number_of_rooms: T.nilable(Integer)).returns(T.nilable(Integer)) }
def number_of_rooms=(_number_of_rooms); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Passenger])).returns(T.nilable(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Passenger]))
}
def passengers=(_passengers); end
# The phone number of the lodging location.
sig { returns(T.nilable(String)) }
def property_phone_number; end
sig { params(_property_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def property_phone_number=(_property_phone_number); end
# The room class for this purchase.
sig { returns(T.nilable(String)) }
def room_class; end
sig { params(_room_class: T.nilable(String)).returns(T.nilable(String)) }
def room_class=(_room_class); end
# The number of room nights
sig { returns(T.nilable(Integer)) }
def room_nights; end
sig { params(_room_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def room_nights=(_room_nights); end
# The total tax amount associating with the room reservation.
sig { returns(T.nilable(Integer)) }
def total_room_tax_amount; end
sig { params(_total_room_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_room_tax_amount=(_total_room_tax_amount); end
# The total tax amount
sig { returns(T.nilable(Integer)) }
def total_tax_amount; end
sig { params(_total_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_tax_amount=(_total_tax_amount); end
sig {
params(address: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Address), adults: T.nilable(Integer), affiliate: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Affiliate), booking_number: T.nilable(String), category: T.nilable(String), checkin_at: Integer, checkout_at: Integer, customer_service_phone_number: T.nilable(String), daily_room_rate_amount: T.nilable(Integer), delivery: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Delivery), extra_charges: T.nilable(T::Array[String]), fire_safety_act_compliance: T.nilable(T::Boolean), name: T.nilable(String), no_show: T.nilable(T::Boolean), number_of_rooms: T.nilable(Integer), passengers: T.nilable(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Passenger]), property_phone_number: T.nilable(String), room_class: T.nilable(String), room_nights: T.nilable(Integer), total_room_tax_amount: T.nilable(Integer), total_tax_amount: T.nilable(Integer)).void
}
def initialize(
address: nil,
adults: nil,
affiliate: nil,
booking_number: nil,
category: nil,
checkin_at: nil,
checkout_at: nil,
customer_service_phone_number: nil,
daily_room_rate_amount: nil,
delivery: nil,
extra_charges: nil,
fire_safety_act_compliance: nil,
name: nil,
no_show: nil,
number_of_rooms: nil,
passengers: nil,
property_phone_number: nil,
room_class: nil,
room_nights: nil,
total_room_tax_amount: nil,
total_tax_amount: nil
); end
end
class Subscription < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class BillingInterval < Stripe::RequestParams
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def count; end
sig { params(_count: Integer).returns(Integer) }
def count=(_count); end
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig { params(count: Integer, interval: String).void }
def initialize(count: nil, interval: nil); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription::Affiliate)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate=(_affiliate); end
# Info whether the subscription will be auto renewed upon expiry.
sig { returns(T.nilable(T::Boolean)) }
def auto_renewal; end
sig { params(_auto_renewal: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_renewal=(_auto_renewal); end
# Subscription billing details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval; end
sig {
params(_billing_interval: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription::BillingInterval)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval=(_billing_interval); end
# Subscription end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Name of the product on subscription. e.g. Apple Music Subscription
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Subscription start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(affiliate: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription::Affiliate), auto_renewal: T.nilable(T::Boolean), billing_interval: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription::BillingInterval), ends_at: T.nilable(Integer), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
affiliate: nil,
auto_renewal: nil,
billing_interval: nil,
ends_at: nil,
name: nil,
starts_at: nil
); end
end
# Car rental details for this PaymentIntent.
sig { returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental)) }
def car_rental; end
sig {
params(_car_rental: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental))
}
def car_rental=(_car_rental); end
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
sig { returns(T.nilable(String)) }
def customer_reference; end
sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) }
def customer_reference=(_customer_reference); end
# Event details for this PaymentIntent
sig { returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails)) }
def event_details; end
sig {
params(_event_details: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails))
}
def event_details=(_event_details); end
# Flight reservation details for this PaymentIntent
sig { returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Flight)) }
def flight; end
sig {
params(_flight: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Flight)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Flight))
}
def flight=(_flight); end
# Lodging reservation details for this PaymentIntent
sig { returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging)) }
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging))
}
def lodging=(_lodging); end
# A unique value assigned by the business to identify the transaction.
sig { returns(T.nilable(String)) }
def order_reference; end
sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) }
def order_reference=(_order_reference); end
# Subscription details for this PaymentIntent
sig { returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription)) }
def subscription; end
sig {
params(_subscription: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription))
}
def subscription=(_subscription); end
sig {
params(car_rental: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental), customer_reference: T.nilable(String), event_details: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails), flight: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Flight), lodging: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging), order_reference: T.nilable(String), subscription: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription)).void
}
def initialize(
car_rental: nil,
customer_reference: nil,
event_details: nil,
flight: nil,
lodging: nil,
order_reference: nil,
subscription: nil
); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address.
sig { returns(::Stripe::Charge::UpdateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::Charge::UpdateParams::Shipping::Address).returns(::Stripe::Charge::UpdateParams::Shipping::Address)
}
def address=(_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
sig { params(_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def tracking_number=(_tracking_number); end
sig {
params(address: ::Stripe::Charge::UpdateParams::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
}
def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
end
# The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms.
sig { returns(T.nilable(::Stripe::Charge::UpdateParams::FraudDetails)) }
def fraud_details; end
sig {
params(_fraud_details: T.nilable(::Stripe::Charge::UpdateParams::FraudDetails)).returns(T.nilable(::Stripe::Charge::UpdateParams::FraudDetails))
}
def fraud_details=(_fraud_details); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Provides industry-specific information about the charge.
sig { returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails)) }
def payment_details; end
sig {
params(_payment_details: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails)).returns(T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails))
}
def payment_details=(_payment_details); end
# This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.
sig { returns(T.nilable(String)) }
def receipt_email; end
sig { params(_receipt_email: T.nilable(String)).returns(T.nilable(String)) }
def receipt_email=(_receipt_email); end
# Shipping information for the charge. Helps prevent fraud on charges for physical goods.
sig { returns(T.nilable(::Stripe::Charge::UpdateParams::Shipping)) }
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::Charge::UpdateParams::Shipping)).returns(T.nilable(::Stripe::Charge::UpdateParams::Shipping))
}
def shipping=(_shipping); end
# A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(customer: T.nilable(String), description: T.nilable(String), expand: T.nilable(T::Array[String]), fraud_details: T.nilable(::Stripe::Charge::UpdateParams::FraudDetails), metadata: T.nilable(T.any(String, T::Hash[String, String])), payment_details: T.nilable(::Stripe::Charge::UpdateParams::PaymentDetails), receipt_email: T.nilable(String), shipping: T.nilable(::Stripe::Charge::UpdateParams::Shipping), transfer_group: T.nilable(String)).void
}
def initialize(
customer: nil,
description: nil,
expand: nil,
fraud_details: nil,
metadata: nil,
payment_details: nil,
receipt_email: nil,
shipping: nil,
transfer_group: nil
); end
end
class SearchParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
sig { returns(T.nilable(String)) }
def page; end
sig { params(_page: T.nilable(String)).returns(T.nilable(String)) }
def page=(_page); end
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for charges](https://stripe.com/docs/search#query-fields-for-charges).
sig { returns(String) }
def query; end
sig { params(_query: String).returns(String) }
def query=(_query); end
sig {
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
}
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
end
class CaptureParams < Stripe::RequestParams
class PaymentDetails < Stripe::RequestParams
class CarRental < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Distance < Stripe::RequestParams
# Distance traveled.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
sig { params(amount: T.nilable(Integer), unit: T.nilable(String)).void }
def initialize(amount: nil, unit: nil); end
end
class Driver < Stripe::RequestParams
# Driver's identification number.
sig { returns(T.nilable(String)) }
def driver_identification_number; end
sig {
params(_driver_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def driver_identification_number=(_driver_identification_number); end
# Driver's tax number.
sig { returns(T.nilable(String)) }
def driver_tax_number; end
sig { params(_driver_tax_number: T.nilable(String)).returns(T.nilable(String)) }
def driver_tax_number=(_driver_tax_number); end
# Full name of the person or entity on the car reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(driver_identification_number: T.nilable(String), driver_tax_number: T.nilable(String), name: String).void
}
def initialize(
driver_identification_number: nil,
driver_tax_number: nil,
name: nil
); end
end
class PickupAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class ReturnAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Affiliate)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the car rental.
sig { returns(String) }
def booking_number; end
sig { params(_booking_number: String).returns(String) }
def booking_number=(_booking_number); end
# Class code of the car.
sig { returns(T.nilable(String)) }
def car_class_code; end
sig { params(_car_class_code: T.nilable(String)).returns(T.nilable(String)) }
def car_class_code=(_car_class_code); end
# Make of the car.
sig { returns(T.nilable(String)) }
def car_make; end
sig { params(_car_make: T.nilable(String)).returns(T.nilable(String)) }
def car_make=(_car_make); end
# Model of the car.
sig { returns(T.nilable(String)) }
def car_model; end
sig { params(_car_model: T.nilable(String)).returns(T.nilable(String)) }
def car_model=(_car_model); end
# The name of the rental car company.
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# The customer service phone number of the car rental company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# Number of days the car is being rented.
sig { returns(Integer) }
def days_rented; end
sig { params(_days_rented: Integer).returns(Integer) }
def days_rented=(_days_rented); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Delivery)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Delivery))
}
def delivery=(_delivery); end
# The details of the distance traveled during the rental period.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Distance))
}
def distance; end
sig {
params(_distance: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Distance)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Distance))
}
def distance=(_distance); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Driver]))
}
def drivers; end
sig {
params(_drivers: T.nilable(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Driver])).returns(T.nilable(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Driver]))
}
def drivers=(_drivers); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates if the customer did not keep nor cancel their booking.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# Car pick-up address.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address; end
sig {
params(_pickup_address: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::PickupAddress)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address=(_pickup_address); end
# Car pick-up time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def pickup_at; end
sig { params(_pickup_at: Integer).returns(Integer) }
def pickup_at=(_pickup_at); end
# Name of the pickup location.
sig { returns(T.nilable(String)) }
def pickup_location_name; end
sig { params(_pickup_location_name: T.nilable(String)).returns(T.nilable(String)) }
def pickup_location_name=(_pickup_location_name); end
# Rental rate.
sig { returns(T.nilable(Integer)) }
def rate_amount; end
sig { params(_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def rate_amount=(_rate_amount); end
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
sig { returns(T.nilable(String)) }
def rate_interval; end
sig { params(_rate_interval: T.nilable(String)).returns(T.nilable(String)) }
def rate_interval=(_rate_interval); end
# The name of the person or entity renting the car.
sig { returns(T.nilable(String)) }
def renter_name; end
sig { params(_renter_name: T.nilable(String)).returns(T.nilable(String)) }
def renter_name=(_renter_name); end
# Car return address.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address; end
sig {
params(_return_address: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::ReturnAddress)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address=(_return_address); end
# Car return time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def return_at; end
sig { params(_return_at: Integer).returns(Integer) }
def return_at=(_return_at); end
# Name of the return location.
sig { returns(T.nilable(String)) }
def return_location_name; end
sig { params(_return_location_name: T.nilable(String)).returns(T.nilable(String)) }
def return_location_name=(_return_location_name); end
# Indicates whether the goods or services are tax-exempt or tax is not collected.
sig { returns(T.nilable(T::Boolean)) }
def tax_exempt; end
sig { params(_tax_exempt: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def tax_exempt=(_tax_exempt); end
# The vehicle identification number.
sig { returns(T.nilable(String)) }
def vehicle_identification_number; end
sig {
params(_vehicle_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def vehicle_identification_number=(_vehicle_identification_number); end
sig {
params(affiliate: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Affiliate), booking_number: String, car_class_code: T.nilable(String), car_make: T.nilable(String), car_model: T.nilable(String), company: T.nilable(String), customer_service_phone_number: T.nilable(String), days_rented: Integer, delivery: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Delivery), distance: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Distance), drivers: T.nilable(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Driver]), extra_charges: T.nilable(T::Array[String]), no_show: T.nilable(T::Boolean), pickup_address: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::PickupAddress), pickup_at: Integer, pickup_location_name: T.nilable(String), rate_amount: T.nilable(Integer), rate_interval: T.nilable(String), renter_name: T.nilable(String), return_address: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::ReturnAddress), return_at: Integer, return_location_name: T.nilable(String), tax_exempt: T.nilable(T::Boolean), vehicle_identification_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
booking_number: nil,
car_class_code: nil,
car_make: nil,
car_model: nil,
company: nil,
customer_service_phone_number: nil,
days_rented: nil,
delivery: nil,
distance: nil,
drivers: nil,
extra_charges: nil,
no_show: nil,
pickup_address: nil,
pickup_at: nil,
pickup_location_name: nil,
rate_amount: nil,
rate_interval: nil,
renter_name: nil,
return_address: nil,
return_at: nil,
return_location_name: nil,
tax_exempt: nil,
vehicle_identification_number: nil
); end
end
class EventDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
# Indicates if the tickets are digitally checked when entering the venue.
sig { returns(T.nilable(T::Boolean)) }
def access_controlled_venue; end
sig {
params(_access_controlled_venue: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def access_controlled_venue=(_access_controlled_venue); end
# The event location's address.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Address)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Address))
}
def address=(_address); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Affiliate)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate=(_affiliate); end
# The name of the company
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Delivery)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Delivery))
}
def delivery=(_delivery); end
# Event end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Type of the event entertainment (concert, sports event etc)
sig { returns(T.nilable(String)) }
def genre; end
sig { params(_genre: T.nilable(String)).returns(T.nilable(String)) }
def genre=(_genre); end
# The name of the event.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Event start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(access_controlled_venue: T.nilable(T::Boolean), address: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Address), affiliate: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Affiliate), company: T.nilable(String), delivery: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Delivery), ends_at: T.nilable(Integer), genre: T.nilable(String), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
access_controlled_venue: nil,
address: nil,
affiliate: nil,
company: nil,
delivery: nil,
ends_at: nil,
genre: nil,
name: nil,
starts_at: nil
); end
end
class Flight < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Delivery::Recipient)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the flight reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Segment < Stripe::RequestParams
# The flight segment amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The International Air Transport Association (IATA) airport code for the arrival airport.
sig { returns(T.nilable(String)) }
def arrival_airport; end
sig { params(_arrival_airport: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport=(_arrival_airport); end
# The arrival time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def arrives_at; end
sig { params(_arrives_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def arrives_at=(_arrives_at); end
# The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The departure time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def departs_at; end
sig { params(_departs_at: Integer).returns(Integer) }
def departs_at=(_departs_at); end
# The International Air Transport Association (IATA) airport code for the departure airport.
sig { returns(T.nilable(String)) }
def departure_airport; end
sig { params(_departure_airport: T.nilable(String)).returns(T.nilable(String)) }
def departure_airport=(_departure_airport); end
# The flight number associated with the segment
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The fare class for the segment.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
sig {
params(amount: T.nilable(Integer), arrival_airport: T.nilable(String), arrives_at: T.nilable(Integer), carrier: T.nilable(String), departs_at: Integer, departure_airport: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String)).void
}
def initialize(
amount: nil,
arrival_airport: nil,
arrives_at: nil,
carrier: nil,
departs_at: nil,
departure_airport: nil,
flight_number: nil,
service_class: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Affiliate)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Affiliate))
}
def affiliate=(_affiliate); end
# The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
sig { returns(T.nilable(String)) }
def agency_number; end
sig { params(_agency_number: T.nilable(String)).returns(T.nilable(String)) }
def agency_number=(_agency_number); end
# The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Delivery)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Delivery))
}
def delivery=(_delivery); end
# The name of the person or entity on the reservation.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# The details of the passengers in the travel reservation.
sig {
returns(T.nilable(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Passenger])).returns(T.nilable(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Passenger]))
}
def passengers=(_passengers); end
# The individual flight segments associated with the trip.
sig {
returns(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Segment])
}
def segments; end
sig {
params(_segments: T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Segment]).returns(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Segment])
}
def segments=(_segments); end
# The ticket number associated with the travel reservation.
sig { returns(T.nilable(String)) }
def ticket_number; end
sig { params(_ticket_number: T.nilable(String)).returns(T.nilable(String)) }
def ticket_number=(_ticket_number); end
sig {
params(affiliate: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Affiliate), agency_number: T.nilable(String), carrier: T.nilable(String), delivery: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Delivery), passenger_name: T.nilable(String), passengers: T.nilable(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Passenger]), segments: T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Segment], ticket_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
agency_number: nil,
carrier: nil,
delivery: nil,
passenger_name: nil,
passengers: nil,
segments: nil,
ticket_number: nil
); end
end
class Lodging < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the lodging reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
# The lodging location's address.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Address)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Address))
}
def address=(_address); end
# The number of adults on the booking
sig { returns(T.nilable(Integer)) }
def adults; end
sig { params(_adults: T.nilable(Integer)).returns(T.nilable(Integer)) }
def adults=(_adults); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Affiliate)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the lodging reservation.
sig { returns(T.nilable(String)) }
def booking_number; end
sig { params(_booking_number: T.nilable(String)).returns(T.nilable(String)) }
def booking_number=(_booking_number); end
# The lodging category
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Lodging check-in time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkin_at; end
sig { params(_checkin_at: Integer).returns(Integer) }
def checkin_at=(_checkin_at); end
# Lodging check-out time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkout_at; end
sig { params(_checkout_at: Integer).returns(Integer) }
def checkout_at=(_checkout_at); end
# The customer service phone number of the lodging company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# The daily lodging room rate.
sig { returns(T.nilable(Integer)) }
def daily_room_rate_amount; end
sig { params(_daily_room_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def daily_room_rate_amount=(_daily_room_rate_amount); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Delivery)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Delivery))
}
def delivery=(_delivery); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates whether the lodging location is compliant with the Fire Safety Act.
sig { returns(T.nilable(T::Boolean)) }
def fire_safety_act_compliance; end
sig {
params(_fire_safety_act_compliance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def fire_safety_act_compliance=(_fire_safety_act_compliance); end
# The name of the lodging location.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Indicates if the customer did not keep their booking while failing to cancel the reservation.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# The number of rooms on the booking
sig { returns(T.nilable(Integer)) }
def number_of_rooms; end
sig { params(_number_of_rooms: T.nilable(Integer)).returns(T.nilable(Integer)) }
def number_of_rooms=(_number_of_rooms); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Passenger])).returns(T.nilable(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Passenger]))
}
def passengers=(_passengers); end
# The phone number of the lodging location.
sig { returns(T.nilable(String)) }
def property_phone_number; end
sig { params(_property_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def property_phone_number=(_property_phone_number); end
# The room class for this purchase.
sig { returns(T.nilable(String)) }
def room_class; end
sig { params(_room_class: T.nilable(String)).returns(T.nilable(String)) }
def room_class=(_room_class); end
# The number of room nights
sig { returns(T.nilable(Integer)) }
def room_nights; end
sig { params(_room_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def room_nights=(_room_nights); end
# The total tax amount associating with the room reservation.
sig { returns(T.nilable(Integer)) }
def total_room_tax_amount; end
sig { params(_total_room_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_room_tax_amount=(_total_room_tax_amount); end
# The total tax amount
sig { returns(T.nilable(Integer)) }
def total_tax_amount; end
sig { params(_total_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_tax_amount=(_total_tax_amount); end
sig {
params(address: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Address), adults: T.nilable(Integer), affiliate: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Affiliate), booking_number: T.nilable(String), category: T.nilable(String), checkin_at: Integer, checkout_at: Integer, customer_service_phone_number: T.nilable(String), daily_room_rate_amount: T.nilable(Integer), delivery: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Delivery), extra_charges: T.nilable(T::Array[String]), fire_safety_act_compliance: T.nilable(T::Boolean), name: T.nilable(String), no_show: T.nilable(T::Boolean), number_of_rooms: T.nilable(Integer), passengers: T.nilable(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Passenger]), property_phone_number: T.nilable(String), room_class: T.nilable(String), room_nights: T.nilable(Integer), total_room_tax_amount: T.nilable(Integer), total_tax_amount: T.nilable(Integer)).void
}
def initialize(
address: nil,
adults: nil,
affiliate: nil,
booking_number: nil,
category: nil,
checkin_at: nil,
checkout_at: nil,
customer_service_phone_number: nil,
daily_room_rate_amount: nil,
delivery: nil,
extra_charges: nil,
fire_safety_act_compliance: nil,
name: nil,
no_show: nil,
number_of_rooms: nil,
passengers: nil,
property_phone_number: nil,
room_class: nil,
room_nights: nil,
total_room_tax_amount: nil,
total_tax_amount: nil
); end
end
class Subscription < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class BillingInterval < Stripe::RequestParams
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def count; end
sig { params(_count: Integer).returns(Integer) }
def count=(_count); end
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig { params(count: Integer, interval: String).void }
def initialize(count: nil, interval: nil); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription::Affiliate)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate=(_affiliate); end
# Info whether the subscription will be auto renewed upon expiry.
sig { returns(T.nilable(T::Boolean)) }
def auto_renewal; end
sig { params(_auto_renewal: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_renewal=(_auto_renewal); end
# Subscription billing details for this purchase.
sig {
returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval; end
sig {
params(_billing_interval: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription::BillingInterval)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval=(_billing_interval); end
# Subscription end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Name of the product on subscription. e.g. Apple Music Subscription
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Subscription start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(affiliate: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription::Affiliate), auto_renewal: T.nilable(T::Boolean), billing_interval: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription::BillingInterval), ends_at: T.nilable(Integer), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
affiliate: nil,
auto_renewal: nil,
billing_interval: nil,
ends_at: nil,
name: nil,
starts_at: nil
); end
end
# Car rental details for this PaymentIntent.
sig { returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental)) }
def car_rental; end
sig {
params(_car_rental: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental))
}
def car_rental=(_car_rental); end
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
sig { returns(T.nilable(String)) }
def customer_reference; end
sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) }
def customer_reference=(_customer_reference); end
# Event details for this PaymentIntent
sig { returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails)) }
def event_details; end
sig {
params(_event_details: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails))
}
def event_details=(_event_details); end
# Flight reservation details for this PaymentIntent
sig { returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Flight)) }
def flight; end
sig {
params(_flight: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Flight)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Flight))
}
def flight=(_flight); end
# Lodging reservation details for this PaymentIntent
sig { returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging)) }
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging))
}
def lodging=(_lodging); end
# A unique value assigned by the business to identify the transaction.
sig { returns(T.nilable(String)) }
def order_reference; end
sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) }
def order_reference=(_order_reference); end
# Subscription details for this PaymentIntent
sig { returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription)) }
def subscription; end
sig {
params(_subscription: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription))
}
def subscription=(_subscription); end
sig {
params(car_rental: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental), customer_reference: T.nilable(String), event_details: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails), flight: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Flight), lodging: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging), order_reference: T.nilable(String), subscription: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription)).void
}
def initialize(
car_rental: nil,
customer_reference: nil,
event_details: nil,
flight: nil,
lodging: nil,
order_reference: nil,
subscription: nil
); end
end
class TransferData < Stripe::RequestParams
# The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
sig { params(amount: T.nilable(Integer)).void }
def initialize(amount: nil); end
end
# The amount to capture, which must be less than or equal to the original amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# An application fee to add on to this charge.
sig { returns(T.nilable(Integer)) }
def application_fee; end
sig { params(_application_fee: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee=(_application_fee); end
# An application fee amount to add on to this charge, which must be less than or equal to the original amount.
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Provides industry-specific information about the charge.
sig { returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails)) }
def payment_details; end
sig {
params(_payment_details: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails)).returns(T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails))
}
def payment_details=(_payment_details); end
# The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.
sig { returns(T.nilable(String)) }
def receipt_email; end
sig { params(_receipt_email: T.nilable(String)).returns(T.nilable(String)) }
def receipt_email=(_receipt_email); end
# For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
sig { returns(T.nilable(::Stripe::Charge::CaptureParams::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::Charge::CaptureParams::TransferData)).returns(T.nilable(::Stripe::Charge::CaptureParams::TransferData))
}
def transfer_data=(_transfer_data); end
# A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(amount: T.nilable(Integer), application_fee: T.nilable(Integer), application_fee_amount: T.nilable(Integer), expand: T.nilable(T::Array[String]), payment_details: T.nilable(::Stripe::Charge::CaptureParams::PaymentDetails), receipt_email: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::Charge::CaptureParams::TransferData), transfer_group: T.nilable(String)).void
}
def initialize(
amount: nil,
application_fee: nil,
application_fee_amount: nil,
expand: nil,
payment_details: nil,
receipt_email: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil,
transfer_group: nil
); end
end
# Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
#
# Uncaptured payments expire a set number of days after they are created ([7 by default](https://docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
#
# Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/capture).
sig {
params(params: T.any(::Stripe::Charge::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge)
}
def capture(params = {}, opts = {}); end
# Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
#
# Uncaptured payments expire a set number of days after they are created ([7 by default](https://docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
#
# Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/capture).
sig {
params(charge: String, params: T.any(::Stripe::Charge::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge)
}
def self.capture(charge, params = {}, opts = {}); end
# This method is no longer recommended—use the [Payment Intents API](https://docs.stripe.com/docs/api/payment_intents)
# to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge
# object used to request payment.
sig {
params(params: T.any(::Stripe::Charge::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge)
}
def self.create(params = {}, opts = {}); end
# Returns a list of charges you've previously created. The charges are returned in sorted order, with the most recent charges appearing first.
sig {
params(params: T.any(::Stripe::Charge::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
sig {
params(params: T.any(::Stripe::Charge::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
}
def self.search(params = {}, opts = {}); end
sig {
params(params: T.any(::Stripe::Charge::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, blk: T.untyped).returns(Stripe::SearchResultObject)
}
def self.search_auto_paging_each(params = {}, opts = {}, &blk); end
# Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(charge: String, params: T.any(::Stripe::Charge::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge)
}
def self.update(charge, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
module Checkout
# A Checkout Session represents your customer's session as they pay for
# one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)
# or [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a
# new Session each time your customer attempts to pay.
#
# Once payment is successful, the Checkout Session will contain a reference
# to the [Customer](https://stripe.com/docs/api/customers), and either the successful
# [PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active
# [Subscription](https://stripe.com/docs/api/subscriptions).
#
# You can create a Checkout Session on your server and redirect to its URL
# to begin Checkout.
#
# Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)
class Session < APIResource
class AdaptivePricing < Stripe::StripeObject
# If enabled, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions).
sig { returns(T::Boolean) }
def enabled; end
end
class AfterExpiration < Stripe::StripeObject
class Recovery < Stripe::StripeObject
# Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
sig { returns(T::Boolean) }
def allow_promotion_codes; end
# If `true`, a recovery url will be generated to recover this Checkout Session if it
# expires before a transaction is completed. It will be attached to the
# Checkout Session object upon expiration.
sig { returns(T::Boolean) }
def enabled; end
# The timestamp at which the recovery URL will expire.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session
sig { returns(T.nilable(String)) }
def url; end
end
# When set, configuration used to recover the Checkout Session on expiry.
sig { returns(T.nilable(Recovery)) }
def recovery; end
end
class AutomaticTax < Stripe::StripeObject
class Liability < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# Indicates whether automatic tax is enabled for the session
sig { returns(T::Boolean) }
def enabled; end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(Liability)) }
def liability; end
# The tax provider powering automatic tax.
sig { returns(T.nilable(String)) }
def provider; end
# The status of the most recent automated tax calculation for this session.
sig { returns(T.nilable(String)) }
def status; end
end
class BrandingSettings < Stripe::StripeObject
class Icon < Stripe::StripeObject; end
class Logo < Stripe::StripeObject; end
# A hex color value starting with `#` representing the background color for the Checkout Session.
sig { returns(String) }
def background_color; end
# The border style for the Checkout Session. Must be one of `rounded`, `rectangular`, or `pill`.
sig { returns(String) }
def border_style; end
# A hex color value starting with `#` representing the button color for the Checkout Session.
sig { returns(String) }
def button_color; end
# The display name shown on the Checkout Session.
sig { returns(String) }
def display_name; end
# The font family for the Checkout Session. Must be one of the [supported font families](https://docs.stripe.com/payments/checkout/customization/appearance?payment-ui=stripe-hosted#font-compatibility).
sig { returns(String) }
def font_family; end
# The icon for the Checkout Session. You cannot set both `logo` and `icon`.
sig { returns(T.nilable(Icon)) }
def icon; end
# The logo for the Checkout Session. You cannot set both `logo` and `icon`.
sig { returns(T.nilable(Logo)) }
def logo; end
end
class CollectedInformation < Stripe::StripeObject
class ShippingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(Address) }
def address; end
# Customer name.
sig { returns(String) }
def name; end
end
class TaxId < Stripe::StripeObject
# The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
sig { returns(String) }
def type; end
# The value of the tax ID.
sig { returns(T.nilable(String)) }
def value; end
end
# Customer’s business name for this Checkout Session
sig { returns(T.nilable(String)) }
def business_name; end
# Customer’s email for this Checkout Session
sig { returns(T.nilable(String)) }
def email; end
# Customer’s individual name for this Checkout Session
sig { returns(T.nilable(String)) }
def individual_name; end
# Customer’s phone number for this Checkout Session
sig { returns(T.nilable(String)) }
def phone; end
# Shipping information for this Checkout Session.
sig { returns(T.nilable(ShippingDetails)) }
def shipping_details; end
# Customer’s tax ids for this Checkout Session.
sig { returns(T.nilable(T::Array[TaxId])) }
def tax_ids; end
end
class Consent < Stripe::StripeObject
# If `opt_in`, the customer consents to receiving promotional communications
# from the merchant about this Checkout Session.
sig { returns(T.nilable(String)) }
def promotions; end
# If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.
sig { returns(T.nilable(String)) }
def terms_of_service; end
end
class ConsentCollection < Stripe::StripeObject
class PaymentMethodReuseAgreement < Stripe::StripeObject
# Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.
#
# When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
sig { returns(String) }
def position; end
end
# If set to `hidden`, it will hide legal text related to the reuse of a payment method.
sig { returns(T.nilable(PaymentMethodReuseAgreement)) }
def payment_method_reuse_agreement; end
# If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
# Session will determine whether to display an option to opt into promotional communication
# from the merchant depending on the customer's locale. Only available to US merchants.
sig { returns(T.nilable(String)) }
def promotions; end
# If set to `required`, it requires customers to accept the terms of service before being able to pay.
sig { returns(T.nilable(String)) }
def terms_of_service; end
end
class CurrencyConversion < Stripe::StripeObject
# Total of all items in source currency before discounts or taxes are applied.
sig { returns(Integer) }
def amount_subtotal; end
# Total of all items in source currency after discounts and taxes are applied.
sig { returns(Integer) }
def amount_total; end
# Exchange rate used to convert source currency amounts to customer currency amounts
sig { returns(String) }
def fx_rate; end
# Creation currency of the CheckoutSession before localization
sig { returns(String) }
def source_currency; end
end
class CustomField < Stripe::StripeObject
class Dropdown < Stripe::StripeObject
class Option < Stripe::StripeObject
# The label for the option, displayed to the customer. Up to 100 characters.
sig { returns(String) }
def label; end
# The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
sig { returns(String) }
def value; end
end
# The value that will pre-fill on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
# The options available for the customer to select. Up to 200 options allowed.
sig { returns(T::Array[Option]) }
def options; end
# The option selected by the customer. This will be the `value` for the option.
sig { returns(T.nilable(String)) }
def value; end
end
class Label < Stripe::StripeObject
# Custom text for the label, displayed to the customer. Up to 50 characters.
sig { returns(T.nilable(String)) }
def custom; end
# The type of the label.
sig { returns(String) }
def type; end
end
class Numeric < Stripe::StripeObject
# The value that will pre-fill the field on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
# The maximum character length constraint for the customer's input.
sig { returns(T.nilable(Integer)) }
def maximum_length; end
# The minimum character length requirement for the customer's input.
sig { returns(T.nilable(Integer)) }
def minimum_length; end
# The value entered by the customer, containing only digits.
sig { returns(T.nilable(String)) }
def value; end
end
class Text < Stripe::StripeObject
# The value that will pre-fill the field on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
# The maximum character length constraint for the customer's input.
sig { returns(T.nilable(Integer)) }
def maximum_length; end
# The minimum character length requirement for the customer's input.
sig { returns(T.nilable(Integer)) }
def minimum_length; end
# The value entered by the customer.
sig { returns(T.nilable(String)) }
def value; end
end
# Attribute for field dropdown
sig { returns(T.nilable(Dropdown)) }
def dropdown; end
# String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
sig { returns(String) }
def key; end
# Attribute for field label
sig { returns(Label) }
def label; end
# Attribute for field numeric
sig { returns(T.nilable(Numeric)) }
def numeric; end
# Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
sig { returns(T::Boolean) }
def optional; end
# Attribute for field text
sig { returns(T.nilable(Text)) }
def text; end
# The type of the field.
sig { returns(String) }
def type; end
end
class CustomText < Stripe::StripeObject
class AfterSubmit < Stripe::StripeObject
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
end
class ShippingAddress < Stripe::StripeObject
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
end
class Submit < Stripe::StripeObject
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
end
class TermsOfServiceAcceptance < Stripe::StripeObject
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
end
# Custom text that should be displayed after the payment confirmation button.
sig { returns(T.nilable(AfterSubmit)) }
def after_submit; end
# Custom text that should be displayed alongside shipping address collection.
sig { returns(T.nilable(ShippingAddress)) }
def shipping_address; end
# Custom text that should be displayed alongside the payment confirmation button.
sig { returns(T.nilable(Submit)) }
def submit; end
# Custom text that should be displayed in place of the default terms of service agreement text.
sig { returns(T.nilable(TermsOfServiceAcceptance)) }
def terms_of_service_acceptance; end
end
class CustomerDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class TaxId < Stripe::StripeObject
# The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
sig { returns(String) }
def type; end
# The value of the tax ID.
sig { returns(T.nilable(String)) }
def value; end
end
# The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
sig { returns(T.nilable(Address)) }
def address; end
# The customer's business name after a completed Checkout Session.
sig { returns(T.nilable(String)) }
def business_name; end
# The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.
# Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.
sig { returns(T.nilable(String)) }
def email; end
# The customer's individual name after a completed Checkout Session.
sig { returns(T.nilable(String)) }
def individual_name; end
# The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
sig { returns(T.nilable(String)) }
def name; end
# The customer's phone number after a completed Checkout Session.
sig { returns(T.nilable(String)) }
def phone; end
# The customer’s tax exempt status after a completed Checkout Session.
sig { returns(T.nilable(String)) }
def tax_exempt; end
# The customer’s tax IDs after a completed Checkout Session.
sig { returns(T.nilable(T::Array[TaxId])) }
def tax_ids; end
end
class Discount < Stripe::StripeObject
# Coupon attached to the Checkout Session.
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
def coupon; end
# Promotion code attached to the Checkout Session.
sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
def promotion_code; end
end
class InvoiceCreation < Stripe::StripeObject
class InvoiceData < Stripe::StripeObject
class CustomField < Stripe::StripeObject
# The name of the custom field.
sig { returns(String) }
def name; end
# The value of the custom field.
sig { returns(String) }
def value; end
end
class Issuer < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
class RenderingOptions < Stripe::StripeObject
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
sig { returns(T.nilable(String)) }
def amount_tax_display; end
# ID of the invoice rendering template to be used for the generated invoice.
sig { returns(T.nilable(String)) }
def template; end
end
# The account tax IDs associated with the invoice.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
def account_tax_ids; end
# Custom fields displayed on the invoice.
sig { returns(T.nilable(T::Array[CustomField])) }
def custom_fields; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# Footer displayed on the invoice.
sig { returns(T.nilable(String)) }
def footer; end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig { returns(T.nilable(Issuer)) }
def issuer; end
# 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])) }
def metadata; end
# Options for invoice PDF rendering.
sig { returns(T.nilable(RenderingOptions)) }
def rendering_options; end
end
# Indicates whether invoice creation is enabled for the Checkout Session.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field invoice_data
sig { returns(InvoiceData) }
def invoice_data; end
end
class NameCollection < Stripe::StripeObject
class Business < Stripe::StripeObject
# Indicates whether business name collection is enabled for the session
sig { returns(T::Boolean) }
def enabled; end
# Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
sig { returns(T::Boolean) }
def optional; end
end
class Individual < Stripe::StripeObject
# Indicates whether individual name collection is enabled for the session
sig { returns(T::Boolean) }
def enabled; end
# Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
sig { returns(T::Boolean) }
def optional; end
end
# Attribute for field business
sig { returns(T.nilable(Business)) }
def business; end
# Attribute for field individual
sig { returns(T.nilable(Individual)) }
def individual; end
end
class OptionalItem < Stripe::StripeObject
class AdjustableQuantity < Stripe::StripeObject
# Set to true if the quantity can be adjusted to any non-negative integer.
sig { returns(T::Boolean) }
def enabled; end
# The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.
sig { returns(T.nilable(Integer)) }
def maximum; end
# The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.
sig { returns(T.nilable(Integer)) }
def minimum; end
end
# Attribute for field adjustable_quantity
sig { returns(T.nilable(AdjustableQuantity)) }
def adjustable_quantity; end
# Attribute for field price
sig { returns(String) }
def price; end
# Attribute for field quantity
sig { returns(Integer) }
def quantity; end
end
class PaymentMethodConfigurationDetails < Stripe::StripeObject
# ID of the payment method configuration used.
sig { returns(String) }
def id; end
# ID of the parent payment method configuration used.
sig { returns(T.nilable(String)) }
def parent; end
end
class PaymentMethodOptions < Stripe::StripeObject
class AcssDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# A URL for custom mandate text
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
# List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.
sig { returns(T.nilable(T::Array[String])) }
def default_for; end
# Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
end
# Currency supported by the bank account. Returned when the Session is in `setup` mode.
sig { returns(T.nilable(String)) }
def currency; end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
end
class Affirm < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class AfterpayClearpay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Alipay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class AmazonPay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class AuBecsDebit < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
end
class BacsDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
end
class Bancontact < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Boleto < Stripe::StripeObject
# The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.
sig { returns(Integer) }
def expires_after_days; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Card < Stripe::StripeObject
class Installments < Stripe::StripeObject
# Indicates if installments are enabled
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
end
class Restrictions < Stripe::StripeObject
# Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can't complete the Session.
sig { returns(T.nilable(T::Array[String])) }
def brands_blocked; end
end
# Attribute for field installments
sig { returns(T.nilable(Installments)) }
def installments; end
# Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
sig { returns(T.nilable(String)) }
def request_decremental_authorization; end
# Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
sig { returns(T.nilable(String)) }
def request_extended_authorization; end
# Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
sig { returns(T.nilable(String)) }
def request_incremental_authorization; end
# Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
sig { returns(T.nilable(String)) }
def request_multicapture; end
# Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
sig { returns(T.nilable(String)) }
def request_overcapture; end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(String) }
def request_three_d_secure; end
# Attribute for field restrictions
sig { returns(T.nilable(Restrictions)) }
def restrictions; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kana; end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kanji; end
end
class Cashapp < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class CustomerBalance < Stripe::StripeObject
class BankTransfer < Stripe::StripeObject
class EuBankTransfer < Stripe::StripeObject
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
end
# Attribute for field eu_bank_transfer
sig { returns(T.nilable(EuBankTransfer)) }
def eu_bank_transfer; end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
# The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(T.nilable(String)) }
def type; end
end
# Attribute for field bank_transfer
sig { returns(T.nilable(BankTransfer)) }
def bank_transfer; end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Eps < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Fpx < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Giropay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Grabpay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Ideal < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class KakaoPay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Klarna < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Konbini < Stripe::StripeObject
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class KrCard < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Link < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Mobilepay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Multibanco < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class NaverPay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Oxxo < Stripe::StripeObject
# The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
sig { returns(Integer) }
def expires_after_days; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class P24 < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Payco < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
end
class Paynow < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Paypal < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# Preferred locale of the PayPal checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
end
class Payto < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
sig { returns(T.nilable(String)) }
def start_date; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Pix < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
# Determines if the amount includes the IOF tax.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
# Type of amount.
sig { returns(T.nilable(String)) }
def amount_type; end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
sig { returns(T.nilable(String)) }
def currency; end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
sig { returns(T.nilable(String)) }
def end_date; end
# Schedule at which the future payments will be charged.
sig { returns(T.nilable(String)) }
def payment_schedule; end
# Subscription name displayed to buyers in their bank app.
sig { returns(T.nilable(String)) }
def reference; end
# Start date of the mandate, in `YYYY-MM-DD`.
sig { returns(T.nilable(String)) }
def start_date; end
end
# Determines if the amount includes the IOF tax.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
# The number of seconds after which Pix payment will expire.
sig { returns(T.nilable(Integer)) }
def expires_after_seconds; end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class RevolutPay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class SamsungPay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
end
class SepaDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
end
class Sofort < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Swish < Stripe::StripeObject
# The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
sig { returns(T.nilable(String)) }
def reference; end
end
class UsBankAccount < Stripe::StripeObject
class FinancialConnections < Stripe::StripeObject
class Filters < Stripe::StripeObject
# The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
# The institution to use to filter for possible accounts to link.
sig { returns(T.nilable(String)) }
def institution; end
end
class ManualEntry < Stripe::StripeObject
# Settings for configuring manual entry of account details.
sig { returns(T.nilable(String)) }
def mode; end
end
# Attribute for field filters
sig { returns(T.nilable(Filters)) }
def filters; end
# Attribute for field manual_entry
sig { returns(T.nilable(ManualEntry)) }
def manual_entry; end
# The list of permissions to request. The `payment_method` permission must be included.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
# Data features requested to be retrieved upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
end
# Attribute for field financial_connections
sig { returns(T.nilable(FinancialConnections)) }
def financial_connections; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
end
# Attribute for field acss_debit
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# Attribute for field affirm
sig { returns(T.nilable(Affirm)) }
def affirm; end
# Attribute for field afterpay_clearpay
sig { returns(T.nilable(AfterpayClearpay)) }
def afterpay_clearpay; end
# Attribute for field alipay
sig { returns(T.nilable(Alipay)) }
def alipay; end
# Attribute for field amazon_pay
sig { returns(T.nilable(AmazonPay)) }
def amazon_pay; end
# Attribute for field au_becs_debit
sig { returns(T.nilable(AuBecsDebit)) }
def au_becs_debit; end
# Attribute for field bacs_debit
sig { returns(T.nilable(BacsDebit)) }
def bacs_debit; end
# Attribute for field bancontact
sig { returns(T.nilable(Bancontact)) }
def bancontact; end
# Attribute for field boleto
sig { returns(T.nilable(Boleto)) }
def boleto; end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# Attribute for field cashapp
sig { returns(T.nilable(Cashapp)) }
def cashapp; end
# Attribute for field customer_balance
sig { returns(T.nilable(CustomerBalance)) }
def customer_balance; end
# Attribute for field eps
sig { returns(T.nilable(Eps)) }
def eps; end
# Attribute for field fpx
sig { returns(T.nilable(Fpx)) }
def fpx; end
# Attribute for field giropay
sig { returns(T.nilable(Giropay)) }
def giropay; end
# Attribute for field grabpay
sig { returns(T.nilable(Grabpay)) }
def grabpay; end
# Attribute for field ideal
sig { returns(T.nilable(Ideal)) }
def ideal; end
# Attribute for field kakao_pay
sig { returns(T.nilable(KakaoPay)) }
def kakao_pay; end
# Attribute for field klarna
sig { returns(T.nilable(Klarna)) }
def klarna; end
# Attribute for field konbini
sig { returns(T.nilable(Konbini)) }
def konbini; end
# Attribute for field kr_card
sig { returns(T.nilable(KrCard)) }
def kr_card; end
# Attribute for field link
sig { returns(T.nilable(Link)) }
def link; end
# Attribute for field mobilepay
sig { returns(T.nilable(Mobilepay)) }
def mobilepay; end
# Attribute for field multibanco
sig { returns(T.nilable(Multibanco)) }
def multibanco; end
# Attribute for field naver_pay
sig { returns(T.nilable(NaverPay)) }
def naver_pay; end
# Attribute for field oxxo
sig { returns(T.nilable(Oxxo)) }
def oxxo; end
# Attribute for field p24
sig { returns(T.nilable(P24)) }
def p24; end
# Attribute for field payco
sig { returns(T.nilable(Payco)) }
def payco; end
# Attribute for field paynow
sig { returns(T.nilable(Paynow)) }
def paynow; end
# Attribute for field paypal
sig { returns(T.nilable(Paypal)) }
def paypal; end
# Attribute for field payto
sig { returns(T.nilable(Payto)) }
def payto; end
# Attribute for field pix
sig { returns(T.nilable(Pix)) }
def pix; end
# Attribute for field revolut_pay
sig { returns(T.nilable(RevolutPay)) }
def revolut_pay; end
# Attribute for field samsung_pay
sig { returns(T.nilable(SamsungPay)) }
def samsung_pay; end
# Attribute for field sepa_debit
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# Attribute for field sofort
sig { returns(T.nilable(Sofort)) }
def sofort; end
# Attribute for field swish
sig { returns(T.nilable(Swish)) }
def swish; end
# Attribute for field us_bank_account
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
end
class Permissions < Stripe::StripeObject
class Update < Stripe::StripeObject
# Determines which entity is allowed to update the line items.
#
# Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
#
# When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
sig { returns(T.nilable(String)) }
def line_items; end
# Determines which entity is allowed to update the shipping details.
#
# Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
#
# When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
sig { returns(T.nilable(String)) }
def shipping_details; end
end
# Permissions for updating the Checkout Session.
sig { returns(T.nilable(Update)) }
def update; end
# Determines which entity is allowed to update the line items.
#
# Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
#
# When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
sig { returns(T.nilable(String)) }
def update_line_items; end
# Determines which entity is allowed to update the shipping details.
#
# Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
#
# When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
sig { returns(T.nilable(String)) }
def update_shipping_details; end
end
class PhoneNumberCollection < Stripe::StripeObject
# Indicates whether phone number collection is enabled for the session
sig { returns(T::Boolean) }
def enabled; end
end
class PresentmentDetails < Stripe::StripeObject
# Amount intended to be collected by this payment, denominated in `presentment_currency`.
sig { returns(Integer) }
def presentment_amount; end
# Currency presented to the customer during payment.
sig { returns(String) }
def presentment_currency; end
end
class SavedPaymentMethodOptions < Stripe::StripeObject
# Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.
sig { returns(T.nilable(T::Array[String])) }
def allow_redisplay_filters; end
# Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
sig { returns(T.nilable(String)) }
def payment_method_remove; end
# Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
sig { returns(T.nilable(String)) }
def payment_method_save; end
end
class ShippingAddressCollection < Stripe::StripeObject
# An array of two-letter ISO country codes representing which countries Checkout should provide as options for
# shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI`.
sig { returns(T::Array[String]) }
def allowed_countries; end
end
class ShippingCost < Stripe::StripeObject
class Tax < Stripe::StripeObject
# Amount of tax applied for this rate.
sig { returns(Integer) }
def amount; end
# Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
#
# Related guide: [Tax rates](/billing/taxes/tax-rates)
sig { returns(Stripe::TaxRate) }
def rate; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(T.nilable(String)) }
def taxability_reason; end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(T.nilable(Integer)) }
def taxable_amount; end
end
# Total shipping cost before any discounts or taxes are applied.
sig { returns(Integer) }
def amount_subtotal; end
# Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
sig { returns(Integer) }
def amount_tax; end
# Total shipping cost after discounts and taxes are applied.
sig { returns(Integer) }
def amount_total; end
# The ID of the ShippingRate for this order.
sig { returns(T.nilable(T.any(String, Stripe::ShippingRate))) }
def shipping_rate; end
# The taxes applied to the shipping rate.
sig { returns(T.nilable(T::Array[Tax])) }
def taxes; end
end
class ShippingOption < Stripe::StripeObject
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def shipping_amount; end
# The shipping rate.
sig { returns(T.any(String, Stripe::ShippingRate)) }
def shipping_rate; end
end
class TaxIdCollection < Stripe::StripeObject
# Indicates whether tax ID collection is enabled for the session
sig { returns(T::Boolean) }
def enabled; end
# Indicates whether a tax ID is required on the payment page
sig { returns(String) }
def required; end
end
class TotalDetails < Stripe::StripeObject
class Breakdown < Stripe::StripeObject
class Discount < Stripe::StripeObject
# The amount discounted.
sig { returns(Integer) }
def amount; end
# 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)
sig { returns(Stripe::Discount) }
def discount; end
end
class Tax < Stripe::StripeObject
# Amount of tax applied for this rate.
sig { returns(Integer) }
def amount; end
# Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
#
# Related guide: [Tax rates](/billing/taxes/tax-rates)
sig { returns(Stripe::TaxRate) }
def rate; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(T.nilable(String)) }
def taxability_reason; end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(T.nilable(Integer)) }
def taxable_amount; end
end
# The aggregated discounts.
sig { returns(T::Array[Discount]) }
def discounts; end
# The aggregated tax amounts by rate.
sig { returns(T::Array[Tax]) }
def taxes; end
end
# This is the sum of all the discounts.
sig { returns(Integer) }
def amount_discount; end
# This is the sum of all the shipping amounts.
sig { returns(T.nilable(Integer)) }
def amount_shipping; end
# This is the sum of all the tax amounts.
sig { returns(Integer) }
def amount_tax; end
# Attribute for field breakdown
sig { returns(T.nilable(Breakdown)) }
def breakdown; end
end
class WalletOptions < Stripe::StripeObject
class Link < Stripe::StripeObject
# Describes whether Checkout should display Link. Defaults to `auto`.
sig { returns(T.nilable(String)) }
def display; end
end
# Attribute for field link
sig { returns(T.nilable(Link)) }
def link; end
end
# Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
sig { returns(T.nilable(AdaptivePricing)) }
def adaptive_pricing; end
# When set, provides configuration for actions to take if this Checkout Session expires.
sig { returns(T.nilable(AfterExpiration)) }
def after_expiration; end
# Enables user redeemable promotion codes.
sig { returns(T.nilable(T::Boolean)) }
def allow_promotion_codes; end
# Total of all items before discounts or taxes are applied.
sig { returns(T.nilable(Integer)) }
def amount_subtotal; end
# Total of all items after discounts and taxes are applied.
sig { returns(T.nilable(Integer)) }
def amount_total; end
# Attribute for field automatic_tax
sig { returns(AutomaticTax) }
def automatic_tax; end
# Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.
sig { returns(T.nilable(String)) }
def billing_address_collection; end
# Attribute for field branding_settings
sig { returns(T.nilable(BrandingSettings)) }
def branding_settings; end
# If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
sig { returns(T.nilable(String)) }
def cancel_url; end
# A unique string to reference the Checkout Session. This can be a
# customer ID, a cart ID, or similar, and can be used to reconcile the
# Session with your internal systems.
sig { returns(T.nilable(String)) }
def client_reference_id; end
# The client secret of your Checkout Session. Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. For `ui_mode: embedded`, the client secret is to be used when initializing Stripe.js embedded checkout.
# For `ui_mode: custom`, use the client secret with [initCheckout](https://stripe.com/docs/js/custom_checkout/init) on your front end.
sig { returns(T.nilable(String)) }
def client_secret; end
# Information about the customer collected within the Checkout Session.
sig { returns(T.nilable(CollectedInformation)) }
def collected_information; end
# Results of `consent_collection` for this session.
sig { returns(T.nilable(Consent)) }
def consent; end
# When set, provides configuration for the Checkout Session to gather active consent from customers.
sig { returns(T.nilable(ConsentCollection)) }
def consent_collection; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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(T.nilable(String)) }
def currency; end
# Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions created before 2025-03-31.
sig { returns(T.nilable(CurrencyConversion)) }
def currency_conversion; end
# Collect additional information from your customer using custom fields. Up to 3 fields are supported.
sig { returns(T::Array[CustomField]) }
def custom_fields; end
# Attribute for field custom_text
sig { returns(CustomText) }
def custom_text; end
# The ID of the customer for this Session.
# For Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout
# will create a new customer object based on information provided
# during the payment flow unless an existing customer was provided when
# the Session was created.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# The ID of the account for this Session.
sig { returns(T.nilable(String)) }
def customer_account; end
# Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
sig { returns(T.nilable(String)) }
def customer_creation; end
# The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode.
sig { returns(T.nilable(CustomerDetails)) }
def customer_details; end
# If provided, this value will be used when the Customer object is created.
# If not provided, customers will be asked to enter their email address.
# Use this parameter to prefill customer data if you already have an email
# on file. To access information about the customer once the payment flow is
# complete, use the `customer` attribute.
sig { returns(T.nilable(String)) }
def customer_email; end
# List of coupons and promotion codes attached to the Checkout Session.
sig { returns(T.nilable(T::Array[Discount])) }
def discounts; end
# A list of the types of payment methods (e.g., `card`) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
sig { returns(T.nilable(T::Array[String])) }
def excluded_payment_method_types; end
# The timestamp at which the Checkout Session will expire.
sig { returns(Integer) }
def expires_at; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# ID of the invoice created by the Checkout Session, if it exists.
sig { returns(T.nilable(T.any(String, Stripe::Invoice))) }
def invoice; end
# Details on the state of invoice creation for the Checkout Session.
sig { returns(T.nilable(InvoiceCreation)) }
def invoice_creation; end
# The line items purchased by the customer.
sig { returns(T.nilable(Stripe::ListObject)) }
def line_items; end
# 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) }
def livemode; end
# The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
sig { returns(T.nilable(String)) }
def locale; end
# 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])) }
def metadata; end
# The mode of the Checkout Session.
sig { returns(String) }
def mode; end
# Attribute for field name_collection
sig { returns(T.nilable(NameCollection)) }
def name_collection; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The optional items presented to the customer at checkout.
sig { returns(T.nilable(T::Array[OptionalItem])) }
def optional_items; end
# Where the user is coming from. This informs the optimizations that are applied to the session.
sig { returns(T.nilable(String)) }
def origin_context; end
# The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
def payment_intent; end
# The ID of the Payment Link that created this Session.
sig { returns(T.nilable(T.any(String, Stripe::PaymentLink))) }
def payment_link; end
# Configure whether a Checkout Session should collect a payment method. Defaults to `always`.
sig { returns(T.nilable(String)) }
def payment_method_collection; end
# Information about the payment method configuration used for this Checkout session if using dynamic payment methods.
sig { returns(T.nilable(PaymentMethodConfigurationDetails)) }
def payment_method_configuration_details; end
# Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
sig { returns(T.nilable(PaymentMethodOptions)) }
def payment_method_options; end
# A list of the types of payment methods (e.g. card) this Checkout
# Session is allowed to accept.
sig { returns(T::Array[String]) }
def payment_method_types; end
# The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.
# You can use this value to decide when to fulfill your customer's order.
sig { returns(String) }
def payment_status; end
# This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
#
# For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.
sig { returns(T.nilable(Permissions)) }
def permissions; end
# Attribute for field phone_number_collection
sig { returns(T.nilable(PhoneNumberCollection)) }
def phone_number_collection; end
# Attribute for field presentment_details
sig { returns(T.nilable(PresentmentDetails)) }
def presentment_details; end
# The ID of the original expired Checkout Session that triggered the recovery flow.
sig { returns(T.nilable(String)) }
def recovered_from; end
# This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
sig { returns(T.nilable(String)) }
def redirect_on_completion; end
# Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
sig { returns(T.nilable(String)) }
def return_url; end
# Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
sig { returns(T.nilable(SavedPaymentMethodOptions)) }
def saved_payment_method_options; end
# The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
sig { returns(T.nilable(T.any(String, Stripe::SetupIntent))) }
def setup_intent; end
# When set, provides configuration for Checkout to collect a shipping address from a customer.
sig { returns(T.nilable(ShippingAddressCollection)) }
def shipping_address_collection; end
# The details of the customer cost of shipping, including the customer chosen ShippingRate.
sig { returns(T.nilable(ShippingCost)) }
def shipping_cost; end
# The shipping rate options applied to this Session.
sig { returns(T::Array[ShippingOption]) }
def shipping_options; end
# The status of the Checkout Session, one of `open`, `complete`, or `expired`.
sig { returns(T.nilable(String)) }
def status; end
# Describes the type of transaction being performed by Checkout in order to customize
# relevant text on the page, such as the submit button. `submit_type` can only be
# specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
sig { returns(T.nilable(String)) }
def submit_type; end
# The ID of the [Subscription](https://stripe.com/docs/api/subscriptions) for Checkout Sessions in `subscription` mode.
sig { returns(T.nilable(T.any(String, Stripe::Subscription))) }
def subscription; end
# The URL the customer will be directed to after the payment or
# subscription creation is successful.
sig { returns(T.nilable(String)) }
def success_url; end
# Attribute for field tax_id_collection
sig { returns(T.nilable(TaxIdCollection)) }
def tax_id_collection; end
# Tax and discount details for the computed total amount.
sig { returns(T.nilable(TotalDetails)) }
def total_details; end
# The UI mode of the Session. Defaults to `hosted`.
sig { returns(T.nilable(String)) }
def ui_mode; end
# The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted`. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`
# This value is only present when the session is active.
sig { returns(T.nilable(String)) }
def url; end
# Wallet-specific configuration for this Checkout Session.
sig { returns(T.nilable(WalletOptions)) }
def wallet_options; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class CustomerDetails < Stripe::RequestParams
# Customer's email address.
sig { returns(String) }
def email; end
sig { params(_email: String).returns(String) }
def email=(_email); end
sig { params(email: String).void }
def initialize(email: nil); end
end
# Only return Checkout Sessions that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Checkout::Session::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Checkout::Session::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Checkout::Session::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return the Checkout Sessions for the Customer specified.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Only return the Checkout Sessions for the Account specified.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Only return the Checkout Sessions for the Customer details specified.
sig { returns(T.nilable(::Stripe::Checkout::Session::ListParams::CustomerDetails)) }
def customer_details; end
sig {
params(_customer_details: T.nilable(::Stripe::Checkout::Session::ListParams::CustomerDetails)).returns(T.nilable(::Stripe::Checkout::Session::ListParams::CustomerDetails))
}
def customer_details=(_customer_details); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return the Checkout Session for the PaymentIntent specified.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# Only return the Checkout Sessions for the Payment Link specified.
sig { returns(T.nilable(String)) }
def payment_link; end
sig { params(_payment_link: T.nilable(String)).returns(T.nilable(String)) }
def payment_link=(_payment_link); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return the Checkout Sessions matching the given status.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# Only return the Checkout Session for the subscription specified.
sig { returns(T.nilable(String)) }
def subscription; end
sig { params(_subscription: T.nilable(String)).returns(T.nilable(String)) }
def subscription=(_subscription); end
sig {
params(created: T.nilable(T.any(::Stripe::Checkout::Session::ListParams::Created, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), customer_details: T.nilable(::Stripe::Checkout::Session::ListParams::CustomerDetails), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_intent: T.nilable(String), payment_link: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String), subscription: T.nilable(String)).void
}
def initialize(
created: nil,
customer: nil,
customer_account: nil,
customer_details: nil,
ending_before: nil,
expand: nil,
limit: nil,
payment_intent: nil,
payment_link: nil,
starting_after: nil,
status: nil,
subscription: nil
); end
end
class CreateParams < Stripe::RequestParams
class AdaptivePricing < Stripe::RequestParams
# If set to `true`, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions). Defaults to your [dashboard setting](https://dashboard.stripe.com/settings/adaptive-pricing).
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
sig { params(enabled: T.nilable(T::Boolean)).void }
def initialize(enabled: nil); end
end
class AfterExpiration < Stripe::RequestParams
class Recovery < Stripe::RequestParams
# Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
sig { returns(T.nilable(T::Boolean)) }
def allow_promotion_codes; end
sig {
params(_allow_promotion_codes: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def allow_promotion_codes=(_allow_promotion_codes); end
# If `true`, a recovery URL will be generated to recover this Checkout Session if it
# expires before a successful transaction is completed. It will be attached to the
# Checkout Session object upon expiration.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(allow_promotion_codes: T.nilable(T::Boolean), enabled: T::Boolean).void }
def initialize(allow_promotion_codes: nil, enabled: nil); end
end
# Configure a Checkout Session that can be used to recover an expired session.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::AfterExpiration::Recovery))
}
def recovery; end
sig {
params(_recovery: T.nilable(::Stripe::Checkout::Session::CreateParams::AfterExpiration::Recovery)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::AfterExpiration::Recovery))
}
def recovery=(_recovery); end
sig {
params(recovery: T.nilable(::Stripe::Checkout::Session::CreateParams::AfterExpiration::Recovery)).void
}
def initialize(recovery: nil); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
#
# Enabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::Checkout::Session::CreateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::Checkout::Session::CreateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class BrandingSettings < Stripe::RequestParams
class Icon < Stripe::RequestParams
# The ID of a [File upload](https://stripe.com/docs/api/files) representing the icon. Purpose must be `business_icon`. Required if `type` is `file` and disallowed otherwise.
sig { returns(T.nilable(String)) }
def file; end
sig { params(_file: T.nilable(String)).returns(T.nilable(String)) }
def file=(_file); end
# The type of image for the icon. Must be one of `file` or `url`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The URL of the image. Required if `type` is `url` and disallowed otherwise.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig { params(file: T.nilable(String), type: String, url: T.nilable(String)).void }
def initialize(file: nil, type: nil, url: nil); end
end
class Logo < Stripe::RequestParams
# The ID of a [File upload](https://stripe.com/docs/api/files) representing the logo. Purpose must be `business_logo`. Required if `type` is `file` and disallowed otherwise.
sig { returns(T.nilable(String)) }
def file; end
sig { params(_file: T.nilable(String)).returns(T.nilable(String)) }
def file=(_file); end
# The type of image for the logo. Must be one of `file` or `url`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The URL of the image. Required if `type` is `url` and disallowed otherwise.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig { params(file: T.nilable(String), type: String, url: T.nilable(String)).void }
def initialize(file: nil, type: nil, url: nil); end
end
# A hex color value starting with `#` representing the background color for the Checkout Session.
sig { returns(T.nilable(String)) }
def background_color; end
sig { params(_background_color: T.nilable(String)).returns(T.nilable(String)) }
def background_color=(_background_color); end
# The border style for the Checkout Session.
sig { returns(T.nilable(T.any(String, String))) }
def border_style; end
sig {
params(_border_style: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def border_style=(_border_style); end
# A hex color value starting with `#` representing the button color for the Checkout Session.
sig { returns(T.nilable(String)) }
def button_color; end
sig { params(_button_color: T.nilable(String)).returns(T.nilable(String)) }
def button_color=(_button_color); end
# A string to override the business name shown on the Checkout Session.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# The font family for the Checkout Session corresponding to one of the [supported font families](https://docs.stripe.com/payments/checkout/customization/appearance?payment-ui=stripe-hosted#font-compatibility).
sig { returns(T.nilable(T.any(String, String))) }
def font_family; end
sig {
params(_font_family: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def font_family=(_font_family); end
# The icon for the Checkout Session. You cannot set both `logo` and `icon`.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::BrandingSettings::Icon))
}
def icon; end
sig {
params(_icon: T.nilable(::Stripe::Checkout::Session::CreateParams::BrandingSettings::Icon)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::BrandingSettings::Icon))
}
def icon=(_icon); end
# The logo for the Checkout Session. You cannot set both `logo` and `icon`.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::BrandingSettings::Logo))
}
def logo; end
sig {
params(_logo: T.nilable(::Stripe::Checkout::Session::CreateParams::BrandingSettings::Logo)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::BrandingSettings::Logo))
}
def logo=(_logo); end
sig {
params(background_color: T.nilable(String), border_style: T.nilable(T.any(String, String)), button_color: T.nilable(String), display_name: T.nilable(String), font_family: T.nilable(T.any(String, String)), icon: T.nilable(::Stripe::Checkout::Session::CreateParams::BrandingSettings::Icon), logo: T.nilable(::Stripe::Checkout::Session::CreateParams::BrandingSettings::Logo)).void
}
def initialize(
background_color: nil,
border_style: nil,
button_color: nil,
display_name: nil,
font_family: nil,
icon: nil,
logo: nil
); end
end
class ConsentCollection < Stripe::RequestParams
class PaymentMethodReuseAgreement < Stripe::RequestParams
# Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's
# defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
sig { returns(String) }
def position; end
sig { params(_position: String).returns(String) }
def position=(_position); end
sig { params(position: String).void }
def initialize(position: nil); end
end
# Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::ConsentCollection::PaymentMethodReuseAgreement))
}
def payment_method_reuse_agreement; end
sig {
params(_payment_method_reuse_agreement: T.nilable(::Stripe::Checkout::Session::CreateParams::ConsentCollection::PaymentMethodReuseAgreement)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::ConsentCollection::PaymentMethodReuseAgreement))
}
def payment_method_reuse_agreement=(_payment_method_reuse_agreement); end
# If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
# Session will determine whether to display an option to opt into promotional communication
# from the merchant depending on the customer's locale. Only available to US merchants.
sig { returns(T.nilable(String)) }
def promotions; end
sig { params(_promotions: T.nilable(String)).returns(T.nilable(String)) }
def promotions=(_promotions); end
# If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
# There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
sig { returns(T.nilable(String)) }
def terms_of_service; end
sig { params(_terms_of_service: T.nilable(String)).returns(T.nilable(String)) }
def terms_of_service=(_terms_of_service); end
sig {
params(payment_method_reuse_agreement: T.nilable(::Stripe::Checkout::Session::CreateParams::ConsentCollection::PaymentMethodReuseAgreement), promotions: T.nilable(String), terms_of_service: T.nilable(String)).void
}
def initialize(
payment_method_reuse_agreement: nil,
promotions: nil,
terms_of_service: nil
); end
end
class CustomField < Stripe::RequestParams
class Dropdown < Stripe::RequestParams
class Option < Stripe::RequestParams
# The label for the option, displayed to the customer. Up to 100 characters.
sig { returns(String) }
def label; end
sig { params(_label: String).returns(String) }
def label=(_label); end
# The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(label: String, value: String).void }
def initialize(label: nil, value: nil); end
end
# The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The options available for the customer to select. Up to 200 options allowed.
sig {
returns(T::Array[::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown::Option])
}
def options; end
sig {
params(_options: T::Array[::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown::Option]).returns(T::Array[::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown::Option])
}
def options=(_options); end
sig {
params(default_value: T.nilable(String), options: T::Array[::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown::Option]).void
}
def initialize(default_value: nil, options: nil); end
end
class Label < Stripe::RequestParams
# Custom text for the label, displayed to the customer. Up to 50 characters.
sig { returns(String) }
def custom; end
sig { params(_custom: String).returns(String) }
def custom=(_custom); end
# The type of the label.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(custom: String, type: String).void }
def initialize(custom: nil, type: nil); end
end
class Numeric < Stripe::RequestParams
# The value that will pre-fill the field on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The maximum character length constraint for the customer's input.
sig { returns(T.nilable(Integer)) }
def maximum_length; end
sig { params(_maximum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_length=(_maximum_length); end
# The minimum character length requirement for the customer's input.
sig { returns(T.nilable(Integer)) }
def minimum_length; end
sig { params(_minimum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_length=(_minimum_length); end
sig {
params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
}
def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
end
class Text < Stripe::RequestParams
# The value that will pre-fill the field on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The maximum character length constraint for the customer's input.
sig { returns(T.nilable(Integer)) }
def maximum_length; end
sig { params(_maximum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_length=(_maximum_length); end
# The minimum character length requirement for the customer's input.
sig { returns(T.nilable(Integer)) }
def minimum_length; end
sig { params(_minimum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_length=(_minimum_length); end
sig {
params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
}
def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
end
# Configuration for `type=dropdown` fields.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown))
}
def dropdown; end
sig {
params(_dropdown: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown))
}
def dropdown=(_dropdown); end
# String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
sig { returns(String) }
def key; end
sig { params(_key: String).returns(String) }
def key=(_key); end
# The label for the field, displayed to the customer.
sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Label) }
def label; end
sig {
params(_label: ::Stripe::Checkout::Session::CreateParams::CustomField::Label).returns(::Stripe::Checkout::Session::CreateParams::CustomField::Label)
}
def label=(_label); end
# Configuration for `type=numeric` fields.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomField::Numeric))
}
def numeric; end
sig {
params(_numeric: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomField::Numeric)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomField::Numeric))
}
def numeric=(_numeric); end
# Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def optional; end
sig { params(_optional: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def optional=(_optional); end
# Configuration for `type=text` fields.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomField::Text)) }
def text; end
sig {
params(_text: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomField::Text)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomField::Text))
}
def text=(_text); end
# The type of the field.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(dropdown: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown), key: String, label: ::Stripe::Checkout::Session::CreateParams::CustomField::Label, numeric: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomField::Numeric), optional: T.nilable(T::Boolean), text: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomField::Text), type: String).void
}
def initialize(
dropdown: nil,
key: nil,
label: nil,
numeric: nil,
optional: nil,
text: nil,
type: nil
); end
end
class CustomText < Stripe::RequestParams
class AfterSubmit < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class ShippingAddress < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class Submit < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class TermsOfServiceAcceptance < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
# Custom text that should be displayed after the payment confirmation button.
sig {
returns(T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::CustomText::AfterSubmit)))
}
def after_submit; end
sig {
params(_after_submit: T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::CustomText::AfterSubmit))).returns(T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::CustomText::AfterSubmit)))
}
def after_submit=(_after_submit); end
# Custom text that should be displayed alongside shipping address collection.
sig {
returns(T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::CustomText::ShippingAddress)))
}
def shipping_address; end
sig {
params(_shipping_address: T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::CustomText::ShippingAddress))).returns(T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::CustomText::ShippingAddress)))
}
def shipping_address=(_shipping_address); end
# Custom text that should be displayed alongside the payment confirmation button.
sig {
returns(T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::CustomText::Submit)))
}
def submit; end
sig {
params(_submit: T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::CustomText::Submit))).returns(T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::CustomText::Submit)))
}
def submit=(_submit); end
# Custom text that should be displayed in place of the default terms of service agreement text.
sig {
returns(T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::CustomText::TermsOfServiceAcceptance)))
}
def terms_of_service_acceptance; end
sig {
params(_terms_of_service_acceptance: T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::CustomText::TermsOfServiceAcceptance))).returns(T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::CustomText::TermsOfServiceAcceptance)))
}
def terms_of_service_acceptance=(_terms_of_service_acceptance); end
sig {
params(after_submit: T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::CustomText::AfterSubmit)), shipping_address: T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::CustomText::ShippingAddress)), submit: T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::CustomText::Submit)), terms_of_service_acceptance: T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::CustomText::TermsOfServiceAcceptance))).void
}
def initialize(
after_submit: nil,
shipping_address: nil,
submit: nil,
terms_of_service_acceptance: nil
); end
end
class CustomerUpdate < Stripe::RequestParams
# Describes whether Checkout saves the billing address onto `customer.address`.
# To always collect a full billing address, use `billing_address_collection`. Defaults to `never`.
sig { returns(T.nilable(String)) }
def address; end
sig { params(_address: T.nilable(String)).returns(T.nilable(String)) }
def address=(_address); end
# Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes whether Checkout saves shipping information onto `customer.shipping`.
# To collect shipping information, use `shipping_address_collection`. Defaults to `never`.
sig { returns(T.nilable(String)) }
def shipping; end
sig { params(_shipping: T.nilable(String)).returns(T.nilable(String)) }
def shipping=(_shipping); end
sig {
params(address: T.nilable(String), name: T.nilable(String), shipping: T.nilable(String)).void
}
def initialize(address: nil, name: nil, shipping: nil); end
end
class Discount < Stripe::RequestParams
class CouponData < Stripe::RequestParams
# A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
sig { returns(T.nilable(Integer)) }
def amount_off; end
sig { params(_amount_off: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_off=(_amount_off); end
# Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
sig { returns(T.nilable(String)) }
def duration; end
sig { params(_duration: T.nilable(String)).returns(T.nilable(String)) }
def duration=(_duration); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
sig { returns(T.nilable(Float)) }
def percent_off; end
sig { params(_percent_off: T.nilable(Float)).returns(T.nilable(Float)) }
def percent_off=(_percent_off); end
sig {
params(amount_off: T.nilable(Integer), currency: T.nilable(String), duration: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String), percent_off: T.nilable(Float)).void
}
def initialize(
amount_off: nil,
currency: nil,
duration: nil,
metadata: nil,
name: nil,
percent_off: nil
); end
end
# The ID of the coupon to apply to this Session.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# Data used to generate a new [Coupon](https://stripe.com/docs/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::Discount::CouponData))
}
def coupon_data; end
sig {
params(_coupon_data: T.nilable(::Stripe::Checkout::Session::CreateParams::Discount::CouponData)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::Discount::CouponData))
}
def coupon_data=(_coupon_data); end
# The ID of a promotion code to apply to this Session.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), coupon_data: T.nilable(::Stripe::Checkout::Session::CreateParams::Discount::CouponData), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, coupon_data: nil, promotion_code: nil); end
end
class InvoiceCreation < Stripe::RequestParams
class InvoiceData < Stripe::RequestParams
class CustomField < Stripe::RequestParams
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The value of the custom field. This may be up to 140 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
class RenderingOptions < Stripe::RequestParams
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(T.any(String, String))) }
def amount_tax_display; end
sig {
params(_amount_tax_display: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def amount_tax_display=(_amount_tax_display); end
# ID of the invoice rendering template to use for this invoice.
sig { returns(T.nilable(String)) }
def template; end
sig { params(_template: T.nilable(String)).returns(T.nilable(String)) }
def template=(_template); end
sig {
params(amount_tax_display: T.nilable(T.any(String, String)), template: T.nilable(String)).void
}
def initialize(amount_tax_display: nil, template: nil); end
end
# The account tax IDs associated with the invoice.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# Default custom fields to be displayed on invoices for this customer.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::CustomField])))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T.any(String, T::Array[::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::CustomField]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::CustomField])))
}
def custom_fields=(_custom_fields); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Default footer to be displayed on invoices for this customer.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::Issuer)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::Issuer))
}
def issuer=(_issuer); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Default options for invoice PDF rendering for this customer.
sig {
returns(T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)))
}
def rendering_options; end
sig {
params(_rendering_options: T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))).returns(T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)))
}
def rendering_options=(_rendering_options); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), custom_fields: T.nilable(T.any(String, T::Array[::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::CustomField])), description: T.nilable(String), footer: T.nilable(String), issuer: T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::Issuer), metadata: T.nilable(T::Hash[String, String]), rendering_options: T.nilable(T.any(String, ::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))).void
}
def initialize(
account_tax_ids: nil,
custom_fields: nil,
description: nil,
footer: nil,
issuer: nil,
metadata: nil,
rendering_options: nil
); end
end
# Set to `true` to enable invoice creation.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Parameters passed when creating invoices for payment-mode Checkout Sessions.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData))
}
def invoice_data; end
sig {
params(_invoice_data: T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData))
}
def invoice_data=(_invoice_data); end
sig {
params(enabled: T::Boolean, invoice_data: T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData)).void
}
def initialize(enabled: nil, invoice_data: nil); end
end
class LineItem < Stripe::RequestParams
class AdjustableQuantity < Stripe::RequestParams
# Set to true if the quantity can be adjusted to any non-negative integer.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil); end
end
class PriceData < Stripe::RequestParams
class ProductData < Stripe::RequestParams
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T::Array[String])) }
def images; end
sig {
params(_images: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def images=(_images); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
sig {
params(description: T.nilable(String), images: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: String, tax_code: T.nilable(String), unit_label: T.nilable(String)).void
}
def initialize(
description: nil,
images: nil,
metadata: nil,
name: nil,
tax_code: nil,
unit_label: nil
); end
end
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::ProductData))
}
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::ProductData)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::ProductData))
}
def product_data=(_product_data); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::Recurring))
}
def recurring; end
sig {
params(_recurring: T.nilable(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::Recurring)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::Recurring))
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: T.nilable(String), product_data: T.nilable(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::ProductData), recurring: T.nilable(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
product_data: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::LineItem::AdjustableQuantity))
}
def adjustable_quantity; end
sig {
params(_adjustable_quantity: T.nilable(::Stripe::Checkout::Session::CreateParams::LineItem::AdjustableQuantity)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::LineItem::AdjustableQuantity))
}
def adjustable_quantity=(_adjustable_quantity); end
# The [tax rates](https://stripe.com/docs/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.
sig { returns(T.nilable(T::Array[String])) }
def dynamic_tax_rates; end
sig {
params(_dynamic_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def dynamic_tax_rates=(_dynamic_tax_rates); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData))
}
def price_data=(_price_data); end
# The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
sig {
params(adjustable_quantity: T.nilable(::Stripe::Checkout::Session::CreateParams::LineItem::AdjustableQuantity), dynamic_tax_rates: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), price: T.nilable(String), price_data: T.nilable(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String])).void
}
def initialize(
adjustable_quantity: nil,
dynamic_tax_rates: nil,
metadata: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class NameCollection < Stripe::RequestParams
class Business < Stripe::RequestParams
# Enable business name collection on the Checkout Session. Defaults to `false`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Whether the customer is required to provide a business name before completing the Checkout Session. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def optional; end
sig { params(_optional: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def optional=(_optional); end
sig { params(enabled: T::Boolean, optional: T.nilable(T::Boolean)).void }
def initialize(enabled: nil, optional: nil); end
end
class Individual < Stripe::RequestParams
# Enable individual name collection on the Checkout Session. Defaults to `false`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Whether the customer is required to provide their name before completing the Checkout Session. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def optional; end
sig { params(_optional: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def optional=(_optional); end
sig { params(enabled: T::Boolean, optional: T.nilable(T::Boolean)).void }
def initialize(enabled: nil, optional: nil); end
end
# Controls settings applied for collecting the customer's business name on the session.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::NameCollection::Business))
}
def business; end
sig {
params(_business: T.nilable(::Stripe::Checkout::Session::CreateParams::NameCollection::Business)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::NameCollection::Business))
}
def business=(_business); end
# Controls settings applied for collecting the customer's individual name on the session.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::NameCollection::Individual))
}
def individual; end
sig {
params(_individual: T.nilable(::Stripe::Checkout::Session::CreateParams::NameCollection::Individual)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::NameCollection::Individual))
}
def individual=(_individual); end
sig {
params(business: T.nilable(::Stripe::Checkout::Session::CreateParams::NameCollection::Business), individual: T.nilable(::Stripe::Checkout::Session::CreateParams::NameCollection::Individual)).void
}
def initialize(business: nil, individual: nil); end
end
class OptionalItem < Stripe::RequestParams
class AdjustableQuantity < Stripe::RequestParams
# Set to true if the quantity can be adjusted to any non-negative integer.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil); end
end
# When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::OptionalItem::AdjustableQuantity))
}
def adjustable_quantity; end
sig {
params(_adjustable_quantity: T.nilable(::Stripe::Checkout::Session::CreateParams::OptionalItem::AdjustableQuantity)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::OptionalItem::AdjustableQuantity))
}
def adjustable_quantity=(_adjustable_quantity); end
# The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# The initial quantity of the line item created when a customer chooses to add this optional item to their order.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
sig {
params(adjustable_quantity: T.nilable(::Stripe::Checkout::Session::CreateParams::OptionalItem::AdjustableQuantity), price: String, quantity: Integer).void
}
def initialize(adjustable_quantity: nil, price: nil, quantity: nil); end
end
class PaymentIntentData < Stripe::RequestParams
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(String) }
def line1; end
sig { params(_line1: String).returns(String) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: String, line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address.
sig {
returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping::Address)
}
def address; end
sig {
params(_address: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping::Address).returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping::Address)
}
def address=(_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
sig { params(_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def tracking_number=(_tracking_number); end
sig {
params(address: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
}
def initialize(
address: nil,
carrier: nil,
name: nil,
phone: nil,
tracking_number: nil
); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# If specified, successful charges will be attributed to the destination
# account for tax reporting, and the funds from charges will be transferred
# to the destination account. The ID of the resulting transfer will be
# returned on the successful charge's `transfer` field.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The Stripe account ID for which these funds are intended. For details,
# see the PaymentIntents [use case for connected
# accounts](/docs/payments/connected-accounts).
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
sig { returns(T.nilable(String)) }
def receipt_email; end
sig { params(_receipt_email: T.nilable(String)).returns(T.nilable(String)) }
def receipt_email=(_receipt_email); end
# Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment
# method collected by this Checkout Session.
#
# When setting this to `on_session`, Checkout will show a notice to the
# customer that their payment details will be saved.
#
# When setting this to `off_session`, Checkout will show a notice to the
# customer that their payment details will be saved and used for future
# payments.
#
# If a Customer has been provided or Checkout creates a new Customer,
# Checkout will attach the payment method to the Customer.
#
# If Checkout does not create a Customer, the payment method is not attached
# to a Customer. To reuse the payment method, you can retrieve it from the
# Checkout Session's PaymentIntent.
#
# When processing card payments, Checkout also uses `setup_future_usage`
# to dynamically optimize your payment flow and comply with regional
# legislation and network rules, such as SCA.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Shipping information for this payment.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping))
}
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping))
}
def shipping=(_shipping); end
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# The parameters used to automatically create a Transfer when the payment succeeds.
# For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::TransferData))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::TransferData)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::TransferData))
}
def transfer_data=(_transfer_data); end
# A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(application_fee_amount: T.nilable(Integer), capture_method: T.nilable(String), description: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), receipt_email: T.nilable(String), setup_future_usage: T.nilable(String), shipping: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::TransferData), transfer_group: T.nilable(String)).void
}
def initialize(
application_fee_amount: nil,
capture_method: nil,
description: nil,
metadata: nil,
on_behalf_of: nil,
receipt_email: nil,
setup_future_usage: nil,
shipping: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil,
transfer_group: nil
); end
end
class PaymentMethodData < Stripe::RequestParams
# Allow redisplay will be set on the payment method on confirmation and indicates whether this payment method can be shown again to the customer in a checkout flow. Only set this field if you wish to override the allow_redisplay value determined by Checkout.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
sig { params(allow_redisplay: T.nilable(String)).void }
def initialize(allow_redisplay: nil); end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.
sig { returns(T.nilable(T::Array[String])) }
def default_for; end
sig {
params(_default_for: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def default_for=(_default_for); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), default_for: T.nilable(T::Array[String]), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
default_for: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# 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). This is only accepted for Checkout Sessions in `setup` mode.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(currency: T.nilable(String), mandate_options: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions), setup_future_usage: T.nilable(String), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
currency: nil,
mandate_options: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class Affirm < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class AfterpayClearpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Alipay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class AmazonPay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class AuBecsDebit < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(setup_future_usage: T.nilable(String), target_date: T.nilable(String)).void
}
def initialize(setup_future_usage: nil, target_date: nil); end
end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions), setup_future_usage: T.nilable(String), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Bancontact < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Boleto < Stripe::RequestParams
# The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
# Setting to true enables installments for this Checkout Session.
# Setting to false will prevent any installment plan from applying to a payment.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
sig { params(enabled: T.nilable(T::Boolean)).void }
def initialize(enabled: nil); end
end
class Restrictions < Stripe::RequestParams
# Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can't complete the Session.
sig { returns(T.nilable(T::Array[String])) }
def brands_blocked; end
sig {
params(_brands_blocked: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def brands_blocked=(_brands_blocked); end
sig { params(brands_blocked: T.nilable(T::Array[String])).void }
def initialize(brands_blocked: nil); end
end
# Installment options for card payments
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Installments))
}
def installments; end
sig {
params(_installments: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Installments)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Installments))
}
def installments=(_installments); end
# Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
sig { returns(T.nilable(String)) }
def request_decremental_authorization; end
sig {
params(_request_decremental_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_decremental_authorization=(_request_decremental_authorization); end
# Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
sig { returns(T.nilable(String)) }
def request_extended_authorization; end
sig {
params(_request_extended_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_extended_authorization=(_request_extended_authorization); end
# Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
sig { returns(T.nilable(String)) }
def request_incremental_authorization; end
sig {
params(_request_incremental_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_incremental_authorization=(_request_incremental_authorization); end
# Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
sig { returns(T.nilable(String)) }
def request_multicapture; end
sig { params(_request_multicapture: T.nilable(String)).returns(T.nilable(String)) }
def request_multicapture=(_request_multicapture); end
# Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
sig { returns(T.nilable(String)) }
def request_overcapture; end
sig { params(_request_overcapture: T.nilable(String)).returns(T.nilable(String)) }
def request_overcapture=(_request_overcapture); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
# Restrictions to apply to the card payment method. For example, you can block specific card brands.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Restrictions))
}
def restrictions; end
sig {
params(_restrictions: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Restrictions)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Restrictions))
}
def restrictions=(_restrictions); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kana; end
sig {
params(_statement_descriptor_suffix_kana: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_suffix_kana=(_statement_descriptor_suffix_kana); end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kanji; end
sig {
params(_statement_descriptor_suffix_kanji: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_suffix_kanji=(_statement_descriptor_suffix_kanji); end
sig {
params(installments: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Installments), request_decremental_authorization: T.nilable(String), request_extended_authorization: T.nilable(String), request_incremental_authorization: T.nilable(String), request_multicapture: T.nilable(String), request_overcapture: T.nilable(String), request_three_d_secure: T.nilable(String), restrictions: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Restrictions), setup_future_usage: T.nilable(String), statement_descriptor_suffix_kana: T.nilable(String), statement_descriptor_suffix_kanji: T.nilable(String)).void
}
def initialize(
installments: nil,
request_decremental_authorization: nil,
request_extended_authorization: nil,
request_incremental_authorization: nil,
request_multicapture: nil,
request_overcapture: nil,
request_three_d_secure: nil,
restrictions: nil,
setup_future_usage: nil,
statement_descriptor_suffix_kana: nil,
statement_descriptor_suffix_kanji: nil
); end
end
class Cashapp < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
sig {
params(_requested_address_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested_address_types=(_requested_address_types); end
# The list of bank transfer types that this PaymentIntent is allowed to use for funding.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
}
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(bank_transfer: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
end
class Eps < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Fpx < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Giropay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Grabpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Ideal < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class KakaoPay < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Klarna < Stripe::RequestParams
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
}
def next_billing; end
sig {
params(_next_billing: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling).returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling, reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Subscription details if the Checkout Session sets up a future subscription.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(setup_future_usage: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(setup_future_usage: nil, subscriptions: nil); end
end
class Konbini < Stripe::RequestParams
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class KrCard < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Link < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Mobilepay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Multibanco < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class NaverPay < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Oxxo < Stripe::RequestParams
# The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class P24 < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Confirm that the payer has accepted the P24 terms and conditions.
sig { returns(T.nilable(T::Boolean)) }
def tos_shown_and_accepted; end
sig {
params(_tos_shown_and_accepted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def tos_shown_and_accepted=(_tos_shown_and_accepted); end
sig {
params(setup_future_usage: T.nilable(String), tos_shown_and_accepted: T.nilable(T::Boolean)).void
}
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Paynow < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Paypal < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference_id; end
sig { params(_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def reference_id=(_reference_id); end
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
sig { returns(T.nilable(String)) }
def risk_correlation_id; end
sig { params(_risk_correlation_id: T.nilable(String)).returns(T.nilable(String)) }
def risk_correlation_id=(_risk_correlation_id); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(capture_method: T.nilable(String), preferred_locale: T.nilable(String), reference: T.nilable(String), reference_id: T.nilable(String), risk_correlation_id: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String)), subsellers: T.nilable(T::Array[String])).void
}
def initialize(
capture_method: nil,
preferred_locale: nil,
reference: nil,
reference_id: nil,
risk_correlation_id: nil,
setup_future_usage: nil,
subsellers: nil
); end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
sig { params(_payments_per_period: T.nilable(Integer)).returns(T.nilable(Integer)) }
def payments_per_period=(_payments_per_period); end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
sig { params(_purpose: T.nilable(String)).returns(T.nilable(String)) }
def purpose=(_purpose); end
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), payments_per_period: T.nilable(Integer), purpose: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil,
start_date: nil
); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto::MandateOptions)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(mandate_options: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto::MandateOptions), setup_future_usage: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil); end
end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Type of amount. Defaults to `maximum`.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), amount_type: T.nilable(String), currency: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), reference: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
amount_type: nil,
currency: nil,
end_date: nil,
payment_schedule: nil,
reference: nil,
start_date: nil
); end
end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
sig { returns(T.nilable(Integer)) }
def expires_after_seconds; end
sig { params(_expires_after_seconds: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_seconds=(_expires_after_seconds); end
# Additional fields for mandate creation.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(amount_includes_iof: T.nilable(String), expires_after_seconds: T.nilable(Integer), mandate_options: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix::MandateOptions), setup_future_usage: T.nilable(String)).void
}
def initialize(
amount_includes_iof: nil,
expires_after_seconds: nil,
mandate_options: nil,
setup_future_usage: nil
); end
end
class RevolutPay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class SamsungPay < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions), setup_future_usage: T.nilable(String), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Sofort < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Swish < Stripe::RequestParams
# The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
sig { params(reference: T.nilable(String)).void }
def initialize(reference: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
sig {
params(permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String])).void
}
def initialize(permissions: nil, prefetch: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), setup_future_usage: T.nilable(String), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
financial_connections: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class WechatPay < Stripe::RequestParams
# The app ID registered with WeChat Pay. Only required when client is ios or android.
sig { returns(T.nilable(String)) }
def app_id; end
sig { params(_app_id: T.nilable(String)).returns(T.nilable(String)) }
def app_id=(_app_id); end
# The client type that the end customer will pay from
sig { returns(String) }
def client; end
sig { params(_client: String).returns(String) }
def client=(_client); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(app_id: T.nilable(String), client: String, setup_future_usage: T.nilable(String)).void
}
def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
end
# contains details about the ACSS Debit payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit))
}
def acss_debit=(_acss_debit); end
# contains details about the Affirm payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Affirm))
}
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Affirm)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Affirm))
}
def affirm=(_affirm); end
# contains details about the Afterpay Clearpay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AfterpayClearpay)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# contains details about the Alipay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Alipay))
}
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Alipay)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Alipay))
}
def alipay=(_alipay); end
# contains details about the AmazonPay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AmazonPay)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# contains details about the AU Becs Debit payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AuBecsDebit)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# contains details about the Bacs Debit payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# contains details about the Bancontact payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Bancontact)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Bancontact))
}
def bancontact=(_bancontact); end
# contains details about the Boleto payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Boleto))
}
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Boleto)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Boleto))
}
def boleto=(_boleto); end
# contains details about the Card payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card))
}
def card=(_card); end
# contains details about the Cashapp Pay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Cashapp))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Cashapp)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Cashapp))
}
def cashapp=(_cashapp); end
# contains details about the Customer Balance payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# contains details about the EPS payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Eps))
}
def eps; end
sig {
params(_eps: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Eps)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Eps))
}
def eps=(_eps); end
# contains details about the FPX payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Fpx))
}
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Fpx)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Fpx))
}
def fpx=(_fpx); end
# contains details about the Giropay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Giropay))
}
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Giropay)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Giropay))
}
def giropay=(_giropay); end
# contains details about the Grabpay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Grabpay))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Grabpay)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Grabpay))
}
def grabpay=(_grabpay); end
# contains details about the Ideal payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Ideal))
}
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Ideal)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Ideal))
}
def ideal=(_ideal); end
# contains details about the Kakao Pay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KakaoPay))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KakaoPay)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# contains details about the Klarna payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# contains details about the Konbini payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Konbini))
}
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Konbini)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Konbini))
}
def konbini=(_konbini); end
# contains details about the Korean card payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KrCard))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KrCard)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KrCard))
}
def kr_card=(_kr_card); end
# contains details about the Link payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Link))
}
def link; end
sig {
params(_link: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Link)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Link))
}
def link=(_link); end
# contains details about the Mobilepay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Mobilepay)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Mobilepay))
}
def mobilepay=(_mobilepay); end
# contains details about the Multibanco payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Multibanco)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Multibanco))
}
def multibanco=(_multibanco); end
# contains details about the Naver Pay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::NaverPay))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::NaverPay)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::NaverPay))
}
def naver_pay=(_naver_pay); end
# contains details about the OXXO payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Oxxo))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Oxxo)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Oxxo))
}
def oxxo=(_oxxo); end
# contains details about the P24 payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::P24))
}
def p24; end
sig {
params(_p24: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::P24)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::P24))
}
def p24=(_p24); end
# contains details about the Pay By Bank payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::PayByBank)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# contains details about the PAYCO payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payco))
}
def payco; end
sig {
params(_payco: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payco)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payco))
}
def payco=(_payco); end
# contains details about the PayNow payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paynow))
}
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paynow)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paynow))
}
def paynow=(_paynow); end
# contains details about the PayPal payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
# contains details about the PayTo payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto))
}
def payto; end
sig {
params(_payto: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto))
}
def payto=(_payto); end
# contains details about the Pix payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix))
}
def pix; end
sig {
params(_pix: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix))
}
def pix=(_pix); end
# contains details about the RevolutPay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::RevolutPay)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# contains details about the Samsung Pay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SamsungPay)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# contains details about the Sepa Debit payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# contains details about the Sofort payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Sofort))
}
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Sofort)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Sofort))
}
def sofort=(_sofort); end
# contains details about the Swish payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Swish))
}
def swish; end
sig {
params(_swish: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Swish)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Swish))
}
def swish=(_swish); end
# contains details about the Us Bank Account payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# contains details about the WeChat Pay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::WechatPay)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::WechatPay))
}
def wechat_pay=(_wechat_pay); end
sig {
params(acss_debit: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit), affirm: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Affirm), afterpay_clearpay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AfterpayClearpay), alipay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Alipay), amazon_pay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AmazonPay), au_becs_debit: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AuBecsDebit), bacs_debit: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit), bancontact: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Bancontact), boleto: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Boleto), card: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card), cashapp: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Cashapp), customer_balance: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance), eps: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Eps), fpx: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Fpx), giropay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Giropay), grabpay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Grabpay), ideal: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Ideal), kakao_pay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KakaoPay), klarna: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna), konbini: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Konbini), kr_card: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KrCard), link: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Link), mobilepay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Mobilepay), multibanco: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Multibanco), naver_pay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::NaverPay), oxxo: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Oxxo), p24: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::P24), pay_by_bank: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::PayByBank), payco: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payco), paynow: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paynow), paypal: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paypal), payto: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto), pix: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix), revolut_pay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::RevolutPay), samsung_pay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SamsungPay), sepa_debit: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit), sofort: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Sofort), swish: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Swish), us_bank_account: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount), wechat_pay: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::WechatPay)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
boleto: nil,
card: nil,
cashapp: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
grabpay: nil,
ideal: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
payto: nil,
pix: nil,
revolut_pay: nil,
samsung_pay: nil,
sepa_debit: nil,
sofort: nil,
swish: nil,
us_bank_account: nil,
wechat_pay: nil
); end
end
class Permissions < Stripe::RequestParams
class Update < Stripe::RequestParams
# Determines which entity is allowed to update the line items.
#
# Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
#
# When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
sig { returns(T.nilable(String)) }
def line_items; end
sig { params(_line_items: T.nilable(String)).returns(T.nilable(String)) }
def line_items=(_line_items); end
# Determines which entity is allowed to update the shipping details.
#
# Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
#
# When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
sig { returns(T.nilable(String)) }
def shipping_details; end
sig { params(_shipping_details: T.nilable(String)).returns(T.nilable(String)) }
def shipping_details=(_shipping_details); end
sig { params(line_items: T.nilable(String), shipping_details: T.nilable(String)).void }
def initialize(line_items: nil, shipping_details: nil); end
end
# Permissions for updating the Checkout Session.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::Permissions::Update)) }
def update; end
sig {
params(_update: T.nilable(::Stripe::Checkout::Session::CreateParams::Permissions::Update)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::Permissions::Update))
}
def update=(_update); end
# Determines which entity is allowed to update the discounts (coupons or promotion codes) that apply to this session.
#
# Default is `client_only`. Stripe Checkout client will automatically handle discount updates. If set to `server_only`, only your server is allowed to update discounts.
sig { returns(T.nilable(String)) }
def update_discounts; end
sig { params(_update_discounts: T.nilable(String)).returns(T.nilable(String)) }
def update_discounts=(_update_discounts); end
# Determines which entity is allowed to update the line items.
#
# Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
#
# When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
sig { returns(T.nilable(String)) }
def update_line_items; end
sig { params(_update_line_items: T.nilable(String)).returns(T.nilable(String)) }
def update_line_items=(_update_line_items); end
# Determines which entity is allowed to update the shipping details.
#
# Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
#
# When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
sig { returns(T.nilable(String)) }
def update_shipping_details; end
sig { params(_update_shipping_details: T.nilable(String)).returns(T.nilable(String)) }
def update_shipping_details=(_update_shipping_details); end
sig {
params(update: T.nilable(::Stripe::Checkout::Session::CreateParams::Permissions::Update), update_discounts: T.nilable(String), update_line_items: T.nilable(String), update_shipping_details: T.nilable(String)).void
}
def initialize(
update: nil,
update_discounts: nil,
update_line_items: nil,
update_shipping_details: nil
); end
end
class PhoneNumberCollection < Stripe::RequestParams
# Set to `true` to enable phone number collection.
#
# Can only be set in `payment` and `subscription` mode.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class SavedPaymentMethodOptions < Stripe::RequestParams
# Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.
sig { returns(T.nilable(T::Array[String])) }
def allow_redisplay_filters; end
sig {
params(_allow_redisplay_filters: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allow_redisplay_filters=(_allow_redisplay_filters); end
# Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
sig { returns(T.nilable(String)) }
def payment_method_remove; end
sig { params(_payment_method_remove: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_remove=(_payment_method_remove); end
# Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
sig { returns(T.nilable(String)) }
def payment_method_save; end
sig { params(_payment_method_save: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_save=(_payment_method_save); end
sig {
params(allow_redisplay_filters: T.nilable(T::Array[String]), payment_method_remove: T.nilable(String), payment_method_save: T.nilable(String)).void
}
def initialize(
allow_redisplay_filters: nil,
payment_method_remove: nil,
payment_method_save: nil
); end
end
class SetupIntentData < Stripe::RequestParams
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The Stripe account for which the setup is intended.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
sig {
params(description: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String)).void
}
def initialize(description: nil, metadata: nil, on_behalf_of: nil); end
end
class ShippingAddressCollection < Stripe::RequestParams
# An array of two-letter ISO country codes representing which countries Checkout should provide as options for
# shipping locations.
sig { returns(T::Array[String]) }
def allowed_countries; end
sig { params(_allowed_countries: T::Array[String]).returns(T::Array[String]) }
def allowed_countries=(_allowed_countries); end
sig { params(allowed_countries: T::Array[String]).void }
def initialize(allowed_countries: nil); end
end
class ShippingOption < Stripe::RequestParams
class ShippingRateData < Stripe::RequestParams
class DeliveryEstimate < Stripe::RequestParams
class Maximum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
class Minimum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum; end
sig {
params(_maximum: T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum=(_maximum); end
# The lower bound of the estimated range. If empty, represents no lower bound.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum; end
sig {
params(_minimum: T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum=(_minimum); end
sig {
params(maximum: T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum), minimum: T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)).void
}
def initialize(maximum: nil, minimum: nil); end
end
class FixedAmount < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig { params(amount: Integer, tax_behavior: T.nilable(String)).void }
def initialize(amount: nil, tax_behavior: nil); end
end
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(amount: Integer, currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])).void
}
def initialize(amount: nil, currency: nil, currency_options: nil); end
end
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate; end
sig {
params(_delivery_estimate: T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate=(_delivery_estimate); end
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount))
}
def fixed_amount; end
sig {
params(_fixed_amount: T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount))
}
def fixed_amount=(_fixed_amount); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The type of calculation to use on the shipping rate.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(delivery_estimate: T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate), display_name: String, fixed_amount: T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount), metadata: T.nilable(T::Hash[String, String]), tax_behavior: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
delivery_estimate: nil,
display_name: nil,
fixed_amount: nil,
metadata: nil,
tax_behavior: nil,
tax_code: nil,
type: nil
); end
end
# The ID of the Shipping Rate to use for this shipping option.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
# Parameters to be passed to Shipping Rate creation for this shipping option.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData))
}
def shipping_rate_data; end
sig {
params(_shipping_rate_data: T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData))
}
def shipping_rate_data=(_shipping_rate_data); end
sig {
params(shipping_rate: T.nilable(String), shipping_rate_data: T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData)).void
}
def initialize(shipping_rate: nil, shipping_rate_data: nil); end
end
class SubscriptionData < Stripe::RequestParams
class BillingMode < Stripe::RequestParams
class Flexible < Stripe::RequestParams
# Set to `true` to display gross amounts, net amounts, and discount amounts consistently between prorations and non-proration items on invoices, line items, and invoice items. Once set to `true`, you can't change it back to `false`.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
sig {
params(_consistent_proration_discount_amounts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consistent_proration_discount_amounts=(
_consistent_proration_discount_amounts
); end
sig { params(consistent_proration_discount_amounts: T.nilable(T::Boolean)).void }
def initialize(consistent_proration_discount_amounts: nil); end
end
# Configure behavior for flexible billing mode.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::BillingMode::Flexible))
}
def flexible; end
sig {
params(_flexible: T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::BillingMode::Flexible)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::BillingMode::Flexible))
}
def flexible=(_flexible); end
# Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(flexible: T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::BillingMode::Flexible), type: String).void
}
def initialize(flexible: nil, type: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(issuer: T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings::Issuer)).void
}
def initialize(issuer: nil); end
end
class TransferData < Stripe::RequestParams
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount_percent: T.nilable(Float), destination: String).void }
def initialize(amount_percent: nil, destination: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
sig { returns(String) }
def missing_payment_method; end
sig { params(_missing_payment_method: String).returns(String) }
def missing_payment_method=(_missing_payment_method); end
sig { params(missing_payment_method: String).void }
def initialize(missing_payment_method: nil); end
end
# Defines how the subscription should behave when the user's free trial ends.
sig {
returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
}
def end_behavior; end
sig {
params(_end_behavior: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings::EndBehavior).returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings::EndBehavior).void
}
def initialize(end_behavior: nil); end
end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
sig { params(_application_fee_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def application_fee_percent=(_application_fee_percent); end
# A future timestamp to anchor the subscription's billing cycle for new subscriptions.
sig { returns(T.nilable(Integer)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(Integer)).returns(T.nilable(Integer)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::BillingMode))
}
def billing_mode; end
sig {
params(_billing_mode: T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::BillingMode)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::BillingMode))
}
def billing_mode=(_billing_mode); end
# The tax rates that will apply to any subscription item that does not have
# `tax_rates` set. Invoices created will have their `default_tax_rates` populated
# from the subscription.
sig { returns(T.nilable(T::Array[String])) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def default_tax_rates=(_default_tax_rates); end
# The subscription's description, meant to be displayable to the customer.
# Use this field to optionally store an explanation of the subscription
# for rendering in the [customer portal](https://stripe.com/docs/customer-management).
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The account on behalf of which to charge, for each of the subscription's invoices.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TransferData))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TransferData)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TransferData))
}
def transfer_data=(_transfer_data); end
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.
sig { returns(T.nilable(Integer)) }
def trial_end; end
sig { params(_trial_end: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_end=(_trial_end); end
# Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
sig { returns(T.nilable(Integer)) }
def trial_period_days; end
sig { params(_trial_period_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_period_days=(_trial_period_days); end
# Settings related to subscription trials.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings))
}
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(application_fee_percent: T.nilable(Float), billing_cycle_anchor: T.nilable(Integer), billing_mode: T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::BillingMode), default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), invoice_settings: T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TransferData), trial_end: T.nilable(Integer), trial_period_days: T.nilable(Integer), trial_settings: T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings)).void
}
def initialize(
application_fee_percent: nil,
billing_cycle_anchor: nil,
billing_mode: nil,
default_tax_rates: nil,
description: nil,
invoice_settings: nil,
metadata: nil,
on_behalf_of: nil,
proration_behavior: nil,
transfer_data: nil,
trial_end: nil,
trial_period_days: nil,
trial_settings: nil
); end
end
class TaxIdCollection < Stripe::RequestParams
# Enable tax ID collection during checkout. Defaults to `false`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Describes whether a tax ID is required during checkout. Defaults to `never`.
sig { returns(T.nilable(String)) }
def required; end
sig { params(_required: T.nilable(String)).returns(T.nilable(String)) }
def required=(_required); end
sig { params(enabled: T::Boolean, required: T.nilable(String)).void }
def initialize(enabled: nil, required: nil); end
end
class WalletOptions < Stripe::RequestParams
class Link < Stripe::RequestParams
# Specifies whether Checkout should display Link as a payment option. By default, Checkout will display all the supported wallets that the Checkout Session was created with. This is the `auto` behavior, and it is the default choice.
sig { returns(T.nilable(String)) }
def display; end
sig { params(_display: T.nilable(String)).returns(T.nilable(String)) }
def display=(_display); end
sig { params(display: T.nilable(String)).void }
def initialize(display: nil); end
end
# contains details about the Link wallet options.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::WalletOptions::Link)) }
def link; end
sig {
params(_link: T.nilable(::Stripe::Checkout::Session::CreateParams::WalletOptions::Link)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::WalletOptions::Link))
}
def link=(_link); end
sig {
params(link: T.nilable(::Stripe::Checkout::Session::CreateParams::WalletOptions::Link)).void
}
def initialize(link: nil); end
end
# Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::AdaptivePricing)) }
def adaptive_pricing; end
sig {
params(_adaptive_pricing: T.nilable(::Stripe::Checkout::Session::CreateParams::AdaptivePricing)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::AdaptivePricing))
}
def adaptive_pricing=(_adaptive_pricing); end
# Configure actions after a Checkout Session has expired.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::AfterExpiration)) }
def after_expiration; end
sig {
params(_after_expiration: T.nilable(::Stripe::Checkout::Session::CreateParams::AfterExpiration)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::AfterExpiration))
}
def after_expiration=(_after_expiration); end
# Enables user redeemable promotion codes.
sig { returns(T.nilable(T::Boolean)) }
def allow_promotion_codes; end
sig { params(_allow_promotion_codes: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def allow_promotion_codes=(_allow_promotion_codes); end
# Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::Checkout::Session::CreateParams::AutomaticTax)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
sig { returns(T.nilable(String)) }
def billing_address_collection; end
sig { params(_billing_address_collection: T.nilable(String)).returns(T.nilable(String)) }
def billing_address_collection=(_billing_address_collection); end
# The branding settings for the Checkout Session. This parameter is not allowed if ui_mode is `custom`.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::BrandingSettings)) }
def branding_settings; end
sig {
params(_branding_settings: T.nilable(::Stripe::Checkout::Session::CreateParams::BrandingSettings)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::BrandingSettings))
}
def branding_settings=(_branding_settings); end
# If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded` or `custom`.
sig { returns(T.nilable(String)) }
def cancel_url; end
sig { params(_cancel_url: T.nilable(String)).returns(T.nilable(String)) }
def cancel_url=(_cancel_url); end
# A unique string to reference the Checkout Session. This can be a
# customer ID, a cart ID, or similar, and can be used to reconcile the
# session with your internal systems.
sig { returns(T.nilable(String)) }
def client_reference_id; end
sig { params(_client_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def client_reference_id=(_client_reference_id); end
# Configure fields for the Checkout Session to gather active consent from customers.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::ConsentCollection)) }
def consent_collection; end
sig {
params(_consent_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::ConsentCollection)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::ConsentCollection))
}
def consent_collection=(_consent_collection); end
# 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). Required in `setup` mode when `payment_method_types` is not set.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Collect additional information from your customer using custom fields. Up to 3 fields are supported.
sig { returns(T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::CustomField])) }
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::CustomField])).returns(T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::CustomField]))
}
def custom_fields=(_custom_fields); end
# Display additional text for your customers using custom text.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText)) }
def custom_text; end
sig {
params(_custom_text: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText))
}
def custom_text=(_custom_text); end
# ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card
# payment method will be used to prefill the email, name, card details, and billing address
# on the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)
# will be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.
#
# If the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.
# If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.
#
# If blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow.
#
# You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# ID of an existing Account, if one exists. Has the same behavior as `customer`.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
#
# When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
# with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).
#
# Sessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)
# in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.
#
# Can only be set in `payment` and `setup` mode.
sig { returns(T.nilable(String)) }
def customer_creation; end
sig { params(_customer_creation: T.nilable(String)).returns(T.nilable(String)) }
def customer_creation=(_customer_creation); end
# If provided, this value will be used when the Customer object is created.
# If not provided, customers will be asked to enter their email address.
# Use this parameter to prefill customer data if you already have an email
# on file. To access information about the customer once a session is
# complete, use the `customer` field.
sig { returns(T.nilable(String)) }
def customer_email; end
sig { params(_customer_email: T.nilable(String)).returns(T.nilable(String)) }
def customer_email=(_customer_email); end
# Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomerUpdate)) }
def customer_update; end
sig {
params(_customer_update: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomerUpdate)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomerUpdate))
}
def customer_update=(_customer_update); end
# The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
sig { returns(T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::Discount])) }
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::Discount])).returns(T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::Discount]))
}
def discounts=(_discounts); end
# A list of the types of payment methods (e.g., `card`) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
sig { returns(T.nilable(T::Array[String])) }
def excluded_payment_method_types; end
sig {
params(_excluded_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def excluded_payment_method_types=(_excluded_payment_method_types); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# Generate a post-purchase Invoice for one-time payments.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation)) }
def invoice_creation; end
sig {
params(_invoice_creation: T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation))
}
def invoice_creation=(_invoice_creation); end
# A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). The parameter is required for `payment` and `subscription` mode.
#
# For `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.
#
# For `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.
sig { returns(T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::LineItem])) }
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::LineItem])).returns(T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::LineItem]))
}
def line_items=(_line_items); end
# The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
sig { returns(T.nilable(String)) }
def locale; end
sig { params(_locale: T.nilable(String)).returns(T.nilable(String)) }
def locale=(_locale); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Controls name collection settings for the session.
#
# You can configure Checkout to collect your customers' business names, individual names, or both. Each name field can be either required or optional.
#
# If a [Customer](https://stripe.com/docs/api/customers) is created or provided, the names can be saved to the Customer object as well.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::NameCollection)) }
def name_collection; end
sig {
params(_name_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::NameCollection)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::NameCollection))
}
def name_collection=(_name_collection); end
# A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
#
# There is a maximum of 10 optional items allowed on a Checkout Session, and the existing limits on the number of line items allowed on a Checkout Session apply to the combined number of line items and optional items.
#
# For `payment` mode, there is a maximum of 100 combined line items and optional items, however it is recommended to consolidate items if there are more than a few dozen.
#
# For `subscription` mode, there is a maximum of 20 line items and optional items with recurring Prices and 20 line items and optional items with one-time Prices.
sig {
returns(T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::OptionalItem]))
}
def optional_items; end
sig {
params(_optional_items: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::OptionalItem])).returns(T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::OptionalItem]))
}
def optional_items=(_optional_items); end
# Where the user is coming from. This informs the optimizations that are applied to the session.
sig { returns(T.nilable(String)) }
def origin_context; end
sig { params(_origin_context: T.nilable(String)).returns(T.nilable(String)) }
def origin_context=(_origin_context); end
# A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentIntentData)) }
def payment_intent_data; end
sig {
params(_payment_intent_data: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentIntentData)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentIntentData))
}
def payment_intent_data=(_payment_intent_data); end
# Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.
# This may occur if the Checkout Session includes a free trial or a discount.
#
# Can only be set in `subscription` mode. Defaults to `always`.
#
# If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
sig { returns(T.nilable(String)) }
def payment_method_collection; end
sig { params(_payment_method_collection: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_collection=(_payment_method_collection); end
# The ID of the payment method configuration to use with this Checkout session.
sig { returns(T.nilable(String)) }
def payment_method_configuration; end
sig { params(_payment_method_configuration: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_configuration=(_payment_method_configuration); end
# This parameter allows you to set some attributes on the payment method created during a Checkout session.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodData)) }
def payment_method_data; end
sig {
params(_payment_method_data: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodData)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodData))
}
def payment_method_data=(_payment_method_data); end
# Payment-method-specific configuration.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions)) }
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
#
# You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
# See [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.
#
# Read more about the supported payment methods and their requirements in our [payment
# method details guide](/docs/payments/checkout/payment-methods).
#
# If multiple payment methods are passed, Checkout will dynamically reorder them to
# prioritize the most relevant payment methods based on the customer's location and
# other characteristics.
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
# This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object. Can only be set when creating `embedded` or `custom` sessions.
#
# For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::Permissions)) }
def permissions; end
sig {
params(_permissions: T.nilable(::Stripe::Checkout::Session::CreateParams::Permissions)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::Permissions))
}
def permissions=(_permissions); end
# Controls phone number collection settings for the session.
#
# We recommend that you review your privacy policy and check with your legal contacts
# before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PhoneNumberCollection)) }
def phone_number_collection; end
sig {
params(_phone_number_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::PhoneNumberCollection)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PhoneNumberCollection))
}
def phone_number_collection=(_phone_number_collection); end
# This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
sig { returns(T.nilable(String)) }
def redirect_on_completion; end
sig { params(_redirect_on_completion: T.nilable(String)).returns(T.nilable(String)) }
def redirect_on_completion=(_redirect_on_completion); end
# The URL to redirect your customer back to after they authenticate or cancel their payment on the
# payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`
# and redirect-based payment methods are enabled on the session.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SavedPaymentMethodOptions))
}
def saved_payment_method_options; end
sig {
params(_saved_payment_method_options: T.nilable(::Stripe::Checkout::Session::CreateParams::SavedPaymentMethodOptions)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SavedPaymentMethodOptions))
}
def saved_payment_method_options=(_saved_payment_method_options); end
# A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SetupIntentData)) }
def setup_intent_data; end
sig {
params(_setup_intent_data: T.nilable(::Stripe::Checkout::Session::CreateParams::SetupIntentData)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SetupIntentData))
}
def setup_intent_data=(_setup_intent_data); end
# When set, provides configuration for Checkout to collect a shipping address from a customer.
sig {
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingAddressCollection))
}
def shipping_address_collection; end
sig {
params(_shipping_address_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingAddressCollection)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingAddressCollection))
}
def shipping_address_collection=(_shipping_address_collection); end
# The shipping rate options to apply to this Session. Up to a maximum of 5.
sig {
returns(T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::ShippingOption]))
}
def shipping_options; end
sig {
params(_shipping_options: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::ShippingOption])).returns(T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::ShippingOption]))
}
def shipping_options=(_shipping_options); end
# Describes the type of transaction being performed by Checkout in order
# to customize relevant text on the page, such as the submit button.
# `submit_type` can only be specified on Checkout Sessions in
# `payment` or `subscription` mode. If blank or `auto`, `pay` is used.
sig { returns(T.nilable(String)) }
def submit_type; end
sig { params(_submit_type: T.nilable(String)).returns(T.nilable(String)) }
def submit_type=(_submit_type); end
# A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData)) }
def subscription_data; end
sig {
params(_subscription_data: T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData))
}
def subscription_data=(_subscription_data); end
# The URL to which Stripe should send customers when payment or setup
# is complete.
# This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use
# information from the successful Checkout Session on your page, read the
# guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).
sig { returns(T.nilable(String)) }
def success_url; end
sig { params(_success_url: T.nilable(String)).returns(T.nilable(String)) }
def success_url=(_success_url); end
# Controls tax ID collection during checkout.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::TaxIdCollection)) }
def tax_id_collection; end
sig {
params(_tax_id_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::TaxIdCollection)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::TaxIdCollection))
}
def tax_id_collection=(_tax_id_collection); end
# The UI mode of the Session. Defaults to `hosted`.
sig { returns(T.nilable(String)) }
def ui_mode; end
sig { params(_ui_mode: T.nilable(String)).returns(T.nilable(String)) }
def ui_mode=(_ui_mode); end
# Wallet-specific configuration.
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::WalletOptions)) }
def wallet_options; end
sig {
params(_wallet_options: T.nilable(::Stripe::Checkout::Session::CreateParams::WalletOptions)).returns(T.nilable(::Stripe::Checkout::Session::CreateParams::WalletOptions))
}
def wallet_options=(_wallet_options); end
sig {
params(adaptive_pricing: T.nilable(::Stripe::Checkout::Session::CreateParams::AdaptivePricing), after_expiration: T.nilable(::Stripe::Checkout::Session::CreateParams::AfterExpiration), allow_promotion_codes: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::Checkout::Session::CreateParams::AutomaticTax), billing_address_collection: T.nilable(String), branding_settings: T.nilable(::Stripe::Checkout::Session::CreateParams::BrandingSettings), cancel_url: T.nilable(String), client_reference_id: T.nilable(String), consent_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::ConsentCollection), currency: T.nilable(String), custom_fields: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::CustomField]), custom_text: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText), customer: T.nilable(String), customer_account: T.nilable(String), customer_creation: T.nilable(String), customer_email: T.nilable(String), customer_update: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomerUpdate), discounts: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::Discount]), excluded_payment_method_types: T.nilable(T::Array[String]), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), invoice_creation: T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::LineItem]), locale: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), mode: T.nilable(String), name_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::NameCollection), optional_items: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::OptionalItem]), origin_context: T.nilable(String), payment_intent_data: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), permissions: T.nilable(::Stripe::Checkout::Session::CreateParams::Permissions), phone_number_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::PhoneNumberCollection), redirect_on_completion: T.nilable(String), return_url: T.nilable(String), saved_payment_method_options: T.nilable(::Stripe::Checkout::Session::CreateParams::SavedPaymentMethodOptions), setup_intent_data: T.nilable(::Stripe::Checkout::Session::CreateParams::SetupIntentData), shipping_address_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingAddressCollection), shipping_options: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::ShippingOption]), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData), success_url: T.nilable(String), tax_id_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::TaxIdCollection), ui_mode: T.nilable(String), wallet_options: T.nilable(::Stripe::Checkout::Session::CreateParams::WalletOptions)).void
}
def initialize(
adaptive_pricing: nil,
after_expiration: nil,
allow_promotion_codes: nil,
automatic_tax: nil,
billing_address_collection: nil,
branding_settings: nil,
cancel_url: nil,
client_reference_id: nil,
consent_collection: nil,
currency: nil,
custom_fields: nil,
custom_text: nil,
customer: nil,
customer_account: nil,
customer_creation: nil,
customer_email: nil,
customer_update: nil,
discounts: nil,
excluded_payment_method_types: nil,
expand: nil,
expires_at: nil,
invoice_creation: nil,
line_items: nil,
locale: nil,
metadata: nil,
mode: nil,
name_collection: nil,
optional_items: nil,
origin_context: nil,
payment_intent_data: nil,
payment_method_collection: nil,
payment_method_configuration: nil,
payment_method_data: nil,
payment_method_options: nil,
payment_method_types: nil,
permissions: nil,
phone_number_collection: nil,
redirect_on_completion: nil,
return_url: nil,
saved_payment_method_options: nil,
setup_intent_data: nil,
shipping_address_collection: nil,
shipping_options: nil,
submit_type: nil,
subscription_data: nil,
success_url: nil,
tax_id_collection: nil,
ui_mode: nil,
wallet_options: nil
); end
end
class UpdateParams < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::Checkout::Session::UpdateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(liability: T.nilable(::Stripe::Checkout::Session::UpdateParams::AutomaticTax::Liability)).void
}
def initialize(liability: nil); end
end
class CollectedInformation < Stripe::RequestParams
class ShippingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(String) }
def line1; end
sig { params(_line1: String).returns(String) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: String, line1: String, line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The address of the customer
sig {
returns(::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails::Address)
}
def address; end
sig {
params(_address: ::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails::Address).returns(::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails::Address)
}
def address=(_address); end
# The name of customer
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(address: ::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails::Address, name: String).void
}
def initialize(address: nil, name: nil); end
end
# The shipping details to apply to this Session.
sig {
returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails))
}
def shipping_details; end
sig {
params(_shipping_details: T.nilable(::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails))
}
def shipping_details=(_shipping_details); end
sig {
params(shipping_details: T.nilable(::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails)).void
}
def initialize(shipping_details: nil); end
end
class Discount < Stripe::RequestParams
class CouponData < Stripe::RequestParams
# A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
sig { returns(T.nilable(Integer)) }
def amount_off; end
sig { params(_amount_off: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_off=(_amount_off); end
# Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
sig { returns(T.nilable(String)) }
def duration; end
sig { params(_duration: T.nilable(String)).returns(T.nilable(String)) }
def duration=(_duration); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
sig { returns(T.nilable(Float)) }
def percent_off; end
sig { params(_percent_off: T.nilable(Float)).returns(T.nilable(Float)) }
def percent_off=(_percent_off); end
sig {
params(amount_off: T.nilable(Integer), currency: T.nilable(String), duration: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String), percent_off: T.nilable(Float)).void
}
def initialize(
amount_off: nil,
currency: nil,
duration: nil,
metadata: nil,
name: nil,
percent_off: nil
); end
end
# The ID of the [Coupon](https://stripe.com/docs/api/coupons) to apply to this Session. One of `coupon` or `coupon_data` is required when updating discounts.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# Data used to generate a new [Coupon](https://stripe.com/docs/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
sig {
returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::Discount::CouponData))
}
def coupon_data; end
sig {
params(_coupon_data: T.nilable(::Stripe::Checkout::Session::UpdateParams::Discount::CouponData)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::Discount::CouponData))
}
def coupon_data=(_coupon_data); end
sig {
params(coupon: T.nilable(String), coupon_data: T.nilable(::Stripe::Checkout::Session::UpdateParams::Discount::CouponData)).void
}
def initialize(coupon: nil, coupon_data: nil); end
end
class InvoiceCreation < Stripe::RequestParams
class InvoiceData < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::InvoiceCreation::InvoiceData::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::Checkout::Session::UpdateParams::InvoiceCreation::InvoiceData::Issuer)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::InvoiceCreation::InvoiceData::Issuer))
}
def issuer=(_issuer); end
sig {
params(issuer: T.nilable(::Stripe::Checkout::Session::UpdateParams::InvoiceCreation::InvoiceData::Issuer)).void
}
def initialize(issuer: nil); end
end
# Parameters passed when creating invoices for payment-mode Checkout Sessions.
sig {
returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::InvoiceCreation::InvoiceData))
}
def invoice_data; end
sig {
params(_invoice_data: T.nilable(::Stripe::Checkout::Session::UpdateParams::InvoiceCreation::InvoiceData)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::InvoiceCreation::InvoiceData))
}
def invoice_data=(_invoice_data); end
sig {
params(invoice_data: T.nilable(::Stripe::Checkout::Session::UpdateParams::InvoiceCreation::InvoiceData)).void
}
def initialize(invoice_data: nil); end
end
class LineItem < Stripe::RequestParams
class AdjustableQuantity < Stripe::RequestParams
# Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil); end
end
class PriceData < Stripe::RequestParams
class ProductData < Stripe::RequestParams
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T::Array[String])) }
def images; end
sig {
params(_images: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def images=(_images); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
sig {
params(description: T.nilable(String), images: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: String, tax_code: T.nilable(String), unit_label: T.nilable(String)).void
}
def initialize(
description: nil,
images: nil,
metadata: nil,
name: nil,
tax_code: nil,
unit_label: nil
); end
end
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
sig {
returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData::ProductData))
}
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData::ProductData)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData::ProductData))
}
def product_data=(_product_data); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData::Recurring))
}
def recurring; end
sig {
params(_recurring: T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData::Recurring)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData::Recurring))
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: T.nilable(String), product_data: T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData::ProductData), recurring: T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
product_data: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
sig {
returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::AdjustableQuantity))
}
def adjustable_quantity; end
sig {
params(_adjustable_quantity: T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::AdjustableQuantity)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::AdjustableQuantity))
}
def adjustable_quantity=(_adjustable_quantity); end
# ID of an existing line item.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The ID of the [Price](https://stripe.com/docs/api/prices). One of `price` or `price_data` is required when creating a new line item.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required when creating a new line item.
sig { returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData))
}
def price_data=(_price_data); end
# The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(adjustable_quantity: T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::AdjustableQuantity), id: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), price: T.nilable(String), price_data: T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
adjustable_quantity: nil,
id: nil,
metadata: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class ShippingOption < Stripe::RequestParams
class ShippingRateData < Stripe::RequestParams
class DeliveryEstimate < Stripe::RequestParams
class Maximum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
class Minimum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
sig {
returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum; end
sig {
params(_maximum: T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum=(_maximum); end
# The lower bound of the estimated range. If empty, represents no lower bound.
sig {
returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum; end
sig {
params(_minimum: T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum=(_minimum); end
sig {
params(maximum: T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum), minimum: T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)).void
}
def initialize(maximum: nil, minimum: nil); end
end
class FixedAmount < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig { params(amount: Integer, tax_behavior: T.nilable(String)).void }
def initialize(amount: nil, tax_behavior: nil); end
end
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(amount: Integer, currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])).void
}
def initialize(amount: nil, currency: nil, currency_options: nil); end
end
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig {
returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate; end
sig {
params(_delivery_estimate: T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate=(_delivery_estimate); end
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
sig {
returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount))
}
def fixed_amount; end
sig {
params(_fixed_amount: T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount))
}
def fixed_amount=(_fixed_amount); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The type of calculation to use on the shipping rate.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(delivery_estimate: T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate), display_name: String, fixed_amount: T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount), metadata: T.nilable(T::Hash[String, String]), tax_behavior: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
delivery_estimate: nil,
display_name: nil,
fixed_amount: nil,
metadata: nil,
tax_behavior: nil,
tax_code: nil,
type: nil
); end
end
# The ID of the Shipping Rate to use for this shipping option.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
# Parameters to be passed to Shipping Rate creation for this shipping option.
sig {
returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData))
}
def shipping_rate_data; end
sig {
params(_shipping_rate_data: T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData))
}
def shipping_rate_data=(_shipping_rate_data); end
sig {
params(shipping_rate: T.nilable(String), shipping_rate_data: T.nilable(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData)).void
}
def initialize(shipping_rate: nil, shipping_rate_data: nil); end
end
class SubscriptionData < Stripe::RequestParams
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::SubscriptionData::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::Checkout::Session::UpdateParams::SubscriptionData::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::SubscriptionData::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(issuer: T.nilable(::Stripe::Checkout::Session::UpdateParams::SubscriptionData::InvoiceSettings::Issuer)).void
}
def initialize(issuer: nil); end
end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::SubscriptionData::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::Checkout::Session::UpdateParams::SubscriptionData::InvoiceSettings)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::SubscriptionData::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.
sig { returns(T.nilable(Integer)) }
def trial_end; end
sig { params(_trial_end: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_end=(_trial_end); end
# Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
sig { returns(T.nilable(T.any(String, Integer))) }
def trial_period_days; end
sig {
params(_trial_period_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def trial_period_days=(_trial_period_days); end
sig {
params(invoice_settings: T.nilable(::Stripe::Checkout::Session::UpdateParams::SubscriptionData::InvoiceSettings), trial_end: T.nilable(Integer), trial_period_days: T.nilable(T.any(String, Integer))).void
}
def initialize(invoice_settings: nil, trial_end: nil, trial_period_days: nil); end
end
# Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
sig { returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::Checkout::Session::UpdateParams::AutomaticTax)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Information about the customer collected within the Checkout Session. Can only be set when updating `embedded` or `custom` sessions.
sig { returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::CollectedInformation)) }
def collected_information; end
sig {
params(_collected_information: T.nilable(::Stripe::Checkout::Session::UpdateParams::CollectedInformation)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::CollectedInformation))
}
def collected_information=(_collected_information); end
# List of coupons and promotion codes attached to the Checkout Session.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Checkout::Session::UpdateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Checkout::Session::UpdateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Checkout::Session::UpdateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Generate a post-purchase Invoice for one-time payments.
sig { returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::InvoiceCreation)) }
def invoice_creation; end
sig {
params(_invoice_creation: T.nilable(::Stripe::Checkout::Session::UpdateParams::InvoiceCreation)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::InvoiceCreation))
}
def invoice_creation=(_invoice_creation); end
# A list of items the customer is purchasing.
#
# When updating line items, you must retransmit the entire array of line items.
#
# To retain an existing line item, specify its `id`.
#
# To update an existing line item, specify its `id` along with the new values of the fields to update.
#
# To add a new line item, specify one of `price` or `price_data` and `quantity`.
#
# To remove an existing line item, omit the line item's ID from the retransmitted array.
#
# To reorder a line item, specify it at the desired position in the retransmitted array.
sig { returns(T.nilable(T::Array[::Stripe::Checkout::Session::UpdateParams::LineItem])) }
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::Checkout::Session::UpdateParams::LineItem])).returns(T.nilable(T::Array[::Stripe::Checkout::Session::UpdateParams::LineItem]))
}
def line_items=(_line_items); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The shipping rate options to apply to this Session. Up to a maximum of 5.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Checkout::Session::UpdateParams::ShippingOption])))
}
def shipping_options; end
sig {
params(_shipping_options: T.nilable(T.any(String, T::Array[::Stripe::Checkout::Session::UpdateParams::ShippingOption]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Checkout::Session::UpdateParams::ShippingOption])))
}
def shipping_options=(_shipping_options); end
# A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
sig { returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::SubscriptionData)) }
def subscription_data; end
sig {
params(_subscription_data: T.nilable(::Stripe::Checkout::Session::UpdateParams::SubscriptionData)).returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::SubscriptionData))
}
def subscription_data=(_subscription_data); end
sig {
params(automatic_tax: T.nilable(::Stripe::Checkout::Session::UpdateParams::AutomaticTax), collected_information: T.nilable(::Stripe::Checkout::Session::UpdateParams::CollectedInformation), discounts: T.nilable(T.any(String, T::Array[::Stripe::Checkout::Session::UpdateParams::Discount])), expand: T.nilable(T::Array[String]), invoice_creation: T.nilable(::Stripe::Checkout::Session::UpdateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::Checkout::Session::UpdateParams::LineItem]), metadata: T.nilable(T.any(String, T::Hash[String, String])), shipping_options: T.nilable(T.any(String, T::Array[::Stripe::Checkout::Session::UpdateParams::ShippingOption])), subscription_data: T.nilable(::Stripe::Checkout::Session::UpdateParams::SubscriptionData)).void
}
def initialize(
automatic_tax: nil,
collected_information: nil,
discounts: nil,
expand: nil,
invoice_creation: nil,
line_items: nil,
metadata: nil,
shipping_options: nil,
subscription_data: nil
); end
end
class ListLineItemsParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class ExpireParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Creates a Checkout Session object.
sig {
params(params: T.any(::Stripe::Checkout::Session::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
}
def self.create(params = {}, opts = {}); end
# A Checkout Session can be expired when it is in one of these statuses: open
#
# 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.
sig {
params(params: T.any(::Stripe::Checkout::Session::ExpireParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
}
def expire(params = {}, opts = {}); end
# A Checkout Session can be expired when it is in one of these statuses: open
#
# 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.
sig {
params(session: String, params: T.any(::Stripe::Checkout::Session::ExpireParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
}
def self.expire(session, params = {}, opts = {}); end
# Returns a list of Checkout Sessions.
sig {
params(params: T.any(::Stripe::Checkout::Session::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
sig {
params(params: T.any(::Stripe::Checkout::Session::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list_line_items(params = {}, opts = {}); end
# When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
sig {
params(session: String, params: T.any(::Stripe::Checkout::Session::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list_line_items(session, params = {}, opts = {}); end
# Updates a Checkout Session object.
#
# Related guide: [Dynamically update Checkout](https://docs.stripe.com/payments/checkout/dynamic-updates)
sig {
params(session: String, params: T.any(::Stripe::Checkout::Session::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
}
def self.update(session, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Climate
# Orders represent your intent to purchase a particular Climate product. When you create an order, the
# payment is deducted from your merchant balance.
class Order < APIResource
class Beneficiary < Stripe::StripeObject
# Publicly displayable name for the end beneficiary of carbon removal.
sig { returns(String) }
def public_name; end
end
class DeliveryDetail < Stripe::StripeObject
class Location < Stripe::StripeObject
# The city where the supplier is located.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter ISO code representing the country where the supplier is located.
sig { returns(String) }
def country; end
# The geographic latitude where the supplier is located.
sig { returns(T.nilable(Float)) }
def latitude; end
# The geographic longitude where the supplier is located.
sig { returns(T.nilable(Float)) }
def longitude; end
# The state/county/province/region where the supplier is located.
sig { returns(T.nilable(String)) }
def region; end
end
# Time at which the delivery occurred. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def delivered_at; end
# Specific location of this delivery.
sig { returns(T.nilable(Location)) }
def location; end
# Quantity of carbon removal supplied by this delivery.
sig { returns(String) }
def metric_tons; end
# Once retired, a URL to the registry entry for the tons from this delivery.
sig { returns(T.nilable(String)) }
def registry_url; end
# A supplier of carbon removal.
sig { returns(Stripe::Climate::Supplier) }
def supplier; end
end
# Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit.
sig { returns(Integer) }
def amount_fees; end
# Total amount of the carbon removal in the currency's smallest unit.
sig { returns(Integer) }
def amount_subtotal; end
# Total amount of the order including fees in the currency's smallest unit.
sig { returns(Integer) }
def amount_total; end
# Attribute for field beneficiary
sig { returns(T.nilable(Beneficiary)) }
def beneficiary; end
# Time at which the order was canceled. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def canceled_at; end
# Reason for the cancellation of this order.
sig { returns(T.nilable(String)) }
def cancellation_reason; end
# For delivered orders, a URL to a delivery certificate for the order.
sig { returns(T.nilable(String)) }
def certificate; end
# Time at which the order was confirmed. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def confirmed_at; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order.
sig { returns(String) }
def currency; end
# Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def delayed_at; end
# Time at which the order was delivered. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def delivered_at; end
# Details about the delivery of carbon removal for this order.
sig { returns(T::Array[DeliveryDetail]) }
def delivery_details; end
# The year this order is expected to be delivered.
sig { returns(Integer) }
def expected_delivery_year; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# Quantity of carbon removal that is included in this order.
sig { returns(String) }
def metric_tons; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Unique ID for the Climate `Product` this order is purchasing.
sig { returns(T.any(String, Stripe::Climate::Product)) }
def product; end
# Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def product_substituted_at; end
# The current status of this order.
sig { returns(String) }
def status; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateParams < Stripe::RequestParams
class Beneficiary < Stripe::RequestParams
# Publicly displayable name for the end beneficiary of carbon removal.
sig { returns(String) }
def public_name; end
sig { params(_public_name: String).returns(String) }
def public_name=(_public_name); end
sig { params(public_name: String).void }
def initialize(public_name: nil); end
end
# Requested amount of carbon removal units. Either this or `metric_tons` must be specified.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.
sig { returns(T.nilable(::Stripe::Climate::Order::CreateParams::Beneficiary)) }
def beneficiary; end
sig {
params(_beneficiary: T.nilable(::Stripe::Climate::Order::CreateParams::Beneficiary)).returns(T.nilable(::Stripe::Climate::Order::CreateParams::Beneficiary))
}
def beneficiary=(_beneficiary); end
# Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Requested number of tons for the order. Either this or `amount` must be specified.
sig { returns(T.nilable(String)) }
def metric_tons; end
sig { params(_metric_tons: T.nilable(String)).returns(T.nilable(String)) }
def metric_tons=(_metric_tons); end
# Unique identifier of the Climate product.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
sig {
params(amount: T.nilable(Integer), beneficiary: T.nilable(::Stripe::Climate::Order::CreateParams::Beneficiary), currency: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), metric_tons: T.nilable(String), product: String).void
}
def initialize(
amount: nil,
beneficiary: nil,
currency: nil,
expand: nil,
metadata: nil,
metric_tons: nil,
product: nil
); end
end
class UpdateParams < Stripe::RequestParams
class Beneficiary < Stripe::RequestParams
# Publicly displayable name for the end beneficiary of carbon removal.
sig { returns(String) }
def public_name; end
sig { params(_public_name: String).returns(String) }
def public_name=(_public_name); end
sig { params(public_name: String).void }
def initialize(public_name: nil); end
end
# Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.
sig {
returns(T.nilable(T.any(String, ::Stripe::Climate::Order::UpdateParams::Beneficiary)))
}
def beneficiary; end
sig {
params(_beneficiary: T.nilable(T.any(String, ::Stripe::Climate::Order::UpdateParams::Beneficiary))).returns(T.nilable(T.any(String, ::Stripe::Climate::Order::UpdateParams::Beneficiary)))
}
def beneficiary=(_beneficiary); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(beneficiary: T.nilable(T.any(String, ::Stripe::Climate::Order::UpdateParams::Beneficiary)), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(beneficiary: nil, expand: nil, metadata: nil); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
# reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
# might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
# provides 90 days advance notice and refunds the amount_total.
sig {
params(params: T.any(::Stripe::Climate::Order::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Climate::Order)
}
def cancel(params = {}, opts = {}); end
# Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
# reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
# might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
# provides 90 days advance notice and refunds the amount_total.
sig {
params(order: String, params: T.any(::Stripe::Climate::Order::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Climate::Order)
}
def self.cancel(order, params = {}, opts = {}); end
# Creates a Climate order object for a given Climate product. The order will be processed immediately
# after creation and payment will be deducted your Stripe balance.
sig {
params(params: T.any(::Stripe::Climate::Order::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Climate::Order)
}
def self.create(params = {}, opts = {}); end
# Lists all Climate order objects. The orders are returned sorted by creation date, with the
# most recently created orders appearing first.
sig {
params(params: T.any(::Stripe::Climate::Order::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates the specified order by setting the values of the parameters passed.
sig {
params(order: String, params: T.any(::Stripe::Climate::Order::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Climate::Order)
}
def self.update(order, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Climate
# A Climate product represents a type of carbon removal unit available for reservation.
# You can retrieve it to see the current price and availability.
class Product < APIResource
class CurrentPricesPerMetricTon < Stripe::StripeObject
# Fees for one metric ton of carbon removal in the currency's smallest unit.
sig { returns(Integer) }
def amount_fees; end
# Subtotal for one metric ton of carbon removal (excluding fees) in the currency's smallest unit.
sig { returns(Integer) }
def amount_subtotal; end
# Total for one metric ton of carbon removal (including fees) in the currency's smallest unit.
sig { returns(Integer) }
def amount_total; end
end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Current prices for a metric ton of carbon removal in a currency's smallest unit.
sig { returns(T::Hash[String, CurrentPricesPerMetricTon]) }
def current_prices_per_metric_ton; end
# The year in which the carbon removal is expected to be delivered.
sig { returns(T.nilable(Integer)) }
def delivery_year; end
# Unique identifier for the object. For convenience, Climate product IDs are human-readable strings
# that start with `climsku_`. See [carbon removal inventory](https://stripe.com/docs/climate/orders/carbon-removal-inventory)
# for a list of available carbon removal products.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# The quantity of metric tons available for reservation.
sig { returns(String) }
def metric_tons_available; end
# The Climate product's name.
sig { returns(String) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The carbon removal suppliers that fulfill orders for this Climate product.
sig { returns(T::Array[Stripe::Climate::Supplier]) }
def suppliers; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Lists all available Climate product objects.
sig {
params(params: T.any(::Stripe::Climate::Product::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Climate
# A supplier of carbon removal.
class Supplier < APIResource
class Location < Stripe::StripeObject
# The city where the supplier is located.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter ISO code representing the country where the supplier is located.
sig { returns(String) }
def country; end
# The geographic latitude where the supplier is located.
sig { returns(T.nilable(Float)) }
def latitude; end
# The geographic longitude where the supplier is located.
sig { returns(T.nilable(Float)) }
def longitude; end
# The state/county/province/region where the supplier is located.
sig { returns(T.nilable(String)) }
def region; end
end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Link to a webpage to learn more about the supplier.
sig { returns(String) }
def info_url; end
# 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) }
def livemode; end
# The locations in which this supplier operates.
sig { returns(T::Array[Location]) }
def locations; end
# Name of this carbon removal supplier.
sig { returns(String) }
def name; end
# String representing the object’s type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The scientific pathway used for carbon removal.
sig { returns(String) }
def removal_pathway; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Lists all available Climate supplier objects.
sig {
params(params: T.any(::Stripe::Climate::Supplier::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
# ConfirmationTokens help transport client side data collected by Stripe JS over
# to your server for confirming a PaymentIntent or SetupIntent. If the confirmation
# is successful, values present on the ConfirmationToken are written onto the Intent.
#
# To learn more about how to use ConfirmationToken, visit the related guides:
# - [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server)
# - [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation).
class ConfirmationToken < APIResource
class MandateData < Stripe::StripeObject
class CustomerAcceptance < Stripe::StripeObject
class Online < Stripe::StripeObject
# The IP address from which the Mandate was accepted by the customer.
sig { returns(T.nilable(String)) }
def ip_address; end
# The user agent of the browser from which the Mandate was accepted by the customer.
sig { returns(T.nilable(String)) }
def user_agent; end
end
# If this is a Mandate accepted online, this hash contains details about the online acceptance.
sig { returns(T.nilable(Online)) }
def online; end
# The type of customer acceptance information included with the Mandate.
sig { returns(String) }
def type; end
end
# This hash contains details about the customer acceptance of the Mandate.
sig { returns(CustomerAcceptance) }
def customer_acceptance; end
end
class PaymentMethodOptions < Stripe::StripeObject
class Card < Stripe::StripeObject
class Installments < Stripe::StripeObject
class Plan < Stripe::StripeObject
# For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.
sig { returns(T.nilable(Integer)) }
def count; end
# For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.
# One of `month`.
sig { returns(T.nilable(String)) }
def interval; end
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
sig { returns(String) }
def type; end
end
# Attribute for field plan
sig { returns(T.nilable(Plan)) }
def plan; end
end
# The `cvc_update` Token collected from the Payment Element.
sig { returns(T.nilable(String)) }
def cvc_token; end
# Installment configuration for payments.
sig { returns(T.nilable(Installments)) }
def installments; end
end
# This hash contains the card payment method options.
sig { returns(T.nilable(Card)) }
def card; end
end
class PaymentMethodPreview < Stripe::StripeObject
class AcssDebit < Stripe::StripeObject
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Institution number of the bank account.
sig { returns(T.nilable(String)) }
def institution_number; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# Transit number of the bank account.
sig { returns(T.nilable(String)) }
def transit_number; end
end
class Affirm < Stripe::StripeObject; end
class AfterpayClearpay < Stripe::StripeObject; end
class Alipay < Stripe::StripeObject; end
class Alma < Stripe::StripeObject; end
class AmazonPay < Stripe::StripeObject; end
class AuBecsDebit < Stripe::StripeObject
# Six-digit number identifying bank and branch associated with this bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
end
class BacsDebit < Stripe::StripeObject
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
end
class Bancontact < Stripe::StripeObject; end
class Billie < Stripe::StripeObject; end
class BillingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Billing address.
sig { returns(T.nilable(Address)) }
def address; end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
end
class Blik < Stripe::StripeObject; end
class Boleto < Stripe::StripeObject
# Uniquely identifies the customer tax id (CNPJ or CPF)
sig { returns(String) }
def tax_id; end
end
class Card < Stripe::StripeObject
class Checks < Stripe::StripeObject
# If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
sig { returns(T.nilable(String)) }
def address_line1_check; end
# If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
sig { returns(T.nilable(String)) }
def address_postal_code_check; end
# If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
sig { returns(T.nilable(String)) }
def cvc_check; end
end
class GeneratedFrom < Stripe::StripeObject
class PaymentMethodDetails < Stripe::StripeObject
class CardPresent < Stripe::StripeObject
class Offline < Stripe::StripeObject
# Time at which the payment was collected while offline
sig { returns(T.nilable(Integer)) }
def stored_at; end
# The method used to process this payment method offline. Only deferred is allowed.
sig { returns(T.nilable(String)) }
def type; end
end
class Receipt < Stripe::StripeObject
# The type of account being debited or credited
sig { returns(T.nilable(String)) }
def account_type; end
# The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.
sig { returns(T.nilable(String)) }
def application_cryptogram; end
# The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip.
sig { returns(T.nilable(String)) }
def application_preferred_name; end
# Identifier for this transaction.
sig { returns(T.nilable(String)) }
def authorization_code; end
# EMV tag 8A. A code returned by the card issuer.
sig { returns(T.nilable(String)) }
def authorization_response_code; end
# Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.
sig { returns(T.nilable(String)) }
def cardholder_verification_method; end
# Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.
sig { returns(T.nilable(String)) }
def dedicated_file_name; end
# A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.
sig { returns(T.nilable(String)) }
def terminal_verification_results; end
# An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.
sig { returns(T.nilable(String)) }
def transaction_status_information; end
end
class Wallet < Stripe::StripeObject
# The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.
sig { returns(String) }
def type; end
end
# The authorized amount
sig { returns(T.nilable(Integer)) }
def amount_authorized; end
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(T.nilable(String)) }
def brand; end
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.
sig { returns(T.nilable(String)) }
def brand_product; end
# When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.
sig { returns(T.nilable(Integer)) }
def capture_before; end
# The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
sig { returns(T.nilable(String)) }
def cardholder_name; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# Authorization response cryptogram.
sig { returns(T.nilable(String)) }
def emv_auth_data; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
sig { returns(T.nilable(String)) }
def generated_card; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
sig { returns(T::Boolean) }
def incremental_authorization_supported; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
# Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
sig { returns(T.nilable(String)) }
def network; end
# This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
sig { returns(T.nilable(String)) }
def network_transaction_id; end
# Details about payments collected offline.
sig { returns(T.nilable(Offline)) }
def offline; end
# Defines whether the authorized amount can be over-captured or not
sig { returns(T::Boolean) }
def overcapture_supported; end
# The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
# How card details were read in this transaction.
sig { returns(T.nilable(String)) }
def read_method; end
# A collection of fields required to be displayed on receipts. Only required for EMV transactions.
sig { returns(T.nilable(Receipt)) }
def receipt; end
# Attribute for field wallet
sig { returns(T.nilable(Wallet)) }
def wallet; end
end
# Attribute for field card_present
sig { returns(T.nilable(CardPresent)) }
def card_present; end
# The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`.
sig { returns(String) }
def type; end
end
# The charge that created this object.
sig { returns(T.nilable(String)) }
def charge; end
# Transaction-specific details of the payment method used in the payment.
sig { returns(T.nilable(PaymentMethodDetails)) }
def payment_method_details; end
# The ID of the SetupAttempt that generated this PaymentMethod, if any.
sig { returns(T.nilable(T.any(String, Stripe::SetupAttempt))) }
def setup_attempt; end
end
class Networks < Stripe::StripeObject
# All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).
sig { returns(T::Array[String]) }
def available; end
# The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.
sig { returns(T.nilable(String)) }
def preferred; end
end
class ThreeDSecureUsage < Stripe::StripeObject
# Whether 3D Secure is supported on this card.
sig { returns(T::Boolean) }
def supported; end
end
class Wallet < Stripe::StripeObject
class AmexExpressCheckout < Stripe::StripeObject; end
class ApplePay < Stripe::StripeObject; end
class GooglePay < Stripe::StripeObject; end
class Link < Stripe::StripeObject; end
class Masterpass < Stripe::StripeObject
class BillingAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class ShippingAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(BillingAddress)) }
def billing_address; end
# Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def email; end
# Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def name; end
# Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(ShippingAddress)) }
def shipping_address; end
end
class SamsungPay < Stripe::StripeObject; end
class VisaCheckout < Stripe::StripeObject
class BillingAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class ShippingAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(BillingAddress)) }
def billing_address; end
# Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def email; end
# Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def name; end
# Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(ShippingAddress)) }
def shipping_address; end
end
# Attribute for field amex_express_checkout
sig { returns(T.nilable(AmexExpressCheckout)) }
def amex_express_checkout; end
# Attribute for field apple_pay
sig { returns(T.nilable(ApplePay)) }
def apple_pay; end
# (For tokenized numbers only.) The last four digits of the device account number.
sig { returns(T.nilable(String)) }
def dynamic_last4; end
# Attribute for field google_pay
sig { returns(T.nilable(GooglePay)) }
def google_pay; end
# Attribute for field link
sig { returns(T.nilable(Link)) }
def link; end
# Attribute for field masterpass
sig { returns(T.nilable(Masterpass)) }
def masterpass; end
# Attribute for field samsung_pay
sig { returns(T.nilable(SamsungPay)) }
def samsung_pay; end
# The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.
sig { returns(String) }
def type; end
# Attribute for field visa_checkout
sig { returns(T.nilable(VisaCheckout)) }
def visa_checkout; end
end
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(String) }
def brand; end
# Checks on Card address and CVC if provided.
sig { returns(T.nilable(Checks)) }
def checks; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future.
sig { returns(T.nilable(String)) }
def display_brand; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(String) }
def funding; end
# Details of the original PaymentMethod that created this object.
sig { returns(T.nilable(GeneratedFrom)) }
def generated_from; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(String) }
def last4; end
# Contains information about card networks that can be used to process the payment.
sig { returns(T.nilable(Networks)) }
def networks; end
# Status of a card based on the card issuer.
sig { returns(T.nilable(String)) }
def regulated_status; end
# Contains details on how this Card may be used for 3D Secure authentication.
sig { returns(T.nilable(ThreeDSecureUsage)) }
def three_d_secure_usage; end
# If this Card is part of a card wallet, this contains the details of the card wallet.
sig { returns(T.nilable(Wallet)) }
def wallet; end
end
class CardPresent < Stripe::StripeObject
class Networks < Stripe::StripeObject
# All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).
sig { returns(T::Array[String]) }
def available; end
# The preferred network for the card.
sig { returns(T.nilable(String)) }
def preferred; end
end
class Offline < Stripe::StripeObject
# Time at which the payment was collected while offline
sig { returns(T.nilable(Integer)) }
def stored_at; end
# The method used to process this payment method offline. Only deferred is allowed.
sig { returns(T.nilable(String)) }
def type; end
end
class Wallet < Stripe::StripeObject
# The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.
sig { returns(String) }
def type; end
end
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(T.nilable(String)) }
def brand; end
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.
sig { returns(T.nilable(String)) }
def brand_product; end
# The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
sig { returns(T.nilable(String)) }
def cardholder_name; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
# Contains information about card networks that can be used to process the payment.
sig { returns(T.nilable(Networks)) }
def networks; end
# Details about payment methods collected offline.
sig { returns(T.nilable(Offline)) }
def offline; end
# The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
# How card details were read in this transaction.
sig { returns(T.nilable(String)) }
def read_method; end
# Attribute for field wallet
sig { returns(T.nilable(Wallet)) }
def wallet; end
end
class Cashapp < Stripe::StripeObject
# A unique and immutable identifier assigned by Cash App to every buyer.
sig { returns(T.nilable(String)) }
def buyer_id; end
# A public identifier for buyers using Cash App.
sig { returns(T.nilable(String)) }
def cashtag; end
end
class Crypto < Stripe::StripeObject; end
class CustomerBalance < Stripe::StripeObject; end
class Eps < Stripe::StripeObject
# The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.
sig { returns(T.nilable(String)) }
def bank; end
end
class Fpx < Stripe::StripeObject
# Account holder type, if provided. Can be one of `individual` or `company`.
sig { returns(T.nilable(String)) }
def account_holder_type; end
# The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
sig { returns(String) }
def bank; end
end
class Giropay < Stripe::StripeObject; end
class Gopay < Stripe::StripeObject; end
class Grabpay < Stripe::StripeObject; end
class IdBankTransfer < Stripe::StripeObject
# Attribute for field bank
sig { returns(T.nilable(String)) }
def bank; end
# Attribute for field bank_code
sig { returns(T.nilable(String)) }
def bank_code; end
# Attribute for field bank_name
sig { returns(T.nilable(String)) }
def bank_name; end
# Attribute for field display_name
sig { returns(T.nilable(String)) }
def display_name; end
end
class Ideal < Stripe::StripeObject
# The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
sig { returns(T.nilable(String)) }
def bank; end
# The Bank Identifier Code of the customer's bank, if the bank was provided.
sig { returns(T.nilable(String)) }
def bic; end
end
class InteracPresent < Stripe::StripeObject
class Networks < Stripe::StripeObject
# All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).
sig { returns(T::Array[String]) }
def available; end
# The preferred network for the card.
sig { returns(T.nilable(String)) }
def preferred; end
end
# Card brand. Can be `interac`, `mastercard` or `visa`.
sig { returns(T.nilable(String)) }
def brand; end
# The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
sig { returns(T.nilable(String)) }
def cardholder_name; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
# Contains information about card networks that can be used to process the payment.
sig { returns(T.nilable(Networks)) }
def networks; end
# The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
# How card details were read in this transaction.
sig { returns(T.nilable(String)) }
def read_method; end
end
class KakaoPay < Stripe::StripeObject; end
class Klarna < Stripe::StripeObject
class Dob < Stripe::StripeObject
# The day of birth, between 1 and 31.
sig { returns(T.nilable(Integer)) }
def day; end
# The month of birth, between 1 and 12.
sig { returns(T.nilable(Integer)) }
def month; end
# The four-digit year of birth.
sig { returns(T.nilable(Integer)) }
def year; end
end
# The customer's date of birth, if provided.
sig { returns(T.nilable(Dob)) }
def dob; end
end
class Konbini < Stripe::StripeObject; end
class KrCard < Stripe::StripeObject
# The local credit or debit card brand.
sig { returns(T.nilable(String)) }
def brand; end
# The last four digits of the card. This may not be present for American Express cards.
sig { returns(T.nilable(String)) }
def last4; end
end
class Link < Stripe::StripeObject
# Account owner's email address.
sig { returns(T.nilable(String)) }
def email; end
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
end
class MbWay < Stripe::StripeObject; end
class Mobilepay < Stripe::StripeObject; end
class Multibanco < Stripe::StripeObject; end
class NaverPay < Stripe::StripeObject
# Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.
sig { returns(T.nilable(String)) }
def buyer_id; end
# Whether to fund this transaction with Naver Pay points or a card.
sig { returns(String) }
def funding; end
end
class NzBankAccount < Stripe::StripeObject
# The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
# The name of the bank.
sig { returns(String) }
def bank_name; end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
# Last four digits of the bank account number.
sig { returns(String) }
def last4; end
# The suffix of the bank account number.
sig { returns(T.nilable(String)) }
def suffix; end
end
class Oxxo < Stripe::StripeObject; end
class P24 < Stripe::StripeObject
# The customer's bank, if provided.
sig { returns(T.nilable(String)) }
def bank; end
end
class PayByBank < Stripe::StripeObject; end
class Payco < Stripe::StripeObject; end
class Paynow < Stripe::StripeObject; end
class Paypal < Stripe::StripeObject
# Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def country; end
# Uniquely identifies this particular PayPal account. You can use this attribute to check whether two PayPal accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Owner's email. Values are provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def payer_email; end
# PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
sig { returns(T.nilable(String)) }
def payer_id; end
# Owner's verified email. Values are verified or provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_email; end
end
class Paypay < Stripe::StripeObject; end
class Payto < Stripe::StripeObject
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
end
class Pix < Stripe::StripeObject; end
class Promptpay < Stripe::StripeObject; end
class Qris < Stripe::StripeObject; end
class Rechnung < Stripe::StripeObject
class Dob < Stripe::StripeObject
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
end
# Attribute for field dob
sig { returns(T.nilable(Dob)) }
def dob; end
end
class RevolutPay < Stripe::StripeObject; end
class SamsungPay < Stripe::StripeObject; end
class Satispay < Stripe::StripeObject; end
class SepaDebit < Stripe::StripeObject
class GeneratedFrom < Stripe::StripeObject
# The ID of the Charge that generated this PaymentMethod, if any.
sig { returns(T.nilable(T.any(String, Stripe::Charge))) }
def charge; end
# The ID of the SetupAttempt that generated this PaymentMethod, if any.
sig { returns(T.nilable(T.any(String, Stripe::SetupAttempt))) }
def setup_attempt; end
end
# Bank code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_code; end
# Branch code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def branch_code; end
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(T.nilable(String)) }
def country; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Information about the object that generated this PaymentMethod.
sig { returns(T.nilable(GeneratedFrom)) }
def generated_from; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def last4; end
end
class Shopeepay < Stripe::StripeObject; end
class Sofort < Stripe::StripeObject
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(T.nilable(String)) }
def country; end
end
class StripeBalance < Stripe::StripeObject
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(String) }
def source_type; end
end
class Swish < Stripe::StripeObject; end
class Twint < Stripe::StripeObject; end
class UsBankAccount < Stripe::StripeObject
class Networks < Stripe::StripeObject
# The preferred network.
sig { returns(T.nilable(String)) }
def preferred; end
# All supported networks.
sig { returns(T::Array[String]) }
def supported; end
end
class StatusDetails < Stripe::StripeObject
class Blocked < Stripe::StripeObject
# The ACH network code that resulted in this block.
sig { returns(T.nilable(String)) }
def network_code; end
# The reason why this PaymentMethod's fingerprint has been blocked
sig { returns(T.nilable(String)) }
def reason; end
end
# Attribute for field blocked
sig { returns(T.nilable(Blocked)) }
def blocked; end
end
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
# The name of the bank.
sig { returns(T.nilable(String)) }
def bank_name; end
# The ID of the Financial Connections Account used to create the payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# Contains information about US bank account networks that can be used.
sig { returns(T.nilable(Networks)) }
def networks; end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
# Contains information about the future reusability of this PaymentMethod.
sig { returns(T.nilable(StatusDetails)) }
def status_details; end
end
class WechatPay < Stripe::StripeObject; end
class Zip < Stripe::StripeObject; end
# Attribute for field acss_debit
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# Attribute for field affirm
sig { returns(T.nilable(Affirm)) }
def affirm; end
# Attribute for field afterpay_clearpay
sig { returns(T.nilable(AfterpayClearpay)) }
def afterpay_clearpay; end
# Attribute for field alipay
sig { returns(T.nilable(Alipay)) }
def alipay; end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
# Attribute for field alma
sig { returns(T.nilable(Alma)) }
def alma; end
# Attribute for field amazon_pay
sig { returns(T.nilable(AmazonPay)) }
def amazon_pay; end
# Attribute for field au_becs_debit
sig { returns(T.nilable(AuBecsDebit)) }
def au_becs_debit; end
# Attribute for field bacs_debit
sig { returns(T.nilable(BacsDebit)) }
def bacs_debit; end
# Attribute for field bancontact
sig { returns(T.nilable(Bancontact)) }
def bancontact; end
# Attribute for field billie
sig { returns(T.nilable(Billie)) }
def billie; end
# Attribute for field billing_details
sig { returns(BillingDetails) }
def billing_details; end
# Attribute for field blik
sig { returns(T.nilable(Blik)) }
def blik; end
# Attribute for field boleto
sig { returns(T.nilable(Boleto)) }
def boleto; end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# Attribute for field card_present
sig { returns(T.nilable(CardPresent)) }
def card_present; end
# Attribute for field cashapp
sig { returns(T.nilable(Cashapp)) }
def cashapp; end
# Attribute for field crypto
sig { returns(T.nilable(Crypto)) }
def crypto; end
# The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# Attribute for field customer_account
sig { returns(T.nilable(String)) }
def customer_account; end
# Attribute for field customer_balance
sig { returns(T.nilable(CustomerBalance)) }
def customer_balance; end
# Attribute for field eps
sig { returns(T.nilable(Eps)) }
def eps; end
# Attribute for field fpx
sig { returns(T.nilable(Fpx)) }
def fpx; end
# Attribute for field giropay
sig { returns(T.nilable(Giropay)) }
def giropay; end
# Attribute for field gopay
sig { returns(T.nilable(Gopay)) }
def gopay; end
# Attribute for field grabpay
sig { returns(T.nilable(Grabpay)) }
def grabpay; end
# Attribute for field id_bank_transfer
sig { returns(T.nilable(IdBankTransfer)) }
def id_bank_transfer; end
# Attribute for field ideal
sig { returns(T.nilable(Ideal)) }
def ideal; end
# Attribute for field interac_present
sig { returns(T.nilable(InteracPresent)) }
def interac_present; end
# Attribute for field kakao_pay
sig { returns(T.nilable(KakaoPay)) }
def kakao_pay; end
# Attribute for field klarna
sig { returns(T.nilable(Klarna)) }
def klarna; end
# Attribute for field konbini
sig { returns(T.nilable(Konbini)) }
def konbini; end
# Attribute for field kr_card
sig { returns(T.nilable(KrCard)) }
def kr_card; end
# Attribute for field link
sig { returns(T.nilable(Link)) }
def link; end
# Attribute for field mb_way
sig { returns(T.nilable(MbWay)) }
def mb_way; end
# Attribute for field mobilepay
sig { returns(T.nilable(Mobilepay)) }
def mobilepay; end
# Attribute for field multibanco
sig { returns(T.nilable(Multibanco)) }
def multibanco; end
# Attribute for field naver_pay
sig { returns(T.nilable(NaverPay)) }
def naver_pay; end
# Attribute for field nz_bank_account
sig { returns(T.nilable(NzBankAccount)) }
def nz_bank_account; end
# Attribute for field oxxo
sig { returns(T.nilable(Oxxo)) }
def oxxo; end
# Attribute for field p24
sig { returns(T.nilable(P24)) }
def p24; end
# Attribute for field pay_by_bank
sig { returns(T.nilable(PayByBank)) }
def pay_by_bank; end
# Attribute for field payco
sig { returns(T.nilable(Payco)) }
def payco; end
# Attribute for field paynow
sig { returns(T.nilable(Paynow)) }
def paynow; end
# Attribute for field paypal
sig { returns(T.nilable(Paypal)) }
def paypal; end
# Attribute for field paypay
sig { returns(T.nilable(Paypay)) }
def paypay; end
# Attribute for field payto
sig { returns(T.nilable(Payto)) }
def payto; end
# Attribute for field pix
sig { returns(T.nilable(Pix)) }
def pix; end
# Attribute for field promptpay
sig { returns(T.nilable(Promptpay)) }
def promptpay; end
# Attribute for field qris
sig { returns(T.nilable(Qris)) }
def qris; end
# Attribute for field rechnung
sig { returns(T.nilable(Rechnung)) }
def rechnung; end
# Attribute for field revolut_pay
sig { returns(T.nilable(RevolutPay)) }
def revolut_pay; end
# Attribute for field samsung_pay
sig { returns(T.nilable(SamsungPay)) }
def samsung_pay; end
# Attribute for field satispay
sig { returns(T.nilable(Satispay)) }
def satispay; end
# Attribute for field sepa_debit
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# Attribute for field shopeepay
sig { returns(T.nilable(Shopeepay)) }
def shopeepay; end
# Attribute for field sofort
sig { returns(T.nilable(Sofort)) }
def sofort; end
# Attribute for field stripe_balance
sig { returns(T.nilable(StripeBalance)) }
def stripe_balance; end
# Attribute for field swish
sig { returns(T.nilable(Swish)) }
def swish; end
# Attribute for field twint
sig { returns(T.nilable(Twint)) }
def twint; end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
# Attribute for field us_bank_account
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
# Attribute for field wechat_pay
sig { returns(T.nilable(WechatPay)) }
def wechat_pay; end
# Attribute for field zip
sig { returns(T.nilable(Zip)) }
def zip; end
end
class Shipping < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(Address) }
def address; end
# Recipient name.
sig { returns(String) }
def name; end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# Data used for generating a Mandate.
sig { returns(T.nilable(MandateData)) }
def mandate_data; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
sig { returns(T.nilable(String)) }
def payment_intent; end
# Payment-method-specific configuration for this ConfirmationToken.
sig { returns(T.nilable(PaymentMethodOptions)) }
def payment_method_options; end
# Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.
sig { returns(T.nilable(PaymentMethodPreview)) }
def payment_method_preview; end
# Return URL used to confirm the Intent.
sig { returns(T.nilable(String)) }
def return_url; end
# Indicates that you intend to make future payments with this ConfirmationToken's payment method.
#
# The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
sig { returns(T.nilable(String)) }
def setup_intent; end
# Shipping information collected on this ConfirmationToken.
sig { returns(T.nilable(Shipping)) }
def shipping; end
# Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken.
sig { returns(T::Boolean) }
def use_stripe_sdk; end
class CreateParams < Stripe::RequestParams
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Institution number of the customer's bank.
sig { returns(String) }
def institution_number; end
sig { params(_institution_number: String).returns(String) }
def institution_number=(_institution_number); end
# Transit number of the customer's bank.
sig { returns(String) }
def transit_number; end
sig { params(_transit_number: String).returns(String) }
def transit_number=(_transit_number); end
sig {
params(account_number: String, institution_number: String, transit_number: String).void
}
def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(String) }
def bsb_number; end
sig { params(_bsb_number: String).returns(String) }
def bsb_number=(_bsb_number); end
sig { params(account_number: String, bsb_number: String).void }
def initialize(account_number: nil, bsb_number: nil); end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
sig { params(_sort_code: T.nilable(String)).returns(T.nilable(String)) }
def sort_code=(_sort_code); end
sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
def initialize(account_number: nil, sort_code: nil); end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
sig { params(_tax_id: String).returns(String) }
def tax_id=(_tax_id); end
sig { params(tax_id: String).void }
def initialize(tax_id: nil); end
end
class Cashapp < Stripe::RequestParams; end
class Crypto < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The customer's bank.
sig { returns(String) }
def bank; end
sig { params(_bank: String).returns(String) }
def bank=(_bank); end
sig { params(account_holder_type: T.nilable(String), bank: String).void }
def initialize(account_holder_type: nil, bank: nil); end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Klarna::Dob))
}
def dob; end
sig {
params(_dob: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Klarna::Dob)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Klarna::Dob))
}
def dob=(_dob); end
sig {
params(dob: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Klarna::Dob)).void
}
def initialize(dob: nil); end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
sig { returns(T.nilable(String)) }
def funding; end
sig { params(_funding: T.nilable(String)).returns(T.nilable(String)) }
def funding=(_funding); end
sig { params(funding: T.nilable(String)).void }
def initialize(funding: nil); end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
sig { params(_bank_code: String).returns(String) }
def bank_code=(_bank_code); end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
sig { params(_branch_code: String).returns(String) }
def branch_code=(_branch_code); end
# Attribute for param field reference
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# The suffix of the bank account number.
sig { returns(String) }
def suffix; end
sig { params(_suffix: String).returns(String) }
def suffix=(_suffix); end
sig {
params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
); end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Paypay < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Rechnung::Dob)
}
def dob; end
sig {
params(_dob: ::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Rechnung::Dob).returns(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Rechnung::Dob)
}
def dob=(_dob); end
sig {
params(dob: ::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Rechnung::Dob).void
}
def initialize(dob: nil); end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
sig { returns(String) }
def iban; end
sig { params(_iban: String).returns(String) }
def iban=(_iban); end
sig { params(iban: String).void }
def initialize(iban: nil); end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
sig { params(account: T.nilable(String), source_type: T.nilable(String)).void }
def initialize(account: nil, source_type: nil); end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig {
params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String))
}
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AcssDebit)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Affirm))
}
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Affirm)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Affirm))
}
def affirm=(_affirm); end
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AfterpayClearpay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Alipay))
}
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Alipay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Alipay))
}
def alipay=(_alipay); end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Alma))
}
def alma; end
sig {
params(_alma: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Alma)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Alma))
}
def alma=(_alma); end
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AmazonPay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AuBecsDebit)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::BacsDebit)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Bancontact)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Bancontact))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Billie))
}
def billie; end
sig {
params(_billie: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Billie)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Billie))
}
def billie=(_billie); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::BillingDetails)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Blik))
}
def blik; end
sig {
params(_blik: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Blik)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Blik))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Boleto))
}
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Boleto)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Boleto))
}
def boleto=(_boleto); end
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Cashapp))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Cashapp)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Cashapp))
}
def cashapp=(_cashapp); end
# If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Crypto))
}
def crypto; end
sig {
params(_crypto: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Crypto)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Crypto))
}
def crypto=(_crypto); end
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::CustomerBalance)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Eps))
}
def eps; end
sig {
params(_eps: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Eps)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Eps))
}
def eps=(_eps); end
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Fpx))
}
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Fpx)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Fpx))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Giropay))
}
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Giropay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Giropay))
}
def giropay=(_giropay); end
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Gopay))
}
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Gopay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Gopay))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Grabpay))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Grabpay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Grabpay))
}
def grabpay=(_grabpay); end
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::IdBankTransfer)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Ideal))
}
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Ideal)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Ideal))
}
def ideal=(_ideal); end
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::InteracPresent))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::InteracPresent)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::InteracPresent))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::KakaoPay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Klarna)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Klarna))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Konbini))
}
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Konbini)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Konbini))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::KrCard))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::KrCard)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::KrCard))
}
def kr_card=(_kr_card); end
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Link))
}
def link; end
sig {
params(_link: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Link)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Link))
}
def link=(_link); end
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::MbWay))
}
def mb_way; end
sig {
params(_mb_way: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::MbWay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::MbWay))
}
def mb_way=(_mb_way); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Mobilepay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Mobilepay))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Multibanco)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Multibanco))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::NaverPay))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::NaverPay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::NaverPay))
}
def naver_pay=(_naver_pay); end
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::NzBankAccount)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Oxxo))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Oxxo)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Oxxo))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::P24))
}
def p24; end
sig {
params(_p24: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::P24)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::P24))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::PayByBank)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Payco))
}
def payco; end
sig {
params(_payco: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Payco)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Payco))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Paynow))
}
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Paynow)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Paynow))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Paypal)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Paypal))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Paypay))
}
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Paypay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Paypay))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Payto))
}
def payto; end
sig {
params(_payto: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Payto)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Payto))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Pix))
}
def pix; end
sig {
params(_pix: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Pix)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Pix))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Promptpay))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Promptpay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Promptpay))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Qris))
}
def qris; end
sig {
params(_qris: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Qris)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Qris))
}
def qris=(_qris); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::RadarOptions))
}
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::RadarOptions)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::RadarOptions))
}
def radar_options=(_radar_options); end
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Rechnung))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Rechnung)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Rechnung))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::RevolutPay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::SamsungPay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Satispay))
}
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Satispay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Satispay))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::SepaDebit)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Shopeepay))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Shopeepay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Shopeepay))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Sofort))
}
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Sofort)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Sofort))
}
def sofort=(_sofort); end
# This hash contains details about the Stripe balance payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::StripeBalance)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Swish))
}
def swish; end
sig {
params(_swish: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Swish)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Swish))
}
def swish=(_swish); end
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Twint))
}
def twint; end
sig {
params(_twint: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Twint)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Twint))
}
def twint=(_twint); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::UsBankAccount)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::WechatPay)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Zip))
}
def zip; end
sig {
params(_zip: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Zip)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Cashapp), crypto: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Crypto), customer_balance: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Giropay), gopay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Gopay), grabpay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Grabpay), id_bank_transfer: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::IdBankTransfer), ideal: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Link), mb_way: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::MbWay), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Paypal), paypay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Paypay), payto: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Payto), pix: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Promptpay), qris: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Qris), radar_options: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::RadarOptions), rechnung: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Rechnung), revolut_pay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::SepaDebit), shopeepay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Shopeepay), sofort: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Sofort), stripe_balance: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::StripeBalance), swish: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class PaymentMethodOptions < Stripe::RequestParams
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
class Plan < Stripe::RequestParams
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
sig { returns(T.nilable(Integer)) }
def count; end
sig { params(_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def count=(_count); end
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
# One of `month`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(count: T.nilable(Integer), interval: T.nilable(String), type: String).void
}
def initialize(count: nil, interval: nil, type: nil); end
end
# The selected installment plan to use for this payment attempt.
# This parameter can only be provided during confirmation.
sig {
returns(::Stripe::ConfirmationToken::CreateParams::PaymentMethodOptions::Card::Installments::Plan)
}
def plan; end
sig {
params(_plan: ::Stripe::ConfirmationToken::CreateParams::PaymentMethodOptions::Card::Installments::Plan).returns(::Stripe::ConfirmationToken::CreateParams::PaymentMethodOptions::Card::Installments::Plan)
}
def plan=(_plan); end
sig {
params(plan: ::Stripe::ConfirmationToken::CreateParams::PaymentMethodOptions::Card::Installments::Plan).void
}
def initialize(plan: nil); end
end
# Installment configuration for payments confirmed using this ConfirmationToken.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodOptions::Card::Installments))
}
def installments; end
sig {
params(_installments: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodOptions::Card::Installments)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodOptions::Card::Installments))
}
def installments=(_installments); end
sig {
params(installments: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodOptions::Card::Installments)).void
}
def initialize(installments: nil); end
end
# Configuration for any card payments confirmed using this ConfirmationToken.
sig {
returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodOptions::Card))
}
def card=(_card); end
sig {
params(card: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodOptions::Card)).void
}
def initialize(card: nil); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address
sig { returns(::Stripe::ConfirmationToken::CreateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::ConfirmationToken::CreateParams::Shipping::Address).returns(::Stripe::ConfirmationToken::CreateParams::Shipping::Address)
}
def address=(_address); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension)
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: ::Stripe::ConfirmationToken::CreateParams::Shipping::Address, name: String, phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# ID of an existing PaymentMethod.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# If provided, this hash will be used to create a PaymentMethod.
sig { returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData)) }
def payment_method_data; end
sig {
params(_payment_method_data: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData))
}
def payment_method_data=(_payment_method_data); end
# Payment-method-specific configuration for this ConfirmationToken.
sig { returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodOptions)) }
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# Return URL used to confirm the Intent.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# Indicates that you intend to make future payments with this ConfirmationToken's payment method.
#
# The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Shipping information for this ConfirmationToken.
sig { returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::Shipping)) }
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::ConfirmationToken::CreateParams::Shipping)).returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::Shipping))
}
def shipping=(_shipping); end
sig {
params(expand: T.nilable(T::Array[String]), payment_method: T.nilable(String), payment_method_data: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodOptions), return_url: T.nilable(String), setup_future_usage: T.nilable(String), shipping: T.nilable(::Stripe::ConfirmationToken::CreateParams::Shipping)).void
}
def initialize(
expand: nil,
payment_method: nil,
payment_method_data: nil,
payment_method_options: nil,
return_url: nil,
setup_future_usage: nil,
shipping: nil
); end
end
end
end
# typed: true
module Stripe
# Stripe needs to collect certain pieces of information about each account
# created. These requirements can differ depending on the account's country. The
# Country Specs API makes these rules available to your integration.
#
# You can also view the information from this API call as [an online
# guide](https://docs.stripe.com/docs/connect/required-verification-information).
class CountrySpec < APIResource
class VerificationFields < Stripe::StripeObject
class Company < Stripe::StripeObject
# Additional fields which are only required for some users.
sig { returns(T::Array[String]) }
def additional; end
# Fields which every account must eventually provide.
sig { returns(T::Array[String]) }
def minimum; end
end
class Individual < Stripe::StripeObject
# Additional fields which are only required for some users.
sig { returns(T::Array[String]) }
def additional; end
# Fields which every account must eventually provide.
sig { returns(T::Array[String]) }
def minimum; end
end
# Attribute for field company
sig { returns(Company) }
def company; end
# Attribute for field individual
sig { returns(Individual) }
def individual; end
end
# The default currency for this country. This applies to both payment methods and bank accounts.
sig { returns(String) }
def default_currency; end
# Unique identifier for the object. Represented as the ISO country code for this country.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Currencies that can be accepted in the specific country (for transfers).
sig { returns(T::Hash[String, T::Array[String]]) }
def supported_bank_account_currencies; end
# Currencies that can be accepted in the specified country (for payments).
sig { returns(T::Array[String]) }
def supported_payment_currencies; end
# Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges).
sig { returns(T::Array[String]) }
def supported_payment_methods; end
# Countries that can accept transfers from the specified country.
sig { returns(T::Array[String]) }
def supported_transfer_countries; end
# Attribute for field verification_fields
sig { returns(VerificationFields) }
def verification_fields; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Lists all Country Spec objects available in the API.
sig {
params(params: T.any(::Stripe::CountrySpec::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# A coupon contains information about a percent-off or amount-off discount you
# might want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),
# [checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).
class Coupon < APIResource
class AppliesTo < Stripe::StripeObject
# A list of product IDs this coupon applies to
sig { returns(T::Array[String]) }
def products; end
end
class CurrencyOptions < Stripe::StripeObject
# Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.
sig { returns(Integer) }
def amount_off; end
end
class Script < Stripe::StripeObject
# The configuration values of the script. The keys and values are specific to the script implementation.
sig { returns(T::Hash[String, T.untyped]) }
def configuration; end
# The name of the script used to calculate the discount.
sig { returns(String) }
def display_name; end
# The script implementation ID for this coupon.
sig { returns(String) }
def id; end
end
# Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.
sig { returns(T.nilable(Integer)) }
def amount_off; end
# Attribute for field applies_to
sig { returns(T.nilable(AppliesTo)) }
def applies_to; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off.
sig { returns(T.nilable(String)) }
def currency; end
# Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig { returns(T.nilable(T::Hash[String, CurrencyOptions])) }
def currency_options; end
# One of `forever`, `once`, or `repeating`. Describes how long a customer who applies this coupon will get the discount.
sig { returns(String) }
def duration; end
# If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`.
sig { returns(T.nilable(Integer)) }
def duration_in_months; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
sig { returns(T.nilable(Integer)) }
def max_redemptions; end
# 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])) }
def metadata; end
# Name of the coupon displayed to customers on for instance invoices or receipts.
sig { returns(T.nilable(String)) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.
sig { returns(T.nilable(Float)) }
def percent_off; end
# Date after which the coupon can no longer be redeemed.
sig { returns(T.nilable(Integer)) }
def redeem_by; end
# Configuration of the [script](https://docs.stripe.com/billing/subscriptions/script-coupons) used to calculate the discount.
sig { returns(T.nilable(Script)) }
def script; end
# Number of times this coupon has been applied to a customer.
sig { returns(Integer) }
def times_redeemed; end
# One of `amount_off`, `percent_off`, or `script`. Describes the type of coupon logic used to calculate the discount.
sig { returns(T.nilable(String)) }
def type; end
# Taking account of the above properties, whether this coupon can still be applied to a customer.
sig { returns(T::Boolean) }
def valid; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams; end
class UpdateParams < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A positive integer representing the amount to subtract from an invoice total.
sig { returns(Integer) }
def amount_off; end
sig { params(_amount_off: Integer).returns(Integer) }
def amount_off=(_amount_off); end
sig { params(amount_off: Integer).void }
def initialize(amount_off: nil); end
end
# Coupons defined in each available currency option (only supported if the coupon is amount-based). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig { returns(T.nilable(T::Hash[String, ::Stripe::Coupon::UpdateParams::CurrencyOptions])) }
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::Coupon::UpdateParams::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::Coupon::UpdateParams::CurrencyOptions]))
}
def currency_options=(_currency_options); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(currency_options: T.nilable(T::Hash[String, ::Stripe::Coupon::UpdateParams::CurrencyOptions]), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String)).void
}
def initialize(currency_options: nil, expand: nil, metadata: nil, name: nil); end
end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
sig { returns(T.nilable(T.any(::Stripe::Coupon::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Coupon::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Coupon::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::Coupon::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class AppliesTo < Stripe::RequestParams
# An array of Product IDs that this Coupon will apply to.
sig { returns(T.nilable(T::Array[String])) }
def products; end
sig { params(_products: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def products=(_products); end
sig { params(products: T.nilable(T::Array[String])).void }
def initialize(products: nil); end
end
class CurrencyOptions < Stripe::RequestParams
# A positive integer representing the amount to subtract from an invoice total.
sig { returns(Integer) }
def amount_off; end
sig { params(_amount_off: Integer).returns(Integer) }
def amount_off=(_amount_off); end
sig { params(amount_off: Integer).void }
def initialize(amount_off: nil); end
end
class Script < Stripe::RequestParams
# The configuration values of the script. The keys and values are specific to the script implementation.
sig { returns(T::Hash[String, T.untyped]) }
def configuration; end
sig {
params(_configuration: T::Hash[String, T.untyped]).returns(T::Hash[String, T.untyped])
}
def configuration=(_configuration); end
# The script implementation ID for this coupon.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
sig { params(configuration: T::Hash[String, T.untyped], id: String).void }
def initialize(configuration: nil, id: nil); end
end
# A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
sig { returns(T.nilable(Integer)) }
def amount_off; end
sig { params(_amount_off: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_off=(_amount_off); end
# A hash containing directions for what this Coupon will apply discounts to.
sig { returns(T.nilable(::Stripe::Coupon::CreateParams::AppliesTo)) }
def applies_to; end
sig {
params(_applies_to: T.nilable(::Stripe::Coupon::CreateParams::AppliesTo)).returns(T.nilable(::Stripe::Coupon::CreateParams::AppliesTo))
}
def applies_to=(_applies_to); end
# Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Coupons defined in each available currency option (only supported if `amount_off` is passed). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig { returns(T.nilable(T::Hash[String, ::Stripe::Coupon::CreateParams::CurrencyOptions])) }
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::Coupon::CreateParams::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::Coupon::CreateParams::CurrencyOptions]))
}
def currency_options=(_currency_options); end
# Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
sig { returns(T.nilable(String)) }
def duration; end
sig { params(_duration: T.nilable(String)).returns(T.nilable(String)) }
def duration=(_duration); end
# Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
sig { returns(T.nilable(Integer)) }
def duration_in_months; end
sig { params(_duration_in_months: T.nilable(Integer)).returns(T.nilable(Integer)) }
def duration_in_months=(_duration_in_months); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.
sig { returns(T.nilable(Integer)) }
def max_redemptions; end
sig { params(_max_redemptions: T.nilable(Integer)).returns(T.nilable(Integer)) }
def max_redemptions=(_max_redemptions); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
sig { returns(T.nilable(Float)) }
def percent_off; end
sig { params(_percent_off: T.nilable(Float)).returns(T.nilable(Float)) }
def percent_off=(_percent_off); end
# Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.
sig { returns(T.nilable(Integer)) }
def redeem_by; end
sig { params(_redeem_by: T.nilable(Integer)).returns(T.nilable(Integer)) }
def redeem_by=(_redeem_by); end
# Configuration of the [script](https://docs.stripe.com/billing/subscriptions/script-coupons) used to calculate the discount.
sig { returns(T.nilable(::Stripe::Coupon::CreateParams::Script)) }
def script; end
sig {
params(_script: T.nilable(::Stripe::Coupon::CreateParams::Script)).returns(T.nilable(::Stripe::Coupon::CreateParams::Script))
}
def script=(_script); end
sig {
params(amount_off: T.nilable(Integer), applies_to: T.nilable(::Stripe::Coupon::CreateParams::AppliesTo), currency: T.nilable(String), currency_options: T.nilable(T::Hash[String, ::Stripe::Coupon::CreateParams::CurrencyOptions]), duration: T.nilable(String), duration_in_months: T.nilable(Integer), expand: T.nilable(T::Array[String]), id: T.nilable(String), max_redemptions: T.nilable(Integer), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String), percent_off: T.nilable(Float), redeem_by: T.nilable(Integer), script: T.nilable(::Stripe::Coupon::CreateParams::Script)).void
}
def initialize(
amount_off: nil,
applies_to: nil,
currency: nil,
currency_options: nil,
duration: nil,
duration_in_months: nil,
expand: nil,
id: nil,
max_redemptions: nil,
metadata: nil,
name: nil,
percent_off: nil,
redeem_by: nil,
script: nil
); end
end
# You can create coupons easily via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.
#
# A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice's subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.
sig {
params(params: T.any(::Stripe::Coupon::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Coupon)
}
def self.create(params = {}, opts = {}); end
# You can delete coupons via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can't redeem the coupon. You can also delete coupons via the API.
sig {
params(coupon: String, params: T.any(::Stripe::Coupon::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Coupon)
}
def self.delete(coupon, params = {}, opts = {}); end
# You can delete coupons via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can't redeem the coupon. You can also delete coupons via the API.
sig {
params(params: T.any(::Stripe::Coupon::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Coupon)
}
def delete(params = {}, opts = {}); end
# Returns a list of your coupons.
sig {
params(params: T.any(::Stripe::Coupon::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
sig {
params(coupon: String, params: T.any(::Stripe::Coupon::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Coupon)
}
def self.update(coupon, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# Issue a credit note to adjust an invoice's amount after the invoice is finalized.
#
# Related guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes)
class CreditNote < APIResource
class DiscountAmount < Stripe::StripeObject
# The amount, in cents (or local equivalent), of the discount.
sig { returns(Integer) }
def amount; end
# The discount that was applied to get this discount amount.
sig { returns(T.any(String, Stripe::Discount)) }
def discount; end
end
class PretaxCreditAmount < Stripe::StripeObject
# The amount, in cents (or local equivalent), of the pretax credit amount.
sig { returns(Integer) }
def amount; end
# The credit balance transaction that was applied to get this pretax credit amount.
sig { returns(T.nilable(T.any(String, Stripe::Billing::CreditBalanceTransaction))) }
def credit_balance_transaction; end
# The discount that was applied to get this pretax credit amount.
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
def discount; end
# Type of the pretax credit amount referenced.
sig { returns(String) }
def type; end
end
class Refund < Stripe::StripeObject
# Amount of the refund that applies to this credit note, in cents (or local equivalent).
sig { returns(Integer) }
def amount_refunded; end
# ID of the refund.
sig { returns(T.any(String, Stripe::Refund)) }
def refund; end
end
class ShippingCost < Stripe::StripeObject
class Tax < Stripe::StripeObject
# Amount of tax applied for this rate.
sig { returns(Integer) }
def amount; end
# Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
#
# Related guide: [Tax rates](/billing/taxes/tax-rates)
sig { returns(Stripe::TaxRate) }
def rate; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(T.nilable(String)) }
def taxability_reason; end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(T.nilable(Integer)) }
def taxable_amount; end
end
# Total shipping cost before any taxes are applied.
sig { returns(Integer) }
def amount_subtotal; end
# Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
sig { returns(Integer) }
def amount_tax; end
# Total shipping cost after taxes are applied.
sig { returns(Integer) }
def amount_total; end
# The ID of the ShippingRate for this invoice.
sig { returns(T.nilable(T.any(String, Stripe::ShippingRate))) }
def shipping_rate; end
# The taxes applied to the shipping rate.
sig { returns(T.nilable(T::Array[Tax])) }
def taxes; end
end
class TotalTax < Stripe::StripeObject
class TaxRateDetails < Stripe::StripeObject
# Attribute for field tax_rate
sig { returns(String) }
def tax_rate; end
end
# The amount of the tax, in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
# Whether this tax is inclusive or exclusive.
sig { returns(String) }
def tax_behavior; end
# Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
sig { returns(T.nilable(TaxRateDetails)) }
def tax_rate_details; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(String) }
def taxability_reason; end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(T.nilable(Integer)) }
def taxable_amount; end
# The type of tax information.
sig { returns(String) }
def type; end
end
# The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
sig { returns(Integer) }
def amount; end
# This is the sum of all the shipping amounts.
sig { returns(Integer) }
def amount_shipping; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# ID of the customer.
sig { returns(T.any(String, Stripe::Customer)) }
def customer; end
# ID of the account.
sig { returns(T.nilable(String)) }
def customer_account; end
# Customer balance transaction related to this credit note.
sig { returns(T.nilable(T.any(String, Stripe::CustomerBalanceTransaction))) }
def customer_balance_transaction; end
# The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
sig { returns(Integer) }
def discount_amount; end
# The aggregate amounts calculated per discount for all line items.
sig { returns(T::Array[DiscountAmount]) }
def discount_amounts; end
# The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
sig { returns(T.nilable(Integer)) }
def effective_at; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# ID of the invoice.
sig { returns(T.any(String, Stripe::Invoice)) }
def invoice; end
# Line items that make up the credit note
sig { returns(Stripe::ListObject) }
def lines; end
# 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) }
def livemode; end
# Customer-facing text that appears on the credit note PDF.
sig { returns(T.nilable(String)) }
def memo; end
# 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])) }
def metadata; end
# A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
sig { returns(String) }
def number; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Amount that was credited outside of Stripe.
sig { returns(T.nilable(Integer)) }
def out_of_band_amount; end
# The link to download the PDF of the credit note.
sig { returns(String) }
def pdf; end
# The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
sig { returns(Integer) }
def post_payment_amount; end
# The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced.
sig { returns(Integer) }
def pre_payment_amount; end
# The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
sig { returns(T::Array[PretaxCreditAmount]) }
def pretax_credit_amounts; end
# Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
sig { returns(T.nilable(String)) }
def reason; end
# Refunds related to this credit note.
sig { returns(T::Array[Refund]) }
def refunds; end
# The details of the cost of shipping, including the ShippingRate applied to the invoice.
sig { returns(T.nilable(ShippingCost)) }
def shipping_cost; end
# Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
sig { returns(String) }
def status; end
# The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
sig { returns(Integer) }
def subtotal; end
# The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
sig { returns(T.nilable(Integer)) }
def subtotal_excluding_tax; end
# The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
sig { returns(Integer) }
def total; end
# The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
sig { returns(T.nilable(Integer)) }
def total_excluding_tax; end
# The aggregate tax information for all line items.
sig { returns(T.nilable(T::Array[TotalTax])) }
def total_taxes; end
# Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid.
sig { returns(String) }
def type; end
# The time that the credit note was voided.
sig { returns(T.nilable(Integer)) }
def voided_at; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return credit notes that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::CreditNote::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::CreditNote::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::CreditNote::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return credit notes for the customer specified by this customer ID.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Only return credit notes for the account specified by this account ID.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Only return credit notes for the invoice specified by this invoice ID.
sig { returns(T.nilable(String)) }
def invoice; end
sig { params(_invoice: T.nilable(String)).returns(T.nilable(String)) }
def invoice=(_invoice); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::CreditNote::ListParams::Created, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: T.nilable(String), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
invoice: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Line < Stripe::RequestParams
class TaxAmount < Stripe::RequestParams
# The amount, in cents (or local equivalent), of the tax.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.
sig { returns(String) }
def tax_rate; end
sig { params(_tax_rate: String).returns(String) }
def tax_rate=(_tax_rate); end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(Integer) }
def taxable_amount; end
sig { params(_taxable_amount: Integer).returns(Integer) }
def taxable_amount=(_taxable_amount); end
sig { params(amount: Integer, tax_rate: String, taxable_amount: Integer).void }
def initialize(amount: nil, tax_rate: nil, taxable_amount: nil); end
end
# The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
sig { returns(T.nilable(String)) }
def invoice_line_item; end
sig { params(_invoice_line_item: T.nilable(String)).returns(T.nilable(String)) }
def invoice_line_item=(_invoice_line_item); end
# The line item quantity to credit.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::CreateParams::Line::TaxAmount])))
}
def tax_amounts; end
sig {
params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNote::CreateParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::CreateParams::Line::TaxAmount])))
}
def tax_amounts=(_tax_amounts); end
# The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(amount: T.nilable(Integer), description: T.nilable(String), invoice_line_item: T.nilable(String), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNote::CreateParams::Line::TaxAmount])), tax_rates: T.nilable(T.any(String, T::Array[String])), type: String, unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
amount: nil,
description: nil,
invoice_line_item: nil,
quantity: nil,
tax_amounts: nil,
tax_rates: nil,
type: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Refund < Stripe::RequestParams
# Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
sig { returns(T.nilable(Integer)) }
def amount_refunded; end
sig { params(_amount_refunded: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_refunded=(_amount_refunded); end
# ID of an existing refund to link this credit note to. Required when `type` is `refund`.
sig { returns(T.nilable(String)) }
def refund; end
sig { params(_refund: T.nilable(String)).returns(T.nilable(String)) }
def refund=(_refund); end
sig { params(amount_refunded: T.nilable(Integer), refund: T.nilable(String)).void }
def initialize(amount_refunded: nil, refund: nil); end
end
class ShippingCost < Stripe::RequestParams
# The ID of the shipping rate to use for this order.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
sig { params(shipping_rate: T.nilable(String)).void }
def initialize(shipping_rate: nil); end
end
# The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
sig { returns(T.nilable(Integer)) }
def credit_amount; end
sig { params(_credit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def credit_amount=(_credit_amount); end
# The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
sig { returns(T.nilable(Integer)) }
def effective_at; end
sig { params(_effective_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def effective_at=(_effective_at); end
# Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
sig { returns(T.nilable(String)) }
def email_type; end
sig { params(_email_type: T.nilable(String)).returns(T.nilable(String)) }
def email_type=(_email_type); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# ID of the invoice.
sig { returns(String) }
def invoice; end
sig { params(_invoice: String).returns(String) }
def invoice=(_invoice); end
# Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Line])) }
def lines; end
sig {
params(_lines: T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Line])).returns(T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Line]))
}
def lines=(_lines); end
# The credit note's memo appears on the credit note PDF.
sig { returns(T.nilable(String)) }
def memo; end
sig { params(_memo: T.nilable(String)).returns(T.nilable(String)) }
def memo=(_memo); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
sig { returns(T.nilable(Integer)) }
def out_of_band_amount; end
sig { params(_out_of_band_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def out_of_band_amount=(_out_of_band_amount); end
# Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
sig { returns(T.nilable(String)) }
def reason; end
sig { params(_reason: T.nilable(String)).returns(T.nilable(String)) }
def reason=(_reason); end
# The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
sig { returns(T.nilable(Integer)) }
def refund_amount; end
sig { params(_refund_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def refund_amount=(_refund_amount); end
# Refunds to link to this credit note.
sig { returns(T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Refund])) }
def refunds; end
sig {
params(_refunds: T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Refund])).returns(T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Refund]))
}
def refunds=(_refunds); end
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(::Stripe::CreditNote::CreateParams::ShippingCost)) }
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(::Stripe::CreditNote::CreateParams::ShippingCost)).returns(T.nilable(::Stripe::CreditNote::CreateParams::ShippingCost))
}
def shipping_cost=(_shipping_cost); end
sig {
params(amount: T.nilable(Integer), credit_amount: T.nilable(Integer), effective_at: T.nilable(Integer), email_type: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: String, lines: T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Line]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), out_of_band_amount: T.nilable(Integer), reason: T.nilable(String), refund_amount: T.nilable(Integer), refunds: T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Refund]), shipping_cost: T.nilable(::Stripe::CreditNote::CreateParams::ShippingCost)).void
}
def initialize(
amount: nil,
credit_amount: nil,
effective_at: nil,
email_type: nil,
expand: nil,
invoice: nil,
lines: nil,
memo: nil,
metadata: nil,
out_of_band_amount: nil,
reason: nil,
refund_amount: nil,
refunds: nil,
shipping_cost: nil
); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Credit note memo.
sig { returns(T.nilable(String)) }
def memo; end
sig { params(_memo: T.nilable(String)).returns(T.nilable(String)) }
def memo=(_memo); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(expand: nil, memo: nil, metadata: nil); end
end
class PreviewParams < Stripe::RequestParams
class Line < Stripe::RequestParams
class TaxAmount < Stripe::RequestParams
# The amount, in cents (or local equivalent), of the tax.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.
sig { returns(String) }
def tax_rate; end
sig { params(_tax_rate: String).returns(String) }
def tax_rate=(_tax_rate); end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(Integer) }
def taxable_amount; end
sig { params(_taxable_amount: Integer).returns(Integer) }
def taxable_amount=(_taxable_amount); end
sig { params(amount: Integer, tax_rate: String, taxable_amount: Integer).void }
def initialize(amount: nil, tax_rate: nil, taxable_amount: nil); end
end
# The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
sig { returns(T.nilable(String)) }
def invoice_line_item; end
sig { params(_invoice_line_item: T.nilable(String)).returns(T.nilable(String)) }
def invoice_line_item=(_invoice_line_item); end
# The line item quantity to credit.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::PreviewParams::Line::TaxAmount])))
}
def tax_amounts; end
sig {
params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNote::PreviewParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::PreviewParams::Line::TaxAmount])))
}
def tax_amounts=(_tax_amounts); end
# The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(amount: T.nilable(Integer), description: T.nilable(String), invoice_line_item: T.nilable(String), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNote::PreviewParams::Line::TaxAmount])), tax_rates: T.nilable(T.any(String, T::Array[String])), type: String, unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
amount: nil,
description: nil,
invoice_line_item: nil,
quantity: nil,
tax_amounts: nil,
tax_rates: nil,
type: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Refund < Stripe::RequestParams
# Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
sig { returns(T.nilable(Integer)) }
def amount_refunded; end
sig { params(_amount_refunded: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_refunded=(_amount_refunded); end
# ID of an existing refund to link this credit note to. Required when `type` is `refund`.
sig { returns(T.nilable(String)) }
def refund; end
sig { params(_refund: T.nilable(String)).returns(T.nilable(String)) }
def refund=(_refund); end
sig { params(amount_refunded: T.nilable(Integer), refund: T.nilable(String)).void }
def initialize(amount_refunded: nil, refund: nil); end
end
class ShippingCost < Stripe::RequestParams
# The ID of the shipping rate to use for this order.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
sig { params(shipping_rate: T.nilable(String)).void }
def initialize(shipping_rate: nil); end
end
# The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
sig { returns(T.nilable(Integer)) }
def credit_amount; end
sig { params(_credit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def credit_amount=(_credit_amount); end
# The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
sig { returns(T.nilable(Integer)) }
def effective_at; end
sig { params(_effective_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def effective_at=(_effective_at); end
# Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
sig { returns(T.nilable(String)) }
def email_type; end
sig { params(_email_type: T.nilable(String)).returns(T.nilable(String)) }
def email_type=(_email_type); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# ID of the invoice.
sig { returns(String) }
def invoice; end
sig { params(_invoice: String).returns(String) }
def invoice=(_invoice); end
# Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Line])) }
def lines; end
sig {
params(_lines: T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Line])).returns(T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Line]))
}
def lines=(_lines); end
# The credit note's memo appears on the credit note PDF.
sig { returns(T.nilable(String)) }
def memo; end
sig { params(_memo: T.nilable(String)).returns(T.nilable(String)) }
def memo=(_memo); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
sig { returns(T.nilable(Integer)) }
def out_of_band_amount; end
sig { params(_out_of_band_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def out_of_band_amount=(_out_of_band_amount); end
# Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
sig { returns(T.nilable(String)) }
def reason; end
sig { params(_reason: T.nilable(String)).returns(T.nilable(String)) }
def reason=(_reason); end
# The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
sig { returns(T.nilable(Integer)) }
def refund_amount; end
sig { params(_refund_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def refund_amount=(_refund_amount); end
# Refunds to link to this credit note.
sig { returns(T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Refund])) }
def refunds; end
sig {
params(_refunds: T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Refund])).returns(T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Refund]))
}
def refunds=(_refunds); end
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(::Stripe::CreditNote::PreviewParams::ShippingCost)) }
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(::Stripe::CreditNote::PreviewParams::ShippingCost)).returns(T.nilable(::Stripe::CreditNote::PreviewParams::ShippingCost))
}
def shipping_cost=(_shipping_cost); end
sig {
params(amount: T.nilable(Integer), credit_amount: T.nilable(Integer), effective_at: T.nilable(Integer), email_type: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: String, lines: T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Line]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), out_of_band_amount: T.nilable(Integer), reason: T.nilable(String), refund_amount: T.nilable(Integer), refunds: T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Refund]), shipping_cost: T.nilable(::Stripe::CreditNote::PreviewParams::ShippingCost)).void
}
def initialize(
amount: nil,
credit_amount: nil,
effective_at: nil,
email_type: nil,
expand: nil,
invoice: nil,
lines: nil,
memo: nil,
metadata: nil,
out_of_band_amount: nil,
reason: nil,
refund_amount: nil,
refunds: nil,
shipping_cost: nil
); end
end
class ListPreviewLineItemsParams < Stripe::RequestParams
class Line < Stripe::RequestParams
class TaxAmount < Stripe::RequestParams
# The amount, in cents (or local equivalent), of the tax.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.
sig { returns(String) }
def tax_rate; end
sig { params(_tax_rate: String).returns(String) }
def tax_rate=(_tax_rate); end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(Integer) }
def taxable_amount; end
sig { params(_taxable_amount: Integer).returns(Integer) }
def taxable_amount=(_taxable_amount); end
sig { params(amount: Integer, tax_rate: String, taxable_amount: Integer).void }
def initialize(amount: nil, tax_rate: nil, taxable_amount: nil); end
end
# The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
sig { returns(T.nilable(String)) }
def invoice_line_item; end
sig { params(_invoice_line_item: T.nilable(String)).returns(T.nilable(String)) }
def invoice_line_item=(_invoice_line_item); end
# The line item quantity to credit.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line::TaxAmount])))
}
def tax_amounts; end
sig {
params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line::TaxAmount])))
}
def tax_amounts=(_tax_amounts); end
# The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(amount: T.nilable(Integer), description: T.nilable(String), invoice_line_item: T.nilable(String), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line::TaxAmount])), tax_rates: T.nilable(T.any(String, T::Array[String])), type: String, unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
amount: nil,
description: nil,
invoice_line_item: nil,
quantity: nil,
tax_amounts: nil,
tax_rates: nil,
type: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Refund < Stripe::RequestParams
# Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
sig { returns(T.nilable(Integer)) }
def amount_refunded; end
sig { params(_amount_refunded: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_refunded=(_amount_refunded); end
# ID of an existing refund to link this credit note to. Required when `type` is `refund`.
sig { returns(T.nilable(String)) }
def refund; end
sig { params(_refund: T.nilable(String)).returns(T.nilable(String)) }
def refund=(_refund); end
sig { params(amount_refunded: T.nilable(Integer), refund: T.nilable(String)).void }
def initialize(amount_refunded: nil, refund: nil); end
end
class ShippingCost < Stripe::RequestParams
# The ID of the shipping rate to use for this order.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
sig { params(shipping_rate: T.nilable(String)).void }
def initialize(shipping_rate: nil); end
end
# The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
sig { returns(T.nilable(Integer)) }
def credit_amount; end
sig { params(_credit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def credit_amount=(_credit_amount); end
# The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
sig { returns(T.nilable(Integer)) }
def effective_at; end
sig { params(_effective_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def effective_at=(_effective_at); end
# Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
sig { returns(T.nilable(String)) }
def email_type; end
sig { params(_email_type: T.nilable(String)).returns(T.nilable(String)) }
def email_type=(_email_type); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# ID of the invoice.
sig { returns(String) }
def invoice; end
sig { params(_invoice: String).returns(String) }
def invoice=(_invoice); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line])) }
def lines; end
sig {
params(_lines: T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line])).returns(T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line]))
}
def lines=(_lines); end
# The credit note's memo appears on the credit note PDF.
sig { returns(T.nilable(String)) }
def memo; end
sig { params(_memo: T.nilable(String)).returns(T.nilable(String)) }
def memo=(_memo); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
sig { returns(T.nilable(Integer)) }
def out_of_band_amount; end
sig { params(_out_of_band_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def out_of_band_amount=(_out_of_band_amount); end
# Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
sig { returns(T.nilable(String)) }
def reason; end
sig { params(_reason: T.nilable(String)).returns(T.nilable(String)) }
def reason=(_reason); end
# The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
sig { returns(T.nilable(Integer)) }
def refund_amount; end
sig { params(_refund_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def refund_amount=(_refund_amount); end
# Refunds to link to this credit note.
sig { returns(T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Refund])) }
def refunds; end
sig {
params(_refunds: T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Refund])).returns(T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Refund]))
}
def refunds=(_refunds); end
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(::Stripe::CreditNote::ListPreviewLineItemsParams::ShippingCost)) }
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(::Stripe::CreditNote::ListPreviewLineItemsParams::ShippingCost)).returns(T.nilable(::Stripe::CreditNote::ListPreviewLineItemsParams::ShippingCost))
}
def shipping_cost=(_shipping_cost); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(amount: T.nilable(Integer), credit_amount: T.nilable(Integer), effective_at: T.nilable(Integer), email_type: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: String, limit: T.nilable(Integer), lines: T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), out_of_band_amount: T.nilable(Integer), reason: T.nilable(String), refund_amount: T.nilable(Integer), refunds: T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Refund]), shipping_cost: T.nilable(::Stripe::CreditNote::ListPreviewLineItemsParams::ShippingCost), starting_after: T.nilable(String)).void
}
def initialize(
amount: nil,
credit_amount: nil,
effective_at: nil,
email_type: nil,
ending_before: nil,
expand: nil,
invoice: nil,
limit: nil,
lines: nil,
memo: nil,
metadata: nil,
out_of_band_amount: nil,
reason: nil,
refund_amount: nil,
refunds: nil,
shipping_cost: nil,
starting_after: nil
); end
end
class VoidCreditNoteParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
# This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
#
#
# Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
# Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
# Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
#
#
# The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
#
# You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
# post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
sig {
params(params: T.any(::Stripe::CreditNote::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
}
def self.create(params = {}, opts = {}); end
# Returns a list of credit notes.
sig {
params(params: T.any(::Stripe::CreditNote::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# When retrieving a credit note preview, you'll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.
sig {
params(params: T.any(::Stripe::CreditNote::ListPreviewLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list_preview_line_items(params = {}, opts = {}); end
# Get a preview of a credit note without creating it.
sig {
params(params: T.any(::Stripe::CreditNote::PreviewParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
}
def self.preview(params = {}, opts = {}); end
# Updates an existing credit note.
sig {
params(id: String, params: T.any(::Stripe::CreditNote::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
}
def self.update(id, params = {}, opts = {}); end
# Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding).
sig {
params(params: T.any(::Stripe::CreditNote::VoidCreditNoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
}
def void_credit_note(params = {}, opts = {}); end
# Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding).
sig {
params(id: String, params: T.any(::Stripe::CreditNote::VoidCreditNoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
}
def self.void_credit_note(id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# The credit note line item object
class CreditNoteLineItem < StripeObject
class DiscountAmount < Stripe::StripeObject
# The amount, in cents (or local equivalent), of the discount.
sig { returns(Integer) }
def amount; end
# The discount that was applied to get this discount amount.
sig { returns(T.any(String, Stripe::Discount)) }
def discount; end
end
class PretaxCreditAmount < Stripe::StripeObject
# The amount, in cents (or local equivalent), of the pretax credit amount.
sig { returns(Integer) }
def amount; end
# The credit balance transaction that was applied to get this pretax credit amount.
sig { returns(T.nilable(T.any(String, Stripe::Billing::CreditBalanceTransaction))) }
def credit_balance_transaction; end
# The discount that was applied to get this pretax credit amount.
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
def discount; end
# Type of the pretax credit amount referenced.
sig { returns(String) }
def type; end
end
class TaxCalculationReference < Stripe::StripeObject
# The calculation identifier for tax calculation response.
sig { returns(T.nilable(String)) }
def calculation_id; end
# The calculation identifier for tax calculation response line item.
sig { returns(T.nilable(String)) }
def calculation_item_id; end
end
class Tax < Stripe::StripeObject
class TaxRateDetails < Stripe::StripeObject
# Attribute for field tax_rate
sig { returns(String) }
def tax_rate; end
end
# The amount of the tax, in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
# Whether this tax is inclusive or exclusive.
sig { returns(String) }
def tax_behavior; end
# Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
sig { returns(T.nilable(TaxRateDetails)) }
def tax_rate_details; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(String) }
def taxability_reason; end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(T.nilable(Integer)) }
def taxable_amount; end
# The type of tax information.
sig { returns(String) }
def type; end
end
# The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
sig { returns(Integer) }
def amount; end
# Description of the item being credited.
sig { returns(T.nilable(String)) }
def description; end
# The integer amount in cents (or local equivalent) representing the discount being credited for this line item.
sig { returns(Integer) }
def discount_amount; end
# The amount of discount calculated per discount for this line item
sig { returns(T::Array[DiscountAmount]) }
def discount_amounts; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# ID of the invoice line item being credited
sig { returns(T.nilable(String)) }
def invoice_line_item; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The pretax credit amounts (ex: discount, credit grants, etc) for this line item.
sig { returns(T::Array[PretaxCreditAmount]) }
def pretax_credit_amounts; end
# The number of units of product being credited.
sig { returns(T.nilable(Integer)) }
def quantity; end
# The tax calculation identifiers of the line item.
sig { returns(T.nilable(TaxCalculationReference)) }
def tax_calculation_reference; end
# The tax rates which apply to the line item.
sig { returns(T::Array[Stripe::TaxRate]) }
def tax_rates; end
# The tax information of the line item.
sig { returns(T.nilable(T::Array[Tax])) }
def taxes; end
# The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.
sig { returns(String) }
def type; end
# The cost of each unit of product being credited.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
# Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
end
end
# 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://docs.stripe.com/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),
# [Customer Session with the Pricing Table](https://docs.stripe.com/payments/checkout/pricing-table#customer-session),
# [Customer Session with the Buy Button](https://docs.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) }
def enabled; end
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]) }
def payment_method_allow_redisplay_filters; end
# Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.
sig { returns(String) }
def payment_method_redisplay; end
# Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. The maximum redisplay limit is `10`.
sig { returns(T.nilable(Integer)) }
def payment_method_redisplay_limit; end
# 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) }
def payment_method_remove; end
# 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) }
def payment_method_save; end
# 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)) }
def payment_method_save_usage; end
end
# Whether the Payment Element is enabled.
sig { returns(T::Boolean) }
def enabled; end
# This hash defines whether the Payment Element supports certain features.
sig { returns(T.nilable(Features)) }
def features; end
end
class PricingTable < Stripe::StripeObject
# Whether the pricing table is enabled.
sig { returns(T::Boolean) }
def enabled; end
end
# This hash contains whether the buy button is enabled.
sig { returns(BuyButton) }
def buy_button; end
# This hash contains whether the Payment Element is enabled and the features it supports.
sig { returns(PaymentElement) }
def payment_element; end
# This hash contains whether the pricing table is enabled.
sig { returns(PricingTable) }
def pricing_table; end
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) }
def client_secret; end
# Configuration for the components supported by this Customer Session.
sig { returns(T.nilable(Components)) }
def components; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The Customer the Customer Session was created for.
sig { returns(T.any(String, Stripe::Customer)) }
def customer; end
# The Account that the Customer Session was created for.
sig { returns(T.nilable(String)) }
def customer_account; end
# The timestamp at which this Customer Session will expire.
sig { returns(Integer) }
def expires_at; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
class CreateParams < Stripe::RequestParams
class Components < Stripe::RequestParams
class BuyButton < Stripe::RequestParams
# Whether the buy button is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
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.nilable(T::Array[String])) }
def payment_method_allow_redisplay_filters; end
sig {
params(_payment_method_allow_redisplay_filters: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_allow_redisplay_filters=(
_payment_method_allow_redisplay_filters
); end
# Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.
sig { returns(T.nilable(String)) }
def payment_method_redisplay; end
sig { params(_payment_method_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_redisplay=(_payment_method_redisplay); end
# Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. The maximum redisplay limit is `10`.
sig { returns(T.nilable(Integer)) }
def payment_method_redisplay_limit; end
sig {
params(_payment_method_redisplay_limit: T.nilable(Integer)).returns(T.nilable(Integer))
}
def payment_method_redisplay_limit=(_payment_method_redisplay_limit); end
# 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(T.nilable(String)) }
def payment_method_remove; end
sig { params(_payment_method_remove: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_remove=(_payment_method_remove); end
# 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(T.nilable(String)) }
def payment_method_save; end
sig { params(_payment_method_save: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_save=(_payment_method_save); end
# 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)) }
def payment_method_save_usage; end
sig { params(_payment_method_save_usage: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_save_usage=(_payment_method_save_usage); end
sig {
params(payment_method_allow_redisplay_filters: T.nilable(T::Array[String]), payment_method_redisplay: T.nilable(String), payment_method_redisplay_limit: T.nilable(Integer), payment_method_remove: T.nilable(String), payment_method_save: T.nilable(String), payment_method_save_usage: T.nilable(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) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# This hash defines whether the Payment Element supports certain features.
sig {
returns(T.nilable(::Stripe::CustomerSession::CreateParams::Components::PaymentElement::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::CustomerSession::CreateParams::Components::PaymentElement::Features)).returns(T.nilable(::Stripe::CustomerSession::CreateParams::Components::PaymentElement::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::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) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
# Configuration for buy button.
sig { returns(T.nilable(::Stripe::CustomerSession::CreateParams::Components::BuyButton)) }
def buy_button; end
sig {
params(_buy_button: T.nilable(::Stripe::CustomerSession::CreateParams::Components::BuyButton)).returns(T.nilable(::Stripe::CustomerSession::CreateParams::Components::BuyButton))
}
def buy_button=(_buy_button); end
# Configuration for the Payment Element.
sig {
returns(T.nilable(::Stripe::CustomerSession::CreateParams::Components::PaymentElement))
}
def payment_element; end
sig {
params(_payment_element: T.nilable(::Stripe::CustomerSession::CreateParams::Components::PaymentElement)).returns(T.nilable(::Stripe::CustomerSession::CreateParams::Components::PaymentElement))
}
def payment_element=(_payment_element); end
# Configuration for the pricing table.
sig {
returns(T.nilable(::Stripe::CustomerSession::CreateParams::Components::PricingTable))
}
def pricing_table; end
sig {
params(_pricing_table: T.nilable(::Stripe::CustomerSession::CreateParams::Components::PricingTable)).returns(T.nilable(::Stripe::CustomerSession::CreateParams::Components::PricingTable))
}
def pricing_table=(_pricing_table); end
sig {
params(buy_button: T.nilable(::Stripe::CustomerSession::CreateParams::Components::BuyButton), payment_element: T.nilable(::Stripe::CustomerSession::CreateParams::Components::PaymentElement), pricing_table: T.nilable(::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) }
def components; end
sig {
params(_components: ::Stripe::CustomerSession::CreateParams::Components).returns(::Stripe::CustomerSession::CreateParams::Components)
}
def components=(_components); end
# The ID of an existing customer for which to create the Customer Session.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The ID of an existing Account for which to create the Customer Session.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(components: ::Stripe::CustomerSession::CreateParams::Components, customer: T.nilable(String), customer_account: T.nilable(String), expand: T.nilable(T::Array[String])).void
}
def initialize(components: nil, customer: nil, customer_account: 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
# typed: true
module Stripe
# This object represents a customer of your business. Use it to [create recurring charges](https://stripe.com/docs/invoicing/customer), [save payment](https://stripe.com/docs/payments/save-during-payment) and contact information,
# and track payments that belong to the same customer.
class Customer < APIResource
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class InvoiceSettings < Stripe::StripeObject
class CustomField < Stripe::StripeObject
# The name of the custom field.
sig { returns(String) }
def name; end
# The value of the custom field.
sig { returns(String) }
def value; end
end
class RenderingOptions < Stripe::StripeObject
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
sig { returns(T.nilable(String)) }
def amount_tax_display; end
# ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.
sig { returns(T.nilable(String)) }
def template; end
end
# Default custom fields to be displayed on invoices for this customer.
sig { returns(T.nilable(T::Array[CustomField])) }
def custom_fields; end
# ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def default_payment_method; end
# Default footer to be displayed on invoices for this customer.
sig { returns(T.nilable(String)) }
def footer; end
# Default options for invoice PDF rendering for this customer.
sig { returns(T.nilable(RenderingOptions)) }
def rendering_options; end
end
class Shipping < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(T.nilable(Address)) }
def address; end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
# Recipient name.
sig { returns(T.nilable(String)) }
def name; end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
end
class Tax < Stripe::StripeObject
class Location < Stripe::StripeObject
# The identified tax country of the customer.
sig { returns(String) }
def country; end
# The data source used to infer the customer's location.
sig { returns(String) }
def source; end
# The identified tax state, county, province, or region of the customer.
sig { returns(T.nilable(String)) }
def state; end
end
# Surfaces if automatic tax computation is possible given the current customer location information.
sig { returns(String) }
def automatic_tax; end
# A recent IP address of the customer used for tax reporting and tax location inference.
sig { returns(T.nilable(String)) }
def ip_address; end
# The identified tax location of the customer.
sig { returns(T.nilable(Location)) }
def location; end
end
# The customer's address.
sig { returns(T.nilable(Address)) }
def address; end
# The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance).
sig { returns(T.nilable(Integer)) }
def balance; end
# The customer's business name.
sig { returns(T.nilable(String)) }
def business_name; end
# The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically.
sig { returns(T.nilable(Stripe::CashBalance)) }
def cash_balance; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.
sig { returns(T.nilable(String)) }
def currency; end
# Attribute for field customer_account
sig { returns(T.nilable(String)) }
def customer_account; end
# ID of the default payment source for the customer.
#
# If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.
sig {
returns(T.nilable(T.any(String, T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source))))
}
def default_source; end
# Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`.
#
# If an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`.
#
# If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`.
sig { returns(T.nilable(T::Boolean)) }
def delinquent; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# Describes the current discount active on the customer, if there is one.
sig { returns(T.nilable(Stripe::Discount)) }
def discount; end
# The customer's email address.
sig { returns(T.nilable(String)) }
def email; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The customer's individual name.
sig { returns(T.nilable(String)) }
def individual_name; end
# The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.
sig { returns(T.nilable(T::Hash[String, Integer])) }
def invoice_credit_balance; end
# The prefix for the customer used to generate unique invoice numbers.
sig { returns(T.nilable(String)) }
def invoice_prefix; end
# Attribute for field invoice_settings
sig { returns(T.nilable(InvoiceSettings)) }
def invoice_settings; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# The customer's full name or business name.
sig { returns(T.nilable(String)) }
def name; end
# The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.
sig { returns(T.nilable(Integer)) }
def next_invoice_sequence; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The customer's phone number.
sig { returns(T.nilable(String)) }
def phone; end
# The customer's preferred locales (languages), ordered by preference.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
# Mailing and shipping address for the customer. Appears on invoices emailed to this customer.
sig { returns(T.nilable(Shipping)) }
def shipping; end
# The customer's payment sources, if any.
sig { returns(T.nilable(Stripe::ListObject)) }
def sources; end
# The customer's current subscriptions, if any.
sig { returns(T.nilable(Stripe::ListObject)) }
def subscriptions; end
# Attribute for field tax
sig { returns(T.nilable(Tax)) }
def tax; end
# Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**.
sig { returns(T.nilable(String)) }
def tax_exempt; end
# The customer's tax IDs.
sig { returns(T.nilable(Stripe::ListObject)) }
def tax_ids; end
# ID of the test clock that this customer belongs to.
sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
def test_clock; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams; end
class UpdateParams < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class CashBalance < Stripe::RequestParams
class Settings < Stripe::RequestParams
# Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
sig { returns(T.nilable(String)) }
def reconciliation_mode; end
sig { params(_reconciliation_mode: T.nilable(String)).returns(T.nilable(String)) }
def reconciliation_mode=(_reconciliation_mode); end
sig { params(reconciliation_mode: T.nilable(String)).void }
def initialize(reconciliation_mode: nil); end
end
# Settings controlling the behavior of the customer's cash balance,
# such as reconciliation of funds received.
sig { returns(T.nilable(::Stripe::Customer::UpdateParams::CashBalance::Settings)) }
def settings; end
sig {
params(_settings: T.nilable(::Stripe::Customer::UpdateParams::CashBalance::Settings)).returns(T.nilable(::Stripe::Customer::UpdateParams::CashBalance::Settings))
}
def settings=(_settings); end
sig {
params(settings: T.nilable(::Stripe::Customer::UpdateParams::CashBalance::Settings)).void
}
def initialize(settings: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class CustomField < Stripe::RequestParams
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The value of the custom field. This may be up to 140 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
class RenderingOptions < Stripe::RequestParams
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(T.any(String, String))) }
def amount_tax_display; end
sig {
params(_amount_tax_display: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def amount_tax_display=(_amount_tax_display); end
# ID of the invoice rendering template to use for future invoices.
sig { returns(T.nilable(String)) }
def template; end
sig { params(_template: T.nilable(String)).returns(T.nilable(String)) }
def template=(_template); end
sig {
params(amount_tax_display: T.nilable(T.any(String, String)), template: T.nilable(String)).void
}
def initialize(amount_tax_display: nil, template: nil); end
end
# The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Customer::UpdateParams::InvoiceSettings::CustomField])))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T.any(String, T::Array[::Stripe::Customer::UpdateParams::InvoiceSettings::CustomField]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Customer::UpdateParams::InvoiceSettings::CustomField])))
}
def custom_fields=(_custom_fields); end
# ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# Default footer to be displayed on invoices for this customer.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# Default options for invoice PDF rendering for this customer.
sig {
returns(T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::InvoiceSettings::RenderingOptions)))
}
def rendering_options; end
sig {
params(_rendering_options: T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::InvoiceSettings::RenderingOptions))).returns(T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::InvoiceSettings::RenderingOptions)))
}
def rendering_options=(_rendering_options); end
sig {
params(custom_fields: T.nilable(T.any(String, T::Array[::Stripe::Customer::UpdateParams::InvoiceSettings::CustomField])), default_payment_method: T.nilable(String), footer: T.nilable(String), rendering_options: T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::InvoiceSettings::RenderingOptions))).void
}
def initialize(
custom_fields: nil,
default_payment_method: nil,
footer: nil,
rendering_options: nil
); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Customer shipping address.
sig { returns(::Stripe::Customer::UpdateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::Customer::UpdateParams::Shipping::Address).returns(::Stripe::Customer::UpdateParams::Shipping::Address)
}
def address=(_address); end
# Customer name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Customer phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: ::Stripe::Customer::UpdateParams::Shipping::Address, name: String, phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
class Tax < Stripe::RequestParams
# A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# A flag that indicates when Stripe should validate the customer tax location. Defaults to `auto`.
sig { returns(T.nilable(String)) }
def validate_location; end
sig { params(_validate_location: T.nilable(String)).returns(T.nilable(String)) }
def validate_location=(_validate_location); end
sig { params(ip_address: T.nilable(String), validate_location: T.nilable(String)).void }
def initialize(ip_address: nil, validate_location: nil); end
end
# The customer's address.
sig { returns(T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::Address))) }
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::Address))).returns(T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::Address)))
}
def address=(_address); end
# An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
sig { returns(T.nilable(Integer)) }
def balance; end
sig { params(_balance: T.nilable(Integer)).returns(T.nilable(Integer)) }
def balance=(_balance); end
# The customer's business name. This may be up to *150 characters*.
sig { returns(T.nilable(String)) }
def business_name; end
sig { params(_business_name: T.nilable(String)).returns(T.nilable(String)) }
def business_name=(_business_name); end
# Balance information and default balance settings for this customer.
sig { returns(T.nilable(::Stripe::Customer::UpdateParams::CashBalance)) }
def cash_balance; end
sig {
params(_cash_balance: T.nilable(::Stripe::Customer::UpdateParams::CashBalance)).returns(T.nilable(::Stripe::Customer::UpdateParams::CashBalance))
}
def cash_balance=(_cash_balance); end
# If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter.
#
# Provide the ID of a payment source already attached to this customer to make it this customer's default payment source.
#
# If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property.
sig { returns(T.nilable(String)) }
def default_source; end
sig { params(_default_source: T.nilable(String)).returns(T.nilable(String)) }
def default_source=(_default_source); end
# An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The customer's full name. This may be up to *150 characters*.
sig { returns(T.nilable(String)) }
def individual_name; end
sig { params(_individual_name: T.nilable(String)).returns(T.nilable(String)) }
def individual_name=(_individual_name); end
# The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
sig { returns(T.nilable(String)) }
def invoice_prefix; end
sig { params(_invoice_prefix: T.nilable(String)).returns(T.nilable(String)) }
def invoice_prefix=(_invoice_prefix); end
# Default invoice settings for this customer.
sig { returns(T.nilable(::Stripe::Customer::UpdateParams::InvoiceSettings)) }
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::Customer::UpdateParams::InvoiceSettings)).returns(T.nilable(::Stripe::Customer::UpdateParams::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The customer's full name or business name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The sequence to be used on the customer's next invoice. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def next_invoice_sequence; end
sig { params(_next_invoice_sequence: T.nilable(Integer)).returns(T.nilable(Integer)) }
def next_invoice_sequence=(_next_invoice_sequence); end
# The customer's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Customer's preferred languages, ordered by preference.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
sig {
params(_preferred_locales: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def preferred_locales=(_preferred_locales); end
# The customer's shipping information. Appears on invoices emailed to this customer.
sig { returns(T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::Shipping))) }
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::Shipping))).returns(T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::Shipping)))
}
def shipping=(_shipping); end
# Attribute for param field source
sig { returns(T.nilable(String)) }
def source; end
sig { params(_source: T.nilable(String)).returns(T.nilable(String)) }
def source=(_source); end
# Tax details about the customer.
sig { returns(T.nilable(::Stripe::Customer::UpdateParams::Tax)) }
def tax; end
sig {
params(_tax: T.nilable(::Stripe::Customer::UpdateParams::Tax)).returns(T.nilable(::Stripe::Customer::UpdateParams::Tax))
}
def tax=(_tax); end
# The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
sig { returns(T.nilable(T.any(String, String))) }
def tax_exempt; end
sig {
params(_tax_exempt: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def tax_exempt=(_tax_exempt); end
# Attribute for param field validate
sig { returns(T.nilable(T::Boolean)) }
def validate; end
sig { params(_validate: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def validate=(_validate); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::Address)), balance: T.nilable(Integer), business_name: T.nilable(String), cash_balance: T.nilable(::Stripe::Customer::UpdateParams::CashBalance), default_source: T.nilable(String), description: T.nilable(String), email: T.nilable(String), expand: T.nilable(T::Array[String]), individual_name: T.nilable(String), invoice_prefix: T.nilable(String), invoice_settings: T.nilable(::Stripe::Customer::UpdateParams::InvoiceSettings), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String), next_invoice_sequence: T.nilable(Integer), phone: T.nilable(String), preferred_locales: T.nilable(T::Array[String]), shipping: T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::Shipping)), source: T.nilable(String), tax: T.nilable(::Stripe::Customer::UpdateParams::Tax), tax_exempt: T.nilable(T.any(String, String)), validate: T.nilable(T::Boolean)).void
}
def initialize(
address: nil,
balance: nil,
business_name: nil,
cash_balance: nil,
default_source: nil,
description: nil,
email: nil,
expand: nil,
individual_name: nil,
invoice_prefix: nil,
invoice_settings: nil,
metadata: nil,
name: nil,
next_invoice_sequence: nil,
phone: nil,
preferred_locales: nil,
shipping: nil,
source: nil,
tax: nil,
tax_exempt: nil,
validate: nil
); end
end
class DeleteDiscountParams < Stripe::RequestParams; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return customers that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Customer::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Customer::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Customer::ListParams::Created, Integer)))
}
def created=(_created); end
# A case-sensitive filter on the list based on the customer's `email` field. The value must be a string.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.
sig { returns(T.nilable(String)) }
def test_clock; end
sig { params(_test_clock: T.nilable(String)).returns(T.nilable(String)) }
def test_clock=(_test_clock); end
sig {
params(created: T.nilable(T.any(::Stripe::Customer::ListParams::Created, Integer)), email: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), test_clock: T.nilable(String)).void
}
def initialize(
created: nil,
email: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
test_clock: nil
); end
end
class CreateParams < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class CashBalance < Stripe::RequestParams
class Settings < Stripe::RequestParams
# Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
sig { returns(T.nilable(String)) }
def reconciliation_mode; end
sig { params(_reconciliation_mode: T.nilable(String)).returns(T.nilable(String)) }
def reconciliation_mode=(_reconciliation_mode); end
sig { params(reconciliation_mode: T.nilable(String)).void }
def initialize(reconciliation_mode: nil); end
end
# Settings controlling the behavior of the customer's cash balance,
# such as reconciliation of funds received.
sig { returns(T.nilable(::Stripe::Customer::CreateParams::CashBalance::Settings)) }
def settings; end
sig {
params(_settings: T.nilable(::Stripe::Customer::CreateParams::CashBalance::Settings)).returns(T.nilable(::Stripe::Customer::CreateParams::CashBalance::Settings))
}
def settings=(_settings); end
sig {
params(settings: T.nilable(::Stripe::Customer::CreateParams::CashBalance::Settings)).void
}
def initialize(settings: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class CustomField < Stripe::RequestParams
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The value of the custom field. This may be up to 140 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
class RenderingOptions < Stripe::RequestParams
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(T.any(String, String))) }
def amount_tax_display; end
sig {
params(_amount_tax_display: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def amount_tax_display=(_amount_tax_display); end
# ID of the invoice rendering template to use for future invoices.
sig { returns(T.nilable(String)) }
def template; end
sig { params(_template: T.nilable(String)).returns(T.nilable(String)) }
def template=(_template); end
sig {
params(amount_tax_display: T.nilable(T.any(String, String)), template: T.nilable(String)).void
}
def initialize(amount_tax_display: nil, template: nil); end
end
# The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Customer::CreateParams::InvoiceSettings::CustomField])))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T.any(String, T::Array[::Stripe::Customer::CreateParams::InvoiceSettings::CustomField]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Customer::CreateParams::InvoiceSettings::CustomField])))
}
def custom_fields=(_custom_fields); end
# ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# Default footer to be displayed on invoices for this customer.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# Default options for invoice PDF rendering for this customer.
sig {
returns(T.nilable(T.any(String, ::Stripe::Customer::CreateParams::InvoiceSettings::RenderingOptions)))
}
def rendering_options; end
sig {
params(_rendering_options: T.nilable(T.any(String, ::Stripe::Customer::CreateParams::InvoiceSettings::RenderingOptions))).returns(T.nilable(T.any(String, ::Stripe::Customer::CreateParams::InvoiceSettings::RenderingOptions)))
}
def rendering_options=(_rendering_options); end
sig {
params(custom_fields: T.nilable(T.any(String, T::Array[::Stripe::Customer::CreateParams::InvoiceSettings::CustomField])), default_payment_method: T.nilable(String), footer: T.nilable(String), rendering_options: T.nilable(T.any(String, ::Stripe::Customer::CreateParams::InvoiceSettings::RenderingOptions))).void
}
def initialize(
custom_fields: nil,
default_payment_method: nil,
footer: nil,
rendering_options: nil
); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Customer shipping address.
sig { returns(::Stripe::Customer::CreateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::Customer::CreateParams::Shipping::Address).returns(::Stripe::Customer::CreateParams::Shipping::Address)
}
def address=(_address); end
# Customer name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Customer phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: ::Stripe::Customer::CreateParams::Shipping::Address, name: String, phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
class Tax < Stripe::RequestParams
# A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`.
sig { returns(T.nilable(String)) }
def validate_location; end
sig { params(_validate_location: T.nilable(String)).returns(T.nilable(String)) }
def validate_location=(_validate_location); end
sig { params(ip_address: T.nilable(String), validate_location: T.nilable(String)).void }
def initialize(ip_address: nil, validate_location: nil); end
end
class TaxIdDatum < Stripe::RequestParams
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Value of the tax ID.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(type: String, value: String).void }
def initialize(type: nil, value: nil); end
end
# The customer's address.
sig { returns(T.nilable(T.any(String, ::Stripe::Customer::CreateParams::Address))) }
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::Customer::CreateParams::Address))).returns(T.nilable(T.any(String, ::Stripe::Customer::CreateParams::Address)))
}
def address=(_address); end
# An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
sig { returns(T.nilable(Integer)) }
def balance; end
sig { params(_balance: T.nilable(Integer)).returns(T.nilable(Integer)) }
def balance=(_balance); end
# The customer's business name. This may be up to *150 characters*.
sig { returns(T.nilable(String)) }
def business_name; end
sig { params(_business_name: T.nilable(String)).returns(T.nilable(String)) }
def business_name=(_business_name); end
# Balance information and default balance settings for this customer.
sig { returns(T.nilable(::Stripe::Customer::CreateParams::CashBalance)) }
def cash_balance; end
sig {
params(_cash_balance: T.nilable(::Stripe::Customer::CreateParams::CashBalance)).returns(T.nilable(::Stripe::Customer::CreateParams::CashBalance))
}
def cash_balance=(_cash_balance); end
# An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The customer's full name. This may be up to *150 characters*.
sig { returns(T.nilable(String)) }
def individual_name; end
sig { params(_individual_name: T.nilable(String)).returns(T.nilable(String)) }
def individual_name=(_individual_name); end
# The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
sig { returns(T.nilable(String)) }
def invoice_prefix; end
sig { params(_invoice_prefix: T.nilable(String)).returns(T.nilable(String)) }
def invoice_prefix=(_invoice_prefix); end
# Default invoice settings for this customer.
sig { returns(T.nilable(::Stripe::Customer::CreateParams::InvoiceSettings)) }
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::Customer::CreateParams::InvoiceSettings)).returns(T.nilable(::Stripe::Customer::CreateParams::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The customer's full name or business name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The sequence to be used on the customer's next invoice. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def next_invoice_sequence; end
sig { params(_next_invoice_sequence: T.nilable(Integer)).returns(T.nilable(Integer)) }
def next_invoice_sequence=(_next_invoice_sequence); end
# Attribute for param field payment_method
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The customer's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Customer's preferred languages, ordered by preference.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
sig {
params(_preferred_locales: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def preferred_locales=(_preferred_locales); end
# The customer's shipping information. Appears on invoices emailed to this customer.
sig { returns(T.nilable(T.any(String, ::Stripe::Customer::CreateParams::Shipping))) }
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::Customer::CreateParams::Shipping))).returns(T.nilable(T.any(String, ::Stripe::Customer::CreateParams::Shipping)))
}
def shipping=(_shipping); end
# Attribute for param field source
sig { returns(T.nilable(String)) }
def source; end
sig { params(_source: T.nilable(String)).returns(T.nilable(String)) }
def source=(_source); end
# Tax details about the customer.
sig { returns(T.nilable(::Stripe::Customer::CreateParams::Tax)) }
def tax; end
sig {
params(_tax: T.nilable(::Stripe::Customer::CreateParams::Tax)).returns(T.nilable(::Stripe::Customer::CreateParams::Tax))
}
def tax=(_tax); end
# The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
sig { returns(T.nilable(T.any(String, String))) }
def tax_exempt; end
sig {
params(_tax_exempt: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def tax_exempt=(_tax_exempt); end
# The customer's tax IDs.
sig { returns(T.nilable(T::Array[::Stripe::Customer::CreateParams::TaxIdDatum])) }
def tax_id_data; end
sig {
params(_tax_id_data: T.nilable(T::Array[::Stripe::Customer::CreateParams::TaxIdDatum])).returns(T.nilable(T::Array[::Stripe::Customer::CreateParams::TaxIdDatum]))
}
def tax_id_data=(_tax_id_data); end
# ID of the test clock to attach to the customer.
sig { returns(T.nilable(String)) }
def test_clock; end
sig { params(_test_clock: T.nilable(String)).returns(T.nilable(String)) }
def test_clock=(_test_clock); end
# Attribute for param field validate
sig { returns(T.nilable(T::Boolean)) }
def validate; end
sig { params(_validate: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def validate=(_validate); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::Customer::CreateParams::Address)), balance: T.nilable(Integer), business_name: T.nilable(String), cash_balance: T.nilable(::Stripe::Customer::CreateParams::CashBalance), description: T.nilable(String), email: T.nilable(String), expand: T.nilable(T::Array[String]), individual_name: T.nilable(String), invoice_prefix: T.nilable(String), invoice_settings: T.nilable(::Stripe::Customer::CreateParams::InvoiceSettings), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String), next_invoice_sequence: T.nilable(Integer), payment_method: T.nilable(String), phone: T.nilable(String), preferred_locales: T.nilable(T::Array[String]), shipping: T.nilable(T.any(String, ::Stripe::Customer::CreateParams::Shipping)), source: T.nilable(String), tax: T.nilable(::Stripe::Customer::CreateParams::Tax), tax_exempt: T.nilable(T.any(String, String)), tax_id_data: T.nilable(T::Array[::Stripe::Customer::CreateParams::TaxIdDatum]), test_clock: T.nilable(String), validate: T.nilable(T::Boolean)).void
}
def initialize(
address: nil,
balance: nil,
business_name: nil,
cash_balance: nil,
description: nil,
email: nil,
expand: nil,
individual_name: nil,
invoice_prefix: nil,
invoice_settings: nil,
metadata: nil,
name: nil,
next_invoice_sequence: nil,
payment_method: nil,
phone: nil,
preferred_locales: nil,
shipping: nil,
source: nil,
tax: nil,
tax_exempt: nil,
tax_id_data: nil,
test_clock: nil,
validate: nil
); end
end
class ListPaymentMethodsParams < Stripe::RequestParams
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(allow_redisplay: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
allow_redisplay: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
type: nil
); end
end
class RetrievePaymentMethodParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class SearchParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
sig { returns(T.nilable(String)) }
def page; end
sig { params(_page: T.nilable(String)).returns(T.nilable(String)) }
def page=(_page); end
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers).
sig { returns(String) }
def query; end
sig { params(_query: String).returns(String) }
def query=(_query); end
sig {
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
}
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
end
class CreateFundingInstructionsParams < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
sig {
params(_requested_address_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested_address_types=(_requested_address_types); end
# The type of the `bank_transfer`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
}
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
end
# Additional parameters for `bank_transfer` funding types
sig { returns(::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer) }
def bank_transfer; end
sig {
params(_bank_transfer: ::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer).returns(::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer)
}
def bank_transfer=(_bank_transfer); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The `funding_type` to get the instructions for.
sig { returns(String) }
def funding_type; end
sig { params(_funding_type: String).returns(String) }
def funding_type=(_funding_type); end
sig {
params(bank_transfer: ::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer, currency: String, expand: T.nilable(T::Array[String]), funding_type: String).void
}
def initialize(bank_transfer: nil, currency: nil, expand: nil, funding_type: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class FundCashBalanceParams < Stripe::RequestParams
# Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's [reconciliation algorithm](https://stripe.com/docs/payments/customer-balance/reconciliation) applies to different user inputs.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
sig {
params(amount: Integer, currency: String, expand: T.nilable(T::Array[String]), reference: T.nilable(String)).void
}
def initialize(amount: nil, currency: nil, expand: nil, reference: nil); end
end
# Creates a new customer object.
sig {
params(params: T.any(::Stripe::Customer::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
}
def self.create(params = {}, opts = {}); end
# Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
# funding instructions will be created. If funding instructions have already been created for a given customer, the same
# funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
sig {
params(params: T.any(::Stripe::Customer::CreateFundingInstructionsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FundingInstructions)
}
def create_funding_instructions(params = {}, opts = {}); end
# Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
# funding instructions will be created. If funding instructions have already been created for a given customer, the same
# funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
sig {
params(customer: String, params: T.any(::Stripe::Customer::CreateFundingInstructionsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FundingInstructions)
}
def self.create_funding_instructions(customer, params = {}, opts = {}); end
# Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
sig {
params(customer: String, params: T.any(::Stripe::Customer::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
}
def self.delete(customer, params = {}, opts = {}); end
# Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
sig {
params(params: T.any(::Stripe::Customer::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
}
def delete(params = {}, opts = {}); end
# Removes the currently applied discount on a customer.
sig {
params(params: T.any(::Stripe::Customer::DeleteDiscountParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Discount)
}
def delete_discount(params = {}, opts = {}); end
# Removes the currently applied discount on a customer.
sig {
params(customer: String, params: T.any(::Stripe::Customer::DeleteDiscountParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Discount)
}
def self.delete_discount(customer, params = {}, opts = {}); end
# Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
sig {
params(params: T.any(::Stripe::Customer::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Returns a list of PaymentMethods for a given Customer
sig {
params(params: T.any(::Stripe::Customer::ListPaymentMethodsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list_payment_methods(params = {}, opts = {}); end
# Returns a list of PaymentMethods for a given Customer
sig {
params(customer: String, params: T.any(::Stripe::Customer::ListPaymentMethodsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list_payment_methods(customer, params = {}, opts = {}); end
# Retrieves a customer's cash balance.
sig {
params(customer: String, params: T.any(::Stripe::Customer::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.untyped)
}
def self.retrieve_cash_balance(customer, params = {}, opts = {}); end
# Retrieves a PaymentMethod object for a given Customer.
sig {
params(payment_method: String, params: T.any(::Stripe::Customer::RetrievePaymentMethodParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
}
def retrieve_payment_method(payment_method, params = {}, opts = {}); end
# Retrieves a PaymentMethod object for a given Customer.
sig {
params(customer: String, payment_method: String, params: T.any(::Stripe::Customer::RetrievePaymentMethodParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
}
def self.retrieve_payment_method(customer, payment_method, params = {}, opts = {}); end
sig {
params(params: T.any(::Stripe::Customer::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
}
def self.search(params = {}, opts = {}); end
sig {
params(params: T.any(::Stripe::Customer::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, blk: T.untyped).returns(Stripe::SearchResultObject)
}
def self.search_auto_paging_each(params = {}, opts = {}, &blk); end
# Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer's active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer's current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.
#
# This request accepts mostly the same arguments as the customer creation call.
sig {
params(customer: String, params: T.any(::Stripe::Customer::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
}
def self.update(customer, params = {}, opts = {}); end
# Changes the settings on a customer's cash balance.
sig {
params(customer: String, params: T.any(::Stripe::Customer::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.untyped)
}
def self.update_cash_balance(customer, params = {}, opts = {}); end
end
end
# 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) }
def amount; end
# The ID of the checkout session (if any) that created the transaction.
sig { returns(T.nilable(T.any(String, Stripe::Checkout::Session))) }
def checkout_session; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The ID of the credit note (if any) related to the transaction.
sig { returns(T.nilable(T.any(String, Stripe::CreditNote))) }
def credit_note; end
# 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) }
def currency; end
# The ID of the customer the transaction belongs to.
sig { returns(T.any(String, Stripe::Customer)) }
def customer; end
# Attribute for field customer_account
sig { returns(T.nilable(String)) }
def customer_account; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# 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) }
def ending_balance; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The ID of the invoice (if any) related to the transaction.
sig { returns(T.nilable(T.any(String, Stripe::Invoice))) }
def invoice; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, `unapplied_from_invoice`, `checkout_session_subscription_payment`, or `checkout_session_subscription_payment_canceled`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types.
sig { returns(String) }
def type; end
end
end
# typed: true
module Stripe
# A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.
class CashBalance < APIResource
class Settings < Stripe::StripeObject
# The configuration for how funds that land in the customer cash balance are reconciled.
sig { returns(String) }
def reconciliation_mode; end
# A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance
sig { returns(T::Boolean) }
def using_merchant_default; end
end
# A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(T::Hash[String, Integer])) }
def available; end
# The ID of the customer whose cash balance this object represents.
sig { returns(String) }
def customer; end
# The ID of the account whose cash balance this object represents.
sig { returns(T.nilable(String)) }
def customer_account; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Attribute for field settings
sig { returns(Settings) }
def settings; end
end
end
# 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)) }
def balance_transaction; end
# 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)) }
def linked_transaction; end
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)) }
def payment_intent; end
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)) }
def bic; end
# The last 4 digits of the IBAN of the sender of the funding.
sig { returns(T.nilable(String)) }
def iban_last4; end
# The full name of the sender, as supplied by the sending bank.
sig { returns(T.nilable(String)) }
def sender_name; end
end
class GbBankTransfer < Stripe::StripeObject
# The last 4 digits of the account number of the sender of the funding.
sig { returns(T.nilable(String)) }
def account_number_last4; end
# The full name of the sender, as supplied by the sending bank.
sig { returns(T.nilable(String)) }
def sender_name; end
# The sort code of the bank of the sender of the funding
sig { returns(T.nilable(String)) }
def sort_code; end
end
class JpBankTransfer < Stripe::StripeObject
# The name of the bank of the sender of the funding.
sig { returns(T.nilable(String)) }
def sender_bank; end
# The name of the bank branch of the sender of the funding.
sig { returns(T.nilable(String)) }
def sender_branch; end
# The full name of the sender, as supplied by the sending bank.
sig { returns(T.nilable(String)) }
def sender_name; end
end
class UsBankTransfer < Stripe::StripeObject
# The banking network used for this funding.
sig { returns(T.nilable(String)) }
def network; end
# The full name of the sender, as supplied by the sending bank.
sig { returns(T.nilable(String)) }
def sender_name; end
end
# Attribute for field eu_bank_transfer
sig { returns(T.nilable(EuBankTransfer)) }
def eu_bank_transfer; end
# Attribute for field gb_bank_transfer
sig { returns(T.nilable(GbBankTransfer)) }
def gb_bank_transfer; end
# Attribute for field jp_bank_transfer
sig { returns(T.nilable(JpBankTransfer)) }
def jp_bank_transfer; end
# The user-supplied reference field on the bank transfer.
sig { returns(T.nilable(String)) }
def reference; end
# 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) }
def type; end
# Attribute for field us_bank_transfer
sig { returns(T.nilable(UsBankTransfer)) }
def us_bank_transfer; end
end
# Attribute for field bank_transfer
sig { returns(BankTransfer) }
def bank_transfer; end
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)) }
def refund; end
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)) }
def balance_transaction; end
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)) }
def payment_intent; end
end
# Attribute for field adjusted_for_overdraft
sig { returns(T.nilable(AdjustedForOverdraft)) }
def adjusted_for_overdraft; end
# Attribute for field applied_to_payment
sig { returns(T.nilable(AppliedToPayment)) }
def applied_to_payment; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# The customer whose available cash balance changed as a result of this transaction.
sig { returns(T.any(String, Stripe::Customer)) }
def customer; end
# Attribute for field customer_account
sig { returns(T.nilable(String)) }
def customer_account; end
# 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) }
def ending_balance; end
# Attribute for field funded
sig { returns(T.nilable(Funded)) }
def funded; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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) }
def net_amount; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Attribute for field refunded_from_payment
sig { returns(T.nilable(RefundedFromPayment)) }
def refunded_from_payment; end
# Attribute for field transferred_to_balance
sig { returns(T.nilable(TransferredToBalance)) }
def transferred_to_balance; end
# 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) }
def type; end
# Attribute for field unapplied_from_payment
sig { returns(T.nilable(UnappliedFromPayment)) }
def unapplied_from_payment; end
end
end
# typed: true
module Stripe
# A dispute occurs when a customer questions your charge with their card issuer.
# When this happens, you have the opportunity to respond to the dispute with
# evidence that shows that the charge is legitimate.
#
# Related guide: [Disputes and fraud](https://stripe.com/docs/disputes)
class Dispute < APIResource
class Evidence < Stripe::StripeObject
class EnhancedEvidence < Stripe::StripeObject
class VisaCompellingEvidence3 < Stripe::StripeObject
class DisputedTransaction < Stripe::StripeObject
class ShippingAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# User Account ID used to log into business platform. Must be recognizable by the user.
sig { returns(T.nilable(String)) }
def customer_account_id; end
# Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.
sig { returns(T.nilable(String)) }
def customer_device_fingerprint; end
# Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.
sig { returns(T.nilable(String)) }
def customer_device_id; end
# The email address of the customer.
sig { returns(T.nilable(String)) }
def customer_email_address; end
# The IP address that the customer used when making the purchase.
sig { returns(T.nilable(String)) }
def customer_purchase_ip; end
# Categorization of disputed payment.
sig { returns(T.nilable(String)) }
def merchandise_or_services; end
# A description of the product or service that was sold.
sig { returns(T.nilable(String)) }
def product_description; end
# The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.
sig { returns(T.nilable(ShippingAddress)) }
def shipping_address; end
end
class PriorUndisputedTransaction < Stripe::StripeObject
class ShippingAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge.
sig { returns(String) }
def charge; end
# User Account ID used to log into business platform. Must be recognizable by the user.
sig { returns(T.nilable(String)) }
def customer_account_id; end
# Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.
sig { returns(T.nilable(String)) }
def customer_device_fingerprint; end
# Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.
sig { returns(T.nilable(String)) }
def customer_device_id; end
# The email address of the customer.
sig { returns(T.nilable(String)) }
def customer_email_address; end
# The IP address that the customer used when making the purchase.
sig { returns(T.nilable(String)) }
def customer_purchase_ip; end
# A description of the product or service that was sold.
sig { returns(T.nilable(String)) }
def product_description; end
# The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.
sig { returns(T.nilable(ShippingAddress)) }
def shipping_address; end
end
# Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission.
sig { returns(T.nilable(DisputedTransaction)) }
def disputed_transaction; end
# List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission.
sig { returns(T::Array[PriorUndisputedTransaction]) }
def prior_undisputed_transactions; end
end
class VisaCompliance < Stripe::StripeObject
# A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Stripe refunds the 500 USD network fee if you win the dispute.
sig { returns(T::Boolean) }
def fee_acknowledged; end
end
# Attribute for field visa_compelling_evidence_3
sig { returns(T.nilable(VisaCompellingEvidence3)) }
def visa_compelling_evidence_3; end
# Attribute for field visa_compliance
sig { returns(T.nilable(VisaCompliance)) }
def visa_compliance; end
end
# Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity.
sig { returns(T.nilable(String)) }
def access_activity_log; end
# The billing address provided by the customer.
sig { returns(T.nilable(String)) }
def billing_address; end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def cancellation_policy; end
# An explanation of how and when the customer was shown your refund policy prior to purchase.
sig { returns(T.nilable(String)) }
def cancellation_policy_disclosure; end
# A justification for why the customer's subscription was not canceled.
sig { returns(T.nilable(String)) }
def cancellation_rebuttal; end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def customer_communication; end
# The email address of the customer.
sig { returns(T.nilable(String)) }
def customer_email_address; end
# The name of the customer.
sig { returns(T.nilable(String)) }
def customer_name; end
# The IP address that the customer used when making the purchase.
sig { returns(T.nilable(String)) }
def customer_purchase_ip; end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def customer_signature; end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def duplicate_charge_documentation; end
# An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate.
sig { returns(T.nilable(String)) }
def duplicate_charge_explanation; end
# The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.
sig { returns(T.nilable(String)) }
def duplicate_charge_id; end
# Attribute for field enhanced_evidence
sig { returns(EnhancedEvidence) }
def enhanced_evidence; end
# A description of the product or service that was sold.
sig { returns(T.nilable(String)) }
def product_description; end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def receipt; end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def refund_policy; end
# Documentation demonstrating that the customer was shown your refund policy prior to purchase.
sig { returns(T.nilable(String)) }
def refund_policy_disclosure; end
# A justification for why the customer is not entitled to a refund.
sig { returns(T.nilable(String)) }
def refund_refusal_explanation; end
# The date on which the customer received or began receiving the purchased service, in a clear human-readable format.
sig { returns(T.nilable(String)) }
def service_date; end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def service_documentation; end
# The address to which a physical product was shipped. You should try to include as complete address information as possible.
sig { returns(T.nilable(String)) }
def shipping_address; end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def shipping_carrier; end
# The date on which a physical product began its route to the shipping address, in a clear human-readable format.
sig { returns(T.nilable(String)) }
def shipping_date; end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def shipping_documentation; end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def shipping_tracking_number; end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def uncategorized_file; end
# Any additional evidence or statements.
sig { returns(T.nilable(String)) }
def uncategorized_text; end
end
class EvidenceDetails < Stripe::StripeObject
class EnhancedEligibility < Stripe::StripeObject
class VisaCompellingEvidence3 < Stripe::StripeObject
# List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission.
sig { returns(T::Array[String]) }
def required_actions; end
# Visa Compelling Evidence 3.0 eligibility status.
sig { returns(String) }
def status; end
end
class VisaCompliance < Stripe::StripeObject
# Visa compliance eligibility status.
sig { returns(String) }
def status; end
end
# Attribute for field visa_compelling_evidence_3
sig { returns(T.nilable(VisaCompellingEvidence3)) }
def visa_compelling_evidence_3; end
# Attribute for field visa_compliance
sig { returns(T.nilable(VisaCompliance)) }
def visa_compliance; end
end
# Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute.
sig { returns(T.nilable(Integer)) }
def due_by; end
# Attribute for field enhanced_eligibility
sig { returns(EnhancedEligibility) }
def enhanced_eligibility; end
# Whether evidence has been staged for this dispute.
sig { returns(T::Boolean) }
def has_evidence; end
# Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed.
sig { returns(T::Boolean) }
def past_due; end
# The number of times evidence has been submitted. Typically, you may only submit evidence once.
sig { returns(Integer) }
def submission_count; end
# Whether the dispute was submitted manually, with Smart Disputes, or not submitted.
sig { returns(T.nilable(String)) }
def submission_method; end
end
class PaymentMethodDetails < Stripe::StripeObject
class AmazonPay < Stripe::StripeObject
# The AmazonPay dispute type, chargeback or claim
sig { returns(T.nilable(String)) }
def dispute_type; end
end
class Card < Stripe::StripeObject
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(String) }
def brand; end
# The type of dispute opened. Different case types may have varying fees and financial impact.
sig { returns(String) }
def case_type; end
# The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network.
sig { returns(T.nilable(String)) }
def network_reason_code; end
end
class Klarna < Stripe::StripeObject
# Chargeback loss reason mapped by Stripe from Klarna's chargeback loss reason
sig { returns(T.nilable(String)) }
def chargeback_loss_reason_code; end
# The reason for the dispute as defined by Klarna
sig { returns(T.nilable(String)) }
def reason_code; end
end
class Paypal < Stripe::StripeObject
# The ID of the dispute in PayPal.
sig { returns(T.nilable(String)) }
def case_id; end
# The reason for the dispute as defined by PayPal
sig { returns(T.nilable(String)) }
def reason_code; end
end
# Attribute for field amazon_pay
sig { returns(T.nilable(AmazonPay)) }
def amazon_pay; end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# Attribute for field klarna
sig { returns(T.nilable(Klarna)) }
def klarna; end
# Attribute for field paypal
sig { returns(T.nilable(Paypal)) }
def paypal; end
# Payment method type.
sig { returns(String) }
def type; end
end
class SmartDisputes < Stripe::StripeObject
# Evidence that could be provided to improve the SmartDisputes packet
sig { returns(T.nilable(T::Array[String])) }
def recommended_evidence; end
# Smart Disputes auto representment packet availability status.
sig { returns(String) }
def status; end
end
# Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed).
sig { returns(Integer) }
def amount; end
# List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.
sig { returns(T::Array[Stripe::BalanceTransaction]) }
def balance_transactions; end
# ID of the charge that's disputed.
sig { returns(T.any(String, Stripe::Charge)) }
def charge; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# List of eligibility types that are included in `enhanced_evidence`.
sig { returns(T::Array[String]) }
def enhanced_eligibility_types; end
# Attribute for field evidence
sig { returns(Evidence) }
def evidence; end
# Attribute for field evidence_details
sig { returns(EvidenceDetails) }
def evidence_details; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Intended submission method for the dispute.
sig { returns(T.nilable(String)) }
def intended_submission_method; end
# If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute.
sig { returns(T::Boolean) }
def is_charge_refundable; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# Network-dependent reason code for the dispute.
sig { returns(T.nilable(String)) }
def network_reason_code; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# ID of the PaymentIntent that's disputed.
sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
def payment_intent; end
# Attribute for field payment_method_details
sig { returns(T.nilable(PaymentMethodDetails)) }
def payment_method_details; end
# Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories).
sig { returns(String) }
def reason; end
# Attribute for field smart_disputes
sig { returns(T.nilable(SmartDisputes)) }
def smart_disputes; end
# The current status of a dispute. Possible values include:`warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, or `prevented`.
sig { returns(String) }
def status; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return disputes associated to the charge specified by this charge ID.
sig { returns(T.nilable(String)) }
def charge; end
sig { params(_charge: T.nilable(String)).returns(T.nilable(String)) }
def charge=(_charge); end
# Only return disputes that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Dispute::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Dispute::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Dispute::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(charge: T.nilable(String), created: T.nilable(T.any(::Stripe::Dispute::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_intent: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
charge: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
payment_intent: nil,
starting_after: nil
); end
end
class UpdateParams < Stripe::RequestParams
class Evidence < Stripe::RequestParams
class EnhancedEvidence < Stripe::RequestParams
class VisaCompellingEvidence3 < Stripe::RequestParams
class DisputedTransaction < Stripe::RequestParams
class ShippingAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# User Account ID used to log into business platform. Must be recognizable by the user.
sig { returns(T.nilable(String)) }
def customer_account_id; end
sig { params(_customer_account_id: T.nilable(String)).returns(T.nilable(String)) }
def customer_account_id=(_customer_account_id); end
# Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.
sig { returns(T.nilable(String)) }
def customer_device_fingerprint; end
sig {
params(_customer_device_fingerprint: T.nilable(String)).returns(T.nilable(String))
}
def customer_device_fingerprint=(_customer_device_fingerprint); end
# Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.
sig { returns(T.nilable(String)) }
def customer_device_id; end
sig { params(_customer_device_id: T.nilable(String)).returns(T.nilable(String)) }
def customer_device_id=(_customer_device_id); end
# The email address of the customer.
sig { returns(T.nilable(String)) }
def customer_email_address; end
sig { params(_customer_email_address: T.nilable(String)).returns(T.nilable(String)) }
def customer_email_address=(_customer_email_address); end
# The IP address that the customer used when making the purchase.
sig { returns(T.nilable(String)) }
def customer_purchase_ip; end
sig { params(_customer_purchase_ip: T.nilable(String)).returns(T.nilable(String)) }
def customer_purchase_ip=(_customer_purchase_ip); end
# Categorization of disputed payment.
sig { returns(T.nilable(String)) }
def merchandise_or_services; end
sig { params(_merchandise_or_services: T.nilable(String)).returns(T.nilable(String)) }
def merchandise_or_services=(_merchandise_or_services); end
# A description of the product or service that was sold.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.
sig {
returns(T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::DisputedTransaction::ShippingAddress))
}
def shipping_address; end
sig {
params(_shipping_address: T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::DisputedTransaction::ShippingAddress)).returns(T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::DisputedTransaction::ShippingAddress))
}
def shipping_address=(_shipping_address); end
sig {
params(customer_account_id: T.nilable(String), customer_device_fingerprint: T.nilable(String), customer_device_id: T.nilable(String), customer_email_address: T.nilable(String), customer_purchase_ip: T.nilable(String), merchandise_or_services: T.nilable(String), product_description: T.nilable(String), shipping_address: T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::DisputedTransaction::ShippingAddress)).void
}
def initialize(
customer_account_id: nil,
customer_device_fingerprint: nil,
customer_device_id: nil,
customer_email_address: nil,
customer_purchase_ip: nil,
merchandise_or_services: nil,
product_description: nil,
shipping_address: nil
); end
end
class PriorUndisputedTransaction < Stripe::RequestParams
class ShippingAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge.
sig { returns(String) }
def charge; end
sig { params(_charge: String).returns(String) }
def charge=(_charge); end
# User Account ID used to log into business platform. Must be recognizable by the user.
sig { returns(T.nilable(String)) }
def customer_account_id; end
sig { params(_customer_account_id: T.nilable(String)).returns(T.nilable(String)) }
def customer_account_id=(_customer_account_id); end
# Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.
sig { returns(T.nilable(String)) }
def customer_device_fingerprint; end
sig {
params(_customer_device_fingerprint: T.nilable(String)).returns(T.nilable(String))
}
def customer_device_fingerprint=(_customer_device_fingerprint); end
# Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.
sig { returns(T.nilable(String)) }
def customer_device_id; end
sig { params(_customer_device_id: T.nilable(String)).returns(T.nilable(String)) }
def customer_device_id=(_customer_device_id); end
# The email address of the customer.
sig { returns(T.nilable(String)) }
def customer_email_address; end
sig { params(_customer_email_address: T.nilable(String)).returns(T.nilable(String)) }
def customer_email_address=(_customer_email_address); end
# The IP address that the customer used when making the purchase.
sig { returns(T.nilable(String)) }
def customer_purchase_ip; end
sig { params(_customer_purchase_ip: T.nilable(String)).returns(T.nilable(String)) }
def customer_purchase_ip=(_customer_purchase_ip); end
# A description of the product or service that was sold.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.
sig {
returns(T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::PriorUndisputedTransaction::ShippingAddress))
}
def shipping_address; end
sig {
params(_shipping_address: T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::PriorUndisputedTransaction::ShippingAddress)).returns(T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::PriorUndisputedTransaction::ShippingAddress))
}
def shipping_address=(_shipping_address); end
sig {
params(charge: String, customer_account_id: T.nilable(String), customer_device_fingerprint: T.nilable(String), customer_device_id: T.nilable(String), customer_email_address: T.nilable(String), customer_purchase_ip: T.nilable(String), product_description: T.nilable(String), shipping_address: T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::PriorUndisputedTransaction::ShippingAddress)).void
}
def initialize(
charge: nil,
customer_account_id: nil,
customer_device_fingerprint: nil,
customer_device_id: nil,
customer_email_address: nil,
customer_purchase_ip: nil,
product_description: nil,
shipping_address: nil
); end
end
# Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission.
sig {
returns(T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::DisputedTransaction))
}
def disputed_transaction; end
sig {
params(_disputed_transaction: T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::DisputedTransaction)).returns(T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::DisputedTransaction))
}
def disputed_transaction=(_disputed_transaction); end
# List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission.
sig {
returns(T.nilable(T::Array[::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::PriorUndisputedTransaction]))
}
def prior_undisputed_transactions; end
sig {
params(_prior_undisputed_transactions: T.nilable(T::Array[::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::PriorUndisputedTransaction])).returns(T.nilable(T::Array[::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::PriorUndisputedTransaction]))
}
def prior_undisputed_transactions=(_prior_undisputed_transactions); end
sig {
params(disputed_transaction: T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::DisputedTransaction), prior_undisputed_transactions: T.nilable(T::Array[::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::PriorUndisputedTransaction])).void
}
def initialize(disputed_transaction: nil, prior_undisputed_transactions: nil); end
end
class VisaCompliance < Stripe::RequestParams
# A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Stripe refunds the 500 USD network fee if you win the dispute.
sig { returns(T.nilable(T::Boolean)) }
def fee_acknowledged; end
sig { params(_fee_acknowledged: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def fee_acknowledged=(_fee_acknowledged); end
sig { params(fee_acknowledged: T.nilable(T::Boolean)).void }
def initialize(fee_acknowledged: nil); end
end
# Evidence provided for Visa Compelling Evidence 3.0 evidence submission.
sig {
returns(T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3))
}
def visa_compelling_evidence_3; end
sig {
params(_visa_compelling_evidence_3: T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3)).returns(T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3))
}
def visa_compelling_evidence_3=(_visa_compelling_evidence_3); end
# Evidence provided for Visa compliance evidence submission.
sig {
returns(T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompliance))
}
def visa_compliance; end
sig {
params(_visa_compliance: T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompliance)).returns(T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompliance))
}
def visa_compliance=(_visa_compliance); end
sig {
params(visa_compelling_evidence_3: T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3), visa_compliance: T.nilable(::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence::VisaCompliance)).void
}
def initialize(visa_compelling_evidence_3: nil, visa_compliance: nil); end
end
# Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. Has a maximum character count of 20,000.
sig { returns(T.nilable(String)) }
def access_activity_log; end
sig { params(_access_activity_log: T.nilable(String)).returns(T.nilable(String)) }
def access_activity_log=(_access_activity_log); end
# The billing address provided by the customer.
sig { returns(T.nilable(String)) }
def billing_address; end
sig { params(_billing_address: T.nilable(String)).returns(T.nilable(String)) }
def billing_address=(_billing_address); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer.
sig { returns(T.nilable(String)) }
def cancellation_policy; end
sig { params(_cancellation_policy: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_policy=(_cancellation_policy); end
# An explanation of how and when the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000.
sig { returns(T.nilable(String)) }
def cancellation_policy_disclosure; end
sig {
params(_cancellation_policy_disclosure: T.nilable(String)).returns(T.nilable(String))
}
def cancellation_policy_disclosure=(_cancellation_policy_disclosure); end
# A justification for why the customer's subscription was not canceled. Has a maximum character count of 20,000.
sig { returns(T.nilable(String)) }
def cancellation_rebuttal; end
sig { params(_cancellation_rebuttal: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_rebuttal=(_cancellation_rebuttal); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.
sig { returns(T.nilable(String)) }
def customer_communication; end
sig { params(_customer_communication: T.nilable(String)).returns(T.nilable(String)) }
def customer_communication=(_customer_communication); end
# The email address of the customer.
sig { returns(T.nilable(String)) }
def customer_email_address; end
sig { params(_customer_email_address: T.nilable(String)).returns(T.nilable(String)) }
def customer_email_address=(_customer_email_address); end
# The name of the customer.
sig { returns(T.nilable(String)) }
def customer_name; end
sig { params(_customer_name: T.nilable(String)).returns(T.nilable(String)) }
def customer_name=(_customer_name); end
# The IP address that the customer used when making the purchase.
sig { returns(T.nilable(String)) }
def customer_purchase_ip; end
sig { params(_customer_purchase_ip: T.nilable(String)).returns(T.nilable(String)) }
def customer_purchase_ip=(_customer_purchase_ip); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature.
sig { returns(T.nilable(String)) }
def customer_signature; end
sig { params(_customer_signature: T.nilable(String)).returns(T.nilable(String)) }
def customer_signature=(_customer_signature); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.
sig { returns(T.nilable(String)) }
def duplicate_charge_documentation; end
sig {
params(_duplicate_charge_documentation: T.nilable(String)).returns(T.nilable(String))
}
def duplicate_charge_documentation=(_duplicate_charge_documentation); end
# An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. Has a maximum character count of 20,000.
sig { returns(T.nilable(String)) }
def duplicate_charge_explanation; end
sig { params(_duplicate_charge_explanation: T.nilable(String)).returns(T.nilable(String)) }
def duplicate_charge_explanation=(_duplicate_charge_explanation); end
# The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.
sig { returns(T.nilable(String)) }
def duplicate_charge_id; end
sig { params(_duplicate_charge_id: T.nilable(String)).returns(T.nilable(String)) }
def duplicate_charge_id=(_duplicate_charge_id); end
# Additional evidence for qualifying evidence programs.
sig {
returns(T.nilable(T.any(String, ::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence)))
}
def enhanced_evidence; end
sig {
params(_enhanced_evidence: T.nilable(T.any(String, ::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence))).returns(T.nilable(T.any(String, ::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence)))
}
def enhanced_evidence=(_enhanced_evidence); end
# A description of the product or service that was sold. Has a maximum character count of 20,000.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge.
sig { returns(T.nilable(String)) }
def receipt; end
sig { params(_receipt: T.nilable(String)).returns(T.nilable(String)) }
def receipt=(_receipt); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer.
sig { returns(T.nilable(String)) }
def refund_policy; end
sig { params(_refund_policy: T.nilable(String)).returns(T.nilable(String)) }
def refund_policy=(_refund_policy); end
# Documentation demonstrating that the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000.
sig { returns(T.nilable(String)) }
def refund_policy_disclosure; end
sig { params(_refund_policy_disclosure: T.nilable(String)).returns(T.nilable(String)) }
def refund_policy_disclosure=(_refund_policy_disclosure); end
# A justification for why the customer is not entitled to a refund. Has a maximum character count of 20,000.
sig { returns(T.nilable(String)) }
def refund_refusal_explanation; end
sig { params(_refund_refusal_explanation: T.nilable(String)).returns(T.nilable(String)) }
def refund_refusal_explanation=(_refund_refusal_explanation); end
# The date on which the customer received or began receiving the purchased service, in a clear human-readable format.
sig { returns(T.nilable(String)) }
def service_date; end
sig { params(_service_date: T.nilable(String)).returns(T.nilable(String)) }
def service_date=(_service_date); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.
sig { returns(T.nilable(String)) }
def service_documentation; end
sig { params(_service_documentation: T.nilable(String)).returns(T.nilable(String)) }
def service_documentation=(_service_documentation); end
# The address to which a physical product was shipped. You should try to include as complete address information as possible.
sig { returns(T.nilable(String)) }
def shipping_address; end
sig { params(_shipping_address: T.nilable(String)).returns(T.nilable(String)) }
def shipping_address=(_shipping_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def shipping_carrier; end
sig { params(_shipping_carrier: T.nilable(String)).returns(T.nilable(String)) }
def shipping_carrier=(_shipping_carrier); end
# The date on which a physical product began its route to the shipping address, in a clear human-readable format.
sig { returns(T.nilable(String)) }
def shipping_date; end
sig { params(_shipping_date: T.nilable(String)).returns(T.nilable(String)) }
def shipping_date=(_shipping_date); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible.
sig { returns(T.nilable(String)) }
def shipping_documentation; end
sig { params(_shipping_documentation: T.nilable(String)).returns(T.nilable(String)) }
def shipping_documentation=(_shipping_documentation); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def shipping_tracking_number; end
sig { params(_shipping_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def shipping_tracking_number=(_shipping_tracking_number); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements.
sig { returns(T.nilable(String)) }
def uncategorized_file; end
sig { params(_uncategorized_file: T.nilable(String)).returns(T.nilable(String)) }
def uncategorized_file=(_uncategorized_file); end
# Any additional evidence or statements. Has a maximum character count of 20,000.
sig { returns(T.nilable(String)) }
def uncategorized_text; end
sig { params(_uncategorized_text: T.nilable(String)).returns(T.nilable(String)) }
def uncategorized_text=(_uncategorized_text); end
sig {
params(access_activity_log: T.nilable(String), billing_address: T.nilable(String), cancellation_policy: T.nilable(String), cancellation_policy_disclosure: T.nilable(String), cancellation_rebuttal: T.nilable(String), customer_communication: T.nilable(String), customer_email_address: T.nilable(String), customer_name: T.nilable(String), customer_purchase_ip: T.nilable(String), customer_signature: T.nilable(String), duplicate_charge_documentation: T.nilable(String), duplicate_charge_explanation: T.nilable(String), duplicate_charge_id: T.nilable(String), enhanced_evidence: T.nilable(T.any(String, ::Stripe::Dispute::UpdateParams::Evidence::EnhancedEvidence)), product_description: T.nilable(String), receipt: T.nilable(String), refund_policy: T.nilable(String), refund_policy_disclosure: T.nilable(String), refund_refusal_explanation: T.nilable(String), service_date: T.nilable(String), service_documentation: T.nilable(String), shipping_address: T.nilable(String), shipping_carrier: T.nilable(String), shipping_date: T.nilable(String), shipping_documentation: T.nilable(String), shipping_tracking_number: T.nilable(String), uncategorized_file: T.nilable(String), uncategorized_text: T.nilable(String)).void
}
def initialize(
access_activity_log: nil,
billing_address: nil,
cancellation_policy: nil,
cancellation_policy_disclosure: nil,
cancellation_rebuttal: nil,
customer_communication: nil,
customer_email_address: nil,
customer_name: nil,
customer_purchase_ip: nil,
customer_signature: nil,
duplicate_charge_documentation: nil,
duplicate_charge_explanation: nil,
duplicate_charge_id: nil,
enhanced_evidence: nil,
product_description: nil,
receipt: nil,
refund_policy: nil,
refund_policy_disclosure: nil,
refund_refusal_explanation: nil,
service_date: nil,
service_documentation: nil,
shipping_address: nil,
shipping_carrier: nil,
shipping_date: nil,
shipping_documentation: nil,
shipping_tracking_number: nil,
uncategorized_file: nil,
uncategorized_text: nil
); end
end
# Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.
sig { returns(T.nilable(::Stripe::Dispute::UpdateParams::Evidence)) }
def evidence; end
sig {
params(_evidence: T.nilable(::Stripe::Dispute::UpdateParams::Evidence)).returns(T.nilable(::Stripe::Dispute::UpdateParams::Evidence))
}
def evidence=(_evidence); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Intended submission method for the dispute.
sig { returns(T.nilable(String)) }
def intended_submission_method; end
sig { params(_intended_submission_method: T.nilable(String)).returns(T.nilable(String)) }
def intended_submission_method=(_intended_submission_method); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default).
sig { returns(T.nilable(T::Boolean)) }
def submit; end
sig { params(_submit: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def submit=(_submit); end
sig {
params(evidence: T.nilable(::Stripe::Dispute::UpdateParams::Evidence), expand: T.nilable(T::Array[String]), intended_submission_method: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), submit: T.nilable(T::Boolean)).void
}
def initialize(
evidence: nil,
expand: nil,
intended_submission_method: nil,
metadata: nil,
submit: nil
); end
end
class CloseParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.
#
# The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.
sig {
params(params: T.any(::Stripe::Dispute::CloseParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Dispute)
}
def close(params = {}, opts = {}); end
# Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.
#
# The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.
sig {
params(dispute: String, params: T.any(::Stripe::Dispute::CloseParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Dispute)
}
def self.close(dispute, params = {}, opts = {}); end
# Returns a list of your disputes.
sig {
params(params: T.any(::Stripe::Dispute::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your [dashboard](https://dashboard.stripe.com/disputes), but if you prefer, you can use the API to submit evidence programmatically.
#
# Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://docs.stripe.com/docs/disputes/categories).
sig {
params(dispute: String, params: T.any(::Stripe::Dispute::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Dispute)
}
def self.update(dispute, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
module Entitlements
# An active entitlement describes access to a feature for a customer.
class ActiveEntitlement < APIResource
# The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to.
sig { returns(T.any(String, Stripe::Entitlements::Feature)) }
def feature; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# A unique key you provide as your own system identifier. This may be up to 80 characters.
sig { returns(String) }
def lookup_key; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
class ListParams < Stripe::RequestParams
# The ID of the customer.
sig { returns(String) }
def customer; end
sig { params(_customer: String).returns(String) }
def customer=(_customer); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(customer: String, ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
customer: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
# Retrieve a list of active entitlements for a customer
sig {
params(params: T.any(::Stripe::Entitlements::ActiveEntitlement::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Entitlements
# A feature represents a monetizable ability or functionality in your system.
# Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
class Feature < APIResource
# Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
sig { returns(T::Boolean) }
def active; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# A unique key you provide as your own system identifier. This may be up to 80 characters.
sig { returns(String) }
def lookup_key; end
# Set of key-value pairs 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::Hash[String, String]) }
def metadata; end
# The feature's name, for your own purpose, not meant to be displayable to the customer.
sig { returns(String) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
class ListParams < Stripe::RequestParams
# If set, filter results to only include features with the given archive status.
sig { returns(T.nilable(T::Boolean)) }
def archived; end
sig { params(_archived: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def archived=(_archived); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# If set, filter results to only include features with the given lookup_key.
sig { returns(T.nilable(String)) }
def lookup_key; end
sig { params(_lookup_key: T.nilable(String)).returns(T.nilable(String)) }
def lookup_key=(_lookup_key); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(archived: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), lookup_key: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
archived: nil,
ending_before: nil,
expand: nil,
limit: nil,
lookup_key: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A unique key you provide as your own system identifier. This may be up to 80 characters.
sig { returns(String) }
def lookup_key; end
sig { params(_lookup_key: String).returns(String) }
def lookup_key=(_lookup_key); end
# Set of key-value pairs 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The feature's name, for your own purpose, not meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(expand: T.nilable(T::Array[String]), lookup_key: String, metadata: T.nilable(T::Hash[String, String]), name: String).void
}
def initialize(expand: nil, lookup_key: nil, metadata: nil, name: nil); end
end
class UpdateParams < Stripe::RequestParams
# Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Set of key-value pairs 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.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The feature's name, for your own purpose, not meant to be displayable to the customer.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(active: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String)).void
}
def initialize(active: nil, expand: nil, metadata: nil, name: nil); end
end
# Creates a feature
sig {
params(params: T.any(::Stripe::Entitlements::Feature::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Entitlements::Feature)
}
def self.create(params = {}, opts = {}); end
# Retrieve a list of features
sig {
params(params: T.any(::Stripe::Entitlements::Feature::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Update a feature's metadata or permanently deactivate it.
sig {
params(id: String, params: T.any(::Stripe::Entitlements::Feature::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Entitlements::Feature)
}
def self.update(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class EphemeralKey < APIResource
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Time at which the key will expire. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def expires; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The key's secret. You can use this value to make authorized requests to the Stripe API.
sig { returns(T.nilable(String)) }
def secret; end
class DeleteParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Invalidates a short-lived API key for a given resource.
sig {
params(key: String, params: T.any(::Stripe::EphemeralKey::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::EphemeralKey)
}
def self.delete(key, params = {}, opts = {}); end
# Invalidates a short-lived API key for a given resource.
sig {
params(params: T.any(::Stripe::EphemeralKey::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::EphemeralKey)
}
def delete(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# Snapshot events allow you to track and react to activity in your Stripe integration. When
# the state of another API resource changes, Stripe creates an `Event` object that contains
# all the relevant information associated with that action, including the affected API
# resource. For example, a successful payment triggers a `charge.succeeded` event, which
# contains the `Charge` in the event's data property. Some actions trigger multiple events.
# For example, if you create a new subscription for a customer, it triggers both a
# `customer.subscription.created` event and a `charge.succeeded` event.
#
# Configure an event destination in your account to listen for events that represent actions
# your integration needs to respond to. Additionally, you can retrieve an individual event or
# a list of events from the API.
#
# [Connect](https://docs.stripe.com/connect) platforms can also receive event notifications
# that occur in their connected accounts. These events include an account attribute that
# identifies the relevant connected account.
#
# You can access events through the [Retrieve Event API](https://docs.stripe.com/api/events#retrieve_event)
# for 30 days.
class Event < APIResource
class Data < Stripe::StripeObject
# Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key.
sig { returns(T::Hash[String, T.untyped]) }
def object; end
# Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements.
sig { returns(T.nilable(T::Hash[String, T.untyped])) }
def previous_attributes; end
end
class Reason < Stripe::StripeObject
class AutomationAction < Stripe::StripeObject
class StripeSendWebhookCustomEvent < Stripe::StripeObject
# Set of key-value pairs attached to the action when creating an Automation.
sig { returns(T.nilable(T::Hash[String, String])) }
def custom_data; end
end
# Attribute for field stripe_send_webhook_custom_event
sig { returns(T.nilable(StripeSendWebhookCustomEvent)) }
def stripe_send_webhook_custom_event; end
# The trigger name of the automation that triggered this action.
# Please visit [Revenue and retention automations](https://docs.stripe.com/billing/automations#choose-a-trigger) for all possible trigger names.
sig { returns(String) }
def trigger; end
# The type of the `automation_action`.
sig { returns(String) }
def type; end
end
class Request < Stripe::StripeObject
# ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.
sig { returns(T.nilable(String)) }
def id; end
# The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*.
sig { returns(T.nilable(String)) }
def idempotency_key; end
end
# Attribute for field automation_action
sig { returns(T.nilable(AutomationAction)) }
def automation_action; end
# Attribute for field request
sig { returns(T.nilable(Request)) }
def request; end
# The type of the reason for the event.
sig { returns(String) }
def type; end
end
class Request < Stripe::StripeObject
# ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.
sig { returns(T.nilable(String)) }
def id; end
# The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*.
sig { returns(T.nilable(String)) }
def idempotency_key; end
end
# The connected account that originates the event.
sig { returns(T.nilable(String)) }
def account; end
# The Stripe API version used to render `data` when the event was created. The contents of `data` never change, so this value remains static regardless of the API version currently in use. This property is populated only for events created on or after October 31, 2014.
sig { returns(T.nilable(String)) }
def api_version; end
# Authentication context needed to fetch the event or related object.
sig { returns(T.nilable(String)) }
def context; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Attribute for field data
sig { returns(Data) }
def data; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.
sig { returns(Integer) }
def pending_webhooks; end
# Information about the action that causes the event. Only present when the event is triggered by an API request or an [Automation](https://docs.stripe.com/billing/automations) action.
sig { returns(T.nilable(Reason)) }
def reason; end
# Information on the API request that triggers the event.
sig { returns(T.nilable(Request)) }
def request; end
# Description of the event (for example, `invoice.created` or `charge.refunded`).
sig { returns(String) }
def type; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return events that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Event::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Event::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Event::ListParams::Created, Integer)))
}
def created=(_created); end
# Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.
sig { returns(T.nilable(T::Boolean)) }
def delivery_success; end
sig { params(_delivery_success: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def delivery_success=(_delivery_success); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both.
sig { returns(T.nilable(T::Array[String])) }
def types; end
sig { params(_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def types=(_types); end
sig {
params(created: T.nilable(T.any(::Stripe::Event::ListParams::Created, Integer)), delivery_success: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), type: T.nilable(String), types: T.nilable(T::Array[String])).void
}
def initialize(
created: nil,
delivery_success: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
type: nil,
types: nil
); end
end
# List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header).
sig {
params(params: T.any(::Stripe::Event::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# `ExchangeRate` objects allow you to determine the rates that Stripe is currently
# using to convert from one currency to another. Since this number is variable
# throughout the day, there are various reasons why you might want to know the current
# rate (for example, to dynamically price an item for a user with a default
# payment in a foreign currency).
#
# Please refer to our [Exchange Rates API](https://stripe.com/docs/fx-rates) guide for more details.
#
# *[Note: this integration path is supported but no longer recommended]* Additionally,
# you can guarantee that a charge is made with an exchange rate that you expect is
# current. To do so, you must pass in the exchange_rate to charges endpoints. If the
# value is no longer up to date, the charge won't go through. Please refer to our
# [Using with charges](https://stripe.com/docs/exchange-rates) guide for more details.
#
# -----
#
#
#
# *This Exchange Rates API is a Beta Service and is subject to Stripe's terms of service. You may use the API solely for the purpose of transacting on Stripe. For example, the API may be queried in order to:*
#
# - *localize prices for processing payments on Stripe*
# - *reconcile Stripe transactions*
# - *determine how much money to send to a connected account*
# - *determine app fees to charge a connected account*
#
# *Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe's terms of service.*
class ExchangeRate < APIResource
# Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.
sig { returns(T::Hash[String, Float]) }
def rates; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.
sig {
params(params: T.any(::Stripe::ExchangeRate::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# To share the contents of a `File` object with non-Stripe users, you can
# create a `FileLink`. `FileLink`s contain a URL that you can use to
# retrieve the contents of the file without authentication.
class FileLink < APIResource
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Returns if the link is already expired.
sig { returns(T::Boolean) }
def expired; end
# Time that the link expires.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# The file object this link points to.
sig { returns(T.any(String, Stripe::File)) }
def file; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The publicly accessible URL to download the file.
sig { returns(T.nilable(String)) }
def url; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return links that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::FileLink::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::FileLink::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::FileLink::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Filter links by their expiration status. By default, Stripe returns all links.
sig { returns(T.nilable(T::Boolean)) }
def expired; end
sig { params(_expired: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def expired=(_expired); end
# Only return links for the given file.
sig { returns(T.nilable(String)) }
def file; end
sig { params(_file: T.nilable(String)).returns(T.nilable(String)) }
def file=(_file); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::FileLink::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), expired: T.nilable(T::Boolean), file: T.nilable(String), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
expired: nil,
file: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The link isn't usable after this future timestamp.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `financial_account_statement`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, `terminal_android_apk`, or `terminal_reader_splashscreen`.
sig { returns(String) }
def file; end
sig { params(_file: String).returns(String) }
def file=(_file); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), file: String, metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, expires_at: nil, file: nil, metadata: nil); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately.
sig { returns(T.nilable(T.any(String, T.any(String, Integer)))) }
def expires_at; end
sig {
params(_expires_at: T.nilable(T.any(String, T.any(String, Integer)))).returns(T.nilable(T.any(String, T.any(String, Integer))))
}
def expires_at=(_expires_at); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), expires_at: T.nilable(T.any(String, T.any(String, Integer))), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, expires_at: nil, metadata: nil); end
end
# Creates a new file link object.
sig {
params(params: T.any(::Stripe::FileLink::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FileLink)
}
def self.create(params = {}, opts = {}); end
# Returns a list of file links.
sig {
params(params: T.any(::Stripe::FileLink::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates an existing file link object. Expired links can no longer be updated.
sig {
params(link: String, params: T.any(::Stripe::FileLink::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FileLink)
}
def self.update(link, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# This object represents files hosted on Stripe's servers. You can upload
# files with the [create file](https://stripe.com/docs/api#create_file) request
# (for example, when uploading dispute evidence). Stripe also
# creates files independently (for example, the results of a [Sigma scheduled
# query](https://docs.stripe.com/api#scheduled_queries)).
#
# Related guide: [File upload guide](https://stripe.com/docs/file-upload)
class File < APIResource
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The file expires and isn't available at this time in epoch seconds.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# The suitable name for saving the file to a filesystem.
sig { returns(T.nilable(String)) }
def filename; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# A list of [file links](https://stripe.com/docs/api#file_links) that point at this file.
sig { returns(T.nilable(Stripe::ListObject)) }
def links; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
sig { returns(String) }
def purpose; end
# The size of the file object in bytes.
sig { returns(Integer) }
def size; end
# A suitable title for the document.
sig { returns(T.nilable(String)) }
def title; end
# The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).
sig { returns(T.nilable(String)) }
def type; end
# Use your live secret API key to download the file from this URL.
sig { returns(T.nilable(String)) }
def url; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return files that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::File::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::File::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::File::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.
sig { returns(T.nilable(String)) }
def purpose; end
sig { params(_purpose: T.nilable(String)).returns(T.nilable(String)) }
def purpose=(_purpose); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::File::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), purpose: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
purpose: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class FileLinkData < Stripe::RequestParams
# Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `issuing_regulatory_reporting`, `pci_document`, `tax_document_user_upload`, `terminal_android_apk`, or `terminal_reader_splashscreen`.
sig { returns(T::Boolean) }
def create; end
sig { params(_create: T::Boolean).returns(T::Boolean) }
def create=(_create); end
# The link isn't available after this future timestamp.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(create: T::Boolean, expires_at: T.nilable(Integer), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(create: nil, expires_at: nil, metadata: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol.
sig { returns(T.untyped) }
def file; end
sig { params(_file: T.untyped).returns(T.untyped) }
def file=(_file); end
# Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.
sig { returns(T.nilable(::Stripe::File::CreateParams::FileLinkData)) }
def file_link_data; end
sig {
params(_file_link_data: T.nilable(::Stripe::File::CreateParams::FileLinkData)).returns(T.nilable(::Stripe::File::CreateParams::FileLinkData))
}
def file_link_data=(_file_link_data); end
# The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
sig { returns(String) }
def purpose; end
sig { params(_purpose: String).returns(String) }
def purpose=(_purpose); end
sig {
params(expand: T.nilable(T::Array[String]), file: T.untyped, file_link_data: T.nilable(::Stripe::File::CreateParams::FileLinkData), purpose: String).void
}
def initialize(expand: nil, file: nil, file_link_data: nil, purpose: nil); end
end
# To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.
#
# All of Stripe's officially supported Client libraries support sending multipart/form-data.
sig {
params(params: T.any(::Stripe::File::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::File)
}
def self.create(params = {}, opts = {}); end
# Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
sig {
params(params: T.any(::Stripe::File::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
module FinancialConnections
# A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.
class Account < APIResource
class AccountHolder < Stripe::StripeObject
# The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# Attribute for field customer_account
sig { returns(T.nilable(String)) }
def customer_account; end
# Type of account holder that this account belongs to.
sig { returns(String) }
def type; end
end
class Balance < Stripe::StripeObject
class Cash < Stripe::StripeObject
# The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and adding any inbound pending transactions.
#
# Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
#
# Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
sig { returns(T.nilable(T::Hash[String, Integer])) }
def available; end
end
class Credit < Stripe::StripeObject
# The credit that has been used by the account holder.
#
# Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
#
# Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
sig { returns(T.nilable(T::Hash[String, Integer])) }
def used; end
end
# The time that the external institution calculated this balance. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def as_of; end
# Attribute for field cash
sig { returns(T.nilable(Cash)) }
def cash; end
# Attribute for field credit
sig { returns(T.nilable(Credit)) }
def credit; end
# The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.
#
# Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
#
# Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
sig { returns(T::Hash[String, Integer]) }
def current; end
# The `type` of the balance. An additional hash is included on the balance with a name matching this value.
sig { returns(String) }
def type; end
end
class BalanceRefresh < Stripe::StripeObject
# The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def last_attempted_at; end
# Time at which the next balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def next_refresh_available_at; end
# The status of the last refresh attempt.
sig { returns(String) }
def status; end
end
class InferredBalancesRefresh < Stripe::StripeObject
# The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def last_attempted_at; end
# Time at which the next inferred balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def next_refresh_available_at; end
# The status of the last refresh attempt.
sig { returns(String) }
def status; end
end
class OwnershipRefresh < Stripe::StripeObject
# The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def last_attempted_at; end
# Time at which the next ownership refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def next_refresh_available_at; end
# The status of the last refresh attempt.
sig { returns(String) }
def status; end
end
class TransactionRefresh < Stripe::StripeObject
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def last_attempted_at; end
# Time at which the next transaction refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def next_refresh_available_at; end
# The status of the last refresh attempt.
sig { returns(String) }
def status; end
end
# The account holder that this account belongs to.
sig { returns(T.nilable(AccountHolder)) }
def account_holder; end
# The most recent information about the account's balance.
sig { returns(T.nilable(Balance)) }
def balance; end
# The state of the most recent attempt to refresh the account balance.
sig { returns(T.nilable(BalanceRefresh)) }
def balance_refresh; end
# The type of the account. Account category is further divided in `subcategory`.
sig { returns(String) }
def category; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# A human-readable name that has been assigned to this account, either by the account holder or by the institution.
sig { returns(T.nilable(String)) }
def display_name; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The state of the most recent attempt to refresh the account's inferred balance history.
sig { returns(T.nilable(InferredBalancesRefresh)) }
def inferred_balances_refresh; end
# The ID of the Financial Connections Institution this account belongs to. Note that this relationship may sometimes change in rare circumstances (e.g. institution mergers).
sig { returns(T.nilable(T.any(String, Stripe::FinancialConnections::Institution))) }
def institution; end
# The name of the institution that holds this account.
sig { returns(String) }
def institution_name; end
# The last 4 digits of the account number. If present, this will be 4 numeric characters.
sig { returns(T.nilable(String)) }
def last4; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The most recent information about the account's owners.
sig { returns(T.nilable(T.any(String, Stripe::FinancialConnections::AccountOwnership))) }
def ownership; end
# The state of the most recent attempt to refresh the account owners.
sig { returns(T.nilable(OwnershipRefresh)) }
def ownership_refresh; end
# The list of permissions granted by this account.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
# The status of the link to the account.
sig { returns(String) }
def status; end
# If `category` is `cash`, one of:
#
# - `checking`
# - `savings`
# - `other`
#
# If `category` is `credit`, one of:
#
# - `mortgage`
# - `line_of_credit`
# - `credit_card`
# - `other`
#
# If `category` is `investment` or `other`, this will be `other`.
sig { returns(String) }
def subcategory; end
# The list of data refresh subscriptions requested on this account.
sig { returns(T.nilable(T::Array[String])) }
def subscriptions; end
# The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
sig { returns(T::Array[String]) }
def supported_payment_method_types; end
# The state of the most recent attempt to refresh the account transactions.
sig { returns(T.nilable(TransactionRefresh)) }
def transaction_refresh; end
class ListParams < Stripe::RequestParams
class AccountHolder < Stripe::RequestParams
# The ID of the Stripe account whose accounts will be retrieved.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The ID of the Stripe customer whose accounts will be retrieved.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The Account ID of the Stripe customer whose accounts will be retrieved.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
sig {
params(account: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String)).void
}
def initialize(account: nil, customer: nil, customer_account: nil); end
end
# If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.
sig {
returns(T.nilable(::Stripe::FinancialConnections::Account::ListParams::AccountHolder))
}
def account_holder; end
sig {
params(_account_holder: T.nilable(::Stripe::FinancialConnections::Account::ListParams::AccountHolder)).returns(T.nilable(::Stripe::FinancialConnections::Account::ListParams::AccountHolder))
}
def account_holder=(_account_holder); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# If present, only return accounts that were collected as part of the given session.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(account_holder: T.nilable(::Stripe::FinancialConnections::Account::ListParams::AccountHolder), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), session: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
account_holder: nil,
ending_before: nil,
expand: nil,
limit: nil,
session: nil,
starting_after: nil
); end
end
class ListOwnersParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The ID of the ownership object to fetch owners from.
sig { returns(String) }
def ownership; end
sig { params(_ownership: String).returns(String) }
def ownership=(_ownership); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), ownership: String, starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
ownership: nil,
starting_after: nil
); end
end
class DisconnectParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class RefreshAccountParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The list of account features that you would like to refresh.
sig { returns(T::Array[String]) }
def features; end
sig { params(_features: T::Array[String]).returns(T::Array[String]) }
def features=(_features); end
sig { params(expand: T.nilable(T::Array[String]), features: T::Array[String]).void }
def initialize(expand: nil, features: nil); end
end
class SubscribeParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The list of account features to which you would like to subscribe.
sig { returns(T::Array[String]) }
def features; end
sig { params(_features: T::Array[String]).returns(T::Array[String]) }
def features=(_features); end
sig { params(expand: T.nilable(T::Array[String]), features: T::Array[String]).void }
def initialize(expand: nil, features: nil); end
end
class UnsubscribeParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The list of account features from which you would like to unsubscribe.
sig { returns(T::Array[String]) }
def features; end
sig { params(_features: T::Array[String]).returns(T::Array[String]) }
def features=(_features); end
sig { params(expand: T.nilable(T::Array[String]), features: T::Array[String]).void }
def initialize(expand: nil, features: nil); end
end
# Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
sig {
params(params: T.any(::Stripe::FinancialConnections::Account::DisconnectParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Account)
}
def disconnect(params = {}, opts = {}); end
# Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
sig {
params(account: String, params: T.any(::Stripe::FinancialConnections::Account::DisconnectParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Account)
}
def self.disconnect(account, params = {}, opts = {}); end
# Returns a list of Financial Connections Account objects.
sig {
params(params: T.any(::Stripe::FinancialConnections::Account::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Lists all owners for a given Account
sig {
params(params: T.any(::Stripe::FinancialConnections::Account::ListOwnersParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list_owners(params = {}, opts = {}); end
# Lists all owners for a given Account
sig {
params(account: String, params: T.any(::Stripe::FinancialConnections::Account::ListOwnersParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list_owners(account, params = {}, opts = {}); end
# Refreshes the data associated with a Financial Connections Account.
sig {
params(params: T.any(::Stripe::FinancialConnections::Account::RefreshAccountParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Account)
}
def refresh_account(params = {}, opts = {}); end
# Refreshes the data associated with a Financial Connections Account.
sig {
params(account: String, params: T.any(::Stripe::FinancialConnections::Account::RefreshAccountParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Account)
}
def self.refresh_account(account, params = {}, opts = {}); end
# Subscribes to periodic refreshes of data associated with a Financial Connections Account.
sig {
params(params: T.any(::Stripe::FinancialConnections::Account::SubscribeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Account)
}
def subscribe(params = {}, opts = {}); end
# Subscribes to periodic refreshes of data associated with a Financial Connections Account.
sig {
params(account: String, params: T.any(::Stripe::FinancialConnections::Account::SubscribeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Account)
}
def self.subscribe(account, params = {}, opts = {}); end
# Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
sig {
params(params: T.any(::Stripe::FinancialConnections::Account::UnsubscribeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Account)
}
def unsubscribe(params = {}, opts = {}); end
# Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
sig {
params(account: String, params: T.any(::Stripe::FinancialConnections::Account::UnsubscribeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Account)
}
def self.unsubscribe(account, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module FinancialConnections
# A historical balance for the account on a particular day. It may be sourced from a balance snapshot provided by a financial institution, or inferred using transactions data.
class AccountInferredBalance < APIResource
# The time for which this balance was calculated, measured in seconds since the Unix epoch. If the balance was computed by Stripe and not provided directly by a financial institution, it will always be 23:59:59 UTC.
sig { returns(Integer) }
def as_of; end
# The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.
#
# Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
#
# Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
sig { returns(T::Hash[String, Integer]) }
def current; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
end
end
end
# typed: true
module Stripe
module FinancialConnections
# An institution represents a financial institution to which an end user can connect using the Financial Connections authentication flow.
class Institution < APIResource
class Features < Stripe::StripeObject
class Balances < Stripe::StripeObject
# Whether the given feature is supported by this institution.
sig { returns(T::Boolean) }
def supported; end
end
class Ownership < Stripe::StripeObject
# Whether the given feature is supported by this institution.
sig { returns(T::Boolean) }
def supported; end
end
class PaymentMethod < Stripe::StripeObject
# Whether the given feature is supported by this institution.
sig { returns(T::Boolean) }
def supported; end
end
class Transactions < Stripe::StripeObject
# Whether the given feature is supported by this institution.
sig { returns(T::Boolean) }
def supported; end
end
# Attribute for field balances
sig { returns(Balances) }
def balances; end
# Attribute for field ownership
sig { returns(Ownership) }
def ownership; end
# Attribute for field payment_method
sig { returns(PaymentMethod) }
def payment_method; end
# Attribute for field transactions
sig { returns(Transactions) }
def transactions; end
end
# The list of countries supported by this institution, formatted as ISO country codes.
sig { returns(T::Array[String]) }
def countries; end
# Attribute for field features
sig { returns(Features) }
def features; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# The name of this institution.
sig { returns(String) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# A list of routing numbers which are known to correspond to this institution. Due to the many to many relationship between institutions and routing numbers, this list may not be comprehensive and routing numbers may also be shared between institutions.
sig { returns(T::Array[String]) }
def routing_numbers; end
# The status of this institution in the Financial Connections authentication flow.
sig { returns(String) }
def status; end
# A URL corresponding to this institution. This URL is also displayed in the authentication flow to help end users confirm that they are authenticating with the right institution.
sig { returns(T.nilable(String)) }
def url; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Returns a list of Financial Connections Institution objects.
sig {
params(params: T.any(::Stripe::FinancialConnections::Institution::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module FinancialConnections
# A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.
class Session < APIResource
class AccountHolder < Stripe::StripeObject
# The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# Attribute for field customer_account
sig { returns(T.nilable(String)) }
def customer_account; end
# Type of account holder that this account belongs to.
sig { returns(String) }
def type; end
end
class Filters < Stripe::StripeObject
# Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
# List of countries from which to filter accounts.
sig { returns(T.nilable(T::Array[String])) }
def countries; end
# Stripe ID of the institution with which the customer should be directed to log in.
sig { returns(T.nilable(String)) }
def institution; end
end
class Limits < Stripe::StripeObject
# The number of accounts that can be linked in this Session.
sig { returns(Integer) }
def accounts; end
end
class ManualEntry < Stripe::StripeObject; end
class StatusDetails < Stripe::StripeObject
class Cancelled < Stripe::StripeObject
# The reason for the Session being cancelled.
sig { returns(String) }
def reason; end
end
# Attribute for field cancelled
sig { returns(T.nilable(Cancelled)) }
def cancelled; end
end
# The account holder for whom accounts are collected in this session.
sig { returns(T.nilable(AccountHolder)) }
def account_holder; end
# The accounts that were collected as part of this Session.
sig { returns(Stripe::ListObject) }
def accounts; end
# A value that will be passed to the client to launch the authentication flow.
sig { returns(String) }
def client_secret; end
# Attribute for field filters
sig { returns(T.nilable(Filters)) }
def filters; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Attribute for field limits
sig { returns(T.nilable(Limits)) }
def limits; end
# 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) }
def livemode; end
# Attribute for field manual_entry
sig { returns(T.nilable(ManualEntry)) }
def manual_entry; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Permissions requested for accounts collected during this session.
sig { returns(T::Array[String]) }
def permissions; end
# Data features requested to be retrieved upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
# The current state of the session.
sig { returns(T.nilable(String)) }
def status; end
# Attribute for field status_details
sig { returns(T.nilable(StatusDetails)) }
def status_details; end
class CreateParams < Stripe::RequestParams
class AccountHolder < Stripe::RequestParams
# The ID of the Stripe account whose accounts will be retrieved. Should only be present if `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The ID of the Stripe customer whose accounts will be retrieved. Should only be present if `type` is `customer`.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The ID of the Stripe customer Account whose accounts will be retrieved. Should only be present if `type` is `customer`.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Type of account holder to collect accounts for.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(account: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), type: String).void
}
def initialize(account: nil, customer: nil, customer_account: nil, type: nil); end
end
class Filters < Stripe::RequestParams
# Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# List of countries from which to collect accounts.
sig { returns(T.nilable(T::Array[String])) }
def countries; end
sig {
params(_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def countries=(_countries); end
# Stripe ID of the institution with which the customer should be directed to log in.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), countries: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, countries: nil, institution: nil); end
end
class Limits < Stripe::RequestParams
# The number of accounts that can be linked in this Session.
sig { returns(Integer) }
def accounts; end
sig { params(_accounts: Integer).returns(Integer) }
def accounts=(_accounts); end
sig { params(accounts: Integer).void }
def initialize(accounts: nil); end
end
class ManualEntry < Stripe::RequestParams
# Whether manual entry will be handled by Stripe during the Session.
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
sig { params(mode: T.nilable(String)).void }
def initialize(mode: nil); end
end
# The account holder to link accounts for.
sig { returns(::Stripe::FinancialConnections::Session::CreateParams::AccountHolder) }
def account_holder; end
sig {
params(_account_holder: ::Stripe::FinancialConnections::Session::CreateParams::AccountHolder).returns(::Stripe::FinancialConnections::Session::CreateParams::AccountHolder)
}
def account_holder=(_account_holder); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Filters to restrict the kinds of accounts to collect.
sig { returns(T.nilable(::Stripe::FinancialConnections::Session::CreateParams::Filters)) }
def filters; end
sig {
params(_filters: T.nilable(::Stripe::FinancialConnections::Session::CreateParams::Filters)).returns(T.nilable(::Stripe::FinancialConnections::Session::CreateParams::Filters))
}
def filters=(_filters); end
# Settings for configuring Session-specific limits.
sig { returns(T.nilable(::Stripe::FinancialConnections::Session::CreateParams::Limits)) }
def limits; end
sig {
params(_limits: T.nilable(::Stripe::FinancialConnections::Session::CreateParams::Limits)).returns(T.nilable(::Stripe::FinancialConnections::Session::CreateParams::Limits))
}
def limits=(_limits); end
# Customize manual entry behavior
sig {
returns(T.nilable(::Stripe::FinancialConnections::Session::CreateParams::ManualEntry))
}
def manual_entry; end
sig {
params(_manual_entry: T.nilable(::Stripe::FinancialConnections::Session::CreateParams::ManualEntry)).returns(T.nilable(::Stripe::FinancialConnections::Session::CreateParams::ManualEntry))
}
def manual_entry=(_manual_entry); end
# List of data features that you would like to request access to.
#
# Possible values are `balances`, `transactions`, `ownership`, and `payment_method`.
sig { returns(T::Array[String]) }
def permissions; end
sig { params(_permissions: T::Array[String]).returns(T::Array[String]) }
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig { params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def prefetch=(_prefetch); end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(account_holder: ::Stripe::FinancialConnections::Session::CreateParams::AccountHolder, expand: T.nilable(T::Array[String]), filters: T.nilable(::Stripe::FinancialConnections::Session::CreateParams::Filters), limits: T.nilable(::Stripe::FinancialConnections::Session::CreateParams::Limits), manual_entry: T.nilable(::Stripe::FinancialConnections::Session::CreateParams::ManualEntry), permissions: T::Array[String], prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
}
def initialize(
account_holder: nil,
expand: nil,
filters: nil,
limits: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
); end
end
# To launch the Financial Connections authorization flow, create a Session. The session's client_secret can be used to launch the flow using Stripe.js.
sig {
params(params: T.any(::Stripe::FinancialConnections::Session::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Session)
}
def self.create(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module FinancialConnections
# A Transaction represents a real transaction that affects a Financial Connections Account balance.
class Transaction < APIResource
class StatusTransitions < Stripe::StripeObject
# Time at which this transaction posted. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def posted_at; end
# Time at which this transaction was voided. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def void_at; end
end
# The ID of the Financial Connections Account this transaction belongs to.
sig { returns(String) }
def account; end
# The amount of this transaction, in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
# The description of this transaction.
sig { returns(String) }
def description; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The status of the transaction.
sig { returns(String) }
def status; end
# Attribute for field status_transitions
sig { returns(StatusTransitions) }
def status_transitions; end
# Time at which the transaction was transacted. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def transacted_at; end
# The token of the transaction refresh that last updated or created this transaction.
sig { returns(String) }
def transaction_refresh; end
# Time at which the object was last updated. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def updated; end
class ListParams < Stripe::RequestParams
class TransactedAt < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class TransactionRefresh < Stripe::RequestParams
# Return results where the transactions were created or updated by a refresh that took place after this refresh (non-inclusive).
sig { returns(String) }
def after; end
sig { params(_after: String).returns(String) }
def after=(_after); end
sig { params(after: String).void }
def initialize(after: nil); end
end
# The ID of the Financial Connections Account whose transactions will be retrieved.
sig { returns(String) }
def account; end
sig { params(_account: String).returns(String) }
def account=(_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# A filter on the list based on the object `transacted_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:
sig {
returns(T.nilable(T.any(::Stripe::FinancialConnections::Transaction::ListParams::TransactedAt, Integer)))
}
def transacted_at; end
sig {
params(_transacted_at: T.nilable(T.any(::Stripe::FinancialConnections::Transaction::ListParams::TransactedAt, Integer))).returns(T.nilable(T.any(::Stripe::FinancialConnections::Transaction::ListParams::TransactedAt, Integer)))
}
def transacted_at=(_transacted_at); end
# A filter on the list based on the object `transaction_refresh` field. The value can be a dictionary with the following options:
sig {
returns(T.nilable(::Stripe::FinancialConnections::Transaction::ListParams::TransactionRefresh))
}
def transaction_refresh; end
sig {
params(_transaction_refresh: T.nilable(::Stripe::FinancialConnections::Transaction::ListParams::TransactionRefresh)).returns(T.nilable(::Stripe::FinancialConnections::Transaction::ListParams::TransactionRefresh))
}
def transaction_refresh=(_transaction_refresh); end
sig {
params(account: String, ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), transacted_at: T.nilable(T.any(::Stripe::FinancialConnections::Transaction::ListParams::TransactedAt, Integer)), transaction_refresh: T.nilable(::Stripe::FinancialConnections::Transaction::ListParams::TransactionRefresh)).void
}
def initialize(
account: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
transacted_at: nil,
transaction_refresh: nil
); end
end
# Returns a list of Financial Connections Transaction objects.
sig {
params(params: T.any(::Stripe::FinancialConnections::Transaction::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Forwarding
# Instructs Stripe to make a request on your behalf using the destination URL. The destination URL
# is activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials
# provided during onboarding, and injects card details from the payment_method into the request.
#
# Stripe redacts all sensitive fields and headers, including authentication credentials and card numbers,
# before storing the request and response data in the forwarding Request object, which are subject to a
# 30-day retention period.
#
# You can provide a Stripe idempotency key to make sure that requests with the same key result in only one
# outbound request. The Stripe idempotency key provided should be unique and different from any idempotency
# keys provided on the underlying third-party request.
#
# Forwarding Requests are synchronous requests that return a response or time out according to
# Stripe's limits.
#
# Related guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding).
class Request < APIResource
class RequestContext < Stripe::StripeObject
# The time it took in milliseconds for the destination endpoint to respond.
sig { returns(Integer) }
def destination_duration; end
# The IP address of the destination.
sig { returns(String) }
def destination_ip_address; end
end
class RequestDetails < Stripe::StripeObject
class Header < Stripe::StripeObject
# The header name.
sig { returns(String) }
def name; end
# The header value.
sig { returns(String) }
def value; end
end
# The body payload to send to the destination endpoint.
sig { returns(String) }
def body; end
# The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.
sig { returns(T::Array[Header]) }
def headers; end
# The HTTP method used to call the destination endpoint.
sig { returns(String) }
def http_method; end
end
class ResponseDetails < Stripe::StripeObject
class Header < Stripe::StripeObject
# The header name.
sig { returns(String) }
def name; end
# The header value.
sig { returns(String) }
def value; end
end
# The response body from the destination endpoint to Stripe.
sig { returns(String) }
def body; end
# HTTP headers that the destination endpoint returned.
sig { returns(T::Array[Header]) }
def headers; end
# The HTTP status code that the destination endpoint returned.
sig { returns(Integer) }
def status; end
end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
sig { returns(String) }
def payment_method; end
# The field kinds to be replaced in the forwarded request.
sig { returns(T::Array[String]) }
def replacements; end
# Context about the request from Stripe's servers to the destination endpoint.
sig { returns(T.nilable(RequestContext)) }
def request_context; end
# The request that was sent to the destination endpoint. We redact any sensitive fields.
sig { returns(T.nilable(RequestDetails)) }
def request_details; end
# The response that the destination endpoint returned to us. We redact any sensitive fields.
sig { returns(T.nilable(ResponseDetails)) }
def response_details; end
# The destination URL for the forwarded request. Must be supported by the config.
sig { returns(T.nilable(String)) }
def url; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Return results where the `created` field is greater than this value.
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Return results where the `created` field is greater than or equal to this value.
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Return results where the `created` field is less than this value.
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Return results where the `created` field is less than or equal to this value.
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.
sig { returns(T.nilable(::Stripe::Forwarding::Request::ListParams::Created)) }
def created; end
sig {
params(_created: T.nilable(::Stripe::Forwarding::Request::ListParams::Created)).returns(T.nilable(::Stripe::Forwarding::Request::ListParams::Created))
}
def created=(_created); end
# A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(::Stripe::Forwarding::Request::ListParams::Created), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Request < Stripe::RequestParams
class Header < Stripe::RequestParams
# The header name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The header value.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
# The body payload to send to the destination endpoint.
sig { returns(T.nilable(String)) }
def body; end
sig { params(_body: T.nilable(String)).returns(T.nilable(String)) }
def body=(_body); end
# The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.
sig {
returns(T.nilable(T::Array[::Stripe::Forwarding::Request::CreateParams::Request::Header]))
}
def headers; end
sig {
params(_headers: T.nilable(T::Array[::Stripe::Forwarding::Request::CreateParams::Request::Header])).returns(T.nilable(T::Array[::Stripe::Forwarding::Request::CreateParams::Request::Header]))
}
def headers=(_headers); end
sig {
params(body: T.nilable(String), headers: T.nilable(T::Array[::Stripe::Forwarding::Request::CreateParams::Request::Header])).void
}
def initialize(body: nil, headers: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
sig { returns(String) }
def payment_method; end
sig { params(_payment_method: String).returns(String) }
def payment_method=(_payment_method); end
# The field kinds to be replaced in the forwarded request.
sig { returns(T::Array[String]) }
def replacements; end
sig { params(_replacements: T::Array[String]).returns(T::Array[String]) }
def replacements=(_replacements); end
# The request body and headers to be sent to the destination endpoint.
sig { returns(::Stripe::Forwarding::Request::CreateParams::Request) }
def request; end
sig {
params(_request: ::Stripe::Forwarding::Request::CreateParams::Request).returns(::Stripe::Forwarding::Request::CreateParams::Request)
}
def request=(_request); end
# The destination URL for the forwarded request. Must be supported by the config.
sig { returns(String) }
def url; end
sig { params(_url: String).returns(String) }
def url=(_url); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), payment_method: String, replacements: T::Array[String], request: ::Stripe::Forwarding::Request::CreateParams::Request, url: String).void
}
def initialize(
expand: nil,
metadata: nil,
payment_method: nil,
replacements: nil,
request: nil,
url: nil
); end
end
# Creates a ForwardingRequest object.
sig {
params(params: T.any(::Stripe::Forwarding::Request::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Forwarding::Request)
}
def self.create(params = {}, opts = {}); end
# Lists all ForwardingRequest objects.
sig {
params(params: T.any(::Stripe::Forwarding::Request::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
# The FX Quotes API provides three functions:
# - View Stripe's current exchange rate for any given currency pair.
# - Extend quoted rates for a 1-hour period or a 24-hour period, minimizing uncertainty from FX fluctuations.
# - Preview the FX fees Stripe will charge on your FX transaction, allowing you to anticipate specific settlement amounts before payment costs.
#
# [View the docs](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api)
class FxQuote < APIResource
class Rates < Stripe::StripeObject
class RateDetails < Stripe::StripeObject
# The rate for the currency pair.
sig { returns(Float) }
def base_rate; end
# The fee for locking the conversion rates.
sig { returns(Float) }
def duration_premium; end
# The FX fee for the currency pair.
sig { returns(Float) }
def fx_fee_rate; end
# A reference rate for the currency pair provided by the reference rate provider.
sig { returns(T.nilable(Float)) }
def reference_rate; end
# The reference rate provider.
sig { returns(T.nilable(String)) }
def reference_rate_provider; end
end
# The rate that includes the FX fee rate.
sig { returns(Float) }
def exchange_rate; end
# Attribute for field rate_details
sig { returns(RateDetails) }
def rate_details; end
end
class Usage < Stripe::StripeObject
class Payment < Stripe::StripeObject
# The Stripe account ID that the funds will be transferred to.
#
# This field should match the account ID that would be used in the PaymentIntent’s transfer_data[destination] field.
sig { returns(T.nilable(String)) }
def destination; end
# The Stripe account ID that these funds are intended for.
#
# This field must match the account ID that would be used in the PaymentIntent’s on_behalf_of field.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
end
class Transfer < Stripe::StripeObject
# The Stripe account ID that the funds will be transferred to.
#
# This field should match the account ID that would be used in the Transfer’s destination field.
sig { returns(String) }
def destination; end
end
# The details required to use an FX Quote for a payment
sig { returns(T.nilable(Payment)) }
def payment; end
# The details required to use an FX Quote for a transfer
sig { returns(T.nilable(Transfer)) }
def transfer; end
# The transaction type for which the FX Quote will be used.
#
# Can be 'payment' or 'transfer'.
sig { returns(String) }
def type; end
end
# Time at which the quote was created, measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The duration the exchange rate quote remains valid from creation time. Allowed values are none, hour, and day. Note that for the test mode API available in alpha, you can request an extended quote, but it won't be usable for any transactions.
sig { returns(String) }
def lock_duration; end
# Time at which the quote will expire, measured in seconds since the Unix epoch.
#
# If lock_duration is set to ‘none’ this field will be set to null.
sig { returns(T.nilable(Integer)) }
def lock_expires_at; end
# Lock status of the quote. Transitions from active to expired once past the lock_expires_at timestamp.
#
# Can return value none, active, or expired.
sig { returns(String) }
def lock_status; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Information about the rates.
sig { returns(T::Hash[String, Rates]) }
def rates; end
# The currency to convert into, typically this is the currency that you want to settle to your Stripe balance. Three-letter ISO currency code, in lowercase. Must be a supported currency.
sig { returns(String) }
def to_currency; end
# Attribute for field usage
sig { returns(Usage) }
def usage; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateParams < Stripe::RequestParams
class Usage < Stripe::RequestParams
class Payment < Stripe::RequestParams
# The Stripe account ID that the funds will be transferred to.
#
# This field should match the account ID that would be used in the PaymentIntent’s transfer_data[destination] field.
sig { returns(T.nilable(String)) }
def destination; end
sig { params(_destination: T.nilable(String)).returns(T.nilable(String)) }
def destination=(_destination); end
# The Stripe account ID that these funds are intended for.
#
# This field should match the account ID that would be used in the PaymentIntent’s on_behalf_of field.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
sig { params(destination: T.nilable(String), on_behalf_of: T.nilable(String)).void }
def initialize(destination: nil, on_behalf_of: nil); end
end
class Transfer < Stripe::RequestParams
# The Stripe account ID that the funds will be transferred to.
#
# This field should match the account ID that would be used in the Transfer’s destination field.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(destination: String).void }
def initialize(destination: nil); end
end
# The payment transaction details that are intended for the FX Quote.
sig { returns(T.nilable(::Stripe::FxQuote::CreateParams::Usage::Payment)) }
def payment; end
sig {
params(_payment: T.nilable(::Stripe::FxQuote::CreateParams::Usage::Payment)).returns(T.nilable(::Stripe::FxQuote::CreateParams::Usage::Payment))
}
def payment=(_payment); end
# The transfer transaction details that are intended for the FX Quote.
sig { returns(T.nilable(::Stripe::FxQuote::CreateParams::Usage::Transfer)) }
def transfer; end
sig {
params(_transfer: T.nilable(::Stripe::FxQuote::CreateParams::Usage::Transfer)).returns(T.nilable(::Stripe::FxQuote::CreateParams::Usage::Transfer))
}
def transfer=(_transfer); end
# Which transaction the FX Quote will be used for
#
# Can be “payment” | “transfer”
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(payment: T.nilable(::Stripe::FxQuote::CreateParams::Usage::Payment), transfer: T.nilable(::Stripe::FxQuote::CreateParams::Usage::Transfer), type: String).void
}
def initialize(payment: nil, transfer: nil, type: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A list of three letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be [supported currencies](https://stripe.com/docs/currencies).
sig { returns(T::Array[String]) }
def from_currencies; end
sig { params(_from_currencies: T::Array[String]).returns(T::Array[String]) }
def from_currencies=(_from_currencies); end
# The duration that you wish the quote to be locked for. The quote will be usable for the duration specified. The default is `none`. The maximum is 1 day.
sig { returns(String) }
def lock_duration; end
sig { params(_lock_duration: String).returns(String) }
def lock_duration=(_lock_duration); end
# 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) }
def to_currency; end
sig { params(_to_currency: String).returns(String) }
def to_currency=(_to_currency); end
# The usage specific information for the quote.
sig { returns(T.nilable(::Stripe::FxQuote::CreateParams::Usage)) }
def usage; end
sig {
params(_usage: T.nilable(::Stripe::FxQuote::CreateParams::Usage)).returns(T.nilable(::Stripe::FxQuote::CreateParams::Usage))
}
def usage=(_usage); end
sig {
params(expand: T.nilable(T::Array[String]), from_currencies: T::Array[String], lock_duration: String, to_currency: String, usage: T.nilable(::Stripe::FxQuote::CreateParams::Usage)).void
}
def initialize(
expand: nil,
from_currencies: nil,
lock_duration: nil,
to_currency: nil,
usage: nil
); end
end
# Creates an FX Quote object
sig {
params(params: T.any(::Stripe::FxQuote::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FxQuote)
}
def self.create(params = {}, opts = {}); end
# Returns a list of FX quotes that have been issued. The FX quotes are returned in sorted order, with the most recent FX quotes appearing first.
sig {
params(params: T.any(::Stripe::FxQuote::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
module Identity
# A VerificationReport is the result of an attempt to collect and verify data from a user.
# The collection of verification checks performed is determined from the `type` and `options`
# parameters used. You can find the result of each verification check performed in the
# appropriate sub-resource: `document`, `id_number`, `selfie`.
#
# Each VerificationReport contains a copy of any data collected by the user as well as
# reference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)
# API. To configure and create VerificationReports, use the
# [VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.
#
# Related guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).
class VerificationReport < APIResource
class Document < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class Dob < Stripe::StripeObject
# Numerical day between 1 and 31.
sig { returns(T.nilable(Integer)) }
def day; end
# Numerical month between 1 and 12.
sig { returns(T.nilable(Integer)) }
def month; end
# The four-digit year.
sig { returns(T.nilable(Integer)) }
def year; end
end
class Error < Stripe::StripeObject
# A short machine-readable string giving the reason for the verification failure.
sig { returns(T.nilable(String)) }
def code; end
# A human-readable message giving the reason for the failure. These messages can be shown to your users.
sig { returns(T.nilable(String)) }
def reason; end
end
class ExpirationDate < Stripe::StripeObject
# Numerical day between 1 and 31.
sig { returns(T.nilable(Integer)) }
def day; end
# Numerical month between 1 and 12.
sig { returns(T.nilable(Integer)) }
def month; end
# The four-digit year.
sig { returns(T.nilable(Integer)) }
def year; end
end
class IssuedDate < Stripe::StripeObject
# Numerical day between 1 and 31.
sig { returns(T.nilable(Integer)) }
def day; end
# Numerical month between 1 and 12.
sig { returns(T.nilable(Integer)) }
def month; end
# The four-digit year.
sig { returns(T.nilable(Integer)) }
def year; end
end
# Address as it appears in the document.
sig { returns(T.nilable(Address)) }
def address; end
# Date of birth as it appears in the document.
sig { returns(T.nilable(Dob)) }
def dob; end
# Details on the verification error. Present when status is `unverified`.
sig { returns(T.nilable(Error)) }
def error; end
# Expiration date of the document.
sig { returns(T.nilable(ExpirationDate)) }
def expiration_date; end
# Array of [File](https://stripe.com/docs/api/files) ids containing images for this document.
sig { returns(T.nilable(T::Array[String])) }
def files; end
# First name as it appears in the document.
sig { returns(T.nilable(String)) }
def first_name; end
# Issued date of the document.
sig { returns(T.nilable(IssuedDate)) }
def issued_date; end
# Issuing country of the document.
sig { returns(T.nilable(String)) }
def issuing_country; end
# Last name as it appears in the document.
sig { returns(T.nilable(String)) }
def last_name; end
# Document ID number.
sig { returns(T.nilable(String)) }
def number; end
# Sex of the person in the document.
sig { returns(T.nilable(String)) }
def sex; end
# Status of this `document` check.
sig { returns(String) }
def status; end
# Type of the document.
sig { returns(T.nilable(String)) }
def type; end
# Place of birth as it appears in the document.
sig { returns(T.nilable(String)) }
def unparsed_place_of_birth; end
# Sex as it appears in the document.
sig { returns(T.nilable(String)) }
def unparsed_sex; end
end
class Email < Stripe::StripeObject
class Error < Stripe::StripeObject
# A short machine-readable string giving the reason for the verification failure.
sig { returns(T.nilable(String)) }
def code; end
# A human-readable message giving the reason for the failure. These messages can be shown to your users.
sig { returns(T.nilable(String)) }
def reason; end
end
# Email to be verified.
sig { returns(T.nilable(String)) }
def email; end
# Details on the verification error. Present when status is `unverified`.
sig { returns(T.nilable(Error)) }
def error; end
# Status of this `email` check.
sig { returns(String) }
def status; end
end
class IdNumber < Stripe::StripeObject
class Dob < Stripe::StripeObject
# Numerical day between 1 and 31.
sig { returns(T.nilable(Integer)) }
def day; end
# Numerical month between 1 and 12.
sig { returns(T.nilable(Integer)) }
def month; end
# The four-digit year.
sig { returns(T.nilable(Integer)) }
def year; end
end
class Error < Stripe::StripeObject
# A short machine-readable string giving the reason for the verification failure.
sig { returns(T.nilable(String)) }
def code; end
# A human-readable message giving the reason for the failure. These messages can be shown to your users.
sig { returns(T.nilable(String)) }
def reason; end
end
# Date of birth.
sig { returns(T.nilable(Dob)) }
def dob; end
# Details on the verification error. Present when status is `unverified`.
sig { returns(T.nilable(Error)) }
def error; end
# First name.
sig { returns(T.nilable(String)) }
def first_name; end
# ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present.
sig { returns(T.nilable(String)) }
def id_number; end
# Type of ID number.
sig { returns(T.nilable(String)) }
def id_number_type; end
# Last name.
sig { returns(T.nilable(String)) }
def last_name; end
# Status of this `id_number` check.
sig { returns(String) }
def status; end
end
class Options < Stripe::StripeObject
class Document < Stripe::StripeObject
# Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
sig { returns(T.nilable(T::Array[String])) }
def allowed_types; end
# Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
sig { returns(T.nilable(T::Boolean)) }
def require_id_number; end
# Disable image uploads, identity document images have to be captured using the device’s camera.
sig { returns(T.nilable(T::Boolean)) }
def require_live_capture; end
# Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).
sig { returns(T.nilable(T::Boolean)) }
def require_matching_selfie; end
end
class IdNumber < Stripe::StripeObject; end
# Attribute for field document
sig { returns(T.nilable(Document)) }
def document; end
# Attribute for field id_number
sig { returns(T.nilable(IdNumber)) }
def id_number; end
end
class Phone < Stripe::StripeObject
class Error < Stripe::StripeObject
# A short machine-readable string giving the reason for the verification failure.
sig { returns(T.nilable(String)) }
def code; end
# A human-readable message giving the reason for the failure. These messages can be shown to your users.
sig { returns(T.nilable(String)) }
def reason; end
end
# Details on the verification error. Present when status is `unverified`.
sig { returns(T.nilable(Error)) }
def error; end
# Phone to be verified.
sig { returns(T.nilable(String)) }
def phone; end
# Status of this `phone` check.
sig { returns(String) }
def status; end
end
class Selfie < Stripe::StripeObject
class Error < Stripe::StripeObject
# A short machine-readable string giving the reason for the verification failure.
sig { returns(T.nilable(String)) }
def code; end
# A human-readable message giving the reason for the failure. These messages can be shown to your users.
sig { returns(T.nilable(String)) }
def reason; end
end
# ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check.
sig { returns(T.nilable(String)) }
def document; end
# Details on the verification error. Present when status is `unverified`.
sig { returns(T.nilable(Error)) }
def error; end
# ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check.
sig { returns(T.nilable(String)) }
def selfie; end
# Status of this `selfie` check.
sig { returns(String) }
def status; end
end
# A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
sig { returns(T.nilable(String)) }
def client_reference_id; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Result from a document check
sig { returns(T.nilable(Document)) }
def document; end
# Result from a email check
sig { returns(T.nilable(Email)) }
def email; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Result from an id_number check
sig { returns(T.nilable(IdNumber)) }
def id_number; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Attribute for field options
sig { returns(T.nilable(Options)) }
def options; end
# Result from a phone check
sig { returns(T.nilable(Phone)) }
def phone; end
# Result from a selfie check
sig { returns(T.nilable(Selfie)) }
def selfie; end
# Type of report.
sig { returns(String) }
def type; end
# The configuration token of a verification flow from the dashboard.
sig { returns(T.nilable(String)) }
def verification_flow; end
# ID of the VerificationSession that created this report.
sig { returns(T.nilable(String)) }
def verification_session; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
sig { returns(T.nilable(String)) }
def client_reference_id; end
sig { params(_client_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def client_reference_id=(_client_reference_id); end
# Only return VerificationReports that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Identity::VerificationReport::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Identity::VerificationReport::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Identity::VerificationReport::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return VerificationReports of this type
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.
sig { returns(T.nilable(String)) }
def verification_session; end
sig { params(_verification_session: T.nilable(String)).returns(T.nilable(String)) }
def verification_session=(_verification_session); end
sig {
params(client_reference_id: T.nilable(String), created: T.nilable(T.any(::Stripe::Identity::VerificationReport::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), type: T.nilable(String), verification_session: T.nilable(String)).void
}
def initialize(
client_reference_id: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
type: nil,
verification_session: nil
); end
end
# List all verification reports.
sig {
params(params: T.any(::Stripe::Identity::VerificationReport::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Identity
# A VerificationSession guides you through the process of collecting and verifying the identities
# of your users. It contains details about the type of verification, such as what [verification
# check](https://docs.stripe.com/docs/identity/verification-checks) to perform. Only create one VerificationSession for
# each verification in your system.
#
# A VerificationSession transitions through [multiple
# statuses](https://docs.stripe.com/docs/identity/how-sessions-work) throughout its lifetime as it progresses through
# the verification flow. The VerificationSession contains the user's verified data after
# verification checks are complete.
#
# Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)
class VerificationSession < APIResource
class LastError < Stripe::StripeObject
# A short machine-readable string giving the reason for the verification or user-session failure.
sig { returns(T.nilable(String)) }
def code; end
# A message that explains the reason for verification or user-session failure.
sig { returns(T.nilable(String)) }
def reason; end
end
class Options < Stripe::StripeObject
class Document < Stripe::StripeObject
# Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
sig { returns(T.nilable(T::Array[String])) }
def allowed_types; end
# Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
sig { returns(T.nilable(T::Boolean)) }
def require_id_number; end
# Disable image uploads, identity document images have to be captured using the device’s camera.
sig { returns(T.nilable(T::Boolean)) }
def require_live_capture; end
# Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).
sig { returns(T.nilable(T::Boolean)) }
def require_matching_selfie; end
end
class Email < Stripe::StripeObject
# Request one time password verification of `provided_details.email`.
sig { returns(T.nilable(T::Boolean)) }
def require_verification; end
end
class IdNumber < Stripe::StripeObject; end
class Matching < Stripe::StripeObject
# Strictness of the DOB matching policy to apply.
sig { returns(T.nilable(String)) }
def dob; end
# Strictness of the name matching policy to apply.
sig { returns(T.nilable(String)) }
def name; end
end
class Phone < Stripe::StripeObject
# Request one time password verification of `provided_details.phone`.
sig { returns(T.nilable(T::Boolean)) }
def require_verification; end
end
# Attribute for field document
sig { returns(T.nilable(Document)) }
def document; end
# Attribute for field email
sig { returns(T.nilable(Email)) }
def email; end
# Attribute for field id_number
sig { returns(T.nilable(IdNumber)) }
def id_number; end
# Attribute for field matching
sig { returns(T.nilable(Matching)) }
def matching; end
# Attribute for field phone
sig { returns(T.nilable(Phone)) }
def phone; end
end
class ProvidedDetails < Stripe::StripeObject
# Email of user being verified
sig { returns(T.nilable(String)) }
def email; end
# Phone number of user being verified
sig { returns(T.nilable(String)) }
def phone; end
end
class Redaction < Stripe::StripeObject
# Indicates whether this object and its related objects have been redacted or not.
sig { returns(String) }
def status; end
end
class RelatedPerson < Stripe::StripeObject
# Token referencing the associated Account of the related Person resource.
sig { returns(String) }
def account; end
# Token referencing the related Person resource.
sig { returns(String) }
def person; end
end
class VerifiedOutputs < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class Dob < Stripe::StripeObject
# Numerical day between 1 and 31.
sig { returns(T.nilable(Integer)) }
def day; end
# Numerical month between 1 and 12.
sig { returns(T.nilable(Integer)) }
def month; end
# The four-digit year.
sig { returns(T.nilable(Integer)) }
def year; end
end
# The user's verified address.
sig { returns(T.nilable(Address)) }
def address; end
# The user’s verified date of birth.
sig { returns(T.nilable(Dob)) }
def dob; end
# The user's verified email address
sig { returns(T.nilable(String)) }
def email; end
# The user's verified first name.
sig { returns(T.nilable(String)) }
def first_name; end
# The user's verified id number.
sig { returns(T.nilable(String)) }
def id_number; end
# The user's verified id number type.
sig { returns(T.nilable(String)) }
def id_number_type; end
# The user's verified last name.
sig { returns(T.nilable(String)) }
def last_name; end
# The user's verified phone number
sig { returns(T.nilable(String)) }
def phone; end
# The user's verified sex.
sig { returns(T.nilable(String)) }
def sex; end
# The user's verified place of birth as it appears in the document.
sig { returns(T.nilable(String)) }
def unparsed_place_of_birth; end
# The user's verified sex as it appears in the document.
sig { returns(T.nilable(String)) }
def unparsed_sex; end
end
# A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
sig { returns(T.nilable(String)) }
def client_reference_id; end
# The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.
sig { returns(T.nilable(String)) }
def client_secret; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# If present, this property tells you the last error encountered when processing the verification.
sig { returns(T.nilable(LastError)) }
def last_error; end
# ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)
sig { returns(T.nilable(T.any(String, Stripe::Identity::VerificationReport))) }
def last_verification_report; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# A set of options for the session’s verification checks.
sig { returns(T.nilable(Options)) }
def options; end
# Details provided about the user being verified. These details may be shown to the user.
sig { returns(T.nilable(ProvidedDetails)) }
def provided_details; end
# Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.
sig { returns(T.nilable(Redaction)) }
def redaction; end
# Customer ID
sig { returns(T.nilable(String)) }
def related_customer; end
# Token referencing a Customer Account resource.
sig { returns(T.nilable(String)) }
def related_customer_account; end
# Attribute for field related_person
sig { returns(T.nilable(RelatedPerson)) }
def related_person; end
# Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
sig { returns(String) }
def status; end
# The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.
sig { returns(String) }
def type; end
# The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.
sig { returns(T.nilable(String)) }
def url; end
# The configuration token of a verification flow from the dashboard.
sig { returns(T.nilable(String)) }
def verification_flow; end
# The user’s verified data.
sig { returns(T.nilable(VerifiedOutputs)) }
def verified_outputs; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
sig { returns(T.nilable(String)) }
def client_reference_id; end
sig { params(_client_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def client_reference_id=(_client_reference_id); end
# Only return VerificationSessions that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Identity::VerificationSession::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Identity::VerificationSession::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Identity::VerificationSession::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Attribute for param field related_customer
sig { returns(T.nilable(String)) }
def related_customer; end
sig { params(_related_customer: T.nilable(String)).returns(T.nilable(String)) }
def related_customer=(_related_customer); end
# Attribute for param field related_customer_account
sig { returns(T.nilable(String)) }
def related_customer_account; end
sig { params(_related_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def related_customer_account=(_related_customer_account); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(client_reference_id: T.nilable(String), created: T.nilable(T.any(::Stripe::Identity::VerificationSession::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), related_customer: T.nilable(String), related_customer_account: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
client_reference_id: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
related_customer: nil,
related_customer_account: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class Options < Stripe::RequestParams
class Document < Stripe::RequestParams
# Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
sig { returns(T.nilable(T::Array[String])) }
def allowed_types; end
sig {
params(_allowed_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_types=(_allowed_types); end
# Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
sig { returns(T.nilable(T::Boolean)) }
def require_id_number; end
sig { params(_require_id_number: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def require_id_number=(_require_id_number); end
# Disable image uploads, identity document images have to be captured using the device’s camera.
sig { returns(T.nilable(T::Boolean)) }
def require_live_capture; end
sig {
params(_require_live_capture: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def require_live_capture=(_require_live_capture); end
# Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).
sig { returns(T.nilable(T::Boolean)) }
def require_matching_selfie; end
sig {
params(_require_matching_selfie: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def require_matching_selfie=(_require_matching_selfie); end
sig {
params(allowed_types: T.nilable(T::Array[String]), require_id_number: T.nilable(T::Boolean), require_live_capture: T.nilable(T::Boolean), require_matching_selfie: T.nilable(T::Boolean)).void
}
def initialize(
allowed_types: nil,
require_id_number: nil,
require_live_capture: nil,
require_matching_selfie: nil
); end
end
# Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document).
sig {
returns(T.nilable(T.any(String, ::Stripe::Identity::VerificationSession::CreateParams::Options::Document)))
}
def document; end
sig {
params(_document: T.nilable(T.any(String, ::Stripe::Identity::VerificationSession::CreateParams::Options::Document))).returns(T.nilable(T.any(String, ::Stripe::Identity::VerificationSession::CreateParams::Options::Document)))
}
def document=(_document); end
sig {
params(document: T.nilable(T.any(String, ::Stripe::Identity::VerificationSession::CreateParams::Options::Document))).void
}
def initialize(document: nil); end
end
class ProvidedDetails < Stripe::RequestParams
# Email of user being verified
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Phone number of user being verified
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig { params(email: T.nilable(String), phone: T.nilable(String)).void }
def initialize(email: nil, phone: nil); end
end
class RelatedPerson < Stripe::RequestParams
# A token representing a connected account. If provided, the person parameter is also required and must be associated with the account.
sig { returns(String) }
def account; end
sig { params(_account: String).returns(String) }
def account=(_account); end
# A token referencing a Person resource that this verification is being used to verify.
sig { returns(String) }
def person; end
sig { params(_person: String).returns(String) }
def person=(_person); end
sig { params(account: String, person: String).void }
def initialize(account: nil, person: nil); end
end
# A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
sig { returns(T.nilable(String)) }
def client_reference_id; end
sig { params(_client_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def client_reference_id=(_client_reference_id); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# A set of options for the session’s verification checks.
sig { returns(T.nilable(::Stripe::Identity::VerificationSession::CreateParams::Options)) }
def options; end
sig {
params(_options: T.nilable(::Stripe::Identity::VerificationSession::CreateParams::Options)).returns(T.nilable(::Stripe::Identity::VerificationSession::CreateParams::Options))
}
def options=(_options); end
# Details provided about the user being verified. These details may be shown to the user.
sig {
returns(T.nilable(::Stripe::Identity::VerificationSession::CreateParams::ProvidedDetails))
}
def provided_details; end
sig {
params(_provided_details: T.nilable(::Stripe::Identity::VerificationSession::CreateParams::ProvidedDetails)).returns(T.nilable(::Stripe::Identity::VerificationSession::CreateParams::ProvidedDetails))
}
def provided_details=(_provided_details); end
# Customer ID
sig { returns(T.nilable(String)) }
def related_customer; end
sig { params(_related_customer: T.nilable(String)).returns(T.nilable(String)) }
def related_customer=(_related_customer); end
# Token referencing a Customer Account resource.
sig { returns(T.nilable(String)) }
def related_customer_account; end
sig { params(_related_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def related_customer_account=(_related_customer_account); end
# Tokens referencing a Person resource and it's associated account.
sig {
returns(T.nilable(::Stripe::Identity::VerificationSession::CreateParams::RelatedPerson))
}
def related_person; end
sig {
params(_related_person: T.nilable(::Stripe::Identity::VerificationSession::CreateParams::RelatedPerson)).returns(T.nilable(::Stripe::Identity::VerificationSession::CreateParams::RelatedPerson))
}
def related_person=(_related_person); end
# The URL that the user will be redirected to upon completing the verification flow.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.
sig { returns(T.nilable(String)) }
def verification_flow; end
sig { params(_verification_flow: T.nilable(String)).returns(T.nilable(String)) }
def verification_flow=(_verification_flow); end
sig {
params(client_reference_id: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), options: T.nilable(::Stripe::Identity::VerificationSession::CreateParams::Options), provided_details: T.nilable(::Stripe::Identity::VerificationSession::CreateParams::ProvidedDetails), related_customer: T.nilable(String), related_customer_account: T.nilable(String), related_person: T.nilable(::Stripe::Identity::VerificationSession::CreateParams::RelatedPerson), return_url: T.nilable(String), type: T.nilable(String), verification_flow: T.nilable(String)).void
}
def initialize(
client_reference_id: nil,
expand: nil,
metadata: nil,
options: nil,
provided_details: nil,
related_customer: nil,
related_customer_account: nil,
related_person: nil,
return_url: nil,
type: nil,
verification_flow: nil
); end
end
class UpdateParams < Stripe::RequestParams
class Options < Stripe::RequestParams
class Document < Stripe::RequestParams
# Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
sig { returns(T.nilable(T::Array[String])) }
def allowed_types; end
sig {
params(_allowed_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_types=(_allowed_types); end
# Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
sig { returns(T.nilable(T::Boolean)) }
def require_id_number; end
sig { params(_require_id_number: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def require_id_number=(_require_id_number); end
# Disable image uploads, identity document images have to be captured using the device’s camera.
sig { returns(T.nilable(T::Boolean)) }
def require_live_capture; end
sig {
params(_require_live_capture: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def require_live_capture=(_require_live_capture); end
# Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).
sig { returns(T.nilable(T::Boolean)) }
def require_matching_selfie; end
sig {
params(_require_matching_selfie: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def require_matching_selfie=(_require_matching_selfie); end
sig {
params(allowed_types: T.nilable(T::Array[String]), require_id_number: T.nilable(T::Boolean), require_live_capture: T.nilable(T::Boolean), require_matching_selfie: T.nilable(T::Boolean)).void
}
def initialize(
allowed_types: nil,
require_id_number: nil,
require_live_capture: nil,
require_matching_selfie: nil
); end
end
# Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document).
sig {
returns(T.nilable(T.any(String, ::Stripe::Identity::VerificationSession::UpdateParams::Options::Document)))
}
def document; end
sig {
params(_document: T.nilable(T.any(String, ::Stripe::Identity::VerificationSession::UpdateParams::Options::Document))).returns(T.nilable(T.any(String, ::Stripe::Identity::VerificationSession::UpdateParams::Options::Document)))
}
def document=(_document); end
sig {
params(document: T.nilable(T.any(String, ::Stripe::Identity::VerificationSession::UpdateParams::Options::Document))).void
}
def initialize(document: nil); end
end
class ProvidedDetails < Stripe::RequestParams
# Email of user being verified
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Phone number of user being verified
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig { params(email: T.nilable(String), phone: T.nilable(String)).void }
def initialize(email: nil, phone: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# A set of options for the session’s verification checks.
sig { returns(T.nilable(::Stripe::Identity::VerificationSession::UpdateParams::Options)) }
def options; end
sig {
params(_options: T.nilable(::Stripe::Identity::VerificationSession::UpdateParams::Options)).returns(T.nilable(::Stripe::Identity::VerificationSession::UpdateParams::Options))
}
def options=(_options); end
# Details provided about the user being verified. These details may be shown to the user.
sig {
returns(T.nilable(::Stripe::Identity::VerificationSession::UpdateParams::ProvidedDetails))
}
def provided_details; end
sig {
params(_provided_details: T.nilable(::Stripe::Identity::VerificationSession::UpdateParams::ProvidedDetails)).returns(T.nilable(::Stripe::Identity::VerificationSession::UpdateParams::ProvidedDetails))
}
def provided_details=(_provided_details); end
# The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), options: T.nilable(::Stripe::Identity::VerificationSession::UpdateParams::Options), provided_details: T.nilable(::Stripe::Identity::VerificationSession::UpdateParams::ProvidedDetails), type: T.nilable(String)).void
}
def initialize(
expand: nil,
metadata: nil,
options: nil,
provided_details: nil,
type: nil
); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class RedactParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
#
# Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
sig {
params(params: T.any(::Stripe::Identity::VerificationSession::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
}
def cancel(params = {}, opts = {}); end
# A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
#
# Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
sig {
params(session: String, params: T.any(::Stripe::Identity::VerificationSession::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
}
def self.cancel(session, params = {}, opts = {}); end
# Creates a VerificationSession object.
#
# After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session's url.
#
# If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode.
#
# Related guide: [Verify your users' identity documents](https://docs.stripe.com/docs/identity/verify-identity-documents)
sig {
params(params: T.any(::Stripe::Identity::VerificationSession::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
}
def self.create(params = {}, opts = {}); end
# Returns a list of VerificationSessions
sig {
params(params: T.any(::Stripe::Identity::VerificationSession::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Redact a VerificationSession to remove all collected information from Stripe. This will redact
# the VerificationSession and all objects related to it, including VerificationReports, Events,
# request logs, etc.
#
# A VerificationSession object can be redacted when it is in requires_input or verified
# [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
# state will automatically cancel it.
#
# The redaction process may take up to four days. When the redaction process is in progress, the
# VerificationSession's redaction.status field will be set to processing; when the process is
# finished, it will change to redacted and an identity.verification_session.redacted event
# will be emitted.
#
# Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the
# fields that contain personal data will be replaced by the string [redacted] or a similar
# placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
# used for any purpose.
#
# [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact).
sig {
params(params: T.any(::Stripe::Identity::VerificationSession::RedactParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
}
def redact(params = {}, opts = {}); end
# Redact a VerificationSession to remove all collected information from Stripe. This will redact
# the VerificationSession and all objects related to it, including VerificationReports, Events,
# request logs, etc.
#
# A VerificationSession object can be redacted when it is in requires_input or verified
# [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
# state will automatically cancel it.
#
# The redaction process may take up to four days. When the redaction process is in progress, the
# VerificationSession's redaction.status field will be set to processing; when the process is
# finished, it will change to redacted and an identity.verification_session.redacted event
# will be emitted.
#
# Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the
# fields that contain personal data will be replaced by the string [redacted] or a similar
# placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
# used for any purpose.
#
# [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact).
sig {
params(session: String, params: T.any(::Stripe::Identity::VerificationSession::RedactParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
}
def self.redact(session, params = {}, opts = {}); end
# Updates a VerificationSession object.
#
# When the session status is requires_input, you can use this method to update the
# verification check and options.
sig {
params(session: String, params: T.any(::Stripe::Identity::VerificationSession::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
}
def self.update(session, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
# Invoice Payments represent payments made against invoices. Invoice Payments can
# be accessed in two ways:
# 1. By expanding the `payments` field on the [Invoice](https://stripe.com/docs/api#invoice) resource.
# 2. By using the Invoice Payment retrieve and list endpoints.
#
# Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices.
# This resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and
# monitor the allocation details of the payments.
class InvoicePayment < APIResource
class Payment < Stripe::StripeObject
# ID of the successful charge for this payment when `type` is `charge`.Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead.
sig { returns(T.nilable(T.any(String, Stripe::Charge))) }
def charge; end
# ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019.
sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
def payment_intent; end
# ID of the PaymentRecord associated with this payment when `type` is `payment_record`.
sig { returns(T.nilable(T.any(String, Stripe::PaymentRecord))) }
def payment_record; end
# Type of payment object associated with this invoice payment.
sig { returns(String) }
def type; end
end
class StatusTransitions < Stripe::StripeObject
# The time that the payment was canceled.
sig { returns(T.nilable(Integer)) }
def canceled_at; end
# The time that the payment succeeded.
sig { returns(T.nilable(Integer)) }
def paid_at; end
end
# Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is `paid`. This amount can be less than the `amount_requested` if the PaymentIntent’s `amount_received` is not sufficient to pay all of the invoices that it is attached to.
sig { returns(T.nilable(Integer)) }
def amount_paid; end
# Amount intended to be paid toward this invoice, in cents (or local equivalent)
sig { returns(Integer) }
def amount_requested; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The invoice that was paid.
sig { returns(T.any(String, Stripe::Invoice)) }
def invoice; end
# Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s `amount_remaining`. The PaymentIntent associated with the default payment can’t be edited or canceled directly.
sig { returns(T::Boolean) }
def is_default; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Attribute for field payment
sig { returns(Payment) }
def payment; end
# The status of the payment, one of `open`, `paid`, or `canceled`.
sig { returns(String) }
def status; end
# Attribute for field status_transitions
sig { returns(StatusTransitions) }
def status_transitions; end
class ListParams < Stripe::RequestParams
class Payment < Stripe::RequestParams
# Only return invoice payments associated by this payment intent ID.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# Only return invoice payments associated by this payment record ID.
sig { returns(T.nilable(String)) }
def payment_record; end
sig { params(_payment_record: T.nilable(String)).returns(T.nilable(String)) }
def payment_record=(_payment_record); end
# Only return invoice payments associated by this payment type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(payment_intent: T.nilable(String), payment_record: T.nilable(String), type: String).void
}
def initialize(payment_intent: nil, payment_record: nil, type: nil); end
end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The identifier of the invoice whose payments to return.
sig { returns(T.nilable(String)) }
def invoice; end
sig { params(_invoice: T.nilable(String)).returns(T.nilable(String)) }
def invoice=(_invoice); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The payment details of the invoice payments to return.
sig { returns(T.nilable(::Stripe::InvoicePayment::ListParams::Payment)) }
def payment; end
sig {
params(_payment: T.nilable(::Stripe::InvoicePayment::ListParams::Payment)).returns(T.nilable(::Stripe::InvoicePayment::ListParams::Payment))
}
def payment=(_payment); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# The status of the invoice payments to return.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: T.nilable(String), limit: T.nilable(Integer), payment: T.nilable(::Stripe::InvoicePayment::ListParams::Payment), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
invoice: nil,
limit: nil,
payment: nil,
starting_after: nil,
status: nil
); end
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.
sig {
params(params: T.any(::Stripe::InvoicePayment::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates
# can be created from within the Dashboard, and they can be used over the API when creating invoices.
class InvoiceRenderingTemplate < APIResource
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# A brief description of the template, hidden from customers
sig { returns(T.nilable(String)) }
def nickname; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The status of the template, one of `active` or `archived`.
sig { returns(String) }
def status; end
# Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering
sig { returns(Integer) }
def version; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Attribute for param field status
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class ArchiveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UnarchiveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Updates the status of an invoice rendering template to ‘archived' so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.
sig {
params(params: T.any(::Stripe::InvoiceRenderingTemplate::ArchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceRenderingTemplate)
}
def archive(params = {}, opts = {}); end
# Updates the status of an invoice rendering template to ‘archived' so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.
sig {
params(template: String, params: T.any(::Stripe::InvoiceRenderingTemplate::ArchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceRenderingTemplate)
}
def self.archive(template, params = {}, opts = {}); end
# List all templates, ordered by creation date, with the most recently created template appearing first.
sig {
params(params: T.any(::Stripe::InvoiceRenderingTemplate::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Unarchive an invoice rendering template so it can be used on new Stripe objects again.
sig {
params(params: T.any(::Stripe::InvoiceRenderingTemplate::UnarchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceRenderingTemplate)
}
def unarchive(params = {}, opts = {}); end
# Unarchive an invoice rendering template so it can be used on new Stripe objects again.
sig {
params(template: String, params: T.any(::Stripe::InvoiceRenderingTemplate::UnarchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceRenderingTemplate)
}
def self.unarchive(template, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# Invoice Items represent the component lines of an [invoice](https://stripe.com/docs/api/invoices). When you create an invoice item with an `invoice` field, it is attached to the specified invoice and included as [an invoice line item](https://stripe.com/docs/api/invoices/line_item) within [invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines).
#
# Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined
# with a [subscription](https://stripe.com/docs/api/subscriptions). 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 guides: [Integrate with the Invoicing API](https://stripe.com/docs/invoicing/integration), [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items).
class InvoiceItem < APIResource
class Parent < Stripe::StripeObject
class SubscriptionDetails < Stripe::StripeObject
# The subscription that generated this invoice item
sig { returns(String) }
def subscription; end
# The subscription item that generated this invoice item
sig { returns(T.nilable(String)) }
def subscription_item; end
end
# Details about the subscription that generated this invoice item
sig { returns(T.nilable(SubscriptionDetails)) }
def subscription_details; end
# The type of parent that generated this invoice item
sig { returns(String) }
def type; end
end
class Period < Stripe::StripeObject
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
sig { returns(Integer) }
def end; end
# The start of the period. This value is inclusive.
sig { returns(Integer) }
def start; end
end
class Pricing < Stripe::StripeObject
class PriceDetails < Stripe::StripeObject
# The ID of the price this item is associated with.
sig { returns(String) }
def price; end
# The ID of the product this item is associated with.
sig { returns(String) }
def product; end
end
# Attribute for field price_details
sig { returns(T.nilable(PriceDetails)) }
def price_details; end
# The type of the pricing details.
sig { returns(String) }
def type; end
# The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
end
class ProrationDetails < Stripe::StripeObject
class DiscountAmount < Stripe::StripeObject
# The amount, in cents (or local equivalent), of the discount.
sig { returns(Integer) }
def amount; end
# The discount that was applied to get this discount amount.
sig { returns(T.any(String, Stripe::Discount)) }
def discount; end
end
# Discount amounts applied when the proration was created.
sig { returns(T::Array[DiscountAmount]) }
def discount_amounts; end
end
# Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
# The ID of the customer who will be billed when this invoice item is billed.
sig { returns(T.any(String, Stripe::Customer)) }
def customer; end
# The ID of the account who will be billed when this invoice item is billed.
sig { returns(T.nilable(String)) }
def customer_account; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def date; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# If true, discounts will apply to this invoice item. Always false for prorations.
sig { returns(T::Boolean) }
def discountable; end
# The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::Discount)])) }
def discounts; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The ID of the invoice this invoice item belongs to.
sig { returns(T.nilable(T.any(String, Stripe::Invoice))) }
def invoice; end
# 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) }
def livemode; end
# The margins which apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::Margin)])) }
def margins; end
# 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])) }
def metadata; end
# The amount after discounts, but before credits and taxes. This field is `null` for `discountable=true` items.
sig { returns(T.nilable(Integer)) }
def net_amount; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The parent that generated this invoice item.
sig { returns(T.nilable(Parent)) }
def parent; end
# Attribute for field period
sig { returns(Period) }
def period; end
# The pricing information of the invoice item.
sig { returns(T.nilable(Pricing)) }
def pricing; end
# Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
sig { returns(T::Boolean) }
def proration; end
# Attribute for field proration_details
sig { returns(T.nilable(ProrationDetails)) }
def proration_details; end
# Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
sig { returns(Integer) }
def quantity; end
# The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.
sig { returns(T.nilable(T::Array[Stripe::TaxRate])) }
def tax_rates; end
# ID of the test clock this invoice item belongs to.
sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
def test_clock; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams; end
class UpdateParams < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceItem::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceItem::UpdateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceItem::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceItem::UpdateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::InvoiceItem::UpdateParams::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceItem::UpdateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceItem::UpdateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceItem::UpdateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
sig { returns(Integer) }
def end; end
sig { params(_end: Integer).returns(Integer) }
def end=(_end); end
# The start of the period. This value is inclusive.
sig { returns(Integer) }
def start; end
sig { params(_start: Integer).returns(Integer) }
def start=(_start); end
sig { params(end_: Integer, start: Integer).void }
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Pricing < Stripe::RequestParams
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
sig { params(price: T.nilable(String)).void }
def initialize(price: nil); end
end
# The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations.
sig { returns(T.nilable(T::Boolean)) }
def discountable; end
sig { params(_discountable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def discountable=(_discountable); end
# The coupons, promotion codes & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceItem::UpdateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceItem::UpdateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceItem::UpdateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def margins; end
sig {
params(_margins: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def margins=(_margins); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
sig { returns(T.nilable(::Stripe::InvoiceItem::UpdateParams::Period)) }
def period; end
sig {
params(_period: T.nilable(::Stripe::InvoiceItem::UpdateParams::Period)).returns(T.nilable(::Stripe::InvoiceItem::UpdateParams::Period))
}
def period=(_period); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig { returns(T.nilable(::Stripe::InvoiceItem::UpdateParams::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::InvoiceItem::UpdateParams::PriceData)).returns(T.nilable(::Stripe::InvoiceItem::UpdateParams::PriceData))
}
def price_data=(_price_data); end
# The pricing information for the invoice item.
sig { returns(T.nilable(::Stripe::InvoiceItem::UpdateParams::Pricing)) }
def pricing; end
sig {
params(_pricing: T.nilable(::Stripe::InvoiceItem::UpdateParams::Pricing)).returns(T.nilable(::Stripe::InvoiceItem::UpdateParams::Pricing))
}
def pricing=(_pricing); end
# Non-negative integer. The quantity of units for the invoice item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(amount: T.nilable(Integer), description: T.nilable(String), discountable: T.nilable(T::Boolean), discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceItem::UpdateParams::Discount])), expand: T.nilable(T::Array[String]), margins: T.nilable(T.any(String, T::Array[String])), metadata: T.nilable(T.any(String, T::Hash[String, String])), period: T.nilable(::Stripe::InvoiceItem::UpdateParams::Period), price_data: T.nilable(::Stripe::InvoiceItem::UpdateParams::PriceData), pricing: T.nilable(::Stripe::InvoiceItem::UpdateParams::Pricing), quantity: T.nilable(Integer), tax_behavior: T.nilable(String), tax_code: T.nilable(String), tax_rates: T.nilable(T.any(String, T::Array[String])), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
amount: nil,
description: nil,
discountable: nil,
discounts: nil,
expand: nil,
margins: nil,
metadata: nil,
period: nil,
price_data: nil,
pricing: nil,
quantity: nil,
tax_behavior: nil,
tax_code: nil,
tax_rates: nil,
unit_amount_decimal: nil
); end
end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return invoice items that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::InvoiceItem::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::InvoiceItem::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::InvoiceItem::ListParams::Created, Integer)))
}
def created=(_created); end
# The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The identifier of the account whose invoice items to return. If none is provided, all invoice items will be returned.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.
sig { returns(T.nilable(String)) }
def invoice; end
sig { params(_invoice: T.nilable(String)).returns(T.nilable(String)) }
def invoice=(_invoice); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Set to `true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied.
sig { returns(T.nilable(T::Boolean)) }
def pending; end
sig { params(_pending: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def pending=(_pending); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::InvoiceItem::ListParams::Created, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: T.nilable(String), limit: T.nilable(Integer), pending: T.nilable(T::Boolean), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
invoice: nil,
limit: nil,
pending: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceItem::CreateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceItem::CreateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceItem::CreateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceItem::CreateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::InvoiceItem::CreateParams::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceItem::CreateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceItem::CreateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceItem::CreateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
sig { returns(Integer) }
def end; end
sig { params(_end: Integer).returns(Integer) }
def end=(_end); end
# The start of the period. This value is inclusive.
sig { returns(Integer) }
def start; end
sig { params(_start: Integer).returns(Integer) }
def start=(_start); end
sig { params(end_: Integer, start: Integer).void }
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Pricing < Stripe::RequestParams
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
sig { params(price: T.nilable(String)).void }
def initialize(price: nil); end
end
# The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The ID of the customer who will be billed when this invoice item is billed.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The ID of the account who will be billed when this invoice item is billed.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.
sig { returns(T.nilable(T::Boolean)) }
def discountable; end
sig { params(_discountable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def discountable=(_discountable); end
# The coupons and promotion codes to redeem into discounts for the invoice item or invoice line item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceItem::CreateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceItem::CreateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceItem::CreateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The ID of an existing invoice to add this invoice item to. For subscription invoices, when left blank, the invoice item will be added to the next upcoming scheduled invoice. For standalone invoices, the invoice item won't be automatically added unless you pass `pending_invoice_item_behavior: 'include'` when creating the invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.
sig { returns(T.nilable(String)) }
def invoice; end
sig { params(_invoice: T.nilable(String)).returns(T.nilable(String)) }
def invoice=(_invoice); end
# The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
sig { returns(T.nilable(T::Array[String])) }
def margins; end
sig { params(_margins: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def margins=(_margins); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
sig { returns(T.nilable(::Stripe::InvoiceItem::CreateParams::Period)) }
def period; end
sig {
params(_period: T.nilable(::Stripe::InvoiceItem::CreateParams::Period)).returns(T.nilable(::Stripe::InvoiceItem::CreateParams::Period))
}
def period=(_period); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig { returns(T.nilable(::Stripe::InvoiceItem::CreateParams::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::InvoiceItem::CreateParams::PriceData)).returns(T.nilable(::Stripe::InvoiceItem::CreateParams::PriceData))
}
def price_data=(_price_data); end
# The pricing information for the invoice item.
sig { returns(T.nilable(::Stripe::InvoiceItem::CreateParams::Pricing)) }
def pricing; end
sig {
params(_pricing: T.nilable(::Stripe::InvoiceItem::CreateParams::Pricing)).returns(T.nilable(::Stripe::InvoiceItem::CreateParams::Pricing))
}
def pricing=(_pricing); end
# Non-negative integer. The quantity of units for the invoice item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
sig { returns(T.nilable(String)) }
def subscription; end
sig { params(_subscription: T.nilable(String)).returns(T.nilable(String)) }
def subscription=(_subscription); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig { params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def tax_rates=(_tax_rates); end
# The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(amount: T.nilable(Integer), currency: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), description: T.nilable(String), discountable: T.nilable(T::Boolean), discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceItem::CreateParams::Discount])), expand: T.nilable(T::Array[String]), invoice: T.nilable(String), margins: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), period: T.nilable(::Stripe::InvoiceItem::CreateParams::Period), price_data: T.nilable(::Stripe::InvoiceItem::CreateParams::PriceData), pricing: T.nilable(::Stripe::InvoiceItem::CreateParams::Pricing), quantity: T.nilable(Integer), subscription: T.nilable(String), tax_behavior: T.nilable(String), tax_code: T.nilable(String), tax_rates: T.nilable(T::Array[String]), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
customer: nil,
customer_account: nil,
description: nil,
discountable: nil,
discounts: nil,
expand: nil,
invoice: nil,
margins: nil,
metadata: nil,
period: nil,
price_data: nil,
pricing: nil,
quantity: nil,
subscription: nil,
tax_behavior: nil,
tax_code: nil,
tax_rates: nil,
unit_amount_decimal: nil
); end
end
# Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.
sig {
params(params: T.any(::Stripe::InvoiceItem::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceItem)
}
def self.create(params = {}, opts = {}); end
# Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they're not attached to invoices, or if it's attached to a draft invoice.
sig {
params(invoiceitem: String, params: T.any(::Stripe::InvoiceItem::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceItem)
}
def self.delete(invoiceitem, params = {}, opts = {}); end
# Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they're not attached to invoices, or if it's attached to a draft invoice.
sig {
params(params: T.any(::Stripe::InvoiceItem::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceItem)
}
def delete(params = {}, opts = {}); end
# Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.
sig {
params(params: T.any(::Stripe::InvoiceItem::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it's attached to is closed.
sig {
params(invoiceitem: String, params: T.any(::Stripe::InvoiceItem::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceItem)
}
def self.update(invoiceitem, params = {}, opts = {}); end
end
end
# typed: 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/invoicing/integration/automatic-advancement-collection), 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://docs.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
class AmountsDue < Stripe::StripeObject
# Incremental amount due for this payment in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
# The amount in cents (or local equivalent) that was paid for this payment.
sig { returns(Integer) }
def amount_paid; end
# The difference between the payment’s amount and amount_paid, in cents (or local equivalent).
sig { returns(Integer) }
def amount_remaining; end
# Number of days from when invoice is finalized until the payment is due.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# Date on which a payment plan’s payment is due.
sig { returns(T.nilable(Integer)) }
def due_date; end
# Timestamp when the payment was paid.
sig { returns(T.nilable(Integer)) }
def paid_at; end
# The status of the payment, one of `open`, `paid`, or `past_due`
sig { returns(String) }
def status; end
end
class AutomaticTax < Stripe::StripeObject
class Liability < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# If Stripe disabled automatic tax, this enum describes why.
sig { returns(T.nilable(String)) }
def disabled_reason; end
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
sig { returns(T::Boolean) }
def enabled; end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(Liability)) }
def liability; end
# The tax provider powering automatic tax.
sig { returns(T.nilable(String)) }
def provider; end
# The status of the most recent automated tax calculation for this invoice.
sig { returns(T.nilable(String)) }
def status; end
end
class ConfirmationSecret < Stripe::StripeObject
# The client_secret of the payment that Stripe creates for the invoice after finalization.
sig { returns(String) }
def client_secret; end
# The type of client_secret. Currently this is always payment_intent, referencing the default payment_intent that Stripe creates during invoice finalization
sig { returns(String) }
def type; end
end
class CustomField < Stripe::StripeObject
# The name of the custom field.
sig { returns(String) }
def name; end
# The value of the custom field.
sig { returns(String) }
def value; end
end
class CustomerAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class CustomerShipping < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(T.nilable(Address)) }
def address; end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
# Recipient name.
sig { returns(T.nilable(String)) }
def name; end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
end
class CustomerTaxId < Stripe::StripeObject
# The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
sig { returns(String) }
def type; end
# The value of the tax ID.
sig { returns(T.nilable(String)) }
def value; end
end
class FromInvoice < Stripe::StripeObject
# The relation between this invoice and the cloned invoice
sig { returns(String) }
def action; end
# The invoice that was cloned.
sig { returns(T.any(String, Stripe::Invoice)) }
def invoice; end
end
class Issuer < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
class LastFinalizationError < Stripe::StripeObject
# For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.
sig { returns(T.nilable(String)) }
def advice_code; end
# For card errors, the ID of the failed charge.
sig { returns(T.nilable(String)) }
def charge; end
# For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
sig { returns(T.nilable(String)) }
def code; end
# For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.
sig { returns(T.nilable(String)) }
def decline_code; end
# A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.
sig { returns(T.nilable(String)) }
def doc_url; end
# A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
sig { returns(T.nilable(String)) }
def message; end
# For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
sig { returns(T.nilable(String)) }
def network_advice_code; end
# For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
sig { returns(T.nilable(String)) }
def network_decline_code; end
# If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
sig { returns(T.nilable(String)) }
def param; end
# 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)
sig { returns(T.nilable(Stripe::PaymentIntent)) }
def payment_intent; end
# 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).
sig { returns(T.nilable(Stripe::PaymentMethod)) }
def payment_method; end
# If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
sig { returns(T.nilable(String)) }
def payment_method_type; end
# A URL to the request log entry in your dashboard.
sig { returns(T.nilable(String)) }
def request_log_url; end
# A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
# For example, you can 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 when you're ready to collect your customer's payment credentials.
# Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
# The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/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) might need to be run through
# [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection
# to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).
# If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),
# it automatically attaches the resulting payment method to that Customer after successful setup.
# 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 to prevent saving invalid or unoptimized payment methods.
#
# By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
#
# Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)
sig { returns(T.nilable(Stripe::SetupIntent)) }
def setup_intent; end
# Attribute for field source
sig {
returns(T.nilable(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source)))
}
def source; end
# The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`
sig { returns(String) }
def type; end
end
class Parent < Stripe::StripeObject
class QuoteDetails < Stripe::StripeObject
# The quote that generated this invoice
sig { returns(String) }
def quote; end
end
class SubscriptionDetails < Stripe::StripeObject
class PauseCollection < Stripe::StripeObject
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(T.nilable(String)) }
def behavior; end
# The time after which the subscription will resume collecting payments.
sig { returns(T.nilable(Integer)) }
def resumes_at; end
end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.
# *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
sig { returns(T.nilable(PauseCollection)) }
def pause_collection; end
# The subscription that generated this invoice
sig { returns(T.any(String, Stripe::Subscription)) }
def subscription; end
# Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
sig { returns(T.nilable(Integer)) }
def subscription_proration_date; end
end
# Details about the quote that generated this invoice
sig { returns(T.nilable(QuoteDetails)) }
def quote_details; end
# Details about the subscription that generated this invoice
sig { returns(T.nilable(SubscriptionDetails)) }
def subscription_details; end
# The type of parent that generated this invoice
sig { returns(String) }
def type; end
end
class PaymentSettings < Stripe::StripeObject
class PaymentMethodOptions < Stripe::StripeObject
class AcssDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
end
class Bancontact < Stripe::StripeObject
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(String) }
def preferred_language; end
end
class Card < Stripe::StripeObject
class Installments < Stripe::StripeObject
# Whether Installments are enabled for this Invoice.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
end
# Attribute for field installments
sig { returns(T.nilable(Installments)) }
def installments; end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
end
class CustomerBalance < Stripe::StripeObject
class BankTransfer < Stripe::StripeObject
class EuBankTransfer < Stripe::StripeObject
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
end
# Attribute for field eu_bank_transfer
sig { returns(T.nilable(EuBankTransfer)) }
def eu_bank_transfer; end
# The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(T.nilable(String)) }
def type; end
end
# Attribute for field bank_transfer
sig { returns(T.nilable(BankTransfer)) }
def bank_transfer; end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
end
class IdBankTransfer < Stripe::StripeObject; end
class Konbini < Stripe::StripeObject; end
class Pix < Stripe::StripeObject
# Determines if the amount includes the IOF tax.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
end
class SepaDebit < Stripe::StripeObject; end
class Upi < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(T.nilable(String)) }
def amount_type; end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
end
class UsBankAccount < Stripe::StripeObject
class FinancialConnections < Stripe::StripeObject
class Filters < Stripe::StripeObject
# The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
# The institution to use to filter for possible accounts to link.
sig { returns(T.nilable(String)) }
def institution; end
end
# Attribute for field filters
sig { returns(T.nilable(Filters)) }
def filters; end
# The list of permissions to request. The `payment_method` permission must be included.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
# Data features requested to be retrieved upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
end
# Attribute for field financial_connections
sig { returns(T.nilable(FinancialConnections)) }
def financial_connections; end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
end
# If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(Bancontact)) }
def bancontact; end
# If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(Card)) }
def card; end
# If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(CustomerBalance)) }
def customer_balance; end
# If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(IdBankTransfer)) }
def id_bank_transfer; end
# If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(Konbini)) }
def konbini; end
# If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(Pix)) }
def pix; end
# If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(Upi)) }
def upi; end
# If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
end
# ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.
sig { returns(T.nilable(String)) }
def default_mandate; end
# Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
sig { returns(T.nilable(PaymentMethodOptions)) }
def payment_method_options; end
# The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
end
class Rendering < Stripe::StripeObject
class Pdf < Stripe::StripeObject
# Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.
sig { returns(T.nilable(String)) }
def page_size; end
end
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
sig { returns(T.nilable(String)) }
def amount_tax_display; end
# Invoice pdf rendering options
sig { returns(T.nilable(Pdf)) }
def pdf; end
# ID of the rendering template that the invoice is formatted by.
sig { returns(T.nilable(String)) }
def template; end
# Version of the rendering template that the invoice is using.
sig { returns(T.nilable(Integer)) }
def template_version; end
end
class ShippingCost < Stripe::StripeObject
class Tax < Stripe::StripeObject
# Amount of tax applied for this rate.
sig { returns(Integer) }
def amount; end
# Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
#
# Related guide: [Tax rates](/billing/taxes/tax-rates)
sig { returns(Stripe::TaxRate) }
def rate; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(T.nilable(String)) }
def taxability_reason; end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(T.nilable(Integer)) }
def taxable_amount; end
end
# Total shipping cost before any taxes are applied.
sig { returns(Integer) }
def amount_subtotal; end
# Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
sig { returns(Integer) }
def amount_tax; end
# Total shipping cost after taxes are applied.
sig { returns(Integer) }
def amount_total; end
# The ID of the ShippingRate for this invoice.
sig { returns(T.nilable(T.any(String, Stripe::ShippingRate))) }
def shipping_rate; end
# The taxes applied to the shipping rate.
sig { returns(T.nilable(T::Array[Tax])) }
def taxes; end
end
class ShippingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(T.nilable(Address)) }
def address; end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
# Recipient name.
sig { returns(T.nilable(String)) }
def name; end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
end
class StatusTransitions < Stripe::StripeObject
# The time that the invoice draft was finalized.
sig { returns(T.nilable(Integer)) }
def finalized_at; end
# The time that the invoice was marked uncollectible.
sig { returns(T.nilable(Integer)) }
def marked_uncollectible_at; end
# The time that the invoice was paid.
sig { returns(T.nilable(Integer)) }
def paid_at; end
# The time that the invoice was voided.
sig { returns(T.nilable(Integer)) }
def voided_at; end
end
class ThresholdReason < Stripe::StripeObject
class ItemReason < Stripe::StripeObject
# The IDs of the line items that triggered the threshold invoice.
sig { returns(T::Array[String]) }
def line_item_ids; end
# The quantity threshold boundary that applied to the given line item.
sig { returns(Integer) }
def usage_gte; end
end
# The total invoice amount threshold boundary if it triggered the threshold invoice.
sig { returns(T.nilable(Integer)) }
def amount_gte; end
# Indicates which line items triggered a threshold invoice.
sig { returns(T::Array[ItemReason]) }
def item_reasons; end
end
class TotalDiscountAmount < Stripe::StripeObject
# The amount, in cents (or local equivalent), of the discount.
sig { returns(Integer) }
def amount; end
# The discount that was applied to get this discount amount.
sig { returns(T.any(String, Stripe::Discount)) }
def discount; end
end
class TotalMarginAmount < Stripe::StripeObject
# The amount, in cents (or local equivalent), of the reduction in line item amount.
sig { returns(Integer) }
def amount; end
# The margin that was applied to get this margin amount.
sig { returns(T.any(String, Stripe::Margin)) }
def margin; end
end
class TotalPretaxCreditAmount < Stripe::StripeObject
# The amount, in cents (or local equivalent), of the pretax credit amount.
sig { returns(Integer) }
def amount; end
# The credit balance transaction that was applied to get this pretax credit amount.
sig { returns(T.nilable(T.any(String, Stripe::Billing::CreditBalanceTransaction))) }
def credit_balance_transaction; end
# The discount that was applied to get this pretax credit amount.
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
def discount; end
# The margin that was applied to get this pretax credit amount.
sig { returns(T.nilable(T.any(String, Stripe::Margin))) }
def margin; end
# Type of the pretax credit amount referenced.
sig { returns(String) }
def type; end
end
class TotalTax < Stripe::StripeObject
class TaxRateDetails < Stripe::StripeObject
# Attribute for field tax_rate
sig { returns(String) }
def tax_rate; end
end
# The amount of the tax, in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
# Whether this tax is inclusive or exclusive.
sig { returns(String) }
def tax_behavior; end
# Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
sig { returns(T.nilable(TaxRateDetails)) }
def tax_rate_details; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(String) }
def taxability_reason; end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(T.nilable(Integer)) }
def taxable_amount; end
# The type of tax information.
sig { returns(String) }
def type; end
end
# The country of the business associated with this invoice, most often the business creating the invoice.
sig { returns(T.nilable(String)) }
def account_country; end
# The public name of the business associated with this invoice, most often the business creating the invoice.
sig { returns(T.nilable(String)) }
def account_name; end
# The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
def account_tax_ids; end
# Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.
sig { returns(Integer) }
def amount_due; end
# Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
sig { returns(Integer) }
def amount_overpaid; end
# The amount, in cents (or local equivalent), that was paid.
sig { returns(Integer) }
def amount_paid; end
# The difference between amount_due and amount_paid, in cents (or local equivalent).
sig { returns(Integer) }
def amount_remaining; end
# This is the sum of all the shipping amounts.
sig { returns(Integer) }
def amount_shipping; end
# List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.
sig { returns(T.nilable(T::Array[AmountsDue])) }
def amounts_due; end
# ID of the Connect Application that created the invoice.
sig { returns(T.nilable(T.any(String, Stripe::Application))) }
def application; end
# Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
sig { returns(Integer) }
def attempt_count; end
# Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.
sig { returns(T::Boolean) }
def attempted; end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def auto_advance; end
# Attribute for field automatic_tax
sig { returns(AutomaticTax) }
def automatic_tax; end
# The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized.
sig { returns(T.nilable(Integer)) }
def automatically_finalizes_at; end
# Indicates the reason why the invoice was created.
#
# * `manual`: Unrelated to a subscription, for example, created via the invoice editor.
# * `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
# * `subscription_create`: A new subscription was created.
# * `subscription_cycle`: A subscription advanced into a new period.
# * `subscription_threshold`: A subscription reached a billing threshold.
# * `subscription_update`: A subscription was updated.
# * `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.
sig { returns(T.nilable(String)) }
def billing_reason; end
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
sig { returns(String) }
def collection_method; end
# The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
sig { returns(T.nilable(ConfirmationSecret)) }
def confirmation_secret; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# Custom fields displayed on the invoice.
sig { returns(T.nilable(T::Array[CustomField])) }
def custom_fields; end
# The ID of the customer who will be billed.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# The ID of the account who will be billed.
sig { returns(T.nilable(String)) }
def customer_account; end
# The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.
sig { returns(T.nilable(CustomerAddress)) }
def customer_address; end
# The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.
sig { returns(T.nilable(String)) }
def customer_email; end
# The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated.
sig { returns(T.nilable(String)) }
def customer_name; end
# The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated.
sig { returns(T.nilable(String)) }
def customer_phone; end
# The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated.
sig { returns(T.nilable(CustomerShipping)) }
def customer_shipping; end
# The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated.
sig { returns(T.nilable(String)) }
def customer_tax_exempt; end
# The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.
sig { returns(T.nilable(T::Array[CustomerTaxId])) }
def customer_tax_ids; end
# The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::Margin)])) }
def default_margins; end
# ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def default_payment_method; end
# ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
sig {
returns(T.nilable(T.any(String, T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source))))
}
def default_source; end
# The tax rates applied to this invoice, if any.
sig { returns(T::Array[Stripe::TaxRate]) }
def default_tax_rates; end
# An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
sig { returns(T.nilable(String)) }
def description; end
# The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
sig { returns(T::Array[T.any(String, Stripe::Discount)]) }
def discounts; end
# The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def due_date; end
# The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
sig { returns(T.nilable(Integer)) }
def effective_at; end
# Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
sig { returns(T.nilable(Integer)) }
def ending_balance; end
# Footer displayed on the invoice.
sig { returns(T.nilable(String)) }
def footer; end
# Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.
sig { returns(T.nilable(FromInvoice)) }
def from_invoice; end
# The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
sig { returns(T.nilable(String)) }
def hosted_invoice_url; end
# Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`.
sig { returns(T.nilable(String)) }
def id; end
# The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
sig { returns(T.nilable(String)) }
def invoice_pdf; end
# Attribute for field issuer
sig { returns(Issuer) }
def issuer; end
# The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
sig { returns(T.nilable(LastFinalizationError)) }
def last_finalization_error; end
# The ID of the most recent non-draft revision of this invoice
sig { returns(T.nilable(T.any(String, Stripe::Invoice))) }
def latest_revision; end
# The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.
sig { returns(Stripe::ListObject) }
def lines; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.
sig { returns(T.nilable(Integer)) }
def next_payment_attempt; end
# A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
sig { returns(T.nilable(String)) }
def number; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def on_behalf_of; end
# The parent that generated this invoice
sig { returns(T.nilable(Parent)) }
def parent; end
# Attribute for field payment_settings
sig { returns(PaymentSettings) }
def payment_settings; end
# Payments for this invoice
sig { returns(T.nilable(Stripe::ListObject)) }
def payments; end
# End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.
sig { returns(Integer) }
def period_end; end
# Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.
sig { returns(Integer) }
def period_start; end
# Total amount of all post-payment credit notes issued for this invoice.
sig { returns(Integer) }
def post_payment_credit_notes_amount; end
# Total amount of all pre-payment credit notes issued for this invoice.
sig { returns(Integer) }
def pre_payment_credit_notes_amount; end
# This is the transaction number that appears on email receipts sent for this invoice.
sig { returns(T.nilable(String)) }
def receipt_number; end
# The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
sig { returns(T.nilable(Rendering)) }
def rendering; end
# The details of the cost of shipping, including the ShippingRate applied on the invoice.
sig { returns(T.nilable(ShippingCost)) }
def shipping_cost; end
# Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.
sig { returns(T.nilable(ShippingDetails)) }
def shipping_details; end
# Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
sig { returns(Integer) }
def starting_balance; end
# Extra information about an invoice for the customer's credit card statement.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
# The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)
sig { returns(T.nilable(String)) }
def status; end
# Attribute for field status_transitions
sig { returns(StatusTransitions) }
def status_transitions; end
# Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
sig { returns(Integer) }
def subtotal; end
# The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
sig { returns(T.nilable(Integer)) }
def subtotal_excluding_tax; end
# ID of the test clock this invoice belongs to.
sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
def test_clock; end
# Attribute for field threshold_reason
sig { returns(T.nilable(ThresholdReason)) }
def threshold_reason; end
# Total after discounts and taxes.
sig { returns(Integer) }
def total; end
# The aggregate amounts calculated per discount across all line items.
sig { returns(T.nilable(T::Array[TotalDiscountAmount])) }
def total_discount_amounts; end
# The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
sig { returns(T.nilable(Integer)) }
def total_excluding_tax; end
# The aggregate amounts calculated per margin across all line items.
sig { returns(T.nilable(T::Array[TotalMarginAmount])) }
def total_margin_amounts; end
# Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
sig { returns(T.nilable(T::Array[TotalPretaxCreditAmount])) }
def total_pretax_credit_amounts; end
# The aggregate tax information of all line items.
sig { returns(T.nilable(T::Array[TotalTax])) }
def total_taxes; end
# Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
sig { returns(T.nilable(Integer)) }
def webhooks_delivered_at; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams; end
class UpdateParams < Stripe::RequestParams
class AmountsDue < Stripe::RequestParams
# The amount in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Number of days from when invoice is finalized until the payment is due.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(String) }
def description; end
sig { params(_description: String).returns(String) }
def description=(_description); end
# Date on which a payment plan’s payment is due.
sig { returns(T.nilable(Integer)) }
def due_date; end
sig { params(_due_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def due_date=(_due_date); end
sig {
params(amount: Integer, days_until_due: T.nilable(Integer), description: String, due_date: T.nilable(Integer)).void
}
def initialize(amount: nil, days_until_due: nil, description: nil, due_date: nil); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(::Stripe::Invoice::UpdateParams::AutomaticTax::Liability)) }
def liability; end
sig {
params(_liability: T.nilable(::Stripe::Invoice::UpdateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::Invoice::UpdateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::Invoice::UpdateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class CustomField < Stripe::RequestParams
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The value of the custom field. This may be up to 140 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Invoice::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Invoice::UpdateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Invoice::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Invoice::UpdateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::Invoice::UpdateParams::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Invoice::UpdateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Invoice::UpdateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Invoice::UpdateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
class PaymentSettings < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig { params(transaction_type: T.nilable(String)).void }
def initialize(transaction_type: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
}
def initialize(mandate_options: nil, verification_method: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
sig { params(preferred_language: T.nilable(String)).void }
def initialize(preferred_language: nil); end
end
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
class Plan < Stripe::RequestParams
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
sig { returns(T.nilable(Integer)) }
def count; end
sig { params(_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def count=(_count); end
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
# One of `month`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(count: T.nilable(Integer), interval: T.nilable(String), type: String).void
}
def initialize(count: nil, interval: nil, type: nil); end
end
# Setting to true enables installments for this invoice.
# Setting to false will prevent any selected plan from applying to a payment.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# The selected installment plan to use for this invoice.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan; end
sig {
params(_plan: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::Installments::Plan))).returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan=(_plan); end
sig {
params(enabled: T.nilable(T::Boolean), plan: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::Installments::Plan))).void
}
def initialize(enabled: nil, plan: nil); end
end
# Installment configuration for payments attempted on this invoice.
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
sig {
returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::Installments))
}
def installments; end
sig {
params(_installments: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::Installments)).returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::Installments))
}
def installments=(_installments); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
sig {
params(installments: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::Installments), request_three_d_secure: T.nilable(String)).void
}
def initialize(installments: nil, request_three_d_secure: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), type: T.nilable(String)).void
}
def initialize(eu_bank_transfer: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
sig {
params(bank_transfer: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil); end
end
class IdBankTransfer < Stripe::RequestParams; end
class Konbini < Stripe::RequestParams; end
class Pix < Stripe::RequestParams
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
sig { params(amount_includes_iof: T.nilable(String)).void }
def initialize(amount_includes_iof: nil); end
end
class SepaDebit < Stripe::RequestParams; end
class Upi < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), description: T.nilable(String), end_date: T.nilable(Integer)).void
}
def initialize(amount: nil, amount_type: nil, description: nil, end_date: nil); end
end
# Configuration options for setting up an eMandate
sig {
returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions)).returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
sig {
params(filters: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String])).void
}
def initialize(filters: nil, permissions: nil, prefetch: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections), verification_method: T.nilable(String)).void
}
def initialize(financial_connections: nil, verification_method: nil); end
end
# If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit))).returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit=(_acss_debit); end
# If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact)))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact))).returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact)))
}
def bancontact=(_bancontact); end
# If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Card)))
}
def card; end
sig {
params(_card: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Card))).returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Card)))
}
def card=(_card); end
# If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance))).returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance=(_customer_balance); end
# If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer))).returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer=(_id_bank_transfer); end
# If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini)))
}
def konbini; end
sig {
params(_konbini: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini))).returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini)))
}
def konbini=(_konbini); end
# If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix)))
}
def pix; end
sig {
params(_pix: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix))).returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix)))
}
def pix=(_pix); end
# If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit))).returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit=(_sepa_debit); end
# If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi)))
}
def upi; end
sig {
params(_upi: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi))).returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi)))
}
def upi=(_upi); end
# If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
sig {
params(acss_debit: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)), bancontact: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact)), card: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Card)), customer_balance: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)), id_bank_transfer: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)), konbini: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini)), pix: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix)), sepa_debit: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)), upi: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi)), us_bank_account: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))).void
}
def initialize(
acss_debit: nil,
bancontact: nil,
card: nil,
customer_balance: nil,
id_bank_transfer: nil,
konbini: nil,
pix: nil,
sepa_debit: nil,
upi: nil,
us_bank_account: nil
); end
end
# ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.
sig { returns(T.nilable(String)) }
def default_mandate; end
sig { params(_default_mandate: T.nilable(String)).returns(T.nilable(String)) }
def default_mandate=(_default_mandate); end
# Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
sig {
returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions)).returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def payment_method_types=(_payment_method_types); end
sig {
params(default_mandate: T.nilable(String), payment_method_options: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings::PaymentMethodOptions), payment_method_types: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
default_mandate: nil,
payment_method_options: nil,
payment_method_types: nil
); end
end
class Rendering < Stripe::RequestParams
class Pdf < Stripe::RequestParams
# Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`.
# If set to `auto`, invoice PDF page size defaults to `a4` for customers with
# Japanese locale and `letter` for customers with other locales.
sig { returns(T.nilable(String)) }
def page_size; end
sig { params(_page_size: T.nilable(String)).returns(T.nilable(String)) }
def page_size=(_page_size); end
sig { params(page_size: T.nilable(String)).void }
def initialize(page_size: nil); end
end
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(T.any(String, String))) }
def amount_tax_display; end
sig {
params(_amount_tax_display: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def amount_tax_display=(_amount_tax_display); end
# Invoice pdf rendering options
sig { returns(T.nilable(::Stripe::Invoice::UpdateParams::Rendering::Pdf)) }
def pdf; end
sig {
params(_pdf: T.nilable(::Stripe::Invoice::UpdateParams::Rendering::Pdf)).returns(T.nilable(::Stripe::Invoice::UpdateParams::Rendering::Pdf))
}
def pdf=(_pdf); end
# ID of the invoice rendering template to use for this invoice.
sig { returns(T.nilable(String)) }
def template; end
sig { params(_template: T.nilable(String)).returns(T.nilable(String)) }
def template=(_template); end
# The specific version of invoice rendering template to use for this invoice.
sig { returns(T.nilable(T.any(String, Integer))) }
def template_version; end
sig {
params(_template_version: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def template_version=(_template_version); end
sig {
params(amount_tax_display: T.nilable(T.any(String, String)), pdf: T.nilable(::Stripe::Invoice::UpdateParams::Rendering::Pdf), template: T.nilable(String), template_version: T.nilable(T.any(String, Integer))).void
}
def initialize(amount_tax_display: nil, pdf: nil, template: nil, template_version: nil); end
end
class ShippingCost < Stripe::RequestParams
class ShippingRateData < Stripe::RequestParams
class DeliveryEstimate < Stripe::RequestParams
class Maximum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
class Minimum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
sig {
returns(T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum; end
sig {
params(_maximum: T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum)).returns(T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum=(_maximum); end
# The lower bound of the estimated range. If empty, represents no lower bound.
sig {
returns(T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum; end
sig {
params(_minimum: T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum)).returns(T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum=(_minimum); end
sig {
params(maximum: T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum), minimum: T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum)).void
}
def initialize(maximum: nil, minimum: nil); end
end
class FixedAmount < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig { params(amount: Integer, tax_behavior: T.nilable(String)).void }
def initialize(amount: nil, tax_behavior: nil); end
end
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(amount: Integer, currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions])).void
}
def initialize(amount: nil, currency: nil, currency_options: nil); end
end
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig {
returns(T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate; end
sig {
params(_delivery_estimate: T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate)).returns(T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate=(_delivery_estimate); end
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
sig {
returns(T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::FixedAmount))
}
def fixed_amount; end
sig {
params(_fixed_amount: T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::FixedAmount)).returns(T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::FixedAmount))
}
def fixed_amount=(_fixed_amount); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The type of calculation to use on the shipping rate.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(delivery_estimate: T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate), display_name: String, fixed_amount: T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData::FixedAmount), metadata: T.nilable(T::Hash[String, String]), tax_behavior: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
delivery_estimate: nil,
display_name: nil,
fixed_amount: nil,
metadata: nil,
tax_behavior: nil,
tax_code: nil,
type: nil
); end
end
# The ID of the shipping rate to use for this order.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
# Parameters to create a new ad-hoc shipping rate for this order.
sig { returns(T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData)) }
def shipping_rate_data; end
sig {
params(_shipping_rate_data: T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData)).returns(T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData))
}
def shipping_rate_data=(_shipping_rate_data); end
sig {
params(shipping_rate: T.nilable(String), shipping_rate_data: T.nilable(::Stripe::Invoice::UpdateParams::ShippingCost::ShippingRateData)).void
}
def initialize(shipping_rate: nil, shipping_rate_data: nil); end
end
class ShippingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address
sig { returns(::Stripe::Invoice::UpdateParams::ShippingDetails::Address) }
def address; end
sig {
params(_address: ::Stripe::Invoice::UpdateParams::ShippingDetails::Address).returns(::Stripe::Invoice::UpdateParams::ShippingDetails::Address)
}
def address=(_address); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension)
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: ::Stripe::Invoice::UpdateParams::ShippingDetails::Address, name: String, phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateParams::AmountsDue])))
}
def amounts_due; end
sig {
params(_amounts_due: T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateParams::AmountsDue]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateParams::AmountsDue])))
}
def amounts_due=(_amounts_due); end
# A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice.
sig { returns(T.nilable(T::Boolean)) }
def auto_advance; end
sig { params(_auto_advance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_advance=(_auto_advance); end
# Settings for automatic tax lookup for this invoice.
sig { returns(T.nilable(::Stripe::Invoice::UpdateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::Invoice::UpdateParams::AutomaticTax)).returns(T.nilable(::Stripe::Invoice::UpdateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state. To turn off automatic finalization, set `auto_advance` to false.
sig { returns(T.nilable(Integer)) }
def automatically_finalizes_at; end
sig { params(_automatically_finalizes_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def automatically_finalizes_at=(_automatically_finalizes_at); end
# Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateParams::CustomField])))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateParams::CustomField]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateParams::CustomField])))
}
def custom_fields=(_custom_fields); end
# The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_margins; end
sig {
params(_default_margins: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_margins=(_default_margins); end
# ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
sig { returns(T.nilable(String)) }
def default_source; end
sig { params(_default_source: T.nilable(String)).returns(T.nilable(String)) }
def default_source=(_default_source); end
# The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts.
sig { returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateParams::Discount]))) }
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateParams::Discount])))
}
def discounts=(_discounts); end
# The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.
sig { returns(T.nilable(Integer)) }
def due_date; end
sig { params(_due_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def due_date=(_due_date); end
# The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
sig { returns(T.nilable(T.any(String, Integer))) }
def effective_at; end
sig {
params(_effective_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def effective_at=(_effective_at); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Footer to be displayed on the invoice.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig { returns(T.nilable(::Stripe::Invoice::UpdateParams::Issuer)) }
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::Invoice::UpdateParams::Issuer)).returns(T.nilable(::Stripe::Invoice::UpdateParams::Issuer))
}
def issuer=(_issuer); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.
sig { returns(T.nilable(String)) }
def number; end
sig { params(_number: T.nilable(String)).returns(T.nilable(String)) }
def number=(_number); end
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
sig { returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings)) }
def payment_settings; end
sig {
params(_payment_settings: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings)).returns(T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings))
}
def payment_settings=(_payment_settings); end
# The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
sig { returns(T.nilable(::Stripe::Invoice::UpdateParams::Rendering)) }
def rendering; end
sig {
params(_rendering: T.nilable(::Stripe::Invoice::UpdateParams::Rendering)).returns(T.nilable(::Stripe::Invoice::UpdateParams::Rendering))
}
def rendering=(_rendering); end
# Settings for the cost of shipping for this invoice.
sig { returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::ShippingCost))) }
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::ShippingCost))).returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::ShippingCost)))
}
def shipping_cost=(_shipping_cost); end
# Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.
sig { returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::ShippingDetails))) }
def shipping_details; end
sig {
params(_shipping_details: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::ShippingDetails))).returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::ShippingDetails)))
}
def shipping_details=(_shipping_details); end
# Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value.
sig { returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::TransferData))) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::TransferData))).returns(T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::TransferData)))
}
def transfer_data=(_transfer_data); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), amounts_due: T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateParams::AmountsDue])), application_fee_amount: T.nilable(Integer), auto_advance: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::Invoice::UpdateParams::AutomaticTax), automatically_finalizes_at: T.nilable(Integer), collection_method: T.nilable(String), custom_fields: T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateParams::CustomField])), days_until_due: T.nilable(Integer), default_margins: T.nilable(T.any(String, T::Array[String])), default_payment_method: T.nilable(String), default_source: T.nilable(String), default_tax_rates: T.nilable(T.any(String, T::Array[String])), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateParams::Discount])), due_date: T.nilable(Integer), effective_at: T.nilable(T.any(String, Integer)), expand: T.nilable(T::Array[String]), footer: T.nilable(String), issuer: T.nilable(::Stripe::Invoice::UpdateParams::Issuer), metadata: T.nilable(T.any(String, T::Hash[String, String])), number: T.nilable(String), on_behalf_of: T.nilable(String), payment_settings: T.nilable(::Stripe::Invoice::UpdateParams::PaymentSettings), rendering: T.nilable(::Stripe::Invoice::UpdateParams::Rendering), shipping_cost: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::ShippingCost)), shipping_details: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::ShippingDetails)), statement_descriptor: T.nilable(String), transfer_data: T.nilable(T.any(String, ::Stripe::Invoice::UpdateParams::TransferData))).void
}
def initialize(
account_tax_ids: nil,
amounts_due: nil,
application_fee_amount: nil,
auto_advance: nil,
automatic_tax: nil,
automatically_finalizes_at: nil,
collection_method: nil,
custom_fields: nil,
days_until_due: nil,
default_margins: nil,
default_payment_method: nil,
default_source: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
due_date: nil,
effective_at: nil,
expand: nil,
footer: nil,
issuer: nil,
metadata: nil,
number: nil,
on_behalf_of: nil,
payment_settings: nil,
rendering: nil,
shipping_cost: nil,
shipping_details: nil,
statement_descriptor: nil,
transfer_data: nil
); end
end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class DueDate < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# Only return invoices that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Invoice::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Invoice::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Invoice::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return invoices for the customer specified by this customer ID.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Only return invoices for the account specified by this account ID.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Attribute for param field due_date
sig { returns(T.nilable(T.any(::Stripe::Invoice::ListParams::DueDate, Integer))) }
def due_date; end
sig {
params(_due_date: T.nilable(T.any(::Stripe::Invoice::ListParams::DueDate, Integer))).returns(T.nilable(T.any(::Stripe::Invoice::ListParams::DueDate, Integer)))
}
def due_date=(_due_date); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# Only return invoices for the subscription specified by this subscription ID.
sig { returns(T.nilable(String)) }
def subscription; end
sig { params(_subscription: T.nilable(String)).returns(T.nilable(String)) }
def subscription=(_subscription); end
sig {
params(collection_method: T.nilable(String), created: T.nilable(T.any(::Stripe::Invoice::ListParams::Created, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), due_date: T.nilable(T.any(::Stripe::Invoice::ListParams::DueDate, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String), subscription: T.nilable(String)).void
}
def initialize(
collection_method: nil,
created: nil,
customer: nil,
customer_account: nil,
due_date: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil,
subscription: nil
); end
end
class CreateParams < Stripe::RequestParams
class AmountsDue < Stripe::RequestParams
# The amount in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Number of days from when invoice is finalized until the payment is due.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(String) }
def description; end
sig { params(_description: String).returns(String) }
def description=(_description); end
# Date on which a payment plan’s payment is due.
sig { returns(T.nilable(Integer)) }
def due_date; end
sig { params(_due_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def due_date=(_due_date); end
sig {
params(amount: Integer, days_until_due: T.nilable(Integer), description: String, due_date: T.nilable(Integer)).void
}
def initialize(amount: nil, days_until_due: nil, description: nil, due_date: nil); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(::Stripe::Invoice::CreateParams::AutomaticTax::Liability)) }
def liability; end
sig {
params(_liability: T.nilable(::Stripe::Invoice::CreateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::Invoice::CreateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::Invoice::CreateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class CustomField < Stripe::RequestParams
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The value of the custom field. This may be up to 140 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Invoice::CreateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Invoice::CreateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Invoice::CreateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Invoice::CreateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::Invoice::CreateParams::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Invoice::CreateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Invoice::CreateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Invoice::CreateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class FromInvoice < Stripe::RequestParams
# The relation between the new invoice and the original invoice. Currently, only 'revision' is permitted
sig { returns(String) }
def action; end
sig { params(_action: String).returns(String) }
def action=(_action); end
# The `id` of the invoice that will be cloned.
sig { returns(String) }
def invoice; end
sig { params(_invoice: String).returns(String) }
def invoice=(_invoice); end
sig { params(action: String, invoice: String).void }
def initialize(action: nil, invoice: nil); end
end
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
class PaymentSettings < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig { params(transaction_type: T.nilable(String)).void }
def initialize(transaction_type: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
}
def initialize(mandate_options: nil, verification_method: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
sig { params(preferred_language: T.nilable(String)).void }
def initialize(preferred_language: nil); end
end
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
class Plan < Stripe::RequestParams
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
sig { returns(T.nilable(Integer)) }
def count; end
sig { params(_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def count=(_count); end
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
# One of `month`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(count: T.nilable(Integer), interval: T.nilable(String), type: String).void
}
def initialize(count: nil, interval: nil, type: nil); end
end
# Setting to true enables installments for this invoice.
# Setting to false will prevent any selected plan from applying to a payment.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# The selected installment plan to use for this invoice.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan; end
sig {
params(_plan: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Card::Installments::Plan))).returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan=(_plan); end
sig {
params(enabled: T.nilable(T::Boolean), plan: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Card::Installments::Plan))).void
}
def initialize(enabled: nil, plan: nil); end
end
# Installment configuration for payments attempted on this invoice.
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
sig {
returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Card::Installments))
}
def installments; end
sig {
params(_installments: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Card::Installments)).returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Card::Installments))
}
def installments=(_installments); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
sig {
params(installments: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Card::Installments), request_three_d_secure: T.nilable(String)).void
}
def initialize(installments: nil, request_three_d_secure: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), type: T.nilable(String)).void
}
def initialize(eu_bank_transfer: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
sig {
params(bank_transfer: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil); end
end
class IdBankTransfer < Stripe::RequestParams; end
class Konbini < Stripe::RequestParams; end
class Pix < Stripe::RequestParams
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
sig { params(amount_includes_iof: T.nilable(String)).void }
def initialize(amount_includes_iof: nil); end
end
class SepaDebit < Stripe::RequestParams; end
class Upi < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), description: T.nilable(String), end_date: T.nilable(Integer)).void
}
def initialize(amount: nil, amount_type: nil, description: nil, end_date: nil); end
end
# Configuration options for setting up an eMandate
sig {
returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions)).returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
sig {
params(filters: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String])).void
}
def initialize(filters: nil, permissions: nil, prefetch: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections), verification_method: T.nilable(String)).void
}
def initialize(financial_connections: nil, verification_method: nil); end
end
# If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit))).returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit=(_acss_debit); end
# If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact)))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact))).returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact)))
}
def bancontact=(_bancontact); end
# If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Card)))
}
def card; end
sig {
params(_card: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Card))).returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Card)))
}
def card=(_card); end
# If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance))).returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance=(_customer_balance); end
# If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer))).returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer=(_id_bank_transfer); end
# If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini)))
}
def konbini; end
sig {
params(_konbini: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini))).returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini)))
}
def konbini=(_konbini); end
# If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Pix)))
}
def pix; end
sig {
params(_pix: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Pix))).returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Pix)))
}
def pix=(_pix); end
# If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit))).returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit=(_sepa_debit); end
# If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Upi)))
}
def upi; end
sig {
params(_upi: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Upi))).returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Upi)))
}
def upi=(_upi); end
# If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
sig {
params(acss_debit: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)), bancontact: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact)), card: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Card)), customer_balance: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)), id_bank_transfer: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)), konbini: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini)), pix: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Pix)), sepa_debit: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)), upi: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::Upi)), us_bank_account: T.nilable(T.any(String, ::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))).void
}
def initialize(
acss_debit: nil,
bancontact: nil,
card: nil,
customer_balance: nil,
id_bank_transfer: nil,
konbini: nil,
pix: nil,
sepa_debit: nil,
upi: nil,
us_bank_account: nil
); end
end
# ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.
sig { returns(T.nilable(String)) }
def default_mandate; end
sig { params(_default_mandate: T.nilable(String)).returns(T.nilable(String)) }
def default_mandate=(_default_mandate); end
# Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
sig {
returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions)).returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def payment_method_types=(_payment_method_types); end
sig {
params(default_mandate: T.nilable(String), payment_method_options: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings::PaymentMethodOptions), payment_method_types: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
default_mandate: nil,
payment_method_options: nil,
payment_method_types: nil
); end
end
class Rendering < Stripe::RequestParams
class Pdf < Stripe::RequestParams
# Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`.
# If set to `auto`, invoice PDF page size defaults to `a4` for customers with
# Japanese locale and `letter` for customers with other locales.
sig { returns(T.nilable(String)) }
def page_size; end
sig { params(_page_size: T.nilable(String)).returns(T.nilable(String)) }
def page_size=(_page_size); end
sig { params(page_size: T.nilable(String)).void }
def initialize(page_size: nil); end
end
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(T.any(String, String))) }
def amount_tax_display; end
sig {
params(_amount_tax_display: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def amount_tax_display=(_amount_tax_display); end
# Invoice pdf rendering options
sig { returns(T.nilable(::Stripe::Invoice::CreateParams::Rendering::Pdf)) }
def pdf; end
sig {
params(_pdf: T.nilable(::Stripe::Invoice::CreateParams::Rendering::Pdf)).returns(T.nilable(::Stripe::Invoice::CreateParams::Rendering::Pdf))
}
def pdf=(_pdf); end
# ID of the invoice rendering template to use for this invoice.
sig { returns(T.nilable(String)) }
def template; end
sig { params(_template: T.nilable(String)).returns(T.nilable(String)) }
def template=(_template); end
# The specific version of invoice rendering template to use for this invoice.
sig { returns(T.nilable(T.any(String, Integer))) }
def template_version; end
sig {
params(_template_version: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def template_version=(_template_version); end
sig {
params(amount_tax_display: T.nilable(T.any(String, String)), pdf: T.nilable(::Stripe::Invoice::CreateParams::Rendering::Pdf), template: T.nilable(String), template_version: T.nilable(T.any(String, Integer))).void
}
def initialize(amount_tax_display: nil, pdf: nil, template: nil, template_version: nil); end
end
class ShippingCost < Stripe::RequestParams
class ShippingRateData < Stripe::RequestParams
class DeliveryEstimate < Stripe::RequestParams
class Maximum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
class Minimum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
sig {
returns(T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum; end
sig {
params(_maximum: T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum)).returns(T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum=(_maximum); end
# The lower bound of the estimated range. If empty, represents no lower bound.
sig {
returns(T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum; end
sig {
params(_minimum: T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum)).returns(T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum=(_minimum); end
sig {
params(maximum: T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum), minimum: T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum)).void
}
def initialize(maximum: nil, minimum: nil); end
end
class FixedAmount < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig { params(amount: Integer, tax_behavior: T.nilable(String)).void }
def initialize(amount: nil, tax_behavior: nil); end
end
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(amount: Integer, currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions])).void
}
def initialize(amount: nil, currency: nil, currency_options: nil); end
end
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig {
returns(T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate; end
sig {
params(_delivery_estimate: T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate)).returns(T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate=(_delivery_estimate); end
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
sig {
returns(T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::FixedAmount))
}
def fixed_amount; end
sig {
params(_fixed_amount: T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::FixedAmount)).returns(T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::FixedAmount))
}
def fixed_amount=(_fixed_amount); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The type of calculation to use on the shipping rate.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(delivery_estimate: T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate), display_name: String, fixed_amount: T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData::FixedAmount), metadata: T.nilable(T::Hash[String, String]), tax_behavior: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
delivery_estimate: nil,
display_name: nil,
fixed_amount: nil,
metadata: nil,
tax_behavior: nil,
tax_code: nil,
type: nil
); end
end
# The ID of the shipping rate to use for this order.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
# Parameters to create a new ad-hoc shipping rate for this order.
sig { returns(T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData)) }
def shipping_rate_data; end
sig {
params(_shipping_rate_data: T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData)).returns(T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData))
}
def shipping_rate_data=(_shipping_rate_data); end
sig {
params(shipping_rate: T.nilable(String), shipping_rate_data: T.nilable(::Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData)).void
}
def initialize(shipping_rate: nil, shipping_rate_data: nil); end
end
class ShippingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address
sig { returns(::Stripe::Invoice::CreateParams::ShippingDetails::Address) }
def address; end
sig {
params(_address: ::Stripe::Invoice::CreateParams::ShippingDetails::Address).returns(::Stripe::Invoice::CreateParams::ShippingDetails::Address)
}
def address=(_address); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension)
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: ::Stripe::Invoice::CreateParams::ShippingDetails::Address, name: String, phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreateParams::AmountsDue])))
}
def amounts_due; end
sig {
params(_amounts_due: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreateParams::AmountsDue]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreateParams::AmountsDue])))
}
def amounts_due=(_amounts_due); end
# A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# 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. Defaults to false.
sig { returns(T.nilable(T::Boolean)) }
def auto_advance; end
sig { params(_auto_advance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_advance=(_auto_advance); end
# Settings for automatic tax lookup for this invoice.
sig { returns(T.nilable(::Stripe::Invoice::CreateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::Invoice::CreateParams::AutomaticTax)).returns(T.nilable(::Stripe::Invoice::CreateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state.
sig { returns(T.nilable(Integer)) }
def automatically_finalizes_at; end
sig { params(_automatically_finalizes_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def automatically_finalizes_at=(_automatically_finalizes_at); end
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# The currency to create this invoice in. Defaults to that of `customer` if not specified.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# A list of up to 4 custom fields to be displayed on the invoice.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreateParams::CustomField])))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreateParams::CustomField]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreateParams::CustomField])))
}
def custom_fields=(_custom_fields); end
# The ID of the customer who will be billed.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The ID of the account who will be billed.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
sig { returns(T.nilable(T::Array[String])) }
def default_margins; end
sig {
params(_default_margins: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def default_margins=(_default_margins); end
# ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
sig { returns(T.nilable(String)) }
def default_source; end
sig { params(_default_source: T.nilable(String)).returns(T.nilable(String)) }
def default_source=(_default_source); end
# The tax rates that will apply to any line item that does not have `tax_rates` set.
sig { returns(T.nilable(T::Array[String])) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def default_tax_rates=(_default_tax_rates); end
# An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The coupons and promotion codes to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts.
sig { returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreateParams::Discount]))) }
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreateParams::Discount])))
}
def discounts=(_discounts); end
# The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`.
sig { returns(T.nilable(Integer)) }
def due_date; end
sig { params(_due_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def due_date=(_due_date); end
# The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
sig { returns(T.nilable(Integer)) }
def effective_at; end
sig { params(_effective_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def effective_at=(_effective_at); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Footer to be displayed on the invoice.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.
sig { returns(T.nilable(::Stripe::Invoice::CreateParams::FromInvoice)) }
def from_invoice; end
sig {
params(_from_invoice: T.nilable(::Stripe::Invoice::CreateParams::FromInvoice)).returns(T.nilable(::Stripe::Invoice::CreateParams::FromInvoice))
}
def from_invoice=(_from_invoice); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig { returns(T.nilable(::Stripe::Invoice::CreateParams::Issuer)) }
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::Invoice::CreateParams::Issuer)).returns(T.nilable(::Stripe::Invoice::CreateParams::Issuer))
}
def issuer=(_issuer); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.
sig { returns(T.nilable(String)) }
def number; end
sig { params(_number: T.nilable(String)).returns(T.nilable(String)) }
def number=(_number); end
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
sig { returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings)) }
def payment_settings; end
sig {
params(_payment_settings: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings)).returns(T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings))
}
def payment_settings=(_payment_settings); end
# How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.
sig { returns(T.nilable(String)) }
def pending_invoice_items_behavior; end
sig { params(_pending_invoice_items_behavior: T.nilable(String)).returns(T.nilable(String)) }
def pending_invoice_items_behavior=(_pending_invoice_items_behavior); end
# The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
sig { returns(T.nilable(::Stripe::Invoice::CreateParams::Rendering)) }
def rendering; end
sig {
params(_rendering: T.nilable(::Stripe::Invoice::CreateParams::Rendering)).returns(T.nilable(::Stripe::Invoice::CreateParams::Rendering))
}
def rendering=(_rendering); end
# Settings for the cost of shipping for this invoice.
sig { returns(T.nilable(::Stripe::Invoice::CreateParams::ShippingCost)) }
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(::Stripe::Invoice::CreateParams::ShippingCost)).returns(T.nilable(::Stripe::Invoice::CreateParams::ShippingCost))
}
def shipping_cost=(_shipping_cost); end
# Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.
sig { returns(T.nilable(::Stripe::Invoice::CreateParams::ShippingDetails)) }
def shipping_details; end
sig {
params(_shipping_details: T.nilable(::Stripe::Invoice::CreateParams::ShippingDetails)).returns(T.nilable(::Stripe::Invoice::CreateParams::ShippingDetails))
}
def shipping_details=(_shipping_details); end
# Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription's billing cycle and regular subscription events won't be affected.
sig { returns(T.nilable(String)) }
def subscription; end
sig { params(_subscription: T.nilable(String)).returns(T.nilable(String)) }
def subscription=(_subscription); end
# If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
sig { returns(T.nilable(::Stripe::Invoice::CreateParams::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::Invoice::CreateParams::TransferData)).returns(T.nilable(::Stripe::Invoice::CreateParams::TransferData))
}
def transfer_data=(_transfer_data); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), amounts_due: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreateParams::AmountsDue])), application_fee_amount: T.nilable(Integer), auto_advance: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::Invoice::CreateParams::AutomaticTax), automatically_finalizes_at: T.nilable(Integer), collection_method: T.nilable(String), currency: T.nilable(String), custom_fields: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreateParams::CustomField])), customer: T.nilable(String), customer_account: T.nilable(String), days_until_due: T.nilable(Integer), default_margins: T.nilable(T::Array[String]), default_payment_method: T.nilable(String), default_source: T.nilable(String), default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreateParams::Discount])), due_date: T.nilable(Integer), effective_at: T.nilable(Integer), expand: T.nilable(T::Array[String]), footer: T.nilable(String), from_invoice: T.nilable(::Stripe::Invoice::CreateParams::FromInvoice), issuer: T.nilable(::Stripe::Invoice::CreateParams::Issuer), metadata: T.nilable(T.any(String, T::Hash[String, String])), number: T.nilable(String), on_behalf_of: T.nilable(String), payment_settings: T.nilable(::Stripe::Invoice::CreateParams::PaymentSettings), pending_invoice_items_behavior: T.nilable(String), rendering: T.nilable(::Stripe::Invoice::CreateParams::Rendering), shipping_cost: T.nilable(::Stripe::Invoice::CreateParams::ShippingCost), shipping_details: T.nilable(::Stripe::Invoice::CreateParams::ShippingDetails), statement_descriptor: T.nilable(String), subscription: T.nilable(String), transfer_data: T.nilable(::Stripe::Invoice::CreateParams::TransferData)).void
}
def initialize(
account_tax_ids: nil,
amounts_due: nil,
application_fee_amount: nil,
auto_advance: nil,
automatic_tax: nil,
automatically_finalizes_at: nil,
collection_method: nil,
currency: nil,
custom_fields: nil,
customer: nil,
customer_account: nil,
days_until_due: nil,
default_margins: nil,
default_payment_method: nil,
default_source: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
due_date: nil,
effective_at: nil,
expand: nil,
footer: nil,
from_invoice: nil,
issuer: nil,
metadata: nil,
number: nil,
on_behalf_of: nil,
payment_settings: nil,
pending_invoice_items_behavior: nil,
rendering: nil,
shipping_cost: nil,
shipping_details: nil,
statement_descriptor: nil,
subscription: nil,
transfer_data: nil
); end
end
class SearchParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
sig { returns(T.nilable(String)) }
def page; end
sig { params(_page: T.nilable(String)).returns(T.nilable(String)) }
def page=(_page); end
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices).
sig { returns(String) }
def query; end
sig { params(_query: String).returns(String) }
def query=(_query); end
sig {
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
}
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
end
class AddLinesParams < Stripe::RequestParams
class Line < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Invoice::AddLinesParams::Line::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Invoice::AddLinesParams::Line::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Invoice::AddLinesParams::Line::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Invoice::AddLinesParams::Line::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::Invoice::AddLinesParams::Line::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Invoice::AddLinesParams::Line::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Invoice::AddLinesParams::Line::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Invoice::AddLinesParams::Line::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
sig { returns(Integer) }
def end; end
sig { params(_end: Integer).returns(Integer) }
def end=(_end); end
# The start of the period. This value is inclusive.
sig { returns(Integer) }
def start; end
sig { params(_start: Integer).returns(Integer) }
def start=(_start); end
sig { params(end_: Integer, start: Integer).void }
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
class ProductData < Stripe::RequestParams
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T::Array[String])) }
def images; end
sig {
params(_images: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def images=(_images); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
sig {
params(description: T.nilable(String), images: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: String, tax_code: T.nilable(String), unit_label: T.nilable(String)).void
}
def initialize(
description: nil,
images: nil,
metadata: nil,
name: nil,
tax_code: nil,
unit_label: nil
); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
sig {
returns(T.nilable(::Stripe::Invoice::AddLinesParams::Line::PriceData::ProductData))
}
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::Invoice::AddLinesParams::Line::PriceData::ProductData)).returns(T.nilable(::Stripe::Invoice::AddLinesParams::Line::PriceData::ProductData))
}
def product_data=(_product_data); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: T.nilable(String), product_data: T.nilable(::Stripe::Invoice::AddLinesParams::Line::PriceData::ProductData), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
product_data: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Pricing < Stripe::RequestParams
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
sig { params(price: T.nilable(String)).void }
def initialize(price: nil); end
end
class TaxAmount < Stripe::RequestParams
class TaxRateData < Stripe::RequestParams
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The display name of the tax rate, which will be shown to users.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# This specifies if the tax rate is inclusive or exclusive.
sig { returns(T::Boolean) }
def inclusive; end
sig { params(_inclusive: T::Boolean).returns(T::Boolean) }
def inclusive=(_inclusive); end
# The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
sig { returns(T.nilable(String)) }
def jurisdiction; end
sig { params(_jurisdiction: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction=(_jurisdiction); end
# The level of the jurisdiction that imposes this tax rate.
sig { returns(T.nilable(String)) }
def jurisdiction_level; end
sig { params(_jurisdiction_level: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction_level=(_jurisdiction_level); end
# The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.
sig { returns(Float) }
def percentage; end
sig { params(_percentage: Float).returns(Float) }
def percentage=(_percentage); end
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# The high-level tax type, such as `vat` or `sales_tax`.
sig { returns(T.nilable(String)) }
def tax_type; end
sig { params(_tax_type: T.nilable(String)).returns(T.nilable(String)) }
def tax_type=(_tax_type); end
sig {
params(country: T.nilable(String), description: T.nilable(String), display_name: String, inclusive: T::Boolean, jurisdiction: T.nilable(String), jurisdiction_level: T.nilable(String), percentage: Float, state: T.nilable(String), tax_type: T.nilable(String)).void
}
def initialize(
country: nil,
description: nil,
display_name: nil,
inclusive: nil,
jurisdiction: nil,
jurisdiction_level: nil,
percentage: nil,
state: nil,
tax_type: nil
); end
end
# The amount, in cents (or local equivalent), of the tax.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Data to find or create a TaxRate object.
#
# Stripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.
sig { returns(::Stripe::Invoice::AddLinesParams::Line::TaxAmount::TaxRateData) }
def tax_rate_data; end
sig {
params(_tax_rate_data: ::Stripe::Invoice::AddLinesParams::Line::TaxAmount::TaxRateData).returns(::Stripe::Invoice::AddLinesParams::Line::TaxAmount::TaxRateData)
}
def tax_rate_data=(_tax_rate_data); end
# The reasoning behind this tax, for example, if the product is tax exempt.
sig { returns(T.nilable(String)) }
def taxability_reason; end
sig { params(_taxability_reason: T.nilable(String)).returns(T.nilable(String)) }
def taxability_reason=(_taxability_reason); end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(Integer) }
def taxable_amount; end
sig { params(_taxable_amount: Integer).returns(Integer) }
def taxable_amount=(_taxable_amount); end
sig {
params(amount: Integer, tax_rate_data: ::Stripe::Invoice::AddLinesParams::Line::TaxAmount::TaxRateData, taxability_reason: T.nilable(String), taxable_amount: Integer).void
}
def initialize(
amount: nil,
tax_rate_data: nil,
taxability_reason: nil,
taxable_amount: nil
); end
end
# The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
sig { returns(T.nilable(T::Boolean)) }
def discountable; end
sig { params(_discountable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def discountable=(_discountable); end
# The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::AddLinesParams::Line::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::AddLinesParams::Line::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::AddLinesParams::Line::Discount])))
}
def discounts=(_discounts); end
# ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.
sig { returns(T.nilable(String)) }
def invoice_item; end
sig { params(_invoice_item: T.nilable(String)).returns(T.nilable(String)) }
def invoice_item=(_invoice_item); end
# The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def margins; end
sig {
params(_margins: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def margins=(_margins); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
sig { returns(T.nilable(::Stripe::Invoice::AddLinesParams::Line::Period)) }
def period; end
sig {
params(_period: T.nilable(::Stripe::Invoice::AddLinesParams::Line::Period)).returns(T.nilable(::Stripe::Invoice::AddLinesParams::Line::Period))
}
def period=(_period); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig { returns(T.nilable(::Stripe::Invoice::AddLinesParams::Line::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Invoice::AddLinesParams::Line::PriceData)).returns(T.nilable(::Stripe::Invoice::AddLinesParams::Line::PriceData))
}
def price_data=(_price_data); end
# The pricing information for the invoice item.
sig { returns(T.nilable(::Stripe::Invoice::AddLinesParams::Line::Pricing)) }
def pricing; end
sig {
params(_pricing: T.nilable(::Stripe::Invoice::AddLinesParams::Line::Pricing)).returns(T.nilable(::Stripe::Invoice::AddLinesParams::Line::Pricing))
}
def pricing=(_pricing); end
# Non-negative integer. The quantity of units for the line item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::AddLinesParams::Line::TaxAmount])))
}
def tax_amounts; end
sig {
params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::AddLinesParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::AddLinesParams::Line::TaxAmount])))
}
def tax_amounts=(_tax_amounts); end
# The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(amount: T.nilable(Integer), description: T.nilable(String), discountable: T.nilable(T::Boolean), discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::AddLinesParams::Line::Discount])), invoice_item: T.nilable(String), margins: T.nilable(T.any(String, T::Array[String])), metadata: T.nilable(T.any(String, T::Hash[String, String])), period: T.nilable(::Stripe::Invoice::AddLinesParams::Line::Period), price_data: T.nilable(::Stripe::Invoice::AddLinesParams::Line::PriceData), pricing: T.nilable(::Stripe::Invoice::AddLinesParams::Line::Pricing), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::AddLinesParams::Line::TaxAmount])), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
amount: nil,
description: nil,
discountable: nil,
discounts: nil,
invoice_item: nil,
margins: nil,
metadata: nil,
period: nil,
price_data: nil,
pricing: nil,
quantity: nil,
tax_amounts: nil,
tax_rates: nil
); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def invoice_metadata; end
sig {
params(_invoice_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def invoice_metadata=(_invoice_metadata); end
# The line items to add.
sig { returns(T::Array[::Stripe::Invoice::AddLinesParams::Line]) }
def lines; end
sig {
params(_lines: T::Array[::Stripe::Invoice::AddLinesParams::Line]).returns(T::Array[::Stripe::Invoice::AddLinesParams::Line])
}
def lines=(_lines); end
sig {
params(expand: T.nilable(T::Array[String]), invoice_metadata: T.nilable(T.any(String, T::Hash[String, String])), lines: T::Array[::Stripe::Invoice::AddLinesParams::Line]).void
}
def initialize(expand: nil, invoice_metadata: nil, lines: nil); end
end
class AttachPaymentParams < Stripe::RequestParams
class PaymentRecordData < Stripe::RequestParams
# The amount that was paid out of band.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The currency that was paid out of band.
sig { returns(String) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The type of money movement for this out of band payment record.
sig { returns(String) }
def money_movement_type; end
sig { params(_money_movement_type: String).returns(String) }
def money_movement_type=(_money_movement_type); end
# The timestamp when this out of band payment was paid.
sig { returns(T.nilable(Integer)) }
def paid_at; end
sig { params(_paid_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def paid_at=(_paid_at); end
# The reference for this out of band payment record.
sig { returns(T.nilable(String)) }
def payment_reference; end
sig { params(_payment_reference: T.nilable(String)).returns(T.nilable(String)) }
def payment_reference=(_payment_reference); end
sig {
params(amount: Integer, currency: String, metadata: T.nilable(T.any(String, T::Hash[String, String])), money_movement_type: String, paid_at: T.nilable(Integer), payment_reference: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
metadata: nil,
money_movement_type: nil,
paid_at: nil,
payment_reference: nil
); end
end
# The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount.
sig { returns(T.nilable(Integer)) }
def amount_requested; end
sig { params(_amount_requested: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_requested=(_amount_requested); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The ID of the PaymentIntent to attach to the invoice.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# The ID of the PaymentRecord to attach to the invoice.
sig { returns(T.nilable(String)) }
def payment_record; end
sig { params(_payment_record: T.nilable(String)).returns(T.nilable(String)) }
def payment_record=(_payment_record); end
# The PaymentRecord data for attaching an out of band payment to the invoice.
sig { returns(T.nilable(::Stripe::Invoice::AttachPaymentParams::PaymentRecordData)) }
def payment_record_data; end
sig {
params(_payment_record_data: T.nilable(::Stripe::Invoice::AttachPaymentParams::PaymentRecordData)).returns(T.nilable(::Stripe::Invoice::AttachPaymentParams::PaymentRecordData))
}
def payment_record_data=(_payment_record_data); end
sig {
params(amount_requested: T.nilable(Integer), expand: T.nilable(T::Array[String]), payment_intent: T.nilable(String), payment_record: T.nilable(String), payment_record_data: T.nilable(::Stripe::Invoice::AttachPaymentParams::PaymentRecordData)).void
}
def initialize(
amount_requested: nil,
expand: nil,
payment_intent: nil,
payment_record: nil,
payment_record_data: nil
); 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.
sig { returns(T.nilable(T::Boolean)) }
def auto_advance; end
sig { params(_auto_advance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_advance=(_auto_advance); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(auto_advance: T.nilable(T::Boolean), expand: T.nilable(T::Array[String])).void }
def initialize(auto_advance: nil, expand: nil); end
end
class MarkUncollectibleParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class PayParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due.
#
# Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def forgive; end
sig { params(_forgive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def forgive=(_forgive); end
# ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set.
sig { returns(T.nilable(String)) }
def mandate; end
sig { params(_mandate: T.nilable(String)).returns(T.nilable(String)) }
def mandate=(_mandate); end
# Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session).
sig { returns(T.nilable(T::Boolean)) }
def off_session; end
sig { params(_off_session: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def off_session=(_off_session); end
# Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def paid_out_of_band; end
sig { params(_paid_out_of_band: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def paid_out_of_band=(_paid_out_of_band); end
# A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.
sig { returns(T.nilable(String)) }
def source; end
sig { params(_source: T.nilable(String)).returns(T.nilable(String)) }
def source=(_source); end
sig {
params(expand: T.nilable(T::Array[String]), forgive: T.nilable(T::Boolean), mandate: T.nilable(String), off_session: T.nilable(T::Boolean), paid_out_of_band: T.nilable(T::Boolean), payment_method: T.nilable(String), source: T.nilable(String)).void
}
def initialize(
expand: nil,
forgive: nil,
mandate: nil,
off_session: nil,
paid_out_of_band: nil,
payment_method: nil,
source: nil
); end
end
class RemoveLinesParams < Stripe::RequestParams
class Line < Stripe::RequestParams
# Either `delete` or `unassign`. Deleted line items are permanently deleted. Unassigned line items can be reassigned to an invoice.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
# ID of an existing line item to remove from this invoice.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
sig { params(behavior: String, id: String).void }
def initialize(behavior: nil, id: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def invoice_metadata; end
sig {
params(_invoice_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def invoice_metadata=(_invoice_metadata); end
# The line items to remove.
sig { returns(T::Array[::Stripe::Invoice::RemoveLinesParams::Line]) }
def lines; end
sig {
params(_lines: T::Array[::Stripe::Invoice::RemoveLinesParams::Line]).returns(T::Array[::Stripe::Invoice::RemoveLinesParams::Line])
}
def lines=(_lines); end
sig {
params(expand: T.nilable(T::Array[String]), invoice_metadata: T.nilable(T.any(String, T::Hash[String, String])), lines: T::Array[::Stripe::Invoice::RemoveLinesParams::Line]).void
}
def initialize(expand: nil, invoice_metadata: nil, lines: nil); end
end
class SendInvoiceParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateLinesParams < Stripe::RequestParams
class Line < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
sig { returns(Integer) }
def end; end
sig { params(_end: Integer).returns(Integer) }
def end=(_end); end
# The start of the period. This value is inclusive.
sig { returns(Integer) }
def start; end
sig { params(_start: Integer).returns(Integer) }
def start=(_start); end
sig { params(end_: Integer, start: Integer).void }
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
class ProductData < Stripe::RequestParams
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T::Array[String])) }
def images; end
sig {
params(_images: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def images=(_images); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
sig {
params(description: T.nilable(String), images: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: String, tax_code: T.nilable(String), unit_label: T.nilable(String)).void
}
def initialize(
description: nil,
images: nil,
metadata: nil,
name: nil,
tax_code: nil,
unit_label: nil
); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
sig {
returns(T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::PriceData::ProductData))
}
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::PriceData::ProductData)).returns(T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::PriceData::ProductData))
}
def product_data=(_product_data); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: T.nilable(String), product_data: T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::PriceData::ProductData), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
product_data: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Pricing < Stripe::RequestParams
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
sig { params(price: T.nilable(String)).void }
def initialize(price: nil); end
end
class TaxAmount < Stripe::RequestParams
class TaxRateData < Stripe::RequestParams
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The display name of the tax rate, which will be shown to users.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# This specifies if the tax rate is inclusive or exclusive.
sig { returns(T::Boolean) }
def inclusive; end
sig { params(_inclusive: T::Boolean).returns(T::Boolean) }
def inclusive=(_inclusive); end
# The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
sig { returns(T.nilable(String)) }
def jurisdiction; end
sig { params(_jurisdiction: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction=(_jurisdiction); end
# The level of the jurisdiction that imposes this tax rate.
sig { returns(T.nilable(String)) }
def jurisdiction_level; end
sig { params(_jurisdiction_level: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction_level=(_jurisdiction_level); end
# The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.
sig { returns(Float) }
def percentage; end
sig { params(_percentage: Float).returns(Float) }
def percentage=(_percentage); end
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# The high-level tax type, such as `vat` or `sales_tax`.
sig { returns(T.nilable(String)) }
def tax_type; end
sig { params(_tax_type: T.nilable(String)).returns(T.nilable(String)) }
def tax_type=(_tax_type); end
sig {
params(country: T.nilable(String), description: T.nilable(String), display_name: String, inclusive: T::Boolean, jurisdiction: T.nilable(String), jurisdiction_level: T.nilable(String), percentage: Float, state: T.nilable(String), tax_type: T.nilable(String)).void
}
def initialize(
country: nil,
description: nil,
display_name: nil,
inclusive: nil,
jurisdiction: nil,
jurisdiction_level: nil,
percentage: nil,
state: nil,
tax_type: nil
); end
end
# The amount, in cents (or local equivalent), of the tax.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Data to find or create a TaxRate object.
#
# Stripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.
sig { returns(::Stripe::Invoice::UpdateLinesParams::Line::TaxAmount::TaxRateData) }
def tax_rate_data; end
sig {
params(_tax_rate_data: ::Stripe::Invoice::UpdateLinesParams::Line::TaxAmount::TaxRateData).returns(::Stripe::Invoice::UpdateLinesParams::Line::TaxAmount::TaxRateData)
}
def tax_rate_data=(_tax_rate_data); end
# The reasoning behind this tax, for example, if the product is tax exempt.
sig { returns(T.nilable(String)) }
def taxability_reason; end
sig { params(_taxability_reason: T.nilable(String)).returns(T.nilable(String)) }
def taxability_reason=(_taxability_reason); end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(Integer) }
def taxable_amount; end
sig { params(_taxable_amount: Integer).returns(Integer) }
def taxable_amount=(_taxable_amount); end
sig {
params(amount: Integer, tax_rate_data: ::Stripe::Invoice::UpdateLinesParams::Line::TaxAmount::TaxRateData, taxability_reason: T.nilable(String), taxable_amount: Integer).void
}
def initialize(
amount: nil,
tax_rate_data: nil,
taxability_reason: nil,
taxable_amount: nil
); end
end
# The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
sig { returns(T.nilable(T::Boolean)) }
def discountable; end
sig { params(_discountable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def discountable=(_discountable); end
# The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateLinesParams::Line::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateLinesParams::Line::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateLinesParams::Line::Discount])))
}
def discounts=(_discounts); end
# ID of an existing line item on the invoice.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
# The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def margins; end
sig {
params(_margins: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def margins=(_margins); end
# 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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
sig { returns(T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::Period)) }
def period; end
sig {
params(_period: T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::Period)).returns(T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::Period))
}
def period=(_period); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig { returns(T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::PriceData)).returns(T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::PriceData))
}
def price_data=(_price_data); end
# The pricing information for the invoice item.
sig { returns(T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::Pricing)) }
def pricing; end
sig {
params(_pricing: T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::Pricing)).returns(T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::Pricing))
}
def pricing=(_pricing); end
# Non-negative integer. The quantity of units for the line item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateLinesParams::Line::TaxAmount])))
}
def tax_amounts; end
sig {
params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateLinesParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateLinesParams::Line::TaxAmount])))
}
def tax_amounts=(_tax_amounts); end
# The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(amount: T.nilable(Integer), description: T.nilable(String), discountable: T.nilable(T::Boolean), discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateLinesParams::Line::Discount])), id: String, margins: T.nilable(T.any(String, T::Array[String])), metadata: T.nilable(T.any(String, T::Hash[String, String])), period: T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::Period), price_data: T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::PriceData), pricing: T.nilable(::Stripe::Invoice::UpdateLinesParams::Line::Pricing), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::UpdateLinesParams::Line::TaxAmount])), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
amount: nil,
description: nil,
discountable: nil,
discounts: nil,
id: nil,
margins: nil,
metadata: nil,
period: nil,
price_data: nil,
pricing: nil,
quantity: nil,
tax_amounts: nil,
tax_rates: nil
); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def invoice_metadata; end
sig {
params(_invoice_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def invoice_metadata=(_invoice_metadata); end
# The line items to update.
sig { returns(T::Array[::Stripe::Invoice::UpdateLinesParams::Line]) }
def lines; end
sig {
params(_lines: T::Array[::Stripe::Invoice::UpdateLinesParams::Line]).returns(T::Array[::Stripe::Invoice::UpdateLinesParams::Line])
}
def lines=(_lines); end
sig {
params(expand: T.nilable(T::Array[String]), invoice_metadata: T.nilable(T.any(String, T::Hash[String, String])), lines: T::Array[::Stripe::Invoice::UpdateLinesParams::Line]).void
}
def initialize(expand: nil, invoice_metadata: nil, lines: nil); end
end
class VoidInvoiceParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class CreatePreviewParams < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::AutomaticTax::Liability)) }
def liability; end
sig {
params(_liability: T.nilable(::Stripe::Invoice::CreatePreviewParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::Invoice::CreatePreviewParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class CustomerDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Customer shipping address.
sig {
returns(::Stripe::Invoice::CreatePreviewParams::CustomerDetails::Shipping::Address)
}
def address; end
sig {
params(_address: ::Stripe::Invoice::CreatePreviewParams::CustomerDetails::Shipping::Address).returns(::Stripe::Invoice::CreatePreviewParams::CustomerDetails::Shipping::Address)
}
def address=(_address); end
# Customer name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Customer phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: ::Stripe::Invoice::CreatePreviewParams::CustomerDetails::Shipping::Address, name: String, phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
class Tax < Stripe::RequestParams
# A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
sig { params(ip_address: T.nilable(String)).void }
def initialize(ip_address: nil); end
end
class TaxId < Stripe::RequestParams
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Value of the tax ID.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(type: String, value: String).void }
def initialize(type: nil, value: nil); end
end
# The customer's address.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::CustomerDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::CustomerDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::CustomerDetails::Address)))
}
def address=(_address); end
# The customer's shipping information. Appears on invoices emailed to this customer.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::CustomerDetails::Shipping)))
}
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::CustomerDetails::Shipping))).returns(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::CustomerDetails::Shipping)))
}
def shipping=(_shipping); end
# Tax details about the customer.
sig { returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::CustomerDetails::Tax)) }
def tax; end
sig {
params(_tax: T.nilable(::Stripe::Invoice::CreatePreviewParams::CustomerDetails::Tax)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::CustomerDetails::Tax))
}
def tax=(_tax); end
# The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
sig { returns(T.nilable(T.any(String, String))) }
def tax_exempt; end
sig {
params(_tax_exempt: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def tax_exempt=(_tax_exempt); end
# The customer's tax IDs.
sig {
returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::CustomerDetails::TaxId]))
}
def tax_ids; end
sig {
params(_tax_ids: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::CustomerDetails::TaxId])).returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::CustomerDetails::TaxId]))
}
def tax_ids=(_tax_ids); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::CustomerDetails::Address)), shipping: T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::CustomerDetails::Shipping)), tax: T.nilable(::Stripe::Invoice::CreatePreviewParams::CustomerDetails::Tax), tax_exempt: T.nilable(T.any(String, String)), tax_ids: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::CustomerDetails::TaxId])).void
}
def initialize(address: nil, shipping: nil, tax: nil, tax_exempt: nil, tax_ids: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class InvoiceItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::InvoiceItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::InvoiceItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::InvoiceItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::InvoiceItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::InvoiceItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::InvoiceItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::InvoiceItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::InvoiceItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
sig { returns(Integer) }
def end; end
sig { params(_end: Integer).returns(Integer) }
def end=(_end); end
# The start of the period. This value is inclusive.
sig { returns(Integer) }
def start; end
sig { params(_start: Integer).returns(Integer) }
def start=(_start); end
sig { params(end_: Integer, start: Integer).void }
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# The integer amount in cents (or local equivalent) of previewed invoice item.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# 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). Only applicable to new invoice items.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.
sig { returns(T.nilable(T::Boolean)) }
def discountable; end
sig { params(_discountable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def discountable=(_discountable); end
# The coupons to redeem into discounts for the invoice item in the preview.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::InvoiceItem::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::InvoiceItem::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::InvoiceItem::Discount])))
}
def discounts=(_discounts); end
# The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.
sig { returns(T.nilable(String)) }
def invoiceitem; end
sig { params(_invoiceitem: T.nilable(String)).returns(T.nilable(String)) }
def invoiceitem=(_invoiceitem); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
sig { returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::InvoiceItem::Period)) }
def period; end
sig {
params(_period: T.nilable(::Stripe::Invoice::CreatePreviewParams::InvoiceItem::Period)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::InvoiceItem::Period))
}
def period=(_period); end
# The ID of the price object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig { returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::InvoiceItem::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::InvoiceItem::PriceData)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::InvoiceItem::PriceData))
}
def price_data=(_price_data); end
# Non-negative integer. The quantity of units for the invoice item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(amount: T.nilable(Integer), currency: T.nilable(String), description: T.nilable(String), discountable: T.nilable(T::Boolean), discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::InvoiceItem::Discount])), invoiceitem: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), period: T.nilable(::Stripe::Invoice::CreatePreviewParams::InvoiceItem::Period), price: T.nilable(String), price_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::InvoiceItem::PriceData), quantity: T.nilable(Integer), tax_behavior: T.nilable(String), tax_code: T.nilable(String), tax_rates: T.nilable(T.any(String, T::Array[String])), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
discountable: nil,
discounts: nil,
invoiceitem: nil,
metadata: nil,
period: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_behavior: nil,
tax_code: nil,
tax_rates: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
class ScheduleDetails < Stripe::RequestParams
class Amendment < Stripe::RequestParams
class AmendmentEnd < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
sig { returns(String) }
def discount; end
sig { params(_discount: String).returns(String) }
def discount=(_discount); end
sig { params(discount: String).void }
def initialize(discount: nil); end
end
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Use the `end` time of a given discount.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd::DiscountEnd)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd::DiscountEnd))
}
def discount_end=(_discount_end); end
# Time span for the amendment starting from the `amendment_start`.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd::Duration)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select one of three ways to pass the `amendment_end`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd::DiscountEnd), duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(discount_end: nil, duration: nil, timestamp: nil, type: nil); end
end
class AmendmentStart < Stripe::RequestParams
class AmendmentEnd < Stripe::RequestParams
# The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array.
sig { returns(Integer) }
def index; end
sig { params(_index: Integer).returns(Integer) }
def index=(_index); end
sig { params(index: Integer).void }
def initialize(index: nil); end
end
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
sig { returns(String) }
def discount; end
sig { params(_discount: String).returns(String) }
def discount=(_discount); end
sig { params(discount: String).void }
def initialize(discount: nil); end
end
# Details of another amendment in the same array, immediately after which this amendment should begin.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart::AmendmentEnd))
}
def amendment_end; end
sig {
params(_amendment_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart::AmendmentEnd)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart::AmendmentEnd))
}
def amendment_end=(_amendment_end); end
# Use the `end` time of a given discount.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart::DiscountEnd)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart::DiscountEnd))
}
def discount_end=(_discount_end); end
# A precise Unix timestamp for the amendment to start.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select one of three ways to pass the `amendment_start`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(amendment_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart::AmendmentEnd), discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart::DiscountEnd), timestamp: T.nilable(Integer), type: String).void
}
def initialize(amendment_end: nil, discount_end: nil, timestamp: nil, type: nil); end
end
class DiscountAction < Stripe::RequestParams
class Add < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
# The coupon code to redeem.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# An ID of an existing discount for a coupon that was already redeemed.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Add::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Add::DiscountEnd)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Add::DiscountEnd))
}
def discount_end=(_discount_end); end
# The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
# The promotion code to redeem.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Add::DiscountEnd), index: T.nilable(Integer), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
index: nil,
promotion_code: nil
); end
end
class Remove < Stripe::RequestParams
# The coupon code to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# The ID of a discount to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# The ID of a promotion code to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
class Set < Stripe::RequestParams
# The coupon code to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# An ID of an existing discount to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# An ID of an existing promotion code to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
# Details of the discount to add.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Add))
}
def add; end
sig {
params(_add: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Add)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Add))
}
def add=(_add); end
# Details of the discount to remove.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Remove))
}
def remove; end
sig {
params(_remove: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Remove)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Remove))
}
def remove=(_remove); end
# Details of the discount to replace the existing discounts with.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Set))
}
def set; end
sig {
params(_set: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Set)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Set))
}
def set=(_set); end
# Determines the type of discount action.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(add: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Add), remove: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Remove), set: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Set), type: String).void
}
def initialize(add: nil, remove: nil, set: nil, type: nil); end
end
class ItemAction < Stripe::RequestParams
class Add < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); end
end
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
sig {
returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount])).returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# Quantity for this item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
# Options that configure the trial on the subscription item.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Trial)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Trial))
}
def trial=(_trial); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount]), metadata: T.nilable(T::Hash[String, String]), price: String, quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String]), trial: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Trial)).void
}
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
class Remove < Stripe::RequestParams
# ID of a price to remove.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
sig { params(price: String).void }
def initialize(price: nil); end
end
class Set < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); end
end
# If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.
sig {
returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount])).returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount]))
}
def discounts=(_discounts); end
# If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
# If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Trial)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Trial))
}
def trial=(_trial); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount]), metadata: T.nilable(T::Hash[String, String]), price: String, quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String]), trial: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Trial)).void
}
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
# Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add))
}
def add; end
sig {
params(_add: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add))
}
def add=(_add); end
# Details of the subscription item to remove.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Remove))
}
def remove; end
sig {
params(_remove: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Remove)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Remove))
}
def remove=(_remove); end
# Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set))
}
def set; end
sig {
params(_set: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set))
}
def set=(_set); end
# Determines the type of item action.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(add: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add), remove: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Remove), set: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set), type: String).void
}
def initialize(add: nil, remove: nil, set: nil, type: nil); end
end
class MetadataAction < Stripe::RequestParams
# Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
sig { returns(T.nilable(T::Hash[String, String])) }
def add; end
sig {
params(_add: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def add=(_add); end
# Keys to remove from schedule phase metadata.
sig { returns(T.nilable(T::Array[String])) }
def remove; end
sig {
params(_remove: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def remove=(_remove); end
# Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def set; end
sig {
params(_set: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def set=(_set); end
# Select one of three ways to update phase-level `metadata` on subscription schedules.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(add: T.nilable(T::Hash[String, String]), remove: T.nilable(T::Array[String]), set: T.nilable(T.any(String, T::Hash[String, String])), type: String).void
}
def initialize(add: nil, remove: nil, set: nil, type: nil); end
end
class SetPauseCollection < Stripe::RequestParams
class Set < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(behavior: String).void }
def initialize(behavior: nil); end
end
# Details of the pause_collection behavior to apply to the amendment.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::SetPauseCollection::Set))
}
def set; end
sig {
params(_set: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::SetPauseCollection::Set)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::SetPauseCollection::Set))
}
def set=(_set); end
# Determines the type of the pause_collection amendment.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(set: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::SetPauseCollection::Set), type: String).void
}
def initialize(set: nil, type: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
sig { params(_prorate_up_front: T.nilable(String)).returns(T.nilable(String)) }
def prorate_up_front=(_prorate_up_front); end
sig { params(prorate_up_front: T.nilable(String)).void }
def initialize(prorate_up_front: nil); end
end
# Defines how the subscription should behave when a trial ends.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::TrialSettings::EndBehavior))
}
def end_behavior; end
sig {
params(_end_behavior: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::TrialSettings::EndBehavior)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::TrialSettings::EndBehavior))
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::TrialSettings::EndBehavior)).void
}
def initialize(end_behavior: nil); end
end
# Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd))
}
def amendment_end; end
sig {
params(_amendment_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd))
}
def amendment_end=(_amendment_end); end
# Details to identify the earliest timestamp where the proposed change should take effect.
sig {
returns(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart)
}
def amendment_start; end
sig {
params(_amendment_start: ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart).returns(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart)
}
def amendment_start=(_amendment_start); end
# For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# Changes to the coupons being redeemed or discounts being applied during the amendment time span.
sig {
returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction]))
}
def discount_actions; end
sig {
params(_discount_actions: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction])).returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction]))
}
def discount_actions=(_discount_actions); end
# Changes to the subscription items during the amendment time span.
sig {
returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction]))
}
def item_actions; end
sig {
params(_item_actions: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction])).returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction]))
}
def item_actions=(_item_actions); end
# Instructions for how to modify phase metadata
sig {
returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::MetadataAction]))
}
def metadata_actions; end
sig {
params(_metadata_actions: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::MetadataAction])).returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::MetadataAction]))
}
def metadata_actions=(_metadata_actions); end
# Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::SetPauseCollection))
}
def set_pause_collection; end
sig {
params(_set_pause_collection: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::SetPauseCollection)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::SetPauseCollection))
}
def set_pause_collection=(_set_pause_collection); end
# Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
sig { returns(T.nilable(String)) }
def set_schedule_end; end
sig { params(_set_schedule_end: T.nilable(String)).returns(T.nilable(String)) }
def set_schedule_end=(_set_schedule_end); end
# Settings related to subscription trials.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::TrialSettings))
}
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::TrialSettings)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(amendment_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd), amendment_start: ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart, billing_cycle_anchor: T.nilable(String), discount_actions: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction]), item_actions: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction]), metadata_actions: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::MetadataAction]), proration_behavior: T.nilable(String), set_pause_collection: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::SetPauseCollection), set_schedule_end: T.nilable(String), trial_settings: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment::TrialSettings)).void
}
def initialize(
amendment_end: nil,
amendment_start: nil,
billing_cycle_anchor: nil,
discount_actions: nil,
item_actions: nil,
metadata_actions: nil,
proration_behavior: nil,
set_pause_collection: nil,
set_schedule_end: nil,
trial_settings: nil
); end
end
class BillingMode < Stripe::RequestParams
class Flexible < Stripe::RequestParams
# Set to `true` to display gross amounts, net amounts, and discount amounts consistently between prorations and non-proration items on invoices, line items, and invoice items. Once set to `true`, you can't change it back to `false`.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
sig {
params(_consistent_proration_discount_amounts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consistent_proration_discount_amounts=(_consistent_proration_discount_amounts); end
sig { params(consistent_proration_discount_amounts: T.nilable(T::Boolean)).void }
def initialize(consistent_proration_discount_amounts: nil); end
end
# Configure behavior for flexible billing mode.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::BillingMode::Flexible))
}
def flexible; end
sig {
params(_flexible: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::BillingMode::Flexible)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::BillingMode::Flexible))
}
def flexible=(_flexible); end
# Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(flexible: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::BillingMode::Flexible), type: String).void
}
def initialize(flexible: nil, type: nil); end
end
class Phase < Stripe::RequestParams
class AddInvoiceItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Period < Stripe::RequestParams
class End < Stripe::RequestParams
# A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the end of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
class Start < Stripe::RequestParams
# A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the start of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
# End of the invoice item period.
sig {
returns(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period::End)
}
def end; end
sig {
params(_end: ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period::End).returns(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period::End)
}
def end=(_end); end
# Start of the invoice item period.
sig {
returns(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period::Start)
}
def start; end
sig {
params(_start: ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period::Start).returns(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period::Start)
}
def start=(_start); end
sig {
params(end_: ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period::End, start: ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period::Start).void
}
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# The coupons to redeem into discounts for the item.
sig {
returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount])).returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period))
}
def period; end
sig {
params(_period: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period))
}
def period=(_period); end
# The ID of the price object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::PriceData)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::PriceData))
}
def price_data=(_price_data); end
# Quantity for this item. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount]), metadata: T.nilable(T::Hash[String, String]), period: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period), price: T.nilable(String), price_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
discounts: nil,
metadata: nil,
period: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax::Liability)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class BillingThresholds < Stripe::RequestParams
# Monetary threshold that triggers the subscription to advance to a new billing period
sig { returns(T.nilable(Integer)) }
def amount_gte; end
sig { params(_amount_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_gte=(_amount_gte); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
sig {
params(_reset_billing_cycle_anchor: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def reset_billing_cycle_anchor=(_reset_billing_cycle_anchor); end
sig {
params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
}
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Duration < Stripe::RequestParams
# Specifies phase duration. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The multiplier applied to the interval.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings::Issuer)).void
}
def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end
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))
sig { returns(Integer) }
def usage_gte; end
sig { params(_usage_gte: Integer).returns(Integer) }
def usage_gte=(_usage_gte); end
sig { params(usage_gte: Integer).void }
def initialize(usage_gte: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData::Recurring)
}
def recurring; end
sig {
params(_recurring: ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData::Recurring).returns(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData::Recurring)
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# The coupons to redeem into discounts for the subscription item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount])))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData))
}
def price_data=(_price_data); end
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# Options that configure the trial on the subscription item.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Trial)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Trial))
}
def trial=(_trial); end
sig {
params(billing_thresholds: T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::BillingThresholds)), discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount])), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String])), trial: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Trial)).void
}
def initialize(
billing_thresholds: nil,
discounts: nil,
metadata: nil,
plan: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
class PauseCollection < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(behavior: String).void }
def initialize(behavior: nil); end
end
class TransferData < Stripe::RequestParams
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount_percent: T.nilable(Float), destination: String).void }
def initialize(amount_percent: nil, destination: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
sig { params(_prorate_up_front: T.nilable(String)).returns(T.nilable(String)) }
def prorate_up_front=(_prorate_up_front); end
sig { params(prorate_up_front: T.nilable(String)).void }
def initialize(prorate_up_front: nil); end
end
# Defines how the subscription should behave when a trial ends.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::TrialSettings::EndBehavior))
}
def end_behavior; end
sig {
params(_end_behavior: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::TrialSettings::EndBehavior)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::TrialSettings::EndBehavior))
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::TrialSettings::EndBehavior)).void
}
def initialize(end_behavior: nil); end
end
# A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
sig {
returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem]))
}
def add_invoice_items; end
sig {
params(_add_invoice_items: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem])).returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem]))
}
def add_invoice_items=(_add_invoice_items); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
sig { params(_application_fee_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def application_fee_percent=(_application_fee_percent); end
# Automatic tax settings for this phase.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax))
}
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# 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).
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount])))
}
def discounts=(_discounts); end
# The number of intervals the phase should last. If set, `end_date` must not be set.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Duration)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Duration))
}
def duration=(_duration); end
# The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
sig { returns(T.nilable(T.any(Integer, String))) }
def end_date; end
sig {
params(_end_date: T.nilable(T.any(Integer, String))).returns(T.nilable(T.any(Integer, String)))
}
def end_date=(_end_date); end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
sig {
returns(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item])
}
def items; end
sig {
params(_items: T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item]).returns(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item])
}
def items=(_items); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The account on behalf of which to charge, for each of the associated subscription's invoices.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::PauseCollection))
}
def pause_collection; end
sig {
params(_pause_collection: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::PauseCollection)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::PauseCollection))
}
def pause_collection=(_pause_collection); end
# 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.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
sig { returns(T.nilable(T.any(Integer, String))) }
def start_date; end
sig {
params(_start_date: T.nilable(T.any(Integer, String))).returns(T.nilable(T.any(Integer, String)))
}
def start_date=(_start_date); end
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::TransferData))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::TransferData)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::TransferData))
}
def transfer_data=(_transfer_data); end
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
sig { returns(T.nilable(T::Boolean)) }
def trial; end
sig { params(_trial: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def trial=(_trial); end
# Specify trial behavior when crossing phase boundaries
sig { returns(T.nilable(String)) }
def trial_continuation; end
sig { params(_trial_continuation: T.nilable(String)).returns(T.nilable(String)) }
def trial_continuation=(_trial_continuation); end
# Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
sig { returns(T.nilable(T.any(Integer, String))) }
def trial_end; end
sig {
params(_trial_end: T.nilable(T.any(Integer, String))).returns(T.nilable(T.any(Integer, String)))
}
def trial_end=(_trial_end); end
# Settings related to subscription trials.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::TrialSettings))
}
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::TrialSettings)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(add_invoice_items: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::BillingThresholds)), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.any(String, T::Array[String])), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount])), duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Duration), end_date: T.nilable(T.any(Integer, String)), invoice_settings: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings), items: T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item], metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), pause_collection: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::PauseCollection), proration_behavior: T.nilable(String), start_date: T.nilable(T.any(Integer, String)), transfer_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::TransferData), trial: T.nilable(T::Boolean), trial_continuation: T.nilable(String), trial_end: T.nilable(T.any(Integer, String)), trial_settings: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::TrialSettings)).void
}
def initialize(
add_invoice_items: nil,
application_fee_percent: nil,
automatic_tax: nil,
billing_cycle_anchor: nil,
billing_thresholds: nil,
collection_method: nil,
currency: nil,
default_payment_method: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
duration: nil,
end_date: nil,
invoice_settings: nil,
items: nil,
metadata: nil,
on_behalf_of: nil,
pause_collection: nil,
proration_behavior: nil,
start_date: nil,
transfer_data: nil,
trial: nil,
trial_continuation: nil,
trial_end: nil,
trial_settings: nil
); end
end
class Prebilling < Stripe::RequestParams
class BillUntil < Stripe::RequestParams
class AmendmentEnd < Stripe::RequestParams
# The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments.
sig { returns(Integer) }
def index; end
sig { params(_index: Integer).returns(Integer) }
def index=(_index); end
sig { params(index: Integer).void }
def initialize(index: nil); end
end
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# End the prebilled period when a specified amendment ends.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil::AmendmentEnd))
}
def amendment_end; end
sig {
params(_amendment_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil::AmendmentEnd)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil::AmendmentEnd))
}
def amendment_end=(_amendment_end); end
# Time span for prebilling, starting from `bill_from`.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil::Duration)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil::Duration))
}
def duration=(_duration); end
# End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select one of several ways to pass the `bill_until` value.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(amendment_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil::AmendmentEnd), duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(amendment_end: nil, duration: nil, timestamp: nil, type: nil); end
end
# The end of the prebilled time period.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil))
}
def bill_until; end
sig {
params(_bill_until: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil))
}
def bill_until=(_bill_until); end
# This is used to determine the number of billing cycles to prebill.
sig { returns(T.nilable(Integer)) }
def iterations; end
sig { params(_iterations: T.nilable(Integer)).returns(T.nilable(Integer)) }
def iterations=(_iterations); end
sig {
params(bill_until: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil), iterations: T.nilable(Integer)).void
}
def initialize(bill_until: nil, iterations: nil); end
end
# Changes to apply to the phases of the subscription schedule, in the order provided.
sig {
returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment]))
}
def amendments; end
sig {
params(_amendments: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment])).returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment]))
}
def amendments=(_amendments); end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
sig { params(_billing_behavior: T.nilable(String)).returns(T.nilable(String)) }
def billing_behavior=(_billing_behavior); end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::BillingMode))
}
def billing_mode; end
sig {
params(_billing_mode: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::BillingMode)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::BillingMode))
}
def billing_mode=(_billing_mode); end
# Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
sig { returns(T.nilable(String)) }
def end_behavior; end
sig { params(_end_behavior: T.nilable(String)).returns(T.nilable(String)) }
def end_behavior=(_end_behavior); end
# List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
sig {
returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase]))
}
def phases; end
sig {
params(_phases: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase])).returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase]))
}
def phases=(_phases); end
# Provide any time periods to bill in advance.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Prebilling])))
}
def prebilling; end
sig {
params(_prebilling: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Prebilling]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Prebilling])))
}
def prebilling=(_prebilling); end
# In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
sig {
params(amendments: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Amendment]), billing_behavior: T.nilable(String), billing_mode: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::BillingMode), end_behavior: T.nilable(String), phases: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase]), prebilling: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Prebilling])), proration_behavior: T.nilable(String)).void
}
def initialize(
amendments: nil,
billing_behavior: nil,
billing_mode: nil,
end_behavior: nil,
phases: nil,
prebilling: nil,
proration_behavior: nil
); end
end
class SubscriptionDetails < Stripe::RequestParams
class BillingMode < Stripe::RequestParams
class Flexible < Stripe::RequestParams
# Set to `true` to display gross amounts, net amounts, and discount amounts consistently between prorations and non-proration items on invoices, line items, and invoice items. Once set to `true`, you can't change it back to `false`.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
sig {
params(_consistent_proration_discount_amounts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consistent_proration_discount_amounts=(_consistent_proration_discount_amounts); end
sig { params(consistent_proration_discount_amounts: T.nilable(T::Boolean)).void }
def initialize(consistent_proration_discount_amounts: nil); end
end
# Configure behavior for flexible billing mode.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::BillingMode::Flexible))
}
def flexible; end
sig {
params(_flexible: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::BillingMode::Flexible)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::BillingMode::Flexible))
}
def flexible=(_flexible); end
# Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(flexible: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::BillingMode::Flexible), type: String).void
}
def initialize(flexible: nil, type: nil); end
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))
sig { returns(Integer) }
def usage_gte; end
sig { params(_usage_gte: Integer).returns(Integer) }
def usage_gte=(_usage_gte); end
sig { params(usage_gte: Integer).void }
def initialize(usage_gte: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::PriceData::Recurring)
}
def recurring; end
sig {
params(_recurring: ::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::PriceData::Recurring).returns(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::PriceData::Recurring)
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: ::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def clear_usage; end
sig { params(_clear_usage: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def clear_usage=(_clear_usage); end
# A flag that, if set to `true`, will delete the specified item.
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
sig { params(_deleted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def deleted=(_deleted); end
# The coupons to redeem into discounts for the subscription item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::Discount])))
}
def discounts=(_discounts); end
# Subscription item to update.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Plan ID for this item, as a string.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::PriceData)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::PriceData))
}
def price_data=(_price_data); end
# Quantity for this item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(billing_thresholds: T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::BillingThresholds)), clear_usage: T.nilable(T::Boolean), deleted: T.nilable(T::Boolean), discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::Discount])), id: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
billing_thresholds: nil,
clear_usage: nil,
deleted: nil,
discounts: nil,
id: nil,
metadata: nil,
plan: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class Prebilling < Stripe::RequestParams
# This is used to determine the number of billing cycles to prebill.
sig { returns(Integer) }
def iterations; end
sig { params(_iterations: Integer).returns(Integer) }
def iterations=(_iterations); end
sig { params(iterations: Integer).void }
def initialize(iterations: nil); end
end
# For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.
sig { returns(T.nilable(T.any(String, Integer))) }
def billing_cycle_anchor; end
sig {
params(_billing_cycle_anchor: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def billing_cycle_anchor=(_billing_cycle_anchor); end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::BillingMode))
}
def billing_mode; end
sig {
params(_billing_mode: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::BillingMode)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::BillingMode))
}
def billing_mode=(_billing_mode); end
# 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.
sig { returns(T.nilable(T.any(String, T.any(Integer, String)))) }
def cancel_at; end
sig {
params(_cancel_at: T.nilable(T.any(String, T.any(Integer, String)))).returns(T.nilable(T.any(String, T.any(Integer, String))))
}
def cancel_at=(_cancel_at); end
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def cancel_at_period_end; end
sig { params(_cancel_at_period_end: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def cancel_at_period_end=(_cancel_at_period_end); end
# This simulates the subscription being canceled or expired immediately.
sig { returns(T.nilable(T::Boolean)) }
def cancel_now; end
sig { params(_cancel_now: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def cancel_now=(_cancel_now); end
# If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# A list of up to 20 subscription items, each with an attached price.
sig {
returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item]))
}
def items; end
sig {
params(_items: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item])).returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item]))
}
def items=(_items); end
# The pre-billing to apply to the subscription as a preview.
sig {
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Prebilling))
}
def prebilling; end
sig {
params(_prebilling: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Prebilling)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Prebilling))
}
def prebilling=(_prebilling); end
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.
sig { returns(T.nilable(Integer)) }
def proration_date; end
sig { params(_proration_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def proration_date=(_proration_date); end
# For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.
sig { returns(T.nilable(String)) }
def resume_at; end
sig { params(_resume_at: T.nilable(String)).returns(T.nilable(String)) }
def resume_at=(_resume_at); end
# Date a subscription is intended to start (can be future or past).
sig { returns(T.nilable(Integer)) }
def start_date; end
sig { params(_start_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def start_date=(_start_date); end
# If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required.
sig { returns(T.nilable(T.any(String, Integer))) }
def trial_end; end
sig {
params(_trial_end: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def trial_end=(_trial_end); end
sig {
params(billing_cycle_anchor: T.nilable(T.any(String, Integer)), billing_mode: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::BillingMode), cancel_at: T.nilable(T.any(String, T.any(Integer, String))), cancel_at_period_end: T.nilable(T::Boolean), cancel_now: T.nilable(T::Boolean), default_tax_rates: T.nilable(T.any(String, T::Array[String])), items: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item]), prebilling: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Prebilling), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), resume_at: T.nilable(String), start_date: T.nilable(Integer), trial_end: T.nilable(T.any(String, Integer))).void
}
def initialize(
billing_cycle_anchor: nil,
billing_mode: nil,
cancel_at: nil,
cancel_at_period_end: nil,
cancel_now: nil,
default_tax_rates: nil,
items: nil,
prebilling: nil,
proration_behavior: nil,
proration_date: nil,
resume_at: nil,
start_date: nil,
trial_end: nil
); end
end
# Settings for automatic tax lookup for this invoice preview.
sig { returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::Invoice::CreatePreviewParams::AutomaticTax)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# The currency to preview this invoice in. Defaults to that of `customer` if not specified.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The identifier of the account whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_account`, `customer_details`, `subscription`, or `schedule` must be set.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
sig { returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::CustomerDetails)) }
def customer_details; end
sig {
params(_customer_details: T.nilable(::Stripe::Invoice::CreatePreviewParams::CustomerDetails)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::CustomerDetails))
}
def customer_details=(_customer_details); end
# The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# List of invoice items to add or update in the upcoming invoice preview (up to 250).
sig { returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::InvoiceItem])) }
def invoice_items; end
sig {
params(_invoice_items: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::InvoiceItem])).returns(T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::InvoiceItem]))
}
def invoice_items=(_invoice_items); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig { returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::Issuer)) }
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::Invoice::CreatePreviewParams::Issuer)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::Issuer))
}
def issuer=(_issuer); end
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.
sig { returns(T.nilable(String)) }
def preview_mode; end
sig { params(_preview_mode: T.nilable(String)).returns(T.nilable(String)) }
def preview_mode=(_preview_mode); end
# The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.
sig { returns(T.nilable(String)) }
def schedule; end
sig { params(_schedule: T.nilable(String)).returns(T.nilable(String)) }
def schedule=(_schedule); end
# The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.
sig { returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails)) }
def schedule_details; end
sig {
params(_schedule_details: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails))
}
def schedule_details=(_schedule_details); end
# The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.
sig { returns(T.nilable(String)) }
def subscription; end
sig { params(_subscription: T.nilable(String)).returns(T.nilable(String)) }
def subscription=(_subscription); end
# The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.
sig { returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails)) }
def subscription_details; end
sig {
params(_subscription_details: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails)).returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails))
}
def subscription_details=(_subscription_details); end
sig {
params(automatic_tax: T.nilable(::Stripe::Invoice::CreatePreviewParams::AutomaticTax), currency: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), customer_details: T.nilable(::Stripe::Invoice::CreatePreviewParams::CustomerDetails), discounts: T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::Discount])), expand: T.nilable(T::Array[String]), invoice_items: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::InvoiceItem]), issuer: T.nilable(::Stripe::Invoice::CreatePreviewParams::Issuer), on_behalf_of: T.nilable(String), preview_mode: T.nilable(String), schedule: T.nilable(String), schedule_details: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails), subscription: T.nilable(String), subscription_details: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails)).void
}
def initialize(
automatic_tax: nil,
currency: nil,
customer: nil,
customer_account: nil,
customer_details: nil,
discounts: nil,
expand: nil,
invoice_items: nil,
issuer: nil,
on_behalf_of: nil,
preview_mode: nil,
schedule: nil,
schedule_details: nil,
subscription: nil,
subscription_details: nil
); end
end
# Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
sig {
params(params: T.any(::Stripe::Invoice::AddLinesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def add_lines(params = {}, opts = {}); end
# Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
sig {
params(invoice: String, params: T.any(::Stripe::Invoice::AddLinesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def self.add_lines(invoice, params = {}, opts = {}); end
# 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.
sig {
params(params: T.any(::Stripe::Invoice::AttachPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def attach_payment(params = {}, opts = {}); end
# 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.
sig {
params(invoice: String, params: T.any(::Stripe::Invoice::AttachPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def self.attach_payment(invoice, params = {}, opts = {}); 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 send](https://docs.stripe.com/api#finalize_invoice) the invoice to your customers.
sig {
params(params: T.any(::Stripe::Invoice::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def self.create(params = {}, opts = {}); 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.
#
# 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.
#
# 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)
sig {
params(params: T.any(::Stripe::Invoice::CreatePreviewParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def self.create_preview(params = {}, opts = {}); 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://docs.stripe.com/api#void_invoice).
sig {
params(invoice: String, params: T.any(::Stripe::Invoice::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def self.delete(invoice, params = {}, opts = {}); 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://docs.stripe.com/api#void_invoice).
sig {
params(params: T.any(::Stripe::Invoice::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def delete(params = {}, opts = {}); end
# Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you'd like to finalize a draft invoice manually, you can do so using this method.
sig {
params(params: T.any(::Stripe::Invoice::FinalizeInvoiceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def finalize_invoice(params = {}, opts = {}); end
# Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you'd like to finalize a draft invoice manually, you can do so using this method.
sig {
params(invoice: String, params: T.any(::Stripe::Invoice::FinalizeInvoiceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def self.finalize_invoice(invoice, params = {}, opts = {}); end
# You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.
sig {
params(params: T.any(::Stripe::Invoice::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
sig {
params(params: T.any(::Stripe::Invoice::MarkUncollectibleParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def mark_uncollectible(params = {}, opts = {}); end
# Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
sig {
params(invoice: String, params: T.any(::Stripe::Invoice::MarkUncollectibleParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def self.mark_uncollectible(invoice, params = {}, opts = {}); end
# Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your [subscriptions settings](https://dashboard.stripe.com/account/billing/automatic). However, if you'd like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.
sig {
params(params: T.any(::Stripe::Invoice::PayParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def pay(params = {}, opts = {}); end
# Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your [subscriptions settings](https://dashboard.stripe.com/account/billing/automatic). However, if you'd like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.
sig {
params(invoice: String, params: T.any(::Stripe::Invoice::PayParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def self.pay(invoice, params = {}, opts = {}); end
# Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.
sig {
params(params: T.any(::Stripe::Invoice::RemoveLinesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def remove_lines(params = {}, opts = {}); end
# Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.
sig {
params(invoice: String, params: T.any(::Stripe::Invoice::RemoveLinesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def self.remove_lines(invoice, params = {}, opts = {}); end
sig {
params(params: T.any(::Stripe::Invoice::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
}
def self.search(params = {}, opts = {}); end
sig {
params(params: T.any(::Stripe::Invoice::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, blk: T.untyped).returns(Stripe::SearchResultObject)
}
def self.search_auto_paging_each(params = {}, opts = {}, &blk); end
# Stripe will automatically send invoices to customers according to your [subscriptions settings](https://dashboard.stripe.com/account/billing/automatic). However, if you'd like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.
#
# Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.
sig {
params(params: T.any(::Stripe::Invoice::SendInvoiceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def send_invoice(params = {}, opts = {}); end
# Stripe will automatically send invoices to customers according to your [subscriptions settings](https://dashboard.stripe.com/account/billing/automatic). However, if you'd like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.
#
# Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.
sig {
params(invoice: String, params: T.any(::Stripe::Invoice::SendInvoiceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def self.send_invoice(invoice, params = {}, opts = {}); end
# 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://docs.stripe.com/docs/billing/invoices/reconciliation) invoices, pass
# auto_advance=false.
sig {
params(invoice: String, params: T.any(::Stripe::Invoice::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def self.update(invoice, params = {}, opts = {}); end
# Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.
sig {
params(params: T.any(::Stripe::Invoice::UpdateLinesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def update_lines(params = {}, opts = {}); end
# Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.
sig {
params(invoice: String, params: T.any(::Stripe::Invoice::UpdateLinesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def self.update_lines(invoice, params = {}, opts = {}); end
# 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 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.
sig {
params(params: T.any(::Stripe::Invoice::VoidInvoiceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def void_invoice(params = {}, opts = {}); end
# 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 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.
sig {
params(invoice: String, params: T.any(::Stripe::Invoice::VoidInvoiceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def self.void_invoice(invoice, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice.
#
# Each line item is backed by either an [invoice item](https://stripe.com/docs/api/invoiceitems) or a [subscription item](https://stripe.com/docs/api/subscription_items).
class InvoiceLineItem < APIResource
class DiscountAmount < Stripe::StripeObject
# The amount, in cents (or local equivalent), of the discount.
sig { returns(Integer) }
def amount; end
# The discount that was applied to get this discount amount.
sig { returns(T.any(String, Stripe::Discount)) }
def discount; end
end
class MarginAmount < Stripe::StripeObject
# The amount, in cents (or local equivalent), of the reduction in line item amount.
sig { returns(Integer) }
def amount; end
# The margin that was applied to get this margin amount.
sig { returns(T.any(String, Stripe::Margin)) }
def margin; end
end
class Parent < Stripe::StripeObject
class InvoiceItemDetails < Stripe::StripeObject
class ProrationDetails < Stripe::StripeObject
class CreditedItems < Stripe::StripeObject
# Invoice containing the credited invoice line items
sig { returns(String) }
def invoice; end
# Credited invoice line items
sig { returns(T::Array[String]) }
def invoice_line_items; end
end
# For a credit proration `line_item`, the original debit line_items to which the credit proration applies.
sig { returns(T.nilable(CreditedItems)) }
def credited_items; end
end
# The invoice item that generated this line item
sig { returns(String) }
def invoice_item; end
# Whether this is a proration
sig { returns(T::Boolean) }
def proration; end
# Additional details for proration line items
sig { returns(T.nilable(ProrationDetails)) }
def proration_details; end
# The subscription that the invoice item belongs to
sig { returns(T.nilable(String)) }
def subscription; end
end
class SubscriptionItemDetails < Stripe::StripeObject
class ProrationDetails < Stripe::StripeObject
class CreditedItems < Stripe::StripeObject
# Invoice containing the credited invoice line items
sig { returns(String) }
def invoice; end
# Credited invoice line items
sig { returns(T::Array[String]) }
def invoice_line_items; end
end
# For a credit proration `line_item`, the original debit line_items to which the credit proration applies.
sig { returns(T.nilable(CreditedItems)) }
def credited_items; end
end
# The invoice item that generated this line item
sig { returns(T.nilable(String)) }
def invoice_item; end
# Whether this is a proration
sig { returns(T::Boolean) }
def proration; end
# Additional details for proration line items
sig { returns(T.nilable(ProrationDetails)) }
def proration_details; end
# The subscription that the subscription item belongs to
sig { returns(T.nilable(String)) }
def subscription; end
# The subscription item that generated this line item
sig { returns(String) }
def subscription_item; end
end
# Details about the invoice item that generated this line item
sig { returns(T.nilable(InvoiceItemDetails)) }
def invoice_item_details; end
# Details about the subscription item that generated this line item
sig { returns(T.nilable(SubscriptionItemDetails)) }
def subscription_item_details; end
# The type of parent that generated this line item
sig { returns(String) }
def type; end
end
class Period < Stripe::StripeObject
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
sig { returns(Integer) }
def end; end
# The start of the period. This value is inclusive.
sig { returns(Integer) }
def start; end
end
class PretaxCreditAmount < Stripe::StripeObject
# The amount, in cents (or local equivalent), of the pretax credit amount.
sig { returns(Integer) }
def amount; end
# The credit balance transaction that was applied to get this pretax credit amount.
sig { returns(T.nilable(T.any(String, Stripe::Billing::CreditBalanceTransaction))) }
def credit_balance_transaction; end
# The discount that was applied to get this pretax credit amount.
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
def discount; end
# The margin that was applied to get this pretax credit amount.
sig { returns(T.nilable(T.any(String, Stripe::Margin))) }
def margin; end
# Type of the pretax credit amount referenced.
sig { returns(String) }
def type; end
end
class Pricing < Stripe::StripeObject
class PriceDetails < Stripe::StripeObject
# The ID of the price this item is associated with.
sig { returns(String) }
def price; end
# The ID of the product this item is associated with.
sig { returns(String) }
def product; end
end
# Attribute for field price_details
sig { returns(T.nilable(PriceDetails)) }
def price_details; end
# The type of the pricing details.
sig { returns(String) }
def type; end
# The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
end
class TaxCalculationReference < Stripe::StripeObject
# The calculation identifier for tax calculation response.
sig { returns(T.nilable(String)) }
def calculation_id; end
# The calculation identifier for tax calculation response line item.
sig { returns(T.nilable(String)) }
def calculation_item_id; end
end
class Tax < Stripe::StripeObject
class TaxRateDetails < Stripe::StripeObject
# Attribute for field tax_rate
sig { returns(String) }
def tax_rate; end
end
# The amount of the tax, in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
# Whether this tax is inclusive or exclusive.
sig { returns(String) }
def tax_behavior; end
# Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
sig { returns(T.nilable(TaxRateDetails)) }
def tax_rate_details; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(String) }
def taxability_reason; end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(T.nilable(Integer)) }
def taxable_amount; end
# The type of tax information.
sig { returns(String) }
def type; end
end
# The amount, in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# The amount of discount calculated per discount for this line item.
sig { returns(T.nilable(T::Array[DiscountAmount])) }
def discount_amounts; end
# If true, discounts will apply to this line item. Always false for prorations.
sig { returns(T::Boolean) }
def discountable; end
# The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
sig { returns(T::Array[T.any(String, Stripe::Discount)]) }
def discounts; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The ID of the invoice that contains this line item.
sig { returns(T.nilable(String)) }
def invoice; end
# 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) }
def livemode; end
# The amount of margin calculated per margin for this line item.
sig { returns(T.nilable(T::Array[MarginAmount])) }
def margin_amounts; end
# The margins applied to the line item. When set, the `default_margins` on the invoice do not apply to the line item. Use `expand[]=margins` to expand each margin.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::Margin)])) }
def margins; end
# 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. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.
sig { returns(T::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The parent that generated this line item.
sig { returns(T.nilable(Parent)) }
def parent; end
# Attribute for field period
sig { returns(Period) }
def period; end
# Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.
sig { returns(T.nilable(T::Array[PretaxCreditAmount])) }
def pretax_credit_amounts; end
# The pricing information of the line item.
sig { returns(T.nilable(Pricing)) }
def pricing; end
# The quantity of the subscription, if the line item is a subscription or a proration.
sig { returns(T.nilable(Integer)) }
def quantity; end
# Attribute for field subscription
sig { returns(T.nilable(T.any(String, Stripe::Subscription))) }
def subscription; end
# The tax calculation identifiers of the line item.
sig { returns(T.nilable(TaxCalculationReference)) }
def tax_calculation_reference; end
# The tax information of the line item.
sig { returns(T.nilable(T::Array[Tax])) }
def taxes; end
class UpdateParams < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
sig { returns(Integer) }
def end; end
sig { params(_end: Integer).returns(Integer) }
def end=(_end); end
# The start of the period. This value is inclusive.
sig { returns(Integer) }
def start; end
sig { params(_start: Integer).returns(Integer) }
def start=(_start); end
sig { params(end_: Integer, start: Integer).void }
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
class ProductData < Stripe::RequestParams
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T::Array[String])) }
def images; end
sig { params(_images: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def images=(_images); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
sig {
params(description: T.nilable(String), images: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: String, tax_code: T.nilable(String), unit_label: T.nilable(String)).void
}
def initialize(
description: nil,
images: nil,
metadata: nil,
name: nil,
tax_code: nil,
unit_label: nil
); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
sig { returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::PriceData::ProductData)) }
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::PriceData::ProductData)).returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::PriceData::ProductData))
}
def product_data=(_product_data); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: T.nilable(String), product_data: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::PriceData::ProductData), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
product_data: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Pricing < Stripe::RequestParams
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
sig { params(price: T.nilable(String)).void }
def initialize(price: nil); end
end
class TaxAmount < Stripe::RequestParams
class TaxRateData < Stripe::RequestParams
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The display name of the tax rate, which will be shown to users.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# This specifies if the tax rate is inclusive or exclusive.
sig { returns(T::Boolean) }
def inclusive; end
sig { params(_inclusive: T::Boolean).returns(T::Boolean) }
def inclusive=(_inclusive); end
# The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
sig { returns(T.nilable(String)) }
def jurisdiction; end
sig { params(_jurisdiction: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction=(_jurisdiction); end
# The level of the jurisdiction that imposes this tax rate.
sig { returns(T.nilable(String)) }
def jurisdiction_level; end
sig { params(_jurisdiction_level: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction_level=(_jurisdiction_level); end
# The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.
sig { returns(Float) }
def percentage; end
sig { params(_percentage: Float).returns(Float) }
def percentage=(_percentage); end
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# The high-level tax type, such as `vat` or `sales_tax`.
sig { returns(T.nilable(String)) }
def tax_type; end
sig { params(_tax_type: T.nilable(String)).returns(T.nilable(String)) }
def tax_type=(_tax_type); end
sig {
params(country: T.nilable(String), description: T.nilable(String), display_name: String, inclusive: T::Boolean, jurisdiction: T.nilable(String), jurisdiction_level: T.nilable(String), percentage: Float, state: T.nilable(String), tax_type: T.nilable(String)).void
}
def initialize(
country: nil,
description: nil,
display_name: nil,
inclusive: nil,
jurisdiction: nil,
jurisdiction_level: nil,
percentage: nil,
state: nil,
tax_type: nil
); end
end
# The amount, in cents (or local equivalent), of the tax.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Data to find or create a TaxRate object.
#
# Stripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.
sig { returns(::Stripe::InvoiceLineItem::UpdateParams::TaxAmount::TaxRateData) }
def tax_rate_data; end
sig {
params(_tax_rate_data: ::Stripe::InvoiceLineItem::UpdateParams::TaxAmount::TaxRateData).returns(::Stripe::InvoiceLineItem::UpdateParams::TaxAmount::TaxRateData)
}
def tax_rate_data=(_tax_rate_data); end
# The reasoning behind this tax, for example, if the product is tax exempt.
sig { returns(T.nilable(String)) }
def taxability_reason; end
sig { params(_taxability_reason: T.nilable(String)).returns(T.nilable(String)) }
def taxability_reason=(_taxability_reason); end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(Integer) }
def taxable_amount; end
sig { params(_taxable_amount: Integer).returns(Integer) }
def taxable_amount=(_taxable_amount); end
sig {
params(amount: Integer, tax_rate_data: ::Stripe::InvoiceLineItem::UpdateParams::TaxAmount::TaxRateData, taxability_reason: T.nilable(String), taxable_amount: Integer).void
}
def initialize(
amount: nil,
tax_rate_data: nil,
taxability_reason: nil,
taxable_amount: nil
); end
end
# The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
sig { returns(T.nilable(T::Boolean)) }
def discountable; end
sig { params(_discountable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def discountable=(_discountable); end
# The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItem::UpdateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItem::UpdateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItem::UpdateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def margins; end
sig {
params(_margins: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def margins=(_margins); end
# 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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
sig { returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Period)) }
def period; end
sig {
params(_period: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Period)).returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Period))
}
def period=(_period); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig { returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::PriceData)).returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::PriceData))
}
def price_data=(_price_data); end
# The pricing information for the invoice item.
sig { returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Pricing)) }
def pricing; end
sig {
params(_pricing: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Pricing)).returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Pricing))
}
def pricing=(_pricing); end
# Non-negative integer. The quantity of units for the line item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItem::UpdateParams::TaxAmount])))
}
def tax_amounts; end
sig {
params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItem::UpdateParams::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItem::UpdateParams::TaxAmount])))
}
def tax_amounts=(_tax_amounts); end
# The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(amount: T.nilable(Integer), description: T.nilable(String), discountable: T.nilable(T::Boolean), discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItem::UpdateParams::Discount])), expand: T.nilable(T::Array[String]), margins: T.nilable(T.any(String, T::Array[String])), metadata: T.nilable(T.any(String, T::Hash[String, String])), period: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Period), price_data: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::PriceData), pricing: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Pricing), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItem::UpdateParams::TaxAmount])), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
amount: nil,
description: nil,
discountable: nil,
discounts: nil,
expand: nil,
margins: nil,
metadata: nil,
period: nil,
price_data: nil,
pricing: nil,
quantity: nil,
tax_amounts: nil,
tax_rates: nil
); end
end
# Updates an invoice's line item. Some fields, such as tax_amounts, only live on the invoice line item,
# so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice
# item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.
# Updating an invoice's line item is only possible before the invoice is finalized.
sig {
params(invoice: String, line_item_id: String, params: T.any(::Stripe::InvoiceLineItem::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceLineItem)
}
def self.update(invoice, line_item_id, params = {}, opts = {}); end
end
end
# typed: true
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
class AmountDetails < Stripe::StripeObject
# The fee charged by the ATM for the cash withdrawal.
sig { returns(T.nilable(Integer)) }
def atm_fee; end
# The amount of cash requested by the cardholder.
sig { returns(T.nilable(Integer)) }
def cashback_amount; end
end
class Fleet < Stripe::StripeObject
class CardholderPromptData < Stripe::StripeObject
# [Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID.
sig { returns(T.nilable(String)) }
def alphanumeric_id; end
# Driver ID.
sig { returns(T.nilable(String)) }
def driver_id; end
# Odometer reading.
sig { returns(T.nilable(Integer)) }
def odometer; end
# An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
sig { returns(T.nilable(String)) }
def unspecified_id; end
# User ID.
sig { returns(T.nilable(String)) }
def user_id; end
# Vehicle number.
sig { returns(T.nilable(String)) }
def vehicle_number; end
end
class ReportedBreakdown < Stripe::StripeObject
class Fuel < Stripe::StripeObject
# Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
end
class NonFuel < Stripe::StripeObject
# Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
end
class Tax < Stripe::StripeObject
# Amount of state or provincial Sales Tax included in the transaction amount. `null` if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def local_amount_decimal; end
# Amount of national Sales Tax or VAT included in the transaction amount. `null` if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def national_amount_decimal; end
end
# Breakdown of fuel portion of the purchase.
sig { returns(T.nilable(Fuel)) }
def fuel; end
# Breakdown of non-fuel portion of the purchase.
sig { returns(T.nilable(NonFuel)) }
def non_fuel; end
# Information about tax included in this transaction.
sig { returns(T.nilable(Tax)) }
def tax; end
end
# Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
sig { returns(T.nilable(CardholderPromptData)) }
def cardholder_prompt_data; end
# The type of purchase.
sig { returns(T.nilable(String)) }
def purchase_type; end
# More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
sig { returns(T.nilable(ReportedBreakdown)) }
def reported_breakdown; end
# The type of fuel service.
sig { returns(T.nilable(String)) }
def service_type; end
end
class FraudChallenge < Stripe::StripeObject
# The method by which the fraud challenge was delivered to the cardholder.
sig { returns(String) }
def channel; end
# The status of the fraud challenge.
sig { returns(String) }
def status; end
# If the challenge is not deliverable, the reason why.
sig { returns(T.nilable(String)) }
def undeliverable_reason; end
end
class Fuel < Stripe::StripeObject
# [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
sig { returns(T.nilable(String)) }
def industry_product_code; end
# The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def quantity_decimal; end
# The type of fuel that was purchased.
sig { returns(T.nilable(String)) }
def type; end
# The units for `quantity_decimal`.
sig { returns(T.nilable(String)) }
def unit; end
# The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_cost_decimal; end
end
class MerchantData < Stripe::StripeObject
# A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.
sig { returns(String) }
def category; end
# The merchant category code for the seller’s business
sig { returns(String) }
def category_code; end
# City where the seller is located
sig { returns(T.nilable(String)) }
def city; end
# Country where the seller is located
sig { returns(T.nilable(String)) }
def country; end
# Name of the seller
sig { returns(T.nilable(String)) }
def name; end
# Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
sig { returns(String) }
def network_id; end
# Postal code where the seller is located
sig { returns(T.nilable(String)) }
def postal_code; end
# State where the seller is located
sig { returns(T.nilable(String)) }
def state; end
# The seller's tax identification number. Currently populated for French merchants only.
sig { returns(T.nilable(String)) }
def tax_id; end
# An ID assigned by the seller to the location of the sale.
sig { returns(T.nilable(String)) }
def terminal_id; end
# URL provided by the merchant on a 3DS request
sig { returns(T.nilable(String)) }
def url; end
end
class NetworkData < Stripe::StripeObject
# Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`.
sig { returns(T.nilable(String)) }
def acquiring_institution_id; end
# The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements.
sig { returns(T.nilable(String)) }
def system_trace_audit_number; end
# Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class PendingRequest < Stripe::StripeObject
class AmountDetails < Stripe::StripeObject
# The fee charged by the ATM for the cash withdrawal.
sig { returns(T.nilable(Integer)) }
def atm_fee; end
# The amount of cash requested by the cardholder.
sig { returns(T.nilable(Integer)) }
def cashback_amount; end
end
# The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(AmountDetails)) }
def amount_details; end
# 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) }
def currency; end
# If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.
sig { returns(T::Boolean) }
def is_amount_controllable; end
# The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def merchant_amount; end
# The local currency the merchant is requesting to authorize.
sig { returns(String) }
def merchant_currency; end
# The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.
sig { returns(T.nilable(Integer)) }
def network_risk_score; end
end
class RequestHistory < Stripe::StripeObject
class AmountDetails < Stripe::StripeObject
# The fee charged by the ATM for the cash withdrawal.
sig { returns(T.nilable(Integer)) }
def atm_fee; end
# The amount of cash requested by the cardholder.
sig { returns(T.nilable(Integer)) }
def cashback_amount; end
end
# The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved.
sig { returns(Integer) }
def amount; end
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(AmountDetails)) }
def amount_details; end
# Whether this request was approved.
sig { returns(T::Boolean) }
def approved; end
# A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations.
sig { returns(T.nilable(String)) }
def authorization_code; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def merchant_amount; end
# The currency that was collected by the merchant and presented to the cardholder for the authorization. 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) }
def merchant_currency; end
# The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.
sig { returns(T.nilable(Integer)) }
def network_risk_score; end
# When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.
sig { returns(String) }
def reason; end
# If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field.
sig { returns(T.nilable(String)) }
def reason_message; end
# Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time.
sig { returns(T.nilable(Integer)) }
def requested_at; end
end
class Treasury < Stripe::StripeObject
# The array of [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) associated with this authorization
sig { returns(T::Array[String]) }
def received_credits; end
# The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization
sig { returns(T::Array[String]) }
def received_debits; end
# The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization
sig { returns(T.nilable(String)) }
def transaction; end
end
class VerificationData < Stripe::StripeObject
class AuthenticationExemption < Stripe::StripeObject
# The entity that requested the exemption, either the acquiring merchant or the Issuing user.
sig { returns(String) }
def claimed_by; end
# The specific exemption claimed for this authorization.
sig { returns(String) }
def type; end
end
class ThreeDSecure < Stripe::StripeObject
# The outcome of the 3D Secure authentication request.
sig { returns(String) }
def result; end
end
# Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`.
sig { returns(String) }
def address_line1_check; end
# Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`.
sig { returns(String) }
def address_postal_code_check; end
# The exemption applied to this authorization.
sig { returns(T.nilable(AuthenticationExemption)) }
def authentication_exemption; end
# Whether the cardholder provided a CVC and if it matched Stripe’s record.
sig { returns(String) }
def cvc_check; end
# Whether the cardholder provided an expiry date and if it matched Stripe’s record.
sig { returns(String) }
def expiry_check; end
# The postal code submitted as part of the authorization used for postal code verification.
sig { returns(T.nilable(String)) }
def postal_code; end
# 3D Secure details.
sig { returns(T.nilable(ThreeDSecure)) }
def three_d_secure; end
end
# The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different.
sig { returns(Integer) }
def amount; end
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(AmountDetails)) }
def amount_details; end
# Whether the authorization has been approved.
sig { returns(T::Boolean) }
def approved; end
# How the card details were provided.
sig { returns(String) }
def authorization_method; end
# List of balance transactions associated with this authorization.
sig { returns(T::Array[Stripe::BalanceTransaction]) }
def balance_transactions; end
# You can [create physical or virtual cards](https://stripe.com/docs/issuing) that are issued to cardholders.
sig { returns(Stripe::Issuing::Card) }
def card; end
# The cardholder to whom this authorization belongs.
sig { returns(T.nilable(T.any(String, Stripe::Issuing::Cardholder))) }
def cardholder; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. 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) }
def currency; end
# Fleet-specific information for authorizations using Fleet cards.
sig { returns(T.nilable(Fleet)) }
def fleet; end
# Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons.
sig { returns(T.nilable(T::Array[FraudChallenge])) }
def fraud_challenges; end
# Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed.
sig { returns(T.nilable(Fuel)) }
def fuel; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different.
sig { returns(Integer) }
def merchant_amount; end
# The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. 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) }
def merchant_currency; end
# Attribute for field merchant_data
sig { returns(MerchantData) }
def merchant_data; end
# 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::Hash[String, String]) }
def metadata; end
# Details about the authorization, such as identifiers, set by the card network.
sig { returns(T.nilable(NetworkData)) }
def network_data; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook.
sig { returns(T.nilable(PendingRequest)) }
def pending_request; end
# History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.
sig { returns(T::Array[RequestHistory]) }
def request_history; end
# The current status of the authorization in its lifecycle.
sig { returns(String) }
def status; end
# [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.
sig { returns(T.nilable(T.any(String, Stripe::Issuing::Token))) }
def token; end
# List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization.
sig { returns(T::Array[Stripe::Issuing::Transaction]) }
def transactions; end
# [Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts).
sig { returns(T.nilable(Treasury)) }
def treasury; end
# Attribute for field verification_data
sig { returns(VerificationData) }
def verification_data; end
# Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant.
sig { returns(T.nilable(T::Boolean)) }
def verified_by_fraud_challenge; end
# The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.
sig { returns(T.nilable(String)) }
def wallet; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return authorizations that belong to the given card.
sig { returns(T.nilable(String)) }
def card; end
sig { params(_card: T.nilable(String)).returns(T.nilable(String)) }
def card=(_card); end
# Only return authorizations that belong to the given cardholder.
sig { returns(T.nilable(String)) }
def cardholder; end
sig { params(_cardholder: T.nilable(String)).returns(T.nilable(String)) }
def cardholder=(_cardholder); end
# Only return authorizations that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Issuing::Authorization::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Issuing::Authorization::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Issuing::Authorization::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(card: T.nilable(String), cardholder: T.nilable(String), created: T.nilable(T.any(::Stripe::Issuing::Authorization::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
card: nil,
cardholder: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, metadata: nil); end
end
class ApproveParams < Stripe::RequestParams
# If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request).
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(amount: T.nilable(Integer), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(amount: nil, expand: nil, metadata: nil); end
end
class DeclineParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, metadata: nil); end
end
class CreateParams < Stripe::RequestParams
class AmountDetails < Stripe::RequestParams
# The ATM withdrawal fee.
sig { returns(T.nilable(Integer)) }
def atm_fee; end
sig { params(_atm_fee: T.nilable(Integer)).returns(T.nilable(Integer)) }
def atm_fee=(_atm_fee); end
# The amount of cash requested by the cardholder.
sig { returns(T.nilable(Integer)) }
def cashback_amount; end
sig { params(_cashback_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def cashback_amount=(_cashback_amount); end
sig { params(atm_fee: T.nilable(Integer), cashback_amount: T.nilable(Integer)).void }
def initialize(atm_fee: nil, cashback_amount: nil); end
end
class Fleet < Stripe::RequestParams
class CardholderPromptData < Stripe::RequestParams
# Driver ID.
sig { returns(T.nilable(String)) }
def driver_id; end
sig { params(_driver_id: T.nilable(String)).returns(T.nilable(String)) }
def driver_id=(_driver_id); end
# Odometer reading.
sig { returns(T.nilable(Integer)) }
def odometer; end
sig { params(_odometer: T.nilable(Integer)).returns(T.nilable(Integer)) }
def odometer=(_odometer); end
# An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
sig { returns(T.nilable(String)) }
def unspecified_id; end
sig { params(_unspecified_id: T.nilable(String)).returns(T.nilable(String)) }
def unspecified_id=(_unspecified_id); end
# User ID.
sig { returns(T.nilable(String)) }
def user_id; end
sig { params(_user_id: T.nilable(String)).returns(T.nilable(String)) }
def user_id=(_user_id); end
# Vehicle number.
sig { returns(T.nilable(String)) }
def vehicle_number; end
sig { params(_vehicle_number: T.nilable(String)).returns(T.nilable(String)) }
def vehicle_number=(_vehicle_number); end
sig {
params(driver_id: T.nilable(String), odometer: T.nilable(Integer), unspecified_id: T.nilable(String), user_id: T.nilable(String), vehicle_number: T.nilable(String)).void
}
def initialize(
driver_id: nil,
odometer: nil,
unspecified_id: nil,
user_id: nil,
vehicle_number: nil
); end
end
class ReportedBreakdown < Stripe::RequestParams
class Fuel < Stripe::RequestParams
# Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig { params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class NonFuel < Stripe::RequestParams
# Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig { params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class Tax < Stripe::RequestParams
# Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def local_amount_decimal; end
sig { params(_local_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def local_amount_decimal=(_local_amount_decimal); end
# Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def national_amount_decimal; end
sig { params(_national_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def national_amount_decimal=(_national_amount_decimal); end
sig {
params(local_amount_decimal: T.nilable(String), national_amount_decimal: T.nilable(String)).void
}
def initialize(local_amount_decimal: nil, national_amount_decimal: nil); end
end
# Breakdown of fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::ReportedBreakdown::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::ReportedBreakdown::Fuel)).returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::ReportedBreakdown::Fuel))
}
def fuel=(_fuel); end
# Breakdown of non-fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel; end
sig {
params(_non_fuel: T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::ReportedBreakdown::NonFuel)).returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel=(_non_fuel); end
# Information about tax included in this transaction.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::ReportedBreakdown::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::ReportedBreakdown::Tax)).returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::ReportedBreakdown::Tax))
}
def tax=(_tax); end
sig {
params(fuel: T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::ReportedBreakdown::Fuel), non_fuel: T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::ReportedBreakdown::NonFuel), tax: T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::ReportedBreakdown::Tax)).void
}
def initialize(fuel: nil, non_fuel: nil, tax: nil); end
end
# Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::CardholderPromptData))
}
def cardholder_prompt_data; end
sig {
params(_cardholder_prompt_data: T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::CardholderPromptData)).returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::CardholderPromptData))
}
def cardholder_prompt_data=(_cardholder_prompt_data); end
# The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
sig { returns(T.nilable(String)) }
def purchase_type; end
sig { params(_purchase_type: T.nilable(String)).returns(T.nilable(String)) }
def purchase_type=(_purchase_type); end
# More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::ReportedBreakdown))
}
def reported_breakdown; end
sig {
params(_reported_breakdown: T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::ReportedBreakdown)).returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::ReportedBreakdown))
}
def reported_breakdown=(_reported_breakdown); end
# The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
sig { returns(T.nilable(String)) }
def service_type; end
sig { params(_service_type: T.nilable(String)).returns(T.nilable(String)) }
def service_type=(_service_type); end
sig {
params(cardholder_prompt_data: T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::CardholderPromptData), purchase_type: T.nilable(String), reported_breakdown: T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet::ReportedBreakdown), service_type: T.nilable(String)).void
}
def initialize(
cardholder_prompt_data: nil,
purchase_type: nil,
reported_breakdown: nil,
service_type: nil
); end
end
class Fuel < Stripe::RequestParams
# [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
sig { returns(T.nilable(String)) }
def industry_product_code; end
sig { params(_industry_product_code: T.nilable(String)).returns(T.nilable(String)) }
def industry_product_code=(_industry_product_code); end
# The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def quantity_decimal; end
sig { params(_quantity_decimal: T.nilable(String)).returns(T.nilable(String)) }
def quantity_decimal=(_quantity_decimal); end
# The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
# The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_cost_decimal; end
sig { params(_unit_cost_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_cost_decimal=(_unit_cost_decimal); end
sig {
params(industry_product_code: T.nilable(String), quantity_decimal: T.nilable(String), type: T.nilable(String), unit: T.nilable(String), unit_cost_decimal: T.nilable(String)).void
}
def initialize(
industry_product_code: nil,
quantity_decimal: nil,
type: nil,
unit: nil,
unit_cost_decimal: nil
); end
end
class MerchantData < Stripe::RequestParams
# A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# City where the seller is located
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Country where the seller is located
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Name of the seller
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
sig { returns(T.nilable(String)) }
def network_id; end
sig { params(_network_id: T.nilable(String)).returns(T.nilable(String)) }
def network_id=(_network_id); end
# Postal code where the seller is located
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State where the seller is located
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# An ID assigned by the seller to the location of the sale.
sig { returns(T.nilable(String)) }
def terminal_id; end
sig { params(_terminal_id: T.nilable(String)).returns(T.nilable(String)) }
def terminal_id=(_terminal_id); end
# URL provided by the merchant on a 3DS request
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(category: T.nilable(String), city: T.nilable(String), country: T.nilable(String), name: T.nilable(String), network_id: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), terminal_id: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
category: nil,
city: nil,
country: nil,
name: nil,
network_id: nil,
postal_code: nil,
state: nil,
terminal_id: nil,
url: nil
); end
end
class NetworkData < Stripe::RequestParams
# Identifier assigned to the acquirer by the card network.
sig { returns(T.nilable(String)) }
def acquiring_institution_id; end
sig { params(_acquiring_institution_id: T.nilable(String)).returns(T.nilable(String)) }
def acquiring_institution_id=(_acquiring_institution_id); end
sig { params(acquiring_institution_id: T.nilable(String)).void }
def initialize(acquiring_institution_id: nil); end
end
class RiskAssessment < Stripe::RequestParams
class CardTestingRisk < Stripe::RequestParams
# The % of declines due to a card number not existing in the past hour, taking place at the same merchant. Higher rates correspond to a greater probability of card testing activity, meaning bad actors may be attempting different card number combinations to guess a correct one. Takes on values between 0 and 100.
sig { returns(T.nilable(Integer)) }
def invalid_account_number_decline_rate_past_hour; end
sig {
params(_invalid_account_number_decline_rate_past_hour: T.nilable(Integer)).returns(T.nilable(Integer))
}
def invalid_account_number_decline_rate_past_hour=(
_invalid_account_number_decline_rate_past_hour
); end
# The % of declines due to incorrect verification data (like CVV or expiry) in the past hour, taking place at the same merchant. Higher rates correspond to a greater probability of bad actors attempting to utilize valid card credentials at merchants with verification requirements. Takes on values between 0 and 100.
sig { returns(T.nilable(Integer)) }
def invalid_credentials_decline_rate_past_hour; end
sig {
params(_invalid_credentials_decline_rate_past_hour: T.nilable(Integer)).returns(T.nilable(Integer))
}
def invalid_credentials_decline_rate_past_hour=(
_invalid_credentials_decline_rate_past_hour
); end
# The likelihood that this authorization is associated with card testing activity. This is assessed by evaluating decline activity over the last hour.
sig { returns(String) }
def risk_level; end
sig { params(_risk_level: String).returns(String) }
def risk_level=(_risk_level); end
sig {
params(invalid_account_number_decline_rate_past_hour: T.nilable(Integer), invalid_credentials_decline_rate_past_hour: T.nilable(Integer), risk_level: String).void
}
def initialize(
invalid_account_number_decline_rate_past_hour: nil,
invalid_credentials_decline_rate_past_hour: nil,
risk_level: nil
); end
end
class MerchantDisputeRisk < Stripe::RequestParams
# The dispute rate observed across all Stripe Issuing authorizations for this merchant. For example, a value of 50 means 50% of authorizations from this merchant on Stripe Issuing have resulted in a dispute. Higher values mean a higher likelihood the authorization is disputed. Takes on values between 0 and 100.
sig { returns(T.nilable(Integer)) }
def dispute_rate; end
sig { params(_dispute_rate: T.nilable(Integer)).returns(T.nilable(Integer)) }
def dispute_rate=(_dispute_rate); end
# The likelihood that authorizations from this merchant will result in a dispute based on their history on Stripe Issuing.
sig { returns(String) }
def risk_level; end
sig { params(_risk_level: String).returns(String) }
def risk_level=(_risk_level); end
sig { params(dispute_rate: T.nilable(Integer), risk_level: String).void }
def initialize(dispute_rate: nil, risk_level: nil); end
end
# Stripe's assessment of this authorization's likelihood of being card testing activity.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::RiskAssessment::CardTestingRisk))
}
def card_testing_risk; end
sig {
params(_card_testing_risk: T.nilable(::Stripe::Issuing::Authorization::CreateParams::RiskAssessment::CardTestingRisk)).returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::RiskAssessment::CardTestingRisk))
}
def card_testing_risk=(_card_testing_risk); end
# The dispute risk of the merchant (the seller on a purchase) on an authorization based on all Stripe Issuing activity.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::RiskAssessment::MerchantDisputeRisk))
}
def merchant_dispute_risk; end
sig {
params(_merchant_dispute_risk: T.nilable(::Stripe::Issuing::Authorization::CreateParams::RiskAssessment::MerchantDisputeRisk)).returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::RiskAssessment::MerchantDisputeRisk))
}
def merchant_dispute_risk=(_merchant_dispute_risk); end
sig {
params(card_testing_risk: T.nilable(::Stripe::Issuing::Authorization::CreateParams::RiskAssessment::CardTestingRisk), merchant_dispute_risk: T.nilable(::Stripe::Issuing::Authorization::CreateParams::RiskAssessment::MerchantDisputeRisk)).void
}
def initialize(card_testing_risk: nil, merchant_dispute_risk: nil); end
end
class VerificationData < Stripe::RequestParams
class AuthenticationExemption < Stripe::RequestParams
# The entity that requested the exemption, either the acquiring merchant or the Issuing user.
sig { returns(String) }
def claimed_by; end
sig { params(_claimed_by: String).returns(String) }
def claimed_by=(_claimed_by); end
# The specific exemption claimed for this authorization.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(claimed_by: String, type: String).void }
def initialize(claimed_by: nil, type: nil); end
end
class ThreeDSecure < Stripe::RequestParams
# The outcome of the 3D Secure authentication request.
sig { returns(String) }
def result; end
sig { params(_result: String).returns(String) }
def result=(_result); end
sig { params(result: String).void }
def initialize(result: nil); end
end
# Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`.
sig { returns(T.nilable(String)) }
def address_line1_check; end
sig { params(_address_line1_check: T.nilable(String)).returns(T.nilable(String)) }
def address_line1_check=(_address_line1_check); end
# Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`.
sig { returns(T.nilable(String)) }
def address_postal_code_check; end
sig { params(_address_postal_code_check: T.nilable(String)).returns(T.nilable(String)) }
def address_postal_code_check=(_address_postal_code_check); end
# The exemption applied to this authorization.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::VerificationData::AuthenticationExemption))
}
def authentication_exemption; end
sig {
params(_authentication_exemption: T.nilable(::Stripe::Issuing::Authorization::CreateParams::VerificationData::AuthenticationExemption)).returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::VerificationData::AuthenticationExemption))
}
def authentication_exemption=(_authentication_exemption); end
# Whether the cardholder provided a CVC and if it matched Stripe’s record.
sig { returns(T.nilable(String)) }
def cvc_check; end
sig { params(_cvc_check: T.nilable(String)).returns(T.nilable(String)) }
def cvc_check=(_cvc_check); end
# Whether the cardholder provided an expiry date and if it matched Stripe’s record.
sig { returns(T.nilable(String)) }
def expiry_check; end
sig { params(_expiry_check: T.nilable(String)).returns(T.nilable(String)) }
def expiry_check=(_expiry_check); end
# 3D Secure details.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::VerificationData::ThreeDSecure))
}
def three_d_secure; end
sig {
params(_three_d_secure: T.nilable(::Stripe::Issuing::Authorization::CreateParams::VerificationData::ThreeDSecure)).returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::VerificationData::ThreeDSecure))
}
def three_d_secure=(_three_d_secure); end
sig {
params(address_line1_check: T.nilable(String), address_postal_code_check: T.nilable(String), authentication_exemption: T.nilable(::Stripe::Issuing::Authorization::CreateParams::VerificationData::AuthenticationExemption), cvc_check: T.nilable(String), expiry_check: T.nilable(String), three_d_secure: T.nilable(::Stripe::Issuing::Authorization::CreateParams::VerificationData::ThreeDSecure)).void
}
def initialize(
address_line1_check: nil,
address_postal_code_check: nil,
authentication_exemption: nil,
cvc_check: nil,
expiry_check: nil,
three_d_secure: nil
); end
end
# The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::AmountDetails)) }
def amount_details; end
sig {
params(_amount_details: T.nilable(::Stripe::Issuing::Authorization::CreateParams::AmountDetails)).returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::AmountDetails))
}
def amount_details=(_amount_details); end
# How the card details were provided. Defaults to online.
sig { returns(T.nilable(String)) }
def authorization_method; end
sig { params(_authorization_method: T.nilable(String)).returns(T.nilable(String)) }
def authorization_method=(_authorization_method); end
# Card associated with this authorization.
sig { returns(String) }
def card; end
sig { params(_card: String).returns(String) }
def card=(_card); end
# The currency of the authorization. If not provided, defaults to the currency of the card. 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Fleet-specific information for authorizations using Fleet cards.
sig { returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet)) }
def fleet; end
sig {
params(_fleet: T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet)).returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet))
}
def fleet=(_fleet); end
# Probability that this transaction can be disputed in the event of fraud. Assessed by comparing the characteristics of the authorization to card network rules.
sig { returns(T.nilable(String)) }
def fraud_disputability_likelihood; end
sig {
params(_fraud_disputability_likelihood: T.nilable(String)).returns(T.nilable(String))
}
def fraud_disputability_likelihood=(_fraud_disputability_likelihood); end
# Information about fuel that was purchased with this transaction.
sig { returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fuel)) }
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fuel)).returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fuel))
}
def fuel=(_fuel); end
# If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.
sig { returns(T.nilable(T::Boolean)) }
def is_amount_controllable; end
sig {
params(_is_amount_controllable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def is_amount_controllable=(_is_amount_controllable); end
# The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(Integer)) }
def merchant_amount; end
sig { params(_merchant_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def merchant_amount=(_merchant_amount); end
# The currency of the authorization. If not provided, defaults to the currency of the card. 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(T.nilable(String)) }
def merchant_currency; end
sig { params(_merchant_currency: T.nilable(String)).returns(T.nilable(String)) }
def merchant_currency=(_merchant_currency); end
# Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.
sig { returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::MerchantData)) }
def merchant_data; end
sig {
params(_merchant_data: T.nilable(::Stripe::Issuing::Authorization::CreateParams::MerchantData)).returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::MerchantData))
}
def merchant_data=(_merchant_data); end
# Details about the authorization, such as identifiers, set by the card network.
sig { returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::NetworkData)) }
def network_data; end
sig {
params(_network_data: T.nilable(::Stripe::Issuing::Authorization::CreateParams::NetworkData)).returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::NetworkData))
}
def network_data=(_network_data); end
# Stripe’s assessment of the fraud risk for this authorization.
sig { returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::RiskAssessment)) }
def risk_assessment; end
sig {
params(_risk_assessment: T.nilable(::Stripe::Issuing::Authorization::CreateParams::RiskAssessment)).returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::RiskAssessment))
}
def risk_assessment=(_risk_assessment); end
# Verifications that Stripe performed on information that the cardholder provided to the merchant.
sig { returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::VerificationData)) }
def verification_data; end
sig {
params(_verification_data: T.nilable(::Stripe::Issuing::Authorization::CreateParams::VerificationData)).returns(T.nilable(::Stripe::Issuing::Authorization::CreateParams::VerificationData))
}
def verification_data=(_verification_data); end
# The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.
sig { returns(T.nilable(String)) }
def wallet; end
sig { params(_wallet: T.nilable(String)).returns(T.nilable(String)) }
def wallet=(_wallet); end
sig {
params(amount: T.nilable(Integer), amount_details: T.nilable(::Stripe::Issuing::Authorization::CreateParams::AmountDetails), authorization_method: T.nilable(String), card: String, currency: T.nilable(String), expand: T.nilable(T::Array[String]), fleet: T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fleet), fraud_disputability_likelihood: T.nilable(String), fuel: T.nilable(::Stripe::Issuing::Authorization::CreateParams::Fuel), is_amount_controllable: T.nilable(T::Boolean), merchant_amount: T.nilable(Integer), merchant_currency: T.nilable(String), merchant_data: T.nilable(::Stripe::Issuing::Authorization::CreateParams::MerchantData), network_data: T.nilable(::Stripe::Issuing::Authorization::CreateParams::NetworkData), risk_assessment: T.nilable(::Stripe::Issuing::Authorization::CreateParams::RiskAssessment), verification_data: T.nilable(::Stripe::Issuing::Authorization::CreateParams::VerificationData), wallet: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_details: nil,
authorization_method: nil,
card: nil,
currency: nil,
expand: nil,
fleet: nil,
fraud_disputability_likelihood: nil,
fuel: nil,
is_amount_controllable: nil,
merchant_amount: nil,
merchant_currency: nil,
merchant_data: nil,
network_data: nil,
risk_assessment: nil,
verification_data: nil,
wallet: nil
); end
end
class CaptureParams < Stripe::RequestParams
class PurchaseDetails < Stripe::RequestParams
class Fleet < Stripe::RequestParams
class CardholderPromptData < Stripe::RequestParams
# Driver ID.
sig { returns(T.nilable(String)) }
def driver_id; end
sig { params(_driver_id: T.nilable(String)).returns(T.nilable(String)) }
def driver_id=(_driver_id); end
# Odometer reading.
sig { returns(T.nilable(Integer)) }
def odometer; end
sig { params(_odometer: T.nilable(Integer)).returns(T.nilable(Integer)) }
def odometer=(_odometer); end
# An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
sig { returns(T.nilable(String)) }
def unspecified_id; end
sig { params(_unspecified_id: T.nilable(String)).returns(T.nilable(String)) }
def unspecified_id=(_unspecified_id); end
# User ID.
sig { returns(T.nilable(String)) }
def user_id; end
sig { params(_user_id: T.nilable(String)).returns(T.nilable(String)) }
def user_id=(_user_id); end
# Vehicle number.
sig { returns(T.nilable(String)) }
def vehicle_number; end
sig { params(_vehicle_number: T.nilable(String)).returns(T.nilable(String)) }
def vehicle_number=(_vehicle_number); end
sig {
params(driver_id: T.nilable(String), odometer: T.nilable(Integer), unspecified_id: T.nilable(String), user_id: T.nilable(String), vehicle_number: T.nilable(String)).void
}
def initialize(
driver_id: nil,
odometer: nil,
unspecified_id: nil,
user_id: nil,
vehicle_number: nil
); end
end
class ReportedBreakdown < Stripe::RequestParams
class Fuel < Stripe::RequestParams
# Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig { params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class NonFuel < Stripe::RequestParams
# Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig { params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class Tax < Stripe::RequestParams
# Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def local_amount_decimal; end
sig { params(_local_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def local_amount_decimal=(_local_amount_decimal); end
# Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def national_amount_decimal; end
sig {
params(_national_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def national_amount_decimal=(_national_amount_decimal); end
sig {
params(local_amount_decimal: T.nilable(String), national_amount_decimal: T.nilable(String)).void
}
def initialize(local_amount_decimal: nil, national_amount_decimal: nil); end
end
# Breakdown of fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel)).returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel))
}
def fuel=(_fuel); end
# Breakdown of non-fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel; end
sig {
params(_non_fuel: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel)).returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel=(_non_fuel); end
# Information about tax included in this transaction.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax)).returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax))
}
def tax=(_tax); end
sig {
params(fuel: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel), non_fuel: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel), tax: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax)).void
}
def initialize(fuel: nil, non_fuel: nil, tax: nil); end
end
# Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::CardholderPromptData))
}
def cardholder_prompt_data; end
sig {
params(_cardholder_prompt_data: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::CardholderPromptData)).returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::CardholderPromptData))
}
def cardholder_prompt_data=(_cardholder_prompt_data); end
# The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
sig { returns(T.nilable(String)) }
def purchase_type; end
sig { params(_purchase_type: T.nilable(String)).returns(T.nilable(String)) }
def purchase_type=(_purchase_type); end
# More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown))
}
def reported_breakdown; end
sig {
params(_reported_breakdown: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown)).returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown))
}
def reported_breakdown=(_reported_breakdown); end
# The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
sig { returns(T.nilable(String)) }
def service_type; end
sig { params(_service_type: T.nilable(String)).returns(T.nilable(String)) }
def service_type=(_service_type); end
sig {
params(cardholder_prompt_data: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::CardholderPromptData), purchase_type: T.nilable(String), reported_breakdown: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown), service_type: T.nilable(String)).void
}
def initialize(
cardholder_prompt_data: nil,
purchase_type: nil,
reported_breakdown: nil,
service_type: nil
); end
end
class Flight < Stripe::RequestParams
class Segment < Stripe::RequestParams
# The three-letter IATA airport code of the flight's destination.
sig { returns(T.nilable(String)) }
def arrival_airport_code; end
sig { params(_arrival_airport_code: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport_code=(_arrival_airport_code); end
# The airline carrier code.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The three-letter IATA airport code that the flight departed from.
sig { returns(T.nilable(String)) }
def departure_airport_code; end
sig { params(_departure_airport_code: T.nilable(String)).returns(T.nilable(String)) }
def departure_airport_code=(_departure_airport_code); end
# The flight number.
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The flight's service class.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
# Whether a stopover is allowed on this flight.
sig { returns(T.nilable(T::Boolean)) }
def stopover_allowed; end
sig {
params(_stopover_allowed: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def stopover_allowed=(_stopover_allowed); end
sig {
params(arrival_airport_code: T.nilable(String), carrier: T.nilable(String), departure_airport_code: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String), stopover_allowed: T.nilable(T::Boolean)).void
}
def initialize(
arrival_airport_code: nil,
carrier: nil,
departure_airport_code: nil,
flight_number: nil,
service_class: nil,
stopover_allowed: nil
); end
end
# The time that the flight departed.
sig { returns(T.nilable(Integer)) }
def departure_at; end
sig { params(_departure_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def departure_at=(_departure_at); end
# The name of the passenger.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# Whether the ticket is refundable.
sig { returns(T.nilable(T::Boolean)) }
def refundable; end
sig { params(_refundable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refundable=(_refundable); end
# The legs of the trip.
sig {
returns(T.nilable(T::Array[::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Flight::Segment]))
}
def segments; end
sig {
params(_segments: T.nilable(T::Array[::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Flight::Segment])).returns(T.nilable(T::Array[::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Flight::Segment]))
}
def segments=(_segments); end
# The travel agency that issued the ticket.
sig { returns(T.nilable(String)) }
def travel_agency; end
sig { params(_travel_agency: T.nilable(String)).returns(T.nilable(String)) }
def travel_agency=(_travel_agency); end
sig {
params(departure_at: T.nilable(Integer), passenger_name: T.nilable(String), refundable: T.nilable(T::Boolean), segments: T.nilable(T::Array[::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Flight::Segment]), travel_agency: T.nilable(String)).void
}
def initialize(
departure_at: nil,
passenger_name: nil,
refundable: nil,
segments: nil,
travel_agency: nil
); end
end
class Fuel < Stripe::RequestParams
# [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
sig { returns(T.nilable(String)) }
def industry_product_code; end
sig { params(_industry_product_code: T.nilable(String)).returns(T.nilable(String)) }
def industry_product_code=(_industry_product_code); end
# The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def quantity_decimal; end
sig { params(_quantity_decimal: T.nilable(String)).returns(T.nilable(String)) }
def quantity_decimal=(_quantity_decimal); end
# The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
# The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_cost_decimal; end
sig { params(_unit_cost_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_cost_decimal=(_unit_cost_decimal); end
sig {
params(industry_product_code: T.nilable(String), quantity_decimal: T.nilable(String), type: T.nilable(String), unit: T.nilable(String), unit_cost_decimal: T.nilable(String)).void
}
def initialize(
industry_product_code: nil,
quantity_decimal: nil,
type: nil,
unit: nil,
unit_cost_decimal: nil
); end
end
class Lodging < Stripe::RequestParams
# The time of checking into the lodging.
sig { returns(T.nilable(Integer)) }
def check_in_at; end
sig { params(_check_in_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def check_in_at=(_check_in_at); end
# The number of nights stayed at the lodging.
sig { returns(T.nilable(Integer)) }
def nights; end
sig { params(_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def nights=(_nights); end
sig { params(check_in_at: T.nilable(Integer), nights: T.nilable(Integer)).void }
def initialize(check_in_at: nil, nights: nil); end
end
class Receipt < Stripe::RequestParams
# Attribute for param field description
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Attribute for param field quantity
sig { returns(T.nilable(String)) }
def quantity; end
sig { params(_quantity: T.nilable(String)).returns(T.nilable(String)) }
def quantity=(_quantity); end
# Attribute for param field total
sig { returns(T.nilable(Integer)) }
def total; end
sig { params(_total: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total=(_total); end
# Attribute for param field unit_cost
sig { returns(T.nilable(Integer)) }
def unit_cost; end
sig { params(_unit_cost: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_cost=(_unit_cost); end
sig {
params(description: T.nilable(String), quantity: T.nilable(String), total: T.nilable(Integer), unit_cost: T.nilable(Integer)).void
}
def initialize(description: nil, quantity: nil, total: nil, unit_cost: nil); end
end
# Fleet-specific information for transactions using Fleet cards.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet))
}
def fleet; end
sig {
params(_fleet: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet)).returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet))
}
def fleet=(_fleet); end
# Information about the flight that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Flight))
}
def flight; end
sig {
params(_flight: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Flight)).returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Flight))
}
def flight=(_flight); end
# Information about fuel that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fuel)).returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fuel))
}
def fuel=(_fuel); end
# Information about lodging that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Lodging))
}
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Lodging)).returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Lodging))
}
def lodging=(_lodging); end
# The line items in the purchase.
sig {
returns(T.nilable(T::Array[::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Receipt]))
}
def receipt; end
sig {
params(_receipt: T.nilable(T::Array[::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Receipt])).returns(T.nilable(T::Array[::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Receipt]))
}
def receipt=(_receipt); end
# A merchant-specific order number.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
sig {
params(fleet: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fleet), flight: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Flight), fuel: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Fuel), lodging: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Lodging), receipt: T.nilable(T::Array[::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails::Receipt]), reference: T.nilable(String)).void
}
def initialize(
fleet: nil,
flight: nil,
fuel: nil,
lodging: nil,
receipt: nil,
reference: nil
); end
end
# The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(Integer)) }
def capture_amount; end
sig { params(_capture_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def capture_amount=(_capture_amount); end
# Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.
sig { returns(T.nilable(T::Boolean)) }
def close_authorization; end
sig { params(_close_authorization: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def close_authorization=(_close_authorization); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Additional purchase information that is optionally provided by the merchant.
sig { returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails)) }
def purchase_details; end
sig {
params(_purchase_details: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails)).returns(T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails))
}
def purchase_details=(_purchase_details); end
sig {
params(capture_amount: T.nilable(Integer), close_authorization: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), purchase_details: T.nilable(::Stripe::Issuing::Authorization::CaptureParams::PurchaseDetails)).void
}
def initialize(
capture_amount: nil,
close_authorization: nil,
expand: nil,
purchase_details: nil
); end
end
class ExpireParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class FinalizeAmountParams < Stripe::RequestParams
class Fleet < Stripe::RequestParams
class CardholderPromptData < Stripe::RequestParams
# Driver ID.
sig { returns(T.nilable(String)) }
def driver_id; end
sig { params(_driver_id: T.nilable(String)).returns(T.nilable(String)) }
def driver_id=(_driver_id); end
# Odometer reading.
sig { returns(T.nilable(Integer)) }
def odometer; end
sig { params(_odometer: T.nilable(Integer)).returns(T.nilable(Integer)) }
def odometer=(_odometer); end
# An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
sig { returns(T.nilable(String)) }
def unspecified_id; end
sig { params(_unspecified_id: T.nilable(String)).returns(T.nilable(String)) }
def unspecified_id=(_unspecified_id); end
# User ID.
sig { returns(T.nilable(String)) }
def user_id; end
sig { params(_user_id: T.nilable(String)).returns(T.nilable(String)) }
def user_id=(_user_id); end
# Vehicle number.
sig { returns(T.nilable(String)) }
def vehicle_number; end
sig { params(_vehicle_number: T.nilable(String)).returns(T.nilable(String)) }
def vehicle_number=(_vehicle_number); end
sig {
params(driver_id: T.nilable(String), odometer: T.nilable(Integer), unspecified_id: T.nilable(String), user_id: T.nilable(String), vehicle_number: T.nilable(String)).void
}
def initialize(
driver_id: nil,
odometer: nil,
unspecified_id: nil,
user_id: nil,
vehicle_number: nil
); end
end
class ReportedBreakdown < Stripe::RequestParams
class Fuel < Stripe::RequestParams
# Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig { params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class NonFuel < Stripe::RequestParams
# Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig { params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class Tax < Stripe::RequestParams
# Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def local_amount_decimal; end
sig { params(_local_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def local_amount_decimal=(_local_amount_decimal); end
# Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def national_amount_decimal; end
sig { params(_national_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def national_amount_decimal=(_national_amount_decimal); end
sig {
params(local_amount_decimal: T.nilable(String), national_amount_decimal: T.nilable(String)).void
}
def initialize(local_amount_decimal: nil, national_amount_decimal: nil); end
end
# Breakdown of fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::ReportedBreakdown::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::ReportedBreakdown::Fuel)).returns(T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::ReportedBreakdown::Fuel))
}
def fuel=(_fuel); end
# Breakdown of non-fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel; end
sig {
params(_non_fuel: T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::ReportedBreakdown::NonFuel)).returns(T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel=(_non_fuel); end
# Information about tax included in this transaction.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::ReportedBreakdown::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::ReportedBreakdown::Tax)).returns(T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::ReportedBreakdown::Tax))
}
def tax=(_tax); end
sig {
params(fuel: T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::ReportedBreakdown::Fuel), non_fuel: T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::ReportedBreakdown::NonFuel), tax: T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::ReportedBreakdown::Tax)).void
}
def initialize(fuel: nil, non_fuel: nil, tax: nil); end
end
# Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::CardholderPromptData))
}
def cardholder_prompt_data; end
sig {
params(_cardholder_prompt_data: T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::CardholderPromptData)).returns(T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::CardholderPromptData))
}
def cardholder_prompt_data=(_cardholder_prompt_data); end
# The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
sig { returns(T.nilable(String)) }
def purchase_type; end
sig { params(_purchase_type: T.nilable(String)).returns(T.nilable(String)) }
def purchase_type=(_purchase_type); end
# More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
sig {
returns(T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::ReportedBreakdown))
}
def reported_breakdown; end
sig {
params(_reported_breakdown: T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::ReportedBreakdown)).returns(T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::ReportedBreakdown))
}
def reported_breakdown=(_reported_breakdown); end
# The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
sig { returns(T.nilable(String)) }
def service_type; end
sig { params(_service_type: T.nilable(String)).returns(T.nilable(String)) }
def service_type=(_service_type); end
sig {
params(cardholder_prompt_data: T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::CardholderPromptData), purchase_type: T.nilable(String), reported_breakdown: T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet::ReportedBreakdown), service_type: T.nilable(String)).void
}
def initialize(
cardholder_prompt_data: nil,
purchase_type: nil,
reported_breakdown: nil,
service_type: nil
); end
end
class Fuel < Stripe::RequestParams
# [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
sig { returns(T.nilable(String)) }
def industry_product_code; end
sig { params(_industry_product_code: T.nilable(String)).returns(T.nilable(String)) }
def industry_product_code=(_industry_product_code); end
# The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def quantity_decimal; end
sig { params(_quantity_decimal: T.nilable(String)).returns(T.nilable(String)) }
def quantity_decimal=(_quantity_decimal); end
# The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
# The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_cost_decimal; end
sig { params(_unit_cost_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_cost_decimal=(_unit_cost_decimal); end
sig {
params(industry_product_code: T.nilable(String), quantity_decimal: T.nilable(String), type: T.nilable(String), unit: T.nilable(String), unit_cost_decimal: T.nilable(String)).void
}
def initialize(
industry_product_code: nil,
quantity_decimal: nil,
type: nil,
unit: nil,
unit_cost_decimal: nil
); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def final_amount; end
sig { params(_final_amount: Integer).returns(Integer) }
def final_amount=(_final_amount); end
# Fleet-specific information for authorizations using Fleet cards.
sig { returns(T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet)) }
def fleet; end
sig {
params(_fleet: T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet)).returns(T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet))
}
def fleet=(_fleet); end
# Information about fuel that was purchased with this transaction.
sig { returns(T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fuel)) }
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fuel)).returns(T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fuel))
}
def fuel=(_fuel); end
sig {
params(expand: T.nilable(T::Array[String]), final_amount: Integer, fleet: T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fleet), fuel: T.nilable(::Stripe::Issuing::Authorization::FinalizeAmountParams::Fuel)).void
}
def initialize(expand: nil, final_amount: nil, fleet: nil, fuel: nil); end
end
class RespondParams < Stripe::RequestParams
# Whether to simulate the user confirming that the transaction was legitimate (true) or telling Stripe that it was fraudulent (false).
sig { returns(T::Boolean) }
def confirmed; end
sig { params(_confirmed: T::Boolean).returns(T::Boolean) }
def confirmed=(_confirmed); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(confirmed: T::Boolean, expand: T.nilable(T::Array[String])).void }
def initialize(confirmed: nil, expand: nil); end
end
class IncrementParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def increment_amount; end
sig { params(_increment_amount: Integer).returns(Integer) }
def increment_amount=(_increment_amount); end
# If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.
sig { returns(T.nilable(T::Boolean)) }
def is_amount_controllable; end
sig {
params(_is_amount_controllable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def is_amount_controllable=(_is_amount_controllable); end
sig {
params(expand: T.nilable(T::Array[String]), increment_amount: Integer, is_amount_controllable: T.nilable(T::Boolean)).void
}
def initialize(expand: nil, increment_amount: nil, is_amount_controllable: nil); end
end
class ReverseParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(Integer)) }
def reverse_amount; end
sig { params(_reverse_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def reverse_amount=(_reverse_amount); end
sig { params(expand: T.nilable(T::Array[String]), reverse_amount: T.nilable(Integer)).void }
def initialize(expand: nil, reverse_amount: nil); end
end
# [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).
sig {
params(params: T.any(::Stripe::Issuing::Authorization::ApproveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
}
def approve(params = {}, opts = {}); end
# [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).
sig {
params(authorization: String, params: T.any(::Stripe::Issuing::Authorization::ApproveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
}
def self.approve(authorization, params = {}, opts = {}); end
# [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).
sig {
params(params: T.any(::Stripe::Issuing::Authorization::DeclineParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
}
def decline(params = {}, opts = {}); end
# [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).
sig {
params(authorization: String, params: T.any(::Stripe::Issuing::Authorization::DeclineParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
}
def self.decline(authorization, params = {}, opts = {}); end
# Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::Authorization::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(authorization: String, params: T.any(::Stripe::Issuing::Authorization::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
}
def self.update(authorization, params = {}, opts = {}); end
end
end
end
# typed: true
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/virtual/issue-cards#create-cardholder)
class Cardholder < APIResource
class Billing < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(Address) }
def address; end
end
class Company < Stripe::StripeObject
# Whether the company's business ID number was provided.
sig { returns(T::Boolean) }
def tax_id_provided; end
end
class Individual < Stripe::StripeObject
class CardIssuing < Stripe::StripeObject
class UserTermsAcceptance < Stripe::StripeObject
# The Unix timestamp marking when the cardholder accepted the Authorized User Terms.
sig { returns(T.nilable(Integer)) }
def date; end
# The IP address from which the cardholder accepted the Authorized User Terms.
sig { returns(T.nilable(String)) }
def ip; end
# The user agent of the browser from which the cardholder accepted the Authorized User Terms.
sig { returns(T.nilable(String)) }
def user_agent; end
end
# Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program.
sig { returns(T.nilable(UserTermsAcceptance)) }
def user_terms_acceptance; end
end
class Dob < Stripe::StripeObject
# The day of birth, between 1 and 31.
sig { returns(T.nilable(Integer)) }
def day; end
# The month of birth, between 1 and 12.
sig { returns(T.nilable(Integer)) }
def month; end
# The four-digit year of birth.
sig { returns(T.nilable(Integer)) }
def year; end
end
class Verification < Stripe::StripeObject
class Document < Stripe::StripeObject
# The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def back; end
# The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def front; end
end
# An identifying document, either a passport or local ID card.
sig { returns(T.nilable(Document)) }
def document; end
end
# Information related to the card_issuing program for this cardholder.
sig { returns(T.nilable(CardIssuing)) }
def card_issuing; end
# The date of birth of this cardholder.
sig { returns(T.nilable(Dob)) }
def dob; end
# The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
sig { returns(T.nilable(String)) }
def first_name; end
# The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
sig { returns(T.nilable(String)) }
def last_name; end
# Government-issued ID document for this cardholder.
sig { returns(T.nilable(Verification)) }
def verification; end
end
class Requirements < Stripe::StripeObject
# If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason.
sig { returns(T.nilable(String)) }
def disabled_reason; end
# Array of fields that need to be collected in order to verify and re-enable the cardholder.
sig { returns(T.nilable(T::Array[String])) }
def past_due; end
end
class SpendingControls < Stripe::StripeObject
class SpendingLimit < Stripe::StripeObject
# Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
sig { returns(T.nilable(T::Array[String])) }
def categories; end
# Interval (or event) to which the amount applies.
sig { returns(String) }
def interval; end
end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
sig { returns(T.nilable(T::Array[String])) }
def allowed_categories; end
# Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def allowed_merchant_countries; end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
sig { returns(T.nilable(T::Array[String])) }
def blocked_categories; end
# Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def blocked_merchant_countries; end
# Limit spending with amount-based rules that apply across this cardholder's cards.
sig { returns(T.nilable(T::Array[SpendingLimit])) }
def spending_limits; end
# Currency of the amounts within `spending_limits`.
sig { returns(T.nilable(String)) }
def spending_limits_currency; end
end
# Attribute for field billing
sig { returns(Billing) }
def billing; end
# Additional information about a `company` cardholder.
sig { returns(T.nilable(Company)) }
def company; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The cardholder's email address.
sig { returns(T.nilable(String)) }
def email; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Additional information about an `individual` cardholder.
sig { returns(T.nilable(Individual)) }
def individual; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# The cardholder's name. This will be printed on cards issued to them.
sig { returns(String) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.
sig { returns(T.nilable(String)) }
def phone_number; end
# The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.
# This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
# Attribute for field requirements
sig { returns(Requirements) }
def requirements; end
# Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
sig { returns(T.nilable(SpendingControls)) }
def spending_controls; end
# Specifies whether to permit authorizations on this cardholder's cards.
sig { returns(String) }
def status; end
# One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details.
sig { returns(String) }
def type; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return cardholders that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Issuing::Cardholder::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Issuing::Cardholder::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Issuing::Cardholder::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return cardholders that have the given email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return cardholders that have the given phone number.
sig { returns(T.nilable(String)) }
def phone_number; end
sig { params(_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def phone_number=(_phone_number); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# Only return cardholders that have the given type. One of `individual` or `company`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(created: T.nilable(T.any(::Stripe::Issuing::Cardholder::ListParams::Created, Integer)), email: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), phone_number: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
created: nil,
email: nil,
ending_before: nil,
expand: nil,
limit: nil,
phone_number: nil,
starting_after: nil,
status: nil,
type: nil
); end
end
class CreateParams < Stripe::RequestParams
class Billing < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(String) }
def city; end
sig { params(_city: String).returns(String) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(String) }
def line1; end
sig { params(_line1: String).returns(String) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(String) }
def postal_code; end
sig { params(_postal_code: String).returns(String) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: String, country: String, line1: String, line2: T.nilable(String), postal_code: String, state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The cardholder’s billing address.
sig { returns(::Stripe::Issuing::Cardholder::CreateParams::Billing::Address) }
def address; end
sig {
params(_address: ::Stripe::Issuing::Cardholder::CreateParams::Billing::Address).returns(::Stripe::Issuing::Cardholder::CreateParams::Billing::Address)
}
def address=(_address); end
sig {
params(address: ::Stripe::Issuing::Cardholder::CreateParams::Billing::Address).void
}
def initialize(address: nil); end
end
class Company < Stripe::RequestParams
# The entity's business ID number.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig { params(tax_id: T.nilable(String)).void }
def initialize(tax_id: nil); end
end
class Individual < Stripe::RequestParams
class CardIssuing < Stripe::RequestParams
class UserTermsAcceptance < Stripe::RequestParams
# The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the cardholder accepted the Authorized User Terms.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program.
sig {
returns(T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::CardIssuing::UserTermsAcceptance))
}
def user_terms_acceptance; end
sig {
params(_user_terms_acceptance: T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::CardIssuing::UserTermsAcceptance)).returns(T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::CardIssuing::UserTermsAcceptance))
}
def user_terms_acceptance=(_user_terms_acceptance); end
sig {
params(user_terms_acceptance: T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::CardIssuing::UserTermsAcceptance)).void
}
def initialize(user_terms_acceptance: nil); end
end
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Verification < Stripe::RequestParams
class Document < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# An identifying document, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::Verification::Document)).returns(T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::Verification::Document))
}
def document=(_document); end
sig {
params(document: T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::Verification::Document)).void
}
def initialize(document: nil); end
end
# Information related to the card_issuing program for this cardholder.
sig {
returns(T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::CardIssuing))
}
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::CardIssuing)).returns(T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::CardIssuing))
}
def card_issuing=(_card_issuing); end
# The date of birth of this cardholder. Cardholders must be older than 13 years old.
sig { returns(T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::Dob)) }
def dob; end
sig {
params(_dob: T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::Dob)).returns(T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::Dob))
}
def dob=(_dob); end
# The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
sig { returns(T.nilable(String)) }
def first_name; end
sig { params(_first_name: T.nilable(String)).returns(T.nilable(String)) }
def first_name=(_first_name); end
# The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
sig { returns(T.nilable(String)) }
def last_name; end
sig { params(_last_name: T.nilable(String)).returns(T.nilable(String)) }
def last_name=(_last_name); end
# Government-issued ID document for this cardholder.
sig {
returns(T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::Verification))
}
def verification; end
sig {
params(_verification: T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::Verification)).returns(T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::Verification))
}
def verification=(_verification); end
sig {
params(card_issuing: T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::CardIssuing), dob: T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::Dob), first_name: T.nilable(String), last_name: T.nilable(String), verification: T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual::Verification)).void
}
def initialize(
card_issuing: nil,
dob: nil,
first_name: nil,
last_name: nil,
verification: nil
); end
end
class SpendingControls < Stripe::RequestParams
class SpendingLimit < Stripe::RequestParams
# Maximum amount allowed to spend per interval.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
sig { returns(T.nilable(T::Array[String])) }
def categories; end
sig {
params(_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def categories=(_categories); end
# Interval (or event) to which the amount applies.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig {
params(amount: Integer, categories: T.nilable(T::Array[String]), interval: String).void
}
def initialize(amount: nil, categories: nil, interval: nil); end
end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
sig { returns(T.nilable(T::Array[String])) }
def allowed_categories; end
sig {
params(_allowed_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_categories=(_allowed_categories); end
# Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def allowed_merchant_countries; end
sig {
params(_allowed_merchant_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_merchant_countries=(_allowed_merchant_countries); end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
sig { returns(T.nilable(T::Array[String])) }
def blocked_categories; end
sig {
params(_blocked_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def blocked_categories=(_blocked_categories); end
# Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def blocked_merchant_countries; end
sig {
params(_blocked_merchant_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def blocked_merchant_countries=(_blocked_merchant_countries); end
# Limit spending with amount-based rules that apply across this cardholder's cards.
sig {
returns(T.nilable(T::Array[::Stripe::Issuing::Cardholder::CreateParams::SpendingControls::SpendingLimit]))
}
def spending_limits; end
sig {
params(_spending_limits: T.nilable(T::Array[::Stripe::Issuing::Cardholder::CreateParams::SpendingControls::SpendingLimit])).returns(T.nilable(T::Array[::Stripe::Issuing::Cardholder::CreateParams::SpendingControls::SpendingLimit]))
}
def spending_limits=(_spending_limits); end
# Currency of amounts within `spending_limits`. Defaults to your merchant country's currency.
sig { returns(T.nilable(String)) }
def spending_limits_currency; end
sig { params(_spending_limits_currency: T.nilable(String)).returns(T.nilable(String)) }
def spending_limits_currency=(_spending_limits_currency); end
sig {
params(allowed_categories: T.nilable(T::Array[String]), allowed_merchant_countries: T.nilable(T::Array[String]), blocked_categories: T.nilable(T::Array[String]), blocked_merchant_countries: T.nilable(T::Array[String]), spending_limits: T.nilable(T::Array[::Stripe::Issuing::Cardholder::CreateParams::SpendingControls::SpendingLimit]), spending_limits_currency: T.nilable(String)).void
}
def initialize(
allowed_categories: nil,
allowed_merchant_countries: nil,
blocked_categories: nil,
blocked_merchant_countries: nil,
spending_limits: nil,
spending_limits_currency: nil
); end
end
# The cardholder's billing address.
sig { returns(::Stripe::Issuing::Cardholder::CreateParams::Billing) }
def billing; end
sig {
params(_billing: ::Stripe::Issuing::Cardholder::CreateParams::Billing).returns(::Stripe::Issuing::Cardholder::CreateParams::Billing)
}
def billing=(_billing); end
# Additional information about a `company` cardholder.
sig { returns(T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Company)) }
def company; end
sig {
params(_company: T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Company)).returns(T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Company))
}
def company=(_company); end
# The cardholder's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Additional information about an `individual` cardholder.
sig { returns(T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual)) }
def individual; end
sig {
params(_individual: T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual)).returns(T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual))
}
def individual=(_individual); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards.
# While phone number is optional if the cardholder will not be creating EU cards, note that this cardholder will not be eligible for 3DS without a phone number. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.
sig { returns(T.nilable(String)) }
def phone_number; end
sig { params(_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def phone_number=(_phone_number); end
# The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.
# This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
sig {
params(_preferred_locales: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def preferred_locales=(_preferred_locales); end
# Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
sig { returns(T.nilable(::Stripe::Issuing::Cardholder::CreateParams::SpendingControls)) }
def spending_controls; end
sig {
params(_spending_controls: T.nilable(::Stripe::Issuing::Cardholder::CreateParams::SpendingControls)).returns(T.nilable(::Stripe::Issuing::Cardholder::CreateParams::SpendingControls))
}
def spending_controls=(_spending_controls); end
# Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(billing: ::Stripe::Issuing::Cardholder::CreateParams::Billing, company: T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Company), email: T.nilable(String), expand: T.nilable(T::Array[String]), individual: T.nilable(::Stripe::Issuing::Cardholder::CreateParams::Individual), metadata: T.nilable(T::Hash[String, String]), name: String, phone_number: T.nilable(String), preferred_locales: T.nilable(T::Array[String]), spending_controls: T.nilable(::Stripe::Issuing::Cardholder::CreateParams::SpendingControls), status: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
billing: nil,
company: nil,
email: nil,
expand: nil,
individual: nil,
metadata: nil,
name: nil,
phone_number: nil,
preferred_locales: nil,
spending_controls: nil,
status: nil,
type: nil
); end
end
class UpdateParams < Stripe::RequestParams
class Billing < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(String) }
def city; end
sig { params(_city: String).returns(String) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(String) }
def line1; end
sig { params(_line1: String).returns(String) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(String) }
def postal_code; end
sig { params(_postal_code: String).returns(String) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: String, country: String, line1: String, line2: T.nilable(String), postal_code: String, state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The cardholder’s billing address.
sig { returns(::Stripe::Issuing::Cardholder::UpdateParams::Billing::Address) }
def address; end
sig {
params(_address: ::Stripe::Issuing::Cardholder::UpdateParams::Billing::Address).returns(::Stripe::Issuing::Cardholder::UpdateParams::Billing::Address)
}
def address=(_address); end
sig {
params(address: ::Stripe::Issuing::Cardholder::UpdateParams::Billing::Address).void
}
def initialize(address: nil); end
end
class Company < Stripe::RequestParams
# The entity's business ID number.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig { params(tax_id: T.nilable(String)).void }
def initialize(tax_id: nil); end
end
class Individual < Stripe::RequestParams
class CardIssuing < Stripe::RequestParams
class UserTermsAcceptance < Stripe::RequestParams
# The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the cardholder accepted the Authorized User Terms.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program.
sig {
returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::CardIssuing::UserTermsAcceptance))
}
def user_terms_acceptance; end
sig {
params(_user_terms_acceptance: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::CardIssuing::UserTermsAcceptance)).returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::CardIssuing::UserTermsAcceptance))
}
def user_terms_acceptance=(_user_terms_acceptance); end
sig {
params(user_terms_acceptance: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::CardIssuing::UserTermsAcceptance)).void
}
def initialize(user_terms_acceptance: nil); end
end
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Verification < Stripe::RequestParams
class Document < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# An identifying document, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::Verification::Document)).returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::Verification::Document))
}
def document=(_document); end
sig {
params(document: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::Verification::Document)).void
}
def initialize(document: nil); end
end
# Information related to the card_issuing program for this cardholder.
sig {
returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::CardIssuing))
}
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::CardIssuing)).returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::CardIssuing))
}
def card_issuing=(_card_issuing); end
# The date of birth of this cardholder. Cardholders must be older than 13 years old.
sig { returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::Dob)) }
def dob; end
sig {
params(_dob: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::Dob)).returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::Dob))
}
def dob=(_dob); end
# The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
sig { returns(T.nilable(String)) }
def first_name; end
sig { params(_first_name: T.nilable(String)).returns(T.nilable(String)) }
def first_name=(_first_name); end
# The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
sig { returns(T.nilable(String)) }
def last_name; end
sig { params(_last_name: T.nilable(String)).returns(T.nilable(String)) }
def last_name=(_last_name); end
# Government-issued ID document for this cardholder.
sig {
returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::Verification))
}
def verification; end
sig {
params(_verification: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::Verification)).returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::Verification))
}
def verification=(_verification); end
sig {
params(card_issuing: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::CardIssuing), dob: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::Dob), first_name: T.nilable(String), last_name: T.nilable(String), verification: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual::Verification)).void
}
def initialize(
card_issuing: nil,
dob: nil,
first_name: nil,
last_name: nil,
verification: nil
); end
end
class SpendingControls < Stripe::RequestParams
class SpendingLimit < Stripe::RequestParams
# Maximum amount allowed to spend per interval.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
sig { returns(T.nilable(T::Array[String])) }
def categories; end
sig {
params(_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def categories=(_categories); end
# Interval (or event) to which the amount applies.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig {
params(amount: Integer, categories: T.nilable(T::Array[String]), interval: String).void
}
def initialize(amount: nil, categories: nil, interval: nil); end
end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
sig { returns(T.nilable(T::Array[String])) }
def allowed_categories; end
sig {
params(_allowed_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_categories=(_allowed_categories); end
# Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def allowed_merchant_countries; end
sig {
params(_allowed_merchant_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_merchant_countries=(_allowed_merchant_countries); end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
sig { returns(T.nilable(T::Array[String])) }
def blocked_categories; end
sig {
params(_blocked_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def blocked_categories=(_blocked_categories); end
# Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def blocked_merchant_countries; end
sig {
params(_blocked_merchant_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def blocked_merchant_countries=(_blocked_merchant_countries); end
# Limit spending with amount-based rules that apply across this cardholder's cards.
sig {
returns(T.nilable(T::Array[::Stripe::Issuing::Cardholder::UpdateParams::SpendingControls::SpendingLimit]))
}
def spending_limits; end
sig {
params(_spending_limits: T.nilable(T::Array[::Stripe::Issuing::Cardholder::UpdateParams::SpendingControls::SpendingLimit])).returns(T.nilable(T::Array[::Stripe::Issuing::Cardholder::UpdateParams::SpendingControls::SpendingLimit]))
}
def spending_limits=(_spending_limits); end
# Currency of amounts within `spending_limits`. Defaults to your merchant country's currency.
sig { returns(T.nilable(String)) }
def spending_limits_currency; end
sig { params(_spending_limits_currency: T.nilable(String)).returns(T.nilable(String)) }
def spending_limits_currency=(_spending_limits_currency); end
sig {
params(allowed_categories: T.nilable(T::Array[String]), allowed_merchant_countries: T.nilable(T::Array[String]), blocked_categories: T.nilable(T::Array[String]), blocked_merchant_countries: T.nilable(T::Array[String]), spending_limits: T.nilable(T::Array[::Stripe::Issuing::Cardholder::UpdateParams::SpendingControls::SpendingLimit]), spending_limits_currency: T.nilable(String)).void
}
def initialize(
allowed_categories: nil,
allowed_merchant_countries: nil,
blocked_categories: nil,
blocked_merchant_countries: nil,
spending_limits: nil,
spending_limits_currency: nil
); end
end
# The cardholder's billing address.
sig { returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Billing)) }
def billing; end
sig {
params(_billing: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Billing)).returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Billing))
}
def billing=(_billing); end
# Additional information about a `company` cardholder.
sig { returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Company)) }
def company; end
sig {
params(_company: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Company)).returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Company))
}
def company=(_company); end
# The cardholder's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Additional information about an `individual` cardholder.
sig { returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual)) }
def individual; end
sig {
params(_individual: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual)).returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual))
}
def individual=(_individual); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure) for more details.
sig { returns(T.nilable(String)) }
def phone_number; end
sig { params(_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def phone_number=(_phone_number); end
# The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.
# This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
sig {
params(_preferred_locales: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def preferred_locales=(_preferred_locales); end
# Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
sig { returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::SpendingControls)) }
def spending_controls; end
sig {
params(_spending_controls: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::SpendingControls)).returns(T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::SpendingControls))
}
def spending_controls=(_spending_controls); end
# Specifies whether to permit authorizations on this cardholder's cards.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(billing: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Billing), company: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Company), email: T.nilable(String), expand: T.nilable(T::Array[String]), individual: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::Individual), metadata: T.nilable(T::Hash[String, String]), phone_number: T.nilable(String), preferred_locales: T.nilable(T::Array[String]), spending_controls: T.nilable(::Stripe::Issuing::Cardholder::UpdateParams::SpendingControls), status: T.nilable(String)).void
}
def initialize(
billing: nil,
company: nil,
email: nil,
expand: nil,
individual: nil,
metadata: nil,
phone_number: nil,
preferred_locales: nil,
spending_controls: nil,
status: nil
); end
end
# Creates a new Issuing Cardholder object that can be issued cards.
sig {
params(params: T.any(::Stripe::Issuing::Cardholder::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Cardholder)
}
def self.create(params = {}, opts = {}); end
# Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::Cardholder::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(cardholder: String, params: T.any(::Stripe::Issuing::Cardholder::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Cardholder)
}
def self.update(cardholder, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
# You can [create physical or virtual cards](https://stripe.com/docs/issuing) that are issued to cardholders.
class Card < APIResource
class Shipping < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class AddressValidation < Stripe::StripeObject
class NormalizedAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# The address validation capabilities to use.
sig { returns(String) }
def mode; end
# The normalized shipping address.
sig { returns(T.nilable(NormalizedAddress)) }
def normalized_address; end
# The validation result for the shipping address.
sig { returns(T.nilable(String)) }
def result; end
end
class Customs < Stripe::StripeObject
# A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU.
sig { returns(T.nilable(String)) }
def eori_number; end
end
# Attribute for field address
sig { returns(Address) }
def address; end
# Address validation details for the shipment.
sig { returns(T.nilable(AddressValidation)) }
def address_validation; end
# The delivery company that shipped a card.
sig { returns(T.nilable(String)) }
def carrier; end
# Additional information that may be required for clearing customs.
sig { returns(T.nilable(Customs)) }
def customs; end
# A unix timestamp representing a best estimate of when the card will be delivered.
sig { returns(T.nilable(Integer)) }
def eta; end
# Recipient name.
sig { returns(String) }
def name; end
# The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created.
sig { returns(T.nilable(String)) }
def phone_number; end
# Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true.
sig { returns(T.nilable(T::Boolean)) }
def require_signature; end
# Shipment service, such as `standard` or `express`.
sig { returns(String) }
def service; end
# The delivery status of the card.
sig { returns(T.nilable(String)) }
def status; end
# A tracking number for a card shipment.
sig { returns(T.nilable(String)) }
def tracking_number; end
# A link to the shipping carrier's site where you can view detailed information about a card shipment.
sig { returns(T.nilable(String)) }
def tracking_url; end
# Packaging options.
sig { returns(String) }
def type; end
end
class SpendingControls < Stripe::StripeObject
class SpendingLimit < Stripe::StripeObject
# Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
sig { returns(T.nilable(T::Array[String])) }
def categories; end
# Interval (or event) to which the amount applies.
sig { returns(String) }
def interval; end
end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
sig { returns(T.nilable(T::Array[String])) }
def allowed_categories; end
# Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def allowed_merchant_countries; end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
sig { returns(T.nilable(T::Array[String])) }
def blocked_categories; end
# Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def blocked_merchant_countries; end
# Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).
sig { returns(T.nilable(T::Array[SpendingLimit])) }
def spending_limits; end
# Currency of the amounts within `spending_limits`. Always the same as the currency of the card.
sig { returns(T.nilable(String)) }
def spending_limits_currency; end
end
class Wallets < Stripe::StripeObject
class ApplePay < Stripe::StripeObject
# Apple Pay Eligibility
sig { returns(T::Boolean) }
def eligible; end
# Reason the card is ineligible for Apple Pay
sig { returns(T.nilable(String)) }
def ineligible_reason; end
end
class GooglePay < Stripe::StripeObject
# Google Pay Eligibility
sig { returns(T::Boolean) }
def eligible; end
# Reason the card is ineligible for Google Pay
sig { returns(T.nilable(String)) }
def ineligible_reason; end
end
# Attribute for field apple_pay
sig { returns(ApplePay) }
def apple_pay; end
# Attribute for field google_pay
sig { returns(GooglePay) }
def google_pay; end
# Unique identifier for a card used with digital wallets
sig { returns(T.nilable(String)) }
def primary_account_identifier; end
end
# The brand of the card.
sig { returns(String) }
def brand; end
# The reason why the card was canceled.
sig { returns(T.nilable(String)) }
def cancellation_reason; end
# 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/virtual/issue-cards#create-cardholder)
sig { returns(Stripe::Issuing::Cardholder) }
def cardholder; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK.
sig { returns(String) }
def currency; end
# The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint.
sig { returns(T.nilable(String)) }
def cvc; end
# The expiration month of the card.
sig { returns(Integer) }
def exp_month; end
# The expiration year of the card.
sig { returns(Integer) }
def exp_year; end
# The financial account this card is attached to.
sig { returns(T.nilable(String)) }
def financial_account; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The last 4 digits of the card number.
sig { returns(String) }
def last4; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint.
sig { returns(T.nilable(String)) }
def number; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The personalization design object belonging to this card.
sig { returns(T.nilable(T.any(String, Stripe::Issuing::PersonalizationDesign))) }
def personalization_design; end
# The latest card that replaces this card, if any.
sig { returns(T.nilable(T.any(String, Stripe::Issuing::Card))) }
def replaced_by; end
# The card this card replaces, if any.
sig { returns(T.nilable(T.any(String, Stripe::Issuing::Card))) }
def replacement_for; end
# The reason why the previous card needed to be replaced.
sig { returns(T.nilable(String)) }
def replacement_reason; end
# Text separate from cardholder name, printed on the card.
sig { returns(T.nilable(String)) }
def second_line; end
# Where and how the card will be shipped.
sig { returns(T.nilable(Shipping)) }
def shipping; end
# Attribute for field spending_controls
sig { returns(SpendingControls) }
def spending_controls; end
# Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.
sig { returns(String) }
def status; end
# The type of the card.
sig { returns(String) }
def type; end
# Information relating to digital wallets (like Apple Pay and Google Pay).
sig { returns(T.nilable(Wallets)) }
def wallets; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return cards belonging to the Cardholder with the provided ID.
sig { returns(T.nilable(String)) }
def cardholder; end
sig { params(_cardholder: T.nilable(String)).returns(T.nilable(String)) }
def cardholder=(_cardholder); end
# Only return cards that were issued during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Issuing::Card::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Issuing::Card::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Issuing::Card::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Only return cards that have the given expiration month.
sig { returns(T.nilable(Integer)) }
def exp_month; end
sig { params(_exp_month: T.nilable(Integer)).returns(T.nilable(Integer)) }
def exp_month=(_exp_month); end
# Only return cards that have the given expiration year.
sig { returns(T.nilable(Integer)) }
def exp_year; end
sig { params(_exp_year: T.nilable(Integer)).returns(T.nilable(Integer)) }
def exp_year=(_exp_year); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Only return cards that have the given last four digits.
sig { returns(T.nilable(String)) }
def last4; end
sig { params(_last4: T.nilable(String)).returns(T.nilable(String)) }
def last4=(_last4); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Attribute for param field personalization_design
sig { returns(T.nilable(String)) }
def personalization_design; end
sig { params(_personalization_design: T.nilable(String)).returns(T.nilable(String)) }
def personalization_design=(_personalization_design); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return cards that have the given status. One of `active`, `inactive`, or `canceled`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# Only return cards that have the given type. One of `virtual` or `physical`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(cardholder: T.nilable(String), created: T.nilable(T.any(::Stripe::Issuing::Card::ListParams::Created, Integer)), ending_before: T.nilable(String), exp_month: T.nilable(Integer), exp_year: T.nilable(Integer), expand: T.nilable(T::Array[String]), last4: T.nilable(String), limit: T.nilable(Integer), personalization_design: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
cardholder: nil,
created: nil,
ending_before: nil,
exp_month: nil,
exp_year: nil,
expand: nil,
last4: nil,
limit: nil,
personalization_design: nil,
starting_after: nil,
status: nil,
type: nil
); end
end
class CreateParams < Stripe::RequestParams
class Pin < Stripe::RequestParams
# The card's desired new PIN, encrypted under Stripe's public key.
sig { returns(T.nilable(String)) }
def encrypted_number; end
sig { params(_encrypted_number: T.nilable(String)).returns(T.nilable(String)) }
def encrypted_number=(_encrypted_number); end
sig { params(encrypted_number: T.nilable(String)).void }
def initialize(encrypted_number: nil); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(String) }
def city; end
sig { params(_city: String).returns(String) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(String) }
def line1; end
sig { params(_line1: String).returns(String) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(String) }
def postal_code; end
sig { params(_postal_code: String).returns(String) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: String, country: String, line1: String, line2: T.nilable(String), postal_code: String, state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressValidation < Stripe::RequestParams
# The address validation capabilities to use.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
sig { params(mode: String).void }
def initialize(mode: nil); end
end
class Customs < Stripe::RequestParams
# The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.
sig { returns(T.nilable(String)) }
def eori_number; end
sig { params(_eori_number: T.nilable(String)).returns(T.nilable(String)) }
def eori_number=(_eori_number); end
sig { params(eori_number: T.nilable(String)).void }
def initialize(eori_number: nil); end
end
# The address that the card is shipped to.
sig { returns(::Stripe::Issuing::Card::CreateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::Issuing::Card::CreateParams::Shipping::Address).returns(::Stripe::Issuing::Card::CreateParams::Shipping::Address)
}
def address=(_address); end
# Address validation settings.
sig {
returns(T.nilable(::Stripe::Issuing::Card::CreateParams::Shipping::AddressValidation))
}
def address_validation; end
sig {
params(_address_validation: T.nilable(::Stripe::Issuing::Card::CreateParams::Shipping::AddressValidation)).returns(T.nilable(::Stripe::Issuing::Card::CreateParams::Shipping::AddressValidation))
}
def address_validation=(_address_validation); end
# Customs information for the shipment.
sig { returns(T.nilable(::Stripe::Issuing::Card::CreateParams::Shipping::Customs)) }
def customs; end
sig {
params(_customs: T.nilable(::Stripe::Issuing::Card::CreateParams::Shipping::Customs)).returns(T.nilable(::Stripe::Issuing::Card::CreateParams::Shipping::Customs))
}
def customs=(_customs); end
# The name printed on the shipping label when shipping the card.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Phone number of the recipient of the shipment.
sig { returns(T.nilable(String)) }
def phone_number; end
sig { params(_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def phone_number=(_phone_number); end
# Whether a signature is required for card delivery.
sig { returns(T.nilable(T::Boolean)) }
def require_signature; end
sig { params(_require_signature: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def require_signature=(_require_signature); end
# Shipment service.
sig { returns(T.nilable(String)) }
def service; end
sig { params(_service: T.nilable(String)).returns(T.nilable(String)) }
def service=(_service); end
# Packaging options.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(address: ::Stripe::Issuing::Card::CreateParams::Shipping::Address, address_validation: T.nilable(::Stripe::Issuing::Card::CreateParams::Shipping::AddressValidation), customs: T.nilable(::Stripe::Issuing::Card::CreateParams::Shipping::Customs), name: String, phone_number: T.nilable(String), require_signature: T.nilable(T::Boolean), service: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
address: nil,
address_validation: nil,
customs: nil,
name: nil,
phone_number: nil,
require_signature: nil,
service: nil,
type: nil
); end
end
class SpendingControls < Stripe::RequestParams
class SpendingLimit < Stripe::RequestParams
# Maximum amount allowed to spend per interval.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
sig { returns(T.nilable(T::Array[String])) }
def categories; end
sig {
params(_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def categories=(_categories); end
# Interval (or event) to which the amount applies.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig {
params(amount: Integer, categories: T.nilable(T::Array[String]), interval: String).void
}
def initialize(amount: nil, categories: nil, interval: nil); end
end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
sig { returns(T.nilable(T::Array[String])) }
def allowed_categories; end
sig {
params(_allowed_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_categories=(_allowed_categories); end
# Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def allowed_merchant_countries; end
sig {
params(_allowed_merchant_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_merchant_countries=(_allowed_merchant_countries); end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
sig { returns(T.nilable(T::Array[String])) }
def blocked_categories; end
sig {
params(_blocked_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def blocked_categories=(_blocked_categories); end
# Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def blocked_merchant_countries; end
sig {
params(_blocked_merchant_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def blocked_merchant_countries=(_blocked_merchant_countries); end
# Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).
sig {
returns(T.nilable(T::Array[::Stripe::Issuing::Card::CreateParams::SpendingControls::SpendingLimit]))
}
def spending_limits; end
sig {
params(_spending_limits: T.nilable(T::Array[::Stripe::Issuing::Card::CreateParams::SpendingControls::SpendingLimit])).returns(T.nilable(T::Array[::Stripe::Issuing::Card::CreateParams::SpendingControls::SpendingLimit]))
}
def spending_limits=(_spending_limits); end
sig {
params(allowed_categories: T.nilable(T::Array[String]), allowed_merchant_countries: T.nilable(T::Array[String]), blocked_categories: T.nilable(T::Array[String]), blocked_merchant_countries: T.nilable(T::Array[String]), spending_limits: T.nilable(T::Array[::Stripe::Issuing::Card::CreateParams::SpendingControls::SpendingLimit])).void
}
def initialize(
allowed_categories: nil,
allowed_merchant_countries: nil,
blocked_categories: nil,
blocked_merchant_countries: nil,
spending_limits: nil
); end
end
# The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated.
sig { returns(T.nilable(String)) }
def cardholder; end
sig { params(_cardholder: T.nilable(String)).returns(T.nilable(String)) }
def cardholder=(_cardholder); end
# The currency for the card.
sig { returns(String) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The desired expiration month (1-12) for this card if [specifying a custom expiration date](/issuing/cards/virtual/issue-cards?testing-method=with-code#exp-dates).
sig { returns(T.nilable(Integer)) }
def exp_month; end
sig { params(_exp_month: T.nilable(Integer)).returns(T.nilable(Integer)) }
def exp_month=(_exp_month); end
# The desired 4-digit expiration year for this card if [specifying a custom expiration date](/issuing/cards/virtual/issue-cards?testing-method=with-code#exp-dates).
sig { returns(T.nilable(Integer)) }
def exp_year; end
sig { params(_exp_year: T.nilable(Integer)).returns(T.nilable(Integer)) }
def exp_year=(_exp_year); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The new financial account ID the card will be associated with. This field allows a card to be reassigned to a different financial account.
sig { returns(T.nilable(String)) }
def financial_account; end
sig { params(_financial_account: T.nilable(String)).returns(T.nilable(String)) }
def financial_account=(_financial_account); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The personalization design object belonging to this card.
sig { returns(T.nilable(String)) }
def personalization_design; end
sig { params(_personalization_design: T.nilable(String)).returns(T.nilable(String)) }
def personalization_design=(_personalization_design); end
# The desired PIN for this card.
sig { returns(T.nilable(::Stripe::Issuing::Card::CreateParams::Pin)) }
def pin; end
sig {
params(_pin: T.nilable(::Stripe::Issuing::Card::CreateParams::Pin)).returns(T.nilable(::Stripe::Issuing::Card::CreateParams::Pin))
}
def pin=(_pin); end
# The card this is meant to be a replacement for (if any).
sig { returns(T.nilable(String)) }
def replacement_for; end
sig { params(_replacement_for: T.nilable(String)).returns(T.nilable(String)) }
def replacement_for=(_replacement_for); end
# If `replacement_for` is specified, this should indicate why that card is being replaced.
sig { returns(T.nilable(String)) }
def replacement_reason; end
sig { params(_replacement_reason: T.nilable(String)).returns(T.nilable(String)) }
def replacement_reason=(_replacement_reason); end
# The second line to print on the card. Max length: 24 characters.
sig { returns(T.nilable(String)) }
def second_line; end
sig { params(_second_line: T.nilable(String)).returns(T.nilable(String)) }
def second_line=(_second_line); end
# The address where the card will be shipped.
sig { returns(T.nilable(::Stripe::Issuing::Card::CreateParams::Shipping)) }
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::Issuing::Card::CreateParams::Shipping)).returns(T.nilable(::Stripe::Issuing::Card::CreateParams::Shipping))
}
def shipping=(_shipping); end
# Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
sig { returns(T.nilable(::Stripe::Issuing::Card::CreateParams::SpendingControls)) }
def spending_controls; end
sig {
params(_spending_controls: T.nilable(::Stripe::Issuing::Card::CreateParams::SpendingControls)).returns(T.nilable(::Stripe::Issuing::Card::CreateParams::SpendingControls))
}
def spending_controls=(_spending_controls); end
# Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# The type of card to issue. Possible values are `physical` or `virtual`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(cardholder: T.nilable(String), currency: String, exp_month: T.nilable(Integer), exp_year: T.nilable(Integer), expand: T.nilable(T::Array[String]), financial_account: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), personalization_design: T.nilable(String), pin: T.nilable(::Stripe::Issuing::Card::CreateParams::Pin), replacement_for: T.nilable(String), replacement_reason: T.nilable(String), second_line: T.nilable(String), shipping: T.nilable(::Stripe::Issuing::Card::CreateParams::Shipping), spending_controls: T.nilable(::Stripe::Issuing::Card::CreateParams::SpendingControls), status: T.nilable(String), type: String).void
}
def initialize(
cardholder: nil,
currency: nil,
exp_month: nil,
exp_year: nil,
expand: nil,
financial_account: nil,
metadata: nil,
personalization_design: nil,
pin: nil,
replacement_for: nil,
replacement_reason: nil,
second_line: nil,
shipping: nil,
spending_controls: nil,
status: nil,
type: nil
); end
end
class UpdateParams < Stripe::RequestParams
class Pin < Stripe::RequestParams
# The card's desired new PIN, encrypted under Stripe's public key.
sig { returns(T.nilable(String)) }
def encrypted_number; end
sig { params(_encrypted_number: T.nilable(String)).returns(T.nilable(String)) }
def encrypted_number=(_encrypted_number); end
sig { params(encrypted_number: T.nilable(String)).void }
def initialize(encrypted_number: nil); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(String) }
def city; end
sig { params(_city: String).returns(String) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(String) }
def line1; end
sig { params(_line1: String).returns(String) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(String) }
def postal_code; end
sig { params(_postal_code: String).returns(String) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: String, country: String, line1: String, line2: T.nilable(String), postal_code: String, state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressValidation < Stripe::RequestParams
# The address validation capabilities to use.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
sig { params(mode: String).void }
def initialize(mode: nil); end
end
class Customs < Stripe::RequestParams
# The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.
sig { returns(T.nilable(String)) }
def eori_number; end
sig { params(_eori_number: T.nilable(String)).returns(T.nilable(String)) }
def eori_number=(_eori_number); end
sig { params(eori_number: T.nilable(String)).void }
def initialize(eori_number: nil); end
end
# The address that the card is shipped to.
sig { returns(::Stripe::Issuing::Card::UpdateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::Issuing::Card::UpdateParams::Shipping::Address).returns(::Stripe::Issuing::Card::UpdateParams::Shipping::Address)
}
def address=(_address); end
# Address validation settings.
sig {
returns(T.nilable(::Stripe::Issuing::Card::UpdateParams::Shipping::AddressValidation))
}
def address_validation; end
sig {
params(_address_validation: T.nilable(::Stripe::Issuing::Card::UpdateParams::Shipping::AddressValidation)).returns(T.nilable(::Stripe::Issuing::Card::UpdateParams::Shipping::AddressValidation))
}
def address_validation=(_address_validation); end
# Customs information for the shipment.
sig { returns(T.nilable(::Stripe::Issuing::Card::UpdateParams::Shipping::Customs)) }
def customs; end
sig {
params(_customs: T.nilable(::Stripe::Issuing::Card::UpdateParams::Shipping::Customs)).returns(T.nilable(::Stripe::Issuing::Card::UpdateParams::Shipping::Customs))
}
def customs=(_customs); end
# The name printed on the shipping label when shipping the card.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Phone number of the recipient of the shipment.
sig { returns(T.nilable(String)) }
def phone_number; end
sig { params(_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def phone_number=(_phone_number); end
# Whether a signature is required for card delivery.
sig { returns(T.nilable(T::Boolean)) }
def require_signature; end
sig { params(_require_signature: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def require_signature=(_require_signature); end
# Shipment service.
sig { returns(T.nilable(String)) }
def service; end
sig { params(_service: T.nilable(String)).returns(T.nilable(String)) }
def service=(_service); end
# Packaging options.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(address: ::Stripe::Issuing::Card::UpdateParams::Shipping::Address, address_validation: T.nilable(::Stripe::Issuing::Card::UpdateParams::Shipping::AddressValidation), customs: T.nilable(::Stripe::Issuing::Card::UpdateParams::Shipping::Customs), name: String, phone_number: T.nilable(String), require_signature: T.nilable(T::Boolean), service: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
address: nil,
address_validation: nil,
customs: nil,
name: nil,
phone_number: nil,
require_signature: nil,
service: nil,
type: nil
); end
end
class SpendingControls < Stripe::RequestParams
class SpendingLimit < Stripe::RequestParams
# Maximum amount allowed to spend per interval.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
sig { returns(T.nilable(T::Array[String])) }
def categories; end
sig {
params(_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def categories=(_categories); end
# Interval (or event) to which the amount applies.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig {
params(amount: Integer, categories: T.nilable(T::Array[String]), interval: String).void
}
def initialize(amount: nil, categories: nil, interval: nil); end
end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
sig { returns(T.nilable(T::Array[String])) }
def allowed_categories; end
sig {
params(_allowed_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_categories=(_allowed_categories); end
# Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def allowed_merchant_countries; end
sig {
params(_allowed_merchant_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_merchant_countries=(_allowed_merchant_countries); end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
sig { returns(T.nilable(T::Array[String])) }
def blocked_categories; end
sig {
params(_blocked_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def blocked_categories=(_blocked_categories); end
# Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def blocked_merchant_countries; end
sig {
params(_blocked_merchant_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def blocked_merchant_countries=(_blocked_merchant_countries); end
# Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).
sig {
returns(T.nilable(T::Array[::Stripe::Issuing::Card::UpdateParams::SpendingControls::SpendingLimit]))
}
def spending_limits; end
sig {
params(_spending_limits: T.nilable(T::Array[::Stripe::Issuing::Card::UpdateParams::SpendingControls::SpendingLimit])).returns(T.nilable(T::Array[::Stripe::Issuing::Card::UpdateParams::SpendingControls::SpendingLimit]))
}
def spending_limits=(_spending_limits); end
sig {
params(allowed_categories: T.nilable(T::Array[String]), allowed_merchant_countries: T.nilable(T::Array[String]), blocked_categories: T.nilable(T::Array[String]), blocked_merchant_countries: T.nilable(T::Array[String]), spending_limits: T.nilable(T::Array[::Stripe::Issuing::Card::UpdateParams::SpendingControls::SpendingLimit])).void
}
def initialize(
allowed_categories: nil,
allowed_merchant_countries: nil,
blocked_categories: nil,
blocked_merchant_countries: nil,
spending_limits: nil
); end
end
# Reason why the `status` of this card is `canceled`.
sig { returns(T.nilable(String)) }
def cancellation_reason; end
sig { params(_cancellation_reason: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_reason=(_cancellation_reason); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Attribute for param field personalization_design
sig { returns(T.nilable(String)) }
def personalization_design; end
sig { params(_personalization_design: T.nilable(String)).returns(T.nilable(String)) }
def personalization_design=(_personalization_design); end
# The desired new PIN for this card.
sig { returns(T.nilable(::Stripe::Issuing::Card::UpdateParams::Pin)) }
def pin; end
sig {
params(_pin: T.nilable(::Stripe::Issuing::Card::UpdateParams::Pin)).returns(T.nilable(::Stripe::Issuing::Card::UpdateParams::Pin))
}
def pin=(_pin); end
# Updated shipping information for the card.
sig { returns(T.nilable(::Stripe::Issuing::Card::UpdateParams::Shipping)) }
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::Issuing::Card::UpdateParams::Shipping)).returns(T.nilable(::Stripe::Issuing::Card::UpdateParams::Shipping))
}
def shipping=(_shipping); end
# Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
sig { returns(T.nilable(::Stripe::Issuing::Card::UpdateParams::SpendingControls)) }
def spending_controls; end
sig {
params(_spending_controls: T.nilable(::Stripe::Issuing::Card::UpdateParams::SpendingControls)).returns(T.nilable(::Stripe::Issuing::Card::UpdateParams::SpendingControls))
}
def spending_controls=(_spending_controls); end
# Dictates whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(cancellation_reason: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), personalization_design: T.nilable(String), pin: T.nilable(::Stripe::Issuing::Card::UpdateParams::Pin), shipping: T.nilable(::Stripe::Issuing::Card::UpdateParams::Shipping), spending_controls: T.nilable(::Stripe::Issuing::Card::UpdateParams::SpendingControls), status: T.nilable(String)).void
}
def initialize(
cancellation_reason: nil,
expand: nil,
metadata: nil,
personalization_design: nil,
pin: nil,
shipping: nil,
spending_controls: nil,
status: nil
); end
end
class DeliverCardParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class FailCardParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ReturnCardParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ShipCardParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class SubmitCardParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Creates an Issuing Card object.
sig {
params(params: T.any(::Stripe::Issuing::Card::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Card)
}
def self.create(params = {}, opts = {}); end
# Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::Card::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(card: String, params: T.any(::Stripe::Issuing::Card::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Card)
}
def self.update(card, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
# Every time an applicant submits an application for a Charge Card product your platform offers, or every time your platform takes a proactive credit decision on an existing account, you must record the decision by creating a new `CreditUnderwritingRecord` object on a connected account.
#
# [Follow the guide](https://stripe.com/docs/issuing/credit/report-credit-decisions-and-manage-aans) to learn about your requirements as a platform.
class CreditUnderwritingRecord < APIResource
class Application < Stripe::StripeObject
# The channel through which the applicant has submitted their application.
sig { returns(String) }
def application_method; end
# Scope of demand made by the applicant.
sig { returns(String) }
def purpose; end
# Date when the applicant submitted their application.
sig { returns(Integer) }
def submitted_at; end
end
class CreditUser < Stripe::StripeObject
# Email of the applicant or accountholder.
sig { returns(String) }
def email; end
# Full name of the company or person.
sig { returns(String) }
def name; end
end
class Decision < Stripe::StripeObject
class ApplicationRejected < Stripe::StripeObject
# Details about the `reasons.other` when present.
sig { returns(T.nilable(String)) }
def reason_other_explanation; end
# List of reasons why the application was rejected up to 4 reasons, in order of importance.
sig { returns(T::Array[String]) }
def reasons; end
end
class CreditLimitApproved < Stripe::StripeObject
# Credit amount approved. An approved credit limit is required before you can set a amount in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy).
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
end
class CreditLimitDecreased < Stripe::StripeObject
# Credit amount approved after decrease. An approved credit limit is required before you can set a amount in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy).
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
# Details about the `reasons.other` when present.
sig { returns(T.nilable(String)) }
def reason_other_explanation; end
# List of reasons why the existing credit was decreased, up to 4 reasons, in order of importance.
sig { returns(T::Array[String]) }
def reasons; end
end
class CreditLineClosed < Stripe::StripeObject
# Details about the `reasons.other` when present.
sig { returns(T.nilable(String)) }
def reason_other_explanation; end
# List of reasons why the existing account was closed, up to 4 reasons, in order of importance.
sig { returns(T::Array[String]) }
def reasons; end
end
# Details about a decision application_rejected.
sig { returns(T.nilable(ApplicationRejected)) }
def application_rejected; end
# Details about a decision credit_limit_approved.
sig { returns(T.nilable(CreditLimitApproved)) }
def credit_limit_approved; end
# Details about a decision credit_limit_decreased.
sig { returns(T.nilable(CreditLimitDecreased)) }
def credit_limit_decreased; end
# Details about a decision credit_line_closed.
sig { returns(T.nilable(CreditLineClosed)) }
def credit_line_closed; end
# Outcome of the decision.
sig { returns(String) }
def type; end
end
class UnderwritingException < Stripe::StripeObject
# Written explanation for the exception.
sig { returns(String) }
def explanation; end
# The decision before the exception was applied.
sig { returns(String) }
def original_decision_type; end
end
# For decisions triggered by an application, details about the submission.
sig { returns(T.nilable(Application)) }
def application; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The event that triggered the underwriting.
sig { returns(String) }
def created_from; end
# Attribute for field credit_user
sig { returns(CreditUser) }
def credit_user; end
# Date when a decision was made.
sig { returns(T.nilable(Integer)) }
def decided_at; end
# Details about the decision.
sig { returns(T.nilable(Decision)) }
def decision; end
# For underwriting initiated by an application, a decision must be taken 30 days after the submission.
sig { returns(T.nilable(Integer)) }
def decision_deadline; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).
sig { returns(T.nilable(String)) }
def regulatory_reporting_file; end
# If an exception to the usual underwriting criteria was made for this application, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.
sig { returns(T.nilable(UnderwritingException)) }
def underwriting_exception; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CorrectParams < Stripe::RequestParams
class Application < Stripe::RequestParams
# The channel through which the applicant has submitted their application. Defaults to `online`.
sig { returns(T.nilable(String)) }
def application_method; end
sig { params(_application_method: T.nilable(String)).returns(T.nilable(String)) }
def application_method=(_application_method); end
# Scope of demand made by the applicant.
sig { returns(String) }
def purpose; end
sig { params(_purpose: String).returns(String) }
def purpose=(_purpose); end
# Date when the applicant submitted their application.
sig { returns(Integer) }
def submitted_at; end
sig { params(_submitted_at: Integer).returns(Integer) }
def submitted_at=(_submitted_at); end
sig {
params(application_method: T.nilable(String), purpose: String, submitted_at: Integer).void
}
def initialize(application_method: nil, purpose: nil, submitted_at: nil); end
end
class CreditUser < Stripe::RequestParams
# Email of the applicant or accountholder.
sig { returns(String) }
def email; end
sig { params(_email: String).returns(String) }
def email=(_email); end
# Full name of the company or person.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(email: String, name: String).void }
def initialize(email: nil, name: nil); end
end
class Decision < Stripe::RequestParams
class ApplicationRejected < Stripe::RequestParams
# Details about the `reasons.other` when present.
sig { returns(T.nilable(String)) }
def reason_other_explanation; end
sig { params(_reason_other_explanation: T.nilable(String)).returns(T.nilable(String)) }
def reason_other_explanation=(_reason_other_explanation); end
# List of reasons why the application was rejected, up to 4 reasons, in order of importance.
sig { returns(T::Array[String]) }
def reasons; end
sig { params(_reasons: T::Array[String]).returns(T::Array[String]) }
def reasons=(_reasons); end
sig {
params(reason_other_explanation: T.nilable(String), reasons: T::Array[String]).void
}
def initialize(reason_other_explanation: nil, reasons: nil); end
end
class CreditLimitApproved < Stripe::RequestParams
# The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The currency of the credit approved, will default to the Account's Issuing currency.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
sig { params(amount: Integer, currency: T.nilable(String)).void }
def initialize(amount: nil, currency: nil); end
end
class CreditLimitDecreased < Stripe::RequestParams
# The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The currency of the credit approved, will default to the Account's Issuing currency.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Details about the `reasons.other` when present.
sig { returns(T.nilable(String)) }
def reason_other_explanation; end
sig { params(_reason_other_explanation: T.nilable(String)).returns(T.nilable(String)) }
def reason_other_explanation=(_reason_other_explanation); end
# List of reasons why the existing credit was decreased, up to 4 reasons, in order of importance.
sig { returns(T::Array[String]) }
def reasons; end
sig { params(_reasons: T::Array[String]).returns(T::Array[String]) }
def reasons=(_reasons); end
sig {
params(amount: Integer, currency: T.nilable(String), reason_other_explanation: T.nilable(String), reasons: T::Array[String]).void
}
def initialize(
amount: nil,
currency: nil,
reason_other_explanation: nil,
reasons: nil
); end
end
class CreditLineClosed < Stripe::RequestParams
# Details about the `reasons.other` when present.
sig { returns(T.nilable(String)) }
def reason_other_explanation; end
sig { params(_reason_other_explanation: T.nilable(String)).returns(T.nilable(String)) }
def reason_other_explanation=(_reason_other_explanation); end
# List of reasons why the credit line was closed, up to 4 reasons, in order of importance.
sig { returns(T::Array[String]) }
def reasons; end
sig { params(_reasons: T::Array[String]).returns(T::Array[String]) }
def reasons=(_reasons); end
sig {
params(reason_other_explanation: T.nilable(String), reasons: T::Array[String]).void
}
def initialize(reason_other_explanation: nil, reasons: nil); end
end
# Details about the application rejection.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision::ApplicationRejected))
}
def application_rejected; end
sig {
params(_application_rejected: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision::ApplicationRejected)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision::ApplicationRejected))
}
def application_rejected=(_application_rejected); end
# Details about the credit limit approved. An approved credit limit is required before you can set a `credit_limit_amount` in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy/)
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision::CreditLimitApproved))
}
def credit_limit_approved; end
sig {
params(_credit_limit_approved: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision::CreditLimitApproved)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision::CreditLimitApproved))
}
def credit_limit_approved=(_credit_limit_approved); end
# Details about the credit limit decreased.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision::CreditLimitDecreased))
}
def credit_limit_decreased; end
sig {
params(_credit_limit_decreased: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision::CreditLimitDecreased)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision::CreditLimitDecreased))
}
def credit_limit_decreased=(_credit_limit_decreased); end
# Details about the credit line closed.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision::CreditLineClosed))
}
def credit_line_closed; end
sig {
params(_credit_line_closed: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision::CreditLineClosed)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision::CreditLineClosed))
}
def credit_line_closed=(_credit_line_closed); end
# Outcome of the decision.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(application_rejected: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision::ApplicationRejected), credit_limit_approved: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision::CreditLimitApproved), credit_limit_decreased: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision::CreditLimitDecreased), credit_line_closed: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision::CreditLineClosed), type: String).void
}
def initialize(
application_rejected: nil,
credit_limit_approved: nil,
credit_limit_decreased: nil,
credit_line_closed: nil,
type: nil
); end
end
class UnderwritingException < Stripe::RequestParams
# Written explanation for the exception.
sig { returns(String) }
def explanation; end
sig { params(_explanation: String).returns(String) }
def explanation=(_explanation); end
# The decision before the exception was applied.
sig { returns(String) }
def original_decision_type; end
sig { params(_original_decision_type: String).returns(String) }
def original_decision_type=(_original_decision_type); end
sig { params(explanation: String, original_decision_type: String).void }
def initialize(explanation: nil, original_decision_type: nil); end
end
# Details about the application submission.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Application))
}
def application; end
sig {
params(_application: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Application)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Application))
}
def application=(_application); end
# Information about the company or person applying or holding the account.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::CreditUser))
}
def credit_user; end
sig {
params(_credit_user: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::CreditUser)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::CreditUser))
}
def credit_user=(_credit_user); end
# Date when a decision was made.
sig { returns(T.nilable(Integer)) }
def decided_at; end
sig { params(_decided_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def decided_at=(_decided_at); end
# Details about the decision.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision))
}
def decision; end
sig {
params(_decision: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision))
}
def decision=(_decision); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions). Optional if previously provided and no changes are needed.
sig { returns(T.nilable(String)) }
def regulatory_reporting_file; end
sig { params(_regulatory_reporting_file: T.nilable(String)).returns(T.nilable(String)) }
def regulatory_reporting_file=(_regulatory_reporting_file); end
# If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::UnderwritingException))
}
def underwriting_exception; end
sig {
params(_underwriting_exception: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::UnderwritingException)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::UnderwritingException))
}
def underwriting_exception=(_underwriting_exception); end
sig {
params(application: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Application), credit_user: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::CreditUser), decided_at: T.nilable(Integer), decision: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::Decision), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), regulatory_reporting_file: T.nilable(String), underwriting_exception: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams::UnderwritingException)).void
}
def initialize(
application: nil,
credit_user: nil,
decided_at: nil,
decision: nil,
expand: nil,
metadata: nil,
regulatory_reporting_file: nil,
underwriting_exception: nil
); end
end
class ReportDecisionParams < Stripe::RequestParams
class Decision < Stripe::RequestParams
class ApplicationRejected < Stripe::RequestParams
# Details about the `reasons.other` when present.
sig { returns(T.nilable(String)) }
def reason_other_explanation; end
sig { params(_reason_other_explanation: T.nilable(String)).returns(T.nilable(String)) }
def reason_other_explanation=(_reason_other_explanation); end
# List of reasons why the application was rejected, up to 4 reasons, in order of importance.
sig { returns(T::Array[String]) }
def reasons; end
sig { params(_reasons: T::Array[String]).returns(T::Array[String]) }
def reasons=(_reasons); end
sig {
params(reason_other_explanation: T.nilable(String), reasons: T::Array[String]).void
}
def initialize(reason_other_explanation: nil, reasons: nil); end
end
class CreditLimitApproved < Stripe::RequestParams
# The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The currency of the credit approved, will default to the Account's Issuing currency.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
sig { params(amount: Integer, currency: T.nilable(String)).void }
def initialize(amount: nil, currency: nil); end
end
# Details about the application rejection.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams::Decision::ApplicationRejected))
}
def application_rejected; end
sig {
params(_application_rejected: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams::Decision::ApplicationRejected)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams::Decision::ApplicationRejected))
}
def application_rejected=(_application_rejected); end
# Details about the credit limit approved. An approved credit limit is required before you can set a `credit_limit_amount` in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy/)
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams::Decision::CreditLimitApproved))
}
def credit_limit_approved; end
sig {
params(_credit_limit_approved: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams::Decision::CreditLimitApproved)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams::Decision::CreditLimitApproved))
}
def credit_limit_approved=(_credit_limit_approved); end
# Outcome of the decision.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(application_rejected: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams::Decision::ApplicationRejected), credit_limit_approved: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams::Decision::CreditLimitApproved), type: String).void
}
def initialize(application_rejected: nil, credit_limit_approved: nil, type: nil); end
end
class UnderwritingException < Stripe::RequestParams
# Written explanation for the exception.
sig { returns(String) }
def explanation; end
sig { params(_explanation: String).returns(String) }
def explanation=(_explanation); end
# The decision before the exception was applied.
sig { returns(String) }
def original_decision_type; end
sig { params(_original_decision_type: String).returns(String) }
def original_decision_type=(_original_decision_type); end
sig { params(explanation: String, original_decision_type: String).void }
def initialize(explanation: nil, original_decision_type: nil); end
end
# Date when a decision was made.
sig { returns(Integer) }
def decided_at; end
sig { params(_decided_at: Integer).returns(Integer) }
def decided_at=(_decided_at); end
# Details about the decision.
sig { returns(::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams::Decision) }
def decision; end
sig {
params(_decision: ::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams::Decision).returns(::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams::Decision)
}
def decision=(_decision); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).
sig { returns(T.nilable(String)) }
def regulatory_reporting_file; end
sig { params(_regulatory_reporting_file: T.nilable(String)).returns(T.nilable(String)) }
def regulatory_reporting_file=(_regulatory_reporting_file); end
# If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams::UnderwritingException))
}
def underwriting_exception; end
sig {
params(_underwriting_exception: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams::UnderwritingException)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams::UnderwritingException))
}
def underwriting_exception=(_underwriting_exception); end
sig {
params(decided_at: Integer, decision: ::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams::Decision, expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), regulatory_reporting_file: T.nilable(String), underwriting_exception: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams::UnderwritingException)).void
}
def initialize(
decided_at: nil,
decision: nil,
expand: nil,
metadata: nil,
regulatory_reporting_file: nil,
underwriting_exception: nil
); end
end
class CreateFromApplicationParams < Stripe::RequestParams
class Application < Stripe::RequestParams
# The channel through which the applicant has submitted their application. Defaults to `online`.
sig { returns(T.nilable(String)) }
def application_method; end
sig { params(_application_method: T.nilable(String)).returns(T.nilable(String)) }
def application_method=(_application_method); end
# Scope of demand made by the applicant.
sig { returns(String) }
def purpose; end
sig { params(_purpose: String).returns(String) }
def purpose=(_purpose); end
# Date when the applicant submitted their application.
sig { returns(Integer) }
def submitted_at; end
sig { params(_submitted_at: Integer).returns(Integer) }
def submitted_at=(_submitted_at); end
sig {
params(application_method: T.nilable(String), purpose: String, submitted_at: Integer).void
}
def initialize(application_method: nil, purpose: nil, submitted_at: nil); end
end
class CreditUser < Stripe::RequestParams
# Email of the applicant or accountholder.
sig { returns(String) }
def email; end
sig { params(_email: String).returns(String) }
def email=(_email); end
# Full name of the company or person.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(email: String, name: String).void }
def initialize(email: nil, name: nil); end
end
# Details about the application submission.
sig {
returns(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromApplicationParams::Application)
}
def application; end
sig {
params(_application: ::Stripe::Issuing::CreditUnderwritingRecord::CreateFromApplicationParams::Application).returns(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromApplicationParams::Application)
}
def application=(_application); end
# Information about the company or person applying or holding the account.
sig {
returns(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromApplicationParams::CreditUser)
}
def credit_user; end
sig {
params(_credit_user: ::Stripe::Issuing::CreditUnderwritingRecord::CreateFromApplicationParams::CreditUser).returns(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromApplicationParams::CreditUser)
}
def credit_user=(_credit_user); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(application: ::Stripe::Issuing::CreditUnderwritingRecord::CreateFromApplicationParams::Application, credit_user: ::Stripe::Issuing::CreditUnderwritingRecord::CreateFromApplicationParams::CreditUser, expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(application: nil, credit_user: nil, expand: nil, metadata: nil); end
end
class CreateFromProactiveReviewParams < Stripe::RequestParams
class CreditUser < Stripe::RequestParams
# Email of the applicant or accountholder.
sig { returns(String) }
def email; end
sig { params(_email: String).returns(String) }
def email=(_email); end
# Full name of the company or person.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(email: String, name: String).void }
def initialize(email: nil, name: nil); end
end
class Decision < Stripe::RequestParams
class CreditLimitApproved < Stripe::RequestParams
# The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The currency of the credit approved, will default to the Account's Issuing currency.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
sig { params(amount: Integer, currency: T.nilable(String)).void }
def initialize(amount: nil, currency: nil); end
end
class CreditLimitDecreased < Stripe::RequestParams
# The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The currency of the credit approved, will default to the Account's Issuing currency.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Details about the `reasons.other` when present.
sig { returns(T.nilable(String)) }
def reason_other_explanation; end
sig { params(_reason_other_explanation: T.nilable(String)).returns(T.nilable(String)) }
def reason_other_explanation=(_reason_other_explanation); end
# List of reasons why the existing credit was decreased, up to 4 reasons, in order of importance.
sig { returns(T::Array[String]) }
def reasons; end
sig { params(_reasons: T::Array[String]).returns(T::Array[String]) }
def reasons=(_reasons); end
sig {
params(amount: Integer, currency: T.nilable(String), reason_other_explanation: T.nilable(String), reasons: T::Array[String]).void
}
def initialize(
amount: nil,
currency: nil,
reason_other_explanation: nil,
reasons: nil
); end
end
class CreditLineClosed < Stripe::RequestParams
# Details about the `reasons.other` when present.
sig { returns(T.nilable(String)) }
def reason_other_explanation; end
sig { params(_reason_other_explanation: T.nilable(String)).returns(T.nilable(String)) }
def reason_other_explanation=(_reason_other_explanation); end
# List of reasons why the credit line was closed, up to 4 reasons, in order of importance.
sig { returns(T::Array[String]) }
def reasons; end
sig { params(_reasons: T::Array[String]).returns(T::Array[String]) }
def reasons=(_reasons); end
sig {
params(reason_other_explanation: T.nilable(String), reasons: T::Array[String]).void
}
def initialize(reason_other_explanation: nil, reasons: nil); end
end
# Details about the credit limit approved. An approved credit limit is required before you can set a `credit_limit_amount` in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy/)
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::Decision::CreditLimitApproved))
}
def credit_limit_approved; end
sig {
params(_credit_limit_approved: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::Decision::CreditLimitApproved)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::Decision::CreditLimitApproved))
}
def credit_limit_approved=(_credit_limit_approved); end
# Details about the credit limit decreased.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::Decision::CreditLimitDecreased))
}
def credit_limit_decreased; end
sig {
params(_credit_limit_decreased: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::Decision::CreditLimitDecreased)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::Decision::CreditLimitDecreased))
}
def credit_limit_decreased=(_credit_limit_decreased); end
# Details about the credit line closed.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::Decision::CreditLineClosed))
}
def credit_line_closed; end
sig {
params(_credit_line_closed: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::Decision::CreditLineClosed)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::Decision::CreditLineClosed))
}
def credit_line_closed=(_credit_line_closed); end
# Outcome of the decision.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(credit_limit_approved: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::Decision::CreditLimitApproved), credit_limit_decreased: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::Decision::CreditLimitDecreased), credit_line_closed: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::Decision::CreditLineClosed), type: String).void
}
def initialize(
credit_limit_approved: nil,
credit_limit_decreased: nil,
credit_line_closed: nil,
type: nil
); end
end
class UnderwritingException < Stripe::RequestParams
# Written explanation for the exception.
sig { returns(String) }
def explanation; end
sig { params(_explanation: String).returns(String) }
def explanation=(_explanation); end
# The decision before the exception was applied.
sig { returns(String) }
def original_decision_type; end
sig { params(_original_decision_type: String).returns(String) }
def original_decision_type=(_original_decision_type); end
sig { params(explanation: String, original_decision_type: String).void }
def initialize(explanation: nil, original_decision_type: nil); end
end
# Information about the company or person applying or holding the account.
sig {
returns(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::CreditUser)
}
def credit_user; end
sig {
params(_credit_user: ::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::CreditUser).returns(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::CreditUser)
}
def credit_user=(_credit_user); end
# Date when a decision was made.
sig { returns(Integer) }
def decided_at; end
sig { params(_decided_at: Integer).returns(Integer) }
def decided_at=(_decided_at); end
# Details about the decision.
sig {
returns(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::Decision)
}
def decision; end
sig {
params(_decision: ::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::Decision).returns(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::Decision)
}
def decision=(_decision); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).
sig { returns(T.nilable(String)) }
def regulatory_reporting_file; end
sig { params(_regulatory_reporting_file: T.nilable(String)).returns(T.nilable(String)) }
def regulatory_reporting_file=(_regulatory_reporting_file); end
# If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::UnderwritingException))
}
def underwriting_exception; end
sig {
params(_underwriting_exception: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::UnderwritingException)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::UnderwritingException))
}
def underwriting_exception=(_underwriting_exception); end
sig {
params(credit_user: ::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::CreditUser, decided_at: Integer, decision: ::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::Decision, expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), regulatory_reporting_file: T.nilable(String), underwriting_exception: T.nilable(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams::UnderwritingException)).void
}
def initialize(
credit_user: nil,
decided_at: nil,
decision: nil,
expand: nil,
metadata: nil,
regulatory_reporting_file: nil,
underwriting_exception: nil
); end
end
# Update a CreditUnderwritingRecord object to correct mistakes.
sig {
params(params: T.any(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::CreditUnderwritingRecord)
}
def correct(params = {}, opts = {}); end
# Update a CreditUnderwritingRecord object to correct mistakes.
sig {
params(credit_underwriting_record: String, params: T.any(::Stripe::Issuing::CreditUnderwritingRecord::CorrectParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::CreditUnderwritingRecord)
}
def self.correct(credit_underwriting_record, params = {}, opts = {}); end
# Creates a CreditUnderwritingRecord object with information about a credit application submission.
sig {
params(params: T.any(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromApplicationParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::CreditUnderwritingRecord)
}
def self.create_from_application(params = {}, opts = {}); end
# Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.
sig {
params(params: T.any(::Stripe::Issuing::CreditUnderwritingRecord::CreateFromProactiveReviewParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::CreditUnderwritingRecord)
}
def self.create_from_proactive_review(params = {}, opts = {}); end
# Retrieves a list of CreditUnderwritingRecord objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::CreditUnderwritingRecord::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Update a CreditUnderwritingRecord object from a decision made on a credit application.
sig {
params(params: T.any(::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::CreditUnderwritingRecord)
}
def report_decision(params = {}, opts = {}); end
# Update a CreditUnderwritingRecord object from a decision made on a credit application.
sig {
params(credit_underwriting_record: String, params: T.any(::Stripe::Issuing::CreditUnderwritingRecord::ReportDecisionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::CreditUnderwritingRecord)
}
def self.report_decision(credit_underwriting_record, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
# Represents a record from the card network of a money movement or change in state for an Issuing dispute. These records are included in the settlement reports that we receive from networks and expose to users as Settlement objects.
class DisputeSettlementDetail < APIResource
class NetworkData < Stripe::StripeObject
# The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.
sig { returns(T.nilable(String)) }
def processing_date; end
end
# Disputed amount in the card’s currency and in the smallest currency unit. Usually the amount of the transaction, but can differ (usually because of currency fluctuation).
sig { returns(Integer) }
def amount; end
# The card used to make the original transaction.
sig { returns(String) }
def card; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The currency the original transaction was made in. 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) }
def currency; end
# The ID of the linked dispute.
sig { returns(String) }
def dispute; end
# The type of event corresponding to this dispute settlement detail, representing the stage in the dispute network lifecycle.
sig { returns(String) }
def event_type; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# The card network for this dispute settlement detail. One of ["visa", "mastercard", "maestro"]
sig { returns(String) }
def network; end
# Details about the transaction, such as processing dates, set by the card network.
sig { returns(T.nilable(NetworkData)) }
def network_data; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The ID of the linked card network settlement.
sig { returns(T.nilable(String)) }
def settlement; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Select the Issuing dispute settlement details for the given settlement.
sig { returns(T.nilable(String)) }
def settlement; end
sig { params(_settlement: T.nilable(String)).returns(T.nilable(String)) }
def settlement=(_settlement); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), settlement: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
settlement: nil,
starting_after: nil
); end
end
# Returns a list of Issuing DisputeSettlementDetail objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::DisputeSettlementDetail::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
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: [Issuing disputes](https://stripe.com/docs/issuing/purchases/disputes)
class Dispute < APIResource
class Evidence < Stripe::StripeObject
class Canceled < Stripe::StripeObject
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def additional_documentation; end
# Date when order was canceled.
sig { returns(T.nilable(Integer)) }
def canceled_at; end
# Whether the cardholder was provided with a cancellation policy.
sig { returns(T.nilable(T::Boolean)) }
def cancellation_policy_provided; end
# Reason for canceling the order.
sig { returns(T.nilable(String)) }
def cancellation_reason; end
# Date when the cardholder expected to receive the product.
sig { returns(T.nilable(Integer)) }
def expected_at; end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
# Description of the merchandise or service that was purchased.
sig { returns(T.nilable(String)) }
def product_description; end
# Whether the product was a merchandise or service.
sig { returns(T.nilable(String)) }
def product_type; end
# Result of cardholder's attempt to return the product.
sig { returns(T.nilable(String)) }
def return_status; end
# Date when the product was returned or attempted to be returned.
sig { returns(T.nilable(Integer)) }
def returned_at; end
end
class Duplicate < Stripe::StripeObject
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def additional_documentation; end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def card_statement; end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def cash_receipt; end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def check_image; end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
# Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.
sig { returns(T.nilable(String)) }
def original_transaction; end
end
class Fraudulent < Stripe::StripeObject
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def additional_documentation; end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
end
class MerchandiseNotAsDescribed < Stripe::StripeObject
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def additional_documentation; end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
# Date when the product was received.
sig { returns(T.nilable(Integer)) }
def received_at; end
# Description of the cardholder's attempt to return the product.
sig { returns(T.nilable(String)) }
def return_description; end
# Result of cardholder's attempt to return the product.
sig { returns(T.nilable(String)) }
def return_status; end
# Date when the product was returned or attempted to be returned.
sig { returns(T.nilable(Integer)) }
def returned_at; end
end
class NoValidAuthorization < Stripe::StripeObject
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def additional_documentation; end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
end
class NotReceived < Stripe::StripeObject
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def additional_documentation; end
# Date when the cardholder expected to receive the product.
sig { returns(T.nilable(Integer)) }
def expected_at; end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
# Description of the merchandise or service that was purchased.
sig { returns(T.nilable(String)) }
def product_description; end
# Whether the product was a merchandise or service.
sig { returns(T.nilable(String)) }
def product_type; end
end
class Other < Stripe::StripeObject
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def additional_documentation; end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
# Description of the merchandise or service that was purchased.
sig { returns(T.nilable(String)) }
def product_description; end
# Whether the product was a merchandise or service.
sig { returns(T.nilable(String)) }
def product_type; end
end
class ServiceNotAsDescribed < Stripe::StripeObject
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def additional_documentation; end
# Date when order was canceled.
sig { returns(T.nilable(Integer)) }
def canceled_at; end
# Reason for canceling the order.
sig { returns(T.nilable(String)) }
def cancellation_reason; end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
# Date when the product was received.
sig { returns(T.nilable(Integer)) }
def received_at; end
end
# Attribute for field canceled
sig { returns(T.nilable(Canceled)) }
def canceled; end
# Attribute for field duplicate
sig { returns(T.nilable(Duplicate)) }
def duplicate; end
# Attribute for field fraudulent
sig { returns(T.nilable(Fraudulent)) }
def fraudulent; end
# Attribute for field merchandise_not_as_described
sig { returns(T.nilable(MerchandiseNotAsDescribed)) }
def merchandise_not_as_described; end
# Attribute for field no_valid_authorization
sig { returns(T.nilable(NoValidAuthorization)) }
def no_valid_authorization; end
# Attribute for field not_received
sig { returns(T.nilable(NotReceived)) }
def not_received; end
# Attribute for field other
sig { returns(T.nilable(Other)) }
def other; end
# The reason for filing the dispute. Its value will match the field containing the evidence.
sig { returns(String) }
def reason; end
# Attribute for field service_not_as_described
sig { returns(T.nilable(ServiceNotAsDescribed)) }
def service_not_as_described; end
end
class Treasury < Stripe::StripeObject
# The Treasury [DebitReversal](https://stripe.com/docs/api/treasury/debit_reversals) representing this Issuing dispute
sig { returns(T.nilable(String)) }
def debit_reversal; end
# The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) that is being disputed.
sig { returns(String) }
def received_debit; end
end
# Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation).
sig { returns(Integer) }
def amount; end
# List of balance transactions associated with the dispute.
sig { returns(T.nilable(T::Array[Stripe::BalanceTransaction])) }
def balance_transactions; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The currency the `transaction` was made in.
sig { returns(String) }
def currency; end
# Attribute for field evidence
sig { returns(Evidence) }
def evidence; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values.
sig { returns(T.nilable(String)) }
def loss_reason; end
# 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::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Current status of the dispute.
sig { returns(String) }
def status; end
# The transaction being disputed.
sig { returns(T.any(String, Stripe::Issuing::Transaction)) }
def transaction; end
# [Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
sig { returns(T.nilable(Treasury)) }
def treasury; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return Issuing disputes that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Issuing::Dispute::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Issuing::Dispute::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Issuing::Dispute::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Select Issuing disputes with the given status.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# Select the Issuing dispute for the given transaction.
sig { returns(T.nilable(String)) }
def transaction; end
sig { params(_transaction: T.nilable(String)).returns(T.nilable(String)) }
def transaction=(_transaction); end
sig {
params(created: T.nilable(T.any(::Stripe::Issuing::Dispute::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String), transaction: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil,
transaction: nil
); end
end
class CreateParams < Stripe::RequestParams
class Evidence < Stripe::RequestParams
class Canceled < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Date when order was canceled.
sig { returns(T.nilable(T.any(String, Integer))) }
def canceled_at; end
sig {
params(_canceled_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def canceled_at=(_canceled_at); end
# Whether the cardholder was provided with a cancellation policy.
sig { returns(T.nilable(T.any(String, T::Boolean))) }
def cancellation_policy_provided; end
sig {
params(_cancellation_policy_provided: T.nilable(T.any(String, T::Boolean))).returns(T.nilable(T.any(String, T::Boolean)))
}
def cancellation_policy_provided=(_cancellation_policy_provided); end
# Reason for canceling the order.
sig { returns(T.nilable(String)) }
def cancellation_reason; end
sig { params(_cancellation_reason: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_reason=(_cancellation_reason); end
# Date when the cardholder expected to receive the product.
sig { returns(T.nilable(T.any(String, Integer))) }
def expected_at; end
sig {
params(_expected_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expected_at=(_expected_at); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Description of the merchandise or service that was purchased.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Whether the product was a merchandise or service.
sig { returns(T.nilable(T.any(String, String))) }
def product_type; end
sig {
params(_product_type: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def product_type=(_product_type); end
# Result of cardholder's attempt to return the product.
sig { returns(T.nilable(T.any(String, String))) }
def return_status; end
sig {
params(_return_status: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def return_status=(_return_status); end
# Date when the product was returned or attempted to be returned.
sig { returns(T.nilable(T.any(String, Integer))) }
def returned_at; end
sig {
params(_returned_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def returned_at=(_returned_at); end
sig {
params(additional_documentation: T.nilable(String), canceled_at: T.nilable(T.any(String, Integer)), cancellation_policy_provided: T.nilable(T.any(String, T::Boolean)), cancellation_reason: T.nilable(String), expected_at: T.nilable(T.any(String, Integer)), explanation: T.nilable(String), product_description: T.nilable(String), product_type: T.nilable(T.any(String, String)), return_status: T.nilable(T.any(String, String)), returned_at: T.nilable(T.any(String, Integer))).void
}
def initialize(
additional_documentation: nil,
canceled_at: nil,
cancellation_policy_provided: nil,
cancellation_reason: nil,
expected_at: nil,
explanation: nil,
product_description: nil,
product_type: nil,
return_status: nil,
returned_at: nil
); end
end
class Duplicate < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.
sig { returns(T.nilable(String)) }
def card_statement; end
sig { params(_card_statement: T.nilable(String)).returns(T.nilable(String)) }
def card_statement=(_card_statement); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.
sig { returns(T.nilable(String)) }
def cash_receipt; end
sig { params(_cash_receipt: T.nilable(String)).returns(T.nilable(String)) }
def cash_receipt=(_cash_receipt); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.
sig { returns(T.nilable(String)) }
def check_image; end
sig { params(_check_image: T.nilable(String)).returns(T.nilable(String)) }
def check_image=(_check_image); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.
sig { returns(T.nilable(String)) }
def original_transaction; end
sig { params(_original_transaction: T.nilable(String)).returns(T.nilable(String)) }
def original_transaction=(_original_transaction); end
sig {
params(additional_documentation: T.nilable(String), card_statement: T.nilable(String), cash_receipt: T.nilable(String), check_image: T.nilable(String), explanation: T.nilable(String), original_transaction: T.nilable(String)).void
}
def initialize(
additional_documentation: nil,
card_statement: nil,
cash_receipt: nil,
check_image: nil,
explanation: nil,
original_transaction: nil
); end
end
class Fraudulent < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
sig {
params(additional_documentation: T.nilable(String), explanation: T.nilable(String)).void
}
def initialize(additional_documentation: nil, explanation: nil); end
end
class MerchandiseNotAsDescribed < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Date when the product was received.
sig { returns(T.nilable(T.any(String, Integer))) }
def received_at; end
sig {
params(_received_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def received_at=(_received_at); end
# Description of the cardholder's attempt to return the product.
sig { returns(T.nilable(String)) }
def return_description; end
sig { params(_return_description: T.nilable(String)).returns(T.nilable(String)) }
def return_description=(_return_description); end
# Result of cardholder's attempt to return the product.
sig { returns(T.nilable(T.any(String, String))) }
def return_status; end
sig {
params(_return_status: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def return_status=(_return_status); end
# Date when the product was returned or attempted to be returned.
sig { returns(T.nilable(T.any(String, Integer))) }
def returned_at; end
sig {
params(_returned_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def returned_at=(_returned_at); end
sig {
params(additional_documentation: T.nilable(String), explanation: T.nilable(String), received_at: T.nilable(T.any(String, Integer)), return_description: T.nilable(String), return_status: T.nilable(T.any(String, String)), returned_at: T.nilable(T.any(String, Integer))).void
}
def initialize(
additional_documentation: nil,
explanation: nil,
received_at: nil,
return_description: nil,
return_status: nil,
returned_at: nil
); end
end
class NoValidAuthorization < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
sig {
params(additional_documentation: T.nilable(String), explanation: T.nilable(String)).void
}
def initialize(additional_documentation: nil, explanation: nil); end
end
class NotReceived < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Date when the cardholder expected to receive the product.
sig { returns(T.nilable(T.any(String, Integer))) }
def expected_at; end
sig {
params(_expected_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expected_at=(_expected_at); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Description of the merchandise or service that was purchased.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Whether the product was a merchandise or service.
sig { returns(T.nilable(T.any(String, String))) }
def product_type; end
sig {
params(_product_type: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def product_type=(_product_type); end
sig {
params(additional_documentation: T.nilable(String), expected_at: T.nilable(T.any(String, Integer)), explanation: T.nilable(String), product_description: T.nilable(String), product_type: T.nilable(T.any(String, String))).void
}
def initialize(
additional_documentation: nil,
expected_at: nil,
explanation: nil,
product_description: nil,
product_type: nil
); end
end
class Other < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Description of the merchandise or service that was purchased.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Whether the product was a merchandise or service.
sig { returns(T.nilable(T.any(String, String))) }
def product_type; end
sig {
params(_product_type: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def product_type=(_product_type); end
sig {
params(additional_documentation: T.nilable(String), explanation: T.nilable(String), product_description: T.nilable(String), product_type: T.nilable(T.any(String, String))).void
}
def initialize(
additional_documentation: nil,
explanation: nil,
product_description: nil,
product_type: nil
); end
end
class ServiceNotAsDescribed < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Date when order was canceled.
sig { returns(T.nilable(T.any(String, Integer))) }
def canceled_at; end
sig {
params(_canceled_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def canceled_at=(_canceled_at); end
# Reason for canceling the order.
sig { returns(T.nilable(String)) }
def cancellation_reason; end
sig { params(_cancellation_reason: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_reason=(_cancellation_reason); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Date when the product was received.
sig { returns(T.nilable(T.any(String, Integer))) }
def received_at; end
sig {
params(_received_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def received_at=(_received_at); end
sig {
params(additional_documentation: T.nilable(String), canceled_at: T.nilable(T.any(String, Integer)), cancellation_reason: T.nilable(String), explanation: T.nilable(String), received_at: T.nilable(T.any(String, Integer))).void
}
def initialize(
additional_documentation: nil,
canceled_at: nil,
cancellation_reason: nil,
explanation: nil,
received_at: nil
); end
end
# Evidence provided when `reason` is 'canceled'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::Canceled)))
}
def canceled; end
sig {
params(_canceled: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::Canceled))).returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::Canceled)))
}
def canceled=(_canceled); end
# Evidence provided when `reason` is 'duplicate'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::Duplicate)))
}
def duplicate; end
sig {
params(_duplicate: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::Duplicate))).returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::Duplicate)))
}
def duplicate=(_duplicate); end
# Evidence provided when `reason` is 'fraudulent'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::Fraudulent)))
}
def fraudulent; end
sig {
params(_fraudulent: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::Fraudulent))).returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::Fraudulent)))
}
def fraudulent=(_fraudulent); end
# Evidence provided when `reason` is 'merchandise_not_as_described'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::MerchandiseNotAsDescribed)))
}
def merchandise_not_as_described; end
sig {
params(_merchandise_not_as_described: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::MerchandiseNotAsDescribed))).returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::MerchandiseNotAsDescribed)))
}
def merchandise_not_as_described=(_merchandise_not_as_described); end
# Evidence provided when `reason` is 'no_valid_authorization'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::NoValidAuthorization)))
}
def no_valid_authorization; end
sig {
params(_no_valid_authorization: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::NoValidAuthorization))).returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::NoValidAuthorization)))
}
def no_valid_authorization=(_no_valid_authorization); end
# Evidence provided when `reason` is 'not_received'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::NotReceived)))
}
def not_received; end
sig {
params(_not_received: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::NotReceived))).returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::NotReceived)))
}
def not_received=(_not_received); end
# Evidence provided when `reason` is 'other'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::Other)))
}
def other; end
sig {
params(_other: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::Other))).returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::Other)))
}
def other=(_other); end
# The reason for filing the dispute. The evidence should be submitted in the field of the same name.
sig { returns(T.nilable(String)) }
def reason; end
sig { params(_reason: T.nilable(String)).returns(T.nilable(String)) }
def reason=(_reason); end
# Evidence provided when `reason` is 'service_not_as_described'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::ServiceNotAsDescribed)))
}
def service_not_as_described; end
sig {
params(_service_not_as_described: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::ServiceNotAsDescribed))).returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::ServiceNotAsDescribed)))
}
def service_not_as_described=(_service_not_as_described); end
sig {
params(canceled: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::Canceled)), duplicate: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::Duplicate)), fraudulent: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::Fraudulent)), merchandise_not_as_described: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::MerchandiseNotAsDescribed)), no_valid_authorization: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::NoValidAuthorization)), not_received: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::NotReceived)), other: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::Other)), reason: T.nilable(String), service_not_as_described: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::CreateParams::Evidence::ServiceNotAsDescribed))).void
}
def initialize(
canceled: nil,
duplicate: nil,
fraudulent: nil,
merchandise_not_as_described: nil,
no_valid_authorization: nil,
not_received: nil,
other: nil,
reason: nil,
service_not_as_described: nil
); end
end
class Treasury < Stripe::RequestParams
# The ID of the ReceivedDebit to initiate an Issuings dispute for.
sig { returns(String) }
def received_debit; end
sig { params(_received_debit: String).returns(String) }
def received_debit=(_received_debit); end
sig { params(received_debit: String).void }
def initialize(received_debit: nil); end
end
# The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If not set, defaults to the full transaction amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Evidence provided for the dispute.
sig { returns(T.nilable(::Stripe::Issuing::Dispute::CreateParams::Evidence)) }
def evidence; end
sig {
params(_evidence: T.nilable(::Stripe::Issuing::Dispute::CreateParams::Evidence)).returns(T.nilable(::Stripe::Issuing::Dispute::CreateParams::Evidence))
}
def evidence=(_evidence); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`.
sig { returns(T.nilable(String)) }
def transaction; end
sig { params(_transaction: T.nilable(String)).returns(T.nilable(String)) }
def transaction=(_transaction); end
# Params for disputes related to Treasury FinancialAccounts
sig { returns(T.nilable(::Stripe::Issuing::Dispute::CreateParams::Treasury)) }
def treasury; end
sig {
params(_treasury: T.nilable(::Stripe::Issuing::Dispute::CreateParams::Treasury)).returns(T.nilable(::Stripe::Issuing::Dispute::CreateParams::Treasury))
}
def treasury=(_treasury); end
sig {
params(amount: T.nilable(Integer), evidence: T.nilable(::Stripe::Issuing::Dispute::CreateParams::Evidence), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), transaction: T.nilable(String), treasury: T.nilable(::Stripe::Issuing::Dispute::CreateParams::Treasury)).void
}
def initialize(
amount: nil,
evidence: nil,
expand: nil,
metadata: nil,
transaction: nil,
treasury: nil
); end
end
class UpdateParams < Stripe::RequestParams
class Evidence < Stripe::RequestParams
class Canceled < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Date when order was canceled.
sig { returns(T.nilable(T.any(String, Integer))) }
def canceled_at; end
sig {
params(_canceled_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def canceled_at=(_canceled_at); end
# Whether the cardholder was provided with a cancellation policy.
sig { returns(T.nilable(T.any(String, T::Boolean))) }
def cancellation_policy_provided; end
sig {
params(_cancellation_policy_provided: T.nilable(T.any(String, T::Boolean))).returns(T.nilable(T.any(String, T::Boolean)))
}
def cancellation_policy_provided=(_cancellation_policy_provided); end
# Reason for canceling the order.
sig { returns(T.nilable(String)) }
def cancellation_reason; end
sig { params(_cancellation_reason: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_reason=(_cancellation_reason); end
# Date when the cardholder expected to receive the product.
sig { returns(T.nilable(T.any(String, Integer))) }
def expected_at; end
sig {
params(_expected_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expected_at=(_expected_at); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Description of the merchandise or service that was purchased.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Whether the product was a merchandise or service.
sig { returns(T.nilable(T.any(String, String))) }
def product_type; end
sig {
params(_product_type: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def product_type=(_product_type); end
# Result of cardholder's attempt to return the product.
sig { returns(T.nilable(T.any(String, String))) }
def return_status; end
sig {
params(_return_status: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def return_status=(_return_status); end
# Date when the product was returned or attempted to be returned.
sig { returns(T.nilable(T.any(String, Integer))) }
def returned_at; end
sig {
params(_returned_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def returned_at=(_returned_at); end
sig {
params(additional_documentation: T.nilable(String), canceled_at: T.nilable(T.any(String, Integer)), cancellation_policy_provided: T.nilable(T.any(String, T::Boolean)), cancellation_reason: T.nilable(String), expected_at: T.nilable(T.any(String, Integer)), explanation: T.nilable(String), product_description: T.nilable(String), product_type: T.nilable(T.any(String, String)), return_status: T.nilable(T.any(String, String)), returned_at: T.nilable(T.any(String, Integer))).void
}
def initialize(
additional_documentation: nil,
canceled_at: nil,
cancellation_policy_provided: nil,
cancellation_reason: nil,
expected_at: nil,
explanation: nil,
product_description: nil,
product_type: nil,
return_status: nil,
returned_at: nil
); end
end
class Duplicate < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.
sig { returns(T.nilable(String)) }
def card_statement; end
sig { params(_card_statement: T.nilable(String)).returns(T.nilable(String)) }
def card_statement=(_card_statement); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.
sig { returns(T.nilable(String)) }
def cash_receipt; end
sig { params(_cash_receipt: T.nilable(String)).returns(T.nilable(String)) }
def cash_receipt=(_cash_receipt); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.
sig { returns(T.nilable(String)) }
def check_image; end
sig { params(_check_image: T.nilable(String)).returns(T.nilable(String)) }
def check_image=(_check_image); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.
sig { returns(T.nilable(String)) }
def original_transaction; end
sig { params(_original_transaction: T.nilable(String)).returns(T.nilable(String)) }
def original_transaction=(_original_transaction); end
sig {
params(additional_documentation: T.nilable(String), card_statement: T.nilable(String), cash_receipt: T.nilable(String), check_image: T.nilable(String), explanation: T.nilable(String), original_transaction: T.nilable(String)).void
}
def initialize(
additional_documentation: nil,
card_statement: nil,
cash_receipt: nil,
check_image: nil,
explanation: nil,
original_transaction: nil
); end
end
class Fraudulent < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
sig {
params(additional_documentation: T.nilable(String), explanation: T.nilable(String)).void
}
def initialize(additional_documentation: nil, explanation: nil); end
end
class MerchandiseNotAsDescribed < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Date when the product was received.
sig { returns(T.nilable(T.any(String, Integer))) }
def received_at; end
sig {
params(_received_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def received_at=(_received_at); end
# Description of the cardholder's attempt to return the product.
sig { returns(T.nilable(String)) }
def return_description; end
sig { params(_return_description: T.nilable(String)).returns(T.nilable(String)) }
def return_description=(_return_description); end
# Result of cardholder's attempt to return the product.
sig { returns(T.nilable(T.any(String, String))) }
def return_status; end
sig {
params(_return_status: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def return_status=(_return_status); end
# Date when the product was returned or attempted to be returned.
sig { returns(T.nilable(T.any(String, Integer))) }
def returned_at; end
sig {
params(_returned_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def returned_at=(_returned_at); end
sig {
params(additional_documentation: T.nilable(String), explanation: T.nilable(String), received_at: T.nilable(T.any(String, Integer)), return_description: T.nilable(String), return_status: T.nilable(T.any(String, String)), returned_at: T.nilable(T.any(String, Integer))).void
}
def initialize(
additional_documentation: nil,
explanation: nil,
received_at: nil,
return_description: nil,
return_status: nil,
returned_at: nil
); end
end
class NoValidAuthorization < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
sig {
params(additional_documentation: T.nilable(String), explanation: T.nilable(String)).void
}
def initialize(additional_documentation: nil, explanation: nil); end
end
class NotReceived < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Date when the cardholder expected to receive the product.
sig { returns(T.nilable(T.any(String, Integer))) }
def expected_at; end
sig {
params(_expected_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expected_at=(_expected_at); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Description of the merchandise or service that was purchased.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Whether the product was a merchandise or service.
sig { returns(T.nilable(T.any(String, String))) }
def product_type; end
sig {
params(_product_type: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def product_type=(_product_type); end
sig {
params(additional_documentation: T.nilable(String), expected_at: T.nilable(T.any(String, Integer)), explanation: T.nilable(String), product_description: T.nilable(String), product_type: T.nilable(T.any(String, String))).void
}
def initialize(
additional_documentation: nil,
expected_at: nil,
explanation: nil,
product_description: nil,
product_type: nil
); end
end
class Other < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Description of the merchandise or service that was purchased.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Whether the product was a merchandise or service.
sig { returns(T.nilable(T.any(String, String))) }
def product_type; end
sig {
params(_product_type: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def product_type=(_product_type); end
sig {
params(additional_documentation: T.nilable(String), explanation: T.nilable(String), product_description: T.nilable(String), product_type: T.nilable(T.any(String, String))).void
}
def initialize(
additional_documentation: nil,
explanation: nil,
product_description: nil,
product_type: nil
); end
end
class ServiceNotAsDescribed < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Date when order was canceled.
sig { returns(T.nilable(T.any(String, Integer))) }
def canceled_at; end
sig {
params(_canceled_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def canceled_at=(_canceled_at); end
# Reason for canceling the order.
sig { returns(T.nilable(String)) }
def cancellation_reason; end
sig { params(_cancellation_reason: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_reason=(_cancellation_reason); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Date when the product was received.
sig { returns(T.nilable(T.any(String, Integer))) }
def received_at; end
sig {
params(_received_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def received_at=(_received_at); end
sig {
params(additional_documentation: T.nilable(String), canceled_at: T.nilable(T.any(String, Integer)), cancellation_reason: T.nilable(String), explanation: T.nilable(String), received_at: T.nilable(T.any(String, Integer))).void
}
def initialize(
additional_documentation: nil,
canceled_at: nil,
cancellation_reason: nil,
explanation: nil,
received_at: nil
); end
end
# Evidence provided when `reason` is 'canceled'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::Canceled)))
}
def canceled; end
sig {
params(_canceled: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::Canceled))).returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::Canceled)))
}
def canceled=(_canceled); end
# Evidence provided when `reason` is 'duplicate'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::Duplicate)))
}
def duplicate; end
sig {
params(_duplicate: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::Duplicate))).returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::Duplicate)))
}
def duplicate=(_duplicate); end
# Evidence provided when `reason` is 'fraudulent'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::Fraudulent)))
}
def fraudulent; end
sig {
params(_fraudulent: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::Fraudulent))).returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::Fraudulent)))
}
def fraudulent=(_fraudulent); end
# Evidence provided when `reason` is 'merchandise_not_as_described'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::MerchandiseNotAsDescribed)))
}
def merchandise_not_as_described; end
sig {
params(_merchandise_not_as_described: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::MerchandiseNotAsDescribed))).returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::MerchandiseNotAsDescribed)))
}
def merchandise_not_as_described=(_merchandise_not_as_described); end
# Evidence provided when `reason` is 'no_valid_authorization'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::NoValidAuthorization)))
}
def no_valid_authorization; end
sig {
params(_no_valid_authorization: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::NoValidAuthorization))).returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::NoValidAuthorization)))
}
def no_valid_authorization=(_no_valid_authorization); end
# Evidence provided when `reason` is 'not_received'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::NotReceived)))
}
def not_received; end
sig {
params(_not_received: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::NotReceived))).returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::NotReceived)))
}
def not_received=(_not_received); end
# Evidence provided when `reason` is 'other'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::Other)))
}
def other; end
sig {
params(_other: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::Other))).returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::Other)))
}
def other=(_other); end
# The reason for filing the dispute. The evidence should be submitted in the field of the same name.
sig { returns(T.nilable(String)) }
def reason; end
sig { params(_reason: T.nilable(String)).returns(T.nilable(String)) }
def reason=(_reason); end
# Evidence provided when `reason` is 'service_not_as_described'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::ServiceNotAsDescribed)))
}
def service_not_as_described; end
sig {
params(_service_not_as_described: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::ServiceNotAsDescribed))).returns(T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::ServiceNotAsDescribed)))
}
def service_not_as_described=(_service_not_as_described); end
sig {
params(canceled: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::Canceled)), duplicate: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::Duplicate)), fraudulent: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::Fraudulent)), merchandise_not_as_described: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::MerchandiseNotAsDescribed)), no_valid_authorization: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::NoValidAuthorization)), not_received: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::NotReceived)), other: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::Other)), reason: T.nilable(String), service_not_as_described: T.nilable(T.any(String, ::Stripe::Issuing::Dispute::UpdateParams::Evidence::ServiceNotAsDescribed))).void
}
def initialize(
canceled: nil,
duplicate: nil,
fraudulent: nil,
merchandise_not_as_described: nil,
no_valid_authorization: nil,
not_received: nil,
other: nil,
reason: nil,
service_not_as_described: nil
); end
end
# The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Evidence provided for the dispute.
sig { returns(T.nilable(::Stripe::Issuing::Dispute::UpdateParams::Evidence)) }
def evidence; end
sig {
params(_evidence: T.nilable(::Stripe::Issuing::Dispute::UpdateParams::Evidence)).returns(T.nilable(::Stripe::Issuing::Dispute::UpdateParams::Evidence))
}
def evidence=(_evidence); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(amount: T.nilable(Integer), evidence: T.nilable(::Stripe::Issuing::Dispute::UpdateParams::Evidence), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(amount: nil, evidence: nil, expand: nil, metadata: nil); end
end
class SubmitParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, metadata: nil); 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://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements.
sig {
params(params: T.any(::Stripe::Issuing::Dispute::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Dispute)
}
def self.create(params = {}, opts = {}); end
# Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::Dispute::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); 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://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence).
sig {
params(params: T.any(::Stripe::Issuing::Dispute::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Dispute)
}
def submit(params = {}, opts = {}); 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://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence).
sig {
params(dispute: String, params: T.any(::Stripe::Issuing::Dispute::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Dispute)
}
def self.submit(dispute, params = {}, opts = {}); end
# Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.
sig {
params(dispute: String, params: T.any(::Stripe::Issuing::Dispute::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Dispute)
}
def self.update(dispute, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
# A fraud liability debit occurs when Stripe debits a platform's account for fraud losses on Issuing transactions.
class FraudLiabilityDebit < APIResource
# Debited amount. This is equal to the disputed amount and is given in the card’s currency and in the smallest currency unit.
sig { returns(Integer) }
def amount; end
# ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this debit.
sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
def balance_transaction; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The currency of the debit. 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) }
def currency; end
# The ID of the linked dispute.
sig { returns(String) }
def dispute; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return Issuing Fraud Liability Debits that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Issuing::FraudLiabilityDebit::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Issuing::FraudLiabilityDebit::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Issuing::FraudLiabilityDebit::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::Issuing::FraudLiabilityDebit::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
# Returns a list of Issuing FraudLiabilityDebit objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::FraudLiabilityDebit::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
# A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.
class PersonalizationDesign < APIResource
class CarrierText < Stripe::StripeObject
# The footer body text of the carrier letter.
sig { returns(T.nilable(String)) }
def footer_body; end
# The footer title text of the carrier letter.
sig { returns(T.nilable(String)) }
def footer_title; end
# The header body text of the carrier letter.
sig { returns(T.nilable(String)) }
def header_body; end
# The header title text of the carrier letter.
sig { returns(T.nilable(String)) }
def header_title; end
end
class Preferences < Stripe::StripeObject
# Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
sig { returns(T::Boolean) }
def is_default; end
# Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist.
sig { returns(T.nilable(T::Boolean)) }
def is_platform_default; end
end
class RejectionReasons < Stripe::StripeObject
# The reason(s) the card logo was rejected.
sig { returns(T.nilable(T::Array[String])) }
def card_logo; end
# The reason(s) the carrier text was rejected.
sig { returns(T.nilable(T::Array[String])) }
def carrier_text; end
end
# The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def card_logo; end
# Hash containing carrier text, for use with physical bundles that support carrier text.
sig { returns(T.nilable(CarrierText)) }
def carrier_text; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
sig { returns(T.nilable(String)) }
def lookup_key; end
# 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::Hash[String, String]) }
def metadata; end
# Friendly display name.
sig { returns(T.nilable(String)) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The physical bundle object belonging to this personalization design.
sig { returns(T.any(String, Stripe::Issuing::PhysicalBundle)) }
def physical_bundle; end
# Attribute for field preferences
sig { returns(Preferences) }
def preferences; end
# Attribute for field rejection_reasons
sig { returns(RejectionReasons) }
def rejection_reasons; end
# Whether this personalization design can be used to create cards.
sig { returns(String) }
def status; end
class ListParams < Stripe::RequestParams
class Preferences < Stripe::RequestParams
# Only return the personalization design that's set as the default. A connected account uses the Connect platform's default design if no personalization design is set as the default.
sig { returns(T.nilable(T::Boolean)) }
def is_default; end
sig { params(_is_default: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def is_default=(_is_default); end
# Only return the personalization design that is set as the Connect platform's default. This parameter is only applicable to connected accounts.
sig { returns(T.nilable(T::Boolean)) }
def is_platform_default; end
sig { params(_is_platform_default: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def is_platform_default=(_is_platform_default); end
sig {
params(is_default: T.nilable(T::Boolean), is_platform_default: T.nilable(T::Boolean)).void
}
def initialize(is_default: nil, is_platform_default: nil); end
end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return personalization designs with the given lookup keys.
sig { returns(T.nilable(T::Array[String])) }
def lookup_keys; end
sig {
params(_lookup_keys: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def lookup_keys=(_lookup_keys); end
# Only return personalization designs with the given preferences.
sig {
returns(T.nilable(::Stripe::Issuing::PersonalizationDesign::ListParams::Preferences))
}
def preferences; end
sig {
params(_preferences: T.nilable(::Stripe::Issuing::PersonalizationDesign::ListParams::Preferences)).returns(T.nilable(::Stripe::Issuing::PersonalizationDesign::ListParams::Preferences))
}
def preferences=(_preferences); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return personalization designs with the given status.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), lookup_keys: T.nilable(T::Array[String]), preferences: T.nilable(::Stripe::Issuing::PersonalizationDesign::ListParams::Preferences), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
lookup_keys: nil,
preferences: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class CarrierText < Stripe::RequestParams
# The footer body text of the carrier letter.
sig { returns(T.nilable(String)) }
def footer_body; end
sig { params(_footer_body: T.nilable(String)).returns(T.nilable(String)) }
def footer_body=(_footer_body); end
# The footer title text of the carrier letter.
sig { returns(T.nilable(String)) }
def footer_title; end
sig { params(_footer_title: T.nilable(String)).returns(T.nilable(String)) }
def footer_title=(_footer_title); end
# The header body text of the carrier letter.
sig { returns(T.nilable(String)) }
def header_body; end
sig { params(_header_body: T.nilable(String)).returns(T.nilable(String)) }
def header_body=(_header_body); end
# The header title text of the carrier letter.
sig { returns(T.nilable(String)) }
def header_title; end
sig { params(_header_title: T.nilable(String)).returns(T.nilable(String)) }
def header_title=(_header_title); end
sig {
params(footer_body: T.nilable(String), footer_title: T.nilable(String), header_body: T.nilable(String), header_title: T.nilable(String)).void
}
def initialize(
footer_body: nil,
footer_title: nil,
header_body: nil,
header_title: nil
); end
end
class Preferences < Stripe::RequestParams
# Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
sig { returns(T::Boolean) }
def is_default; end
sig { params(_is_default: T::Boolean).returns(T::Boolean) }
def is_default=(_is_default); end
sig { params(is_default: T::Boolean).void }
def initialize(is_default: nil); end
end
# The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
sig { returns(T.nilable(String)) }
def card_logo; end
sig { params(_card_logo: T.nilable(String)).returns(T.nilable(String)) }
def card_logo=(_card_logo); end
# Hash containing carrier text, for use with physical bundles that support carrier text.
sig {
returns(T.nilable(::Stripe::Issuing::PersonalizationDesign::CreateParams::CarrierText))
}
def carrier_text; end
sig {
params(_carrier_text: T.nilable(::Stripe::Issuing::PersonalizationDesign::CreateParams::CarrierText)).returns(T.nilable(::Stripe::Issuing::PersonalizationDesign::CreateParams::CarrierText))
}
def carrier_text=(_carrier_text); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
sig { returns(T.nilable(String)) }
def lookup_key; end
sig { params(_lookup_key: T.nilable(String)).returns(T.nilable(String)) }
def lookup_key=(_lookup_key); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Friendly display name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The physical bundle object belonging to this personalization design.
sig { returns(String) }
def physical_bundle; end
sig { params(_physical_bundle: String).returns(String) }
def physical_bundle=(_physical_bundle); end
# Information on whether this personalization design is used to create cards when one is not specified.
sig {
returns(T.nilable(::Stripe::Issuing::PersonalizationDesign::CreateParams::Preferences))
}
def preferences; end
sig {
params(_preferences: T.nilable(::Stripe::Issuing::PersonalizationDesign::CreateParams::Preferences)).returns(T.nilable(::Stripe::Issuing::PersonalizationDesign::CreateParams::Preferences))
}
def preferences=(_preferences); end
# If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
sig { returns(T.nilable(T::Boolean)) }
def transfer_lookup_key; end
sig { params(_transfer_lookup_key: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def transfer_lookup_key=(_transfer_lookup_key); end
sig {
params(card_logo: T.nilable(String), carrier_text: T.nilable(::Stripe::Issuing::PersonalizationDesign::CreateParams::CarrierText), expand: T.nilable(T::Array[String]), lookup_key: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), name: T.nilable(String), physical_bundle: String, preferences: T.nilable(::Stripe::Issuing::PersonalizationDesign::CreateParams::Preferences), transfer_lookup_key: T.nilable(T::Boolean)).void
}
def initialize(
card_logo: nil,
carrier_text: nil,
expand: nil,
lookup_key: nil,
metadata: nil,
name: nil,
physical_bundle: nil,
preferences: nil,
transfer_lookup_key: nil
); end
end
class UpdateParams < Stripe::RequestParams
class CarrierText < Stripe::RequestParams
# The footer body text of the carrier letter.
sig { returns(T.nilable(String)) }
def footer_body; end
sig { params(_footer_body: T.nilable(String)).returns(T.nilable(String)) }
def footer_body=(_footer_body); end
# The footer title text of the carrier letter.
sig { returns(T.nilable(String)) }
def footer_title; end
sig { params(_footer_title: T.nilable(String)).returns(T.nilable(String)) }
def footer_title=(_footer_title); end
# The header body text of the carrier letter.
sig { returns(T.nilable(String)) }
def header_body; end
sig { params(_header_body: T.nilable(String)).returns(T.nilable(String)) }
def header_body=(_header_body); end
# The header title text of the carrier letter.
sig { returns(T.nilable(String)) }
def header_title; end
sig { params(_header_title: T.nilable(String)).returns(T.nilable(String)) }
def header_title=(_header_title); end
sig {
params(footer_body: T.nilable(String), footer_title: T.nilable(String), header_body: T.nilable(String), header_title: T.nilable(String)).void
}
def initialize(
footer_body: nil,
footer_title: nil,
header_body: nil,
header_title: nil
); end
end
class Preferences < Stripe::RequestParams
# Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
sig { returns(T::Boolean) }
def is_default; end
sig { params(_is_default: T::Boolean).returns(T::Boolean) }
def is_default=(_is_default); end
sig { params(is_default: T::Boolean).void }
def initialize(is_default: nil); end
end
# The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
sig { returns(T.nilable(String)) }
def card_logo; end
sig { params(_card_logo: T.nilable(String)).returns(T.nilable(String)) }
def card_logo=(_card_logo); end
# Hash containing carrier text, for use with physical bundles that support carrier text.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::PersonalizationDesign::UpdateParams::CarrierText)))
}
def carrier_text; end
sig {
params(_carrier_text: T.nilable(T.any(String, ::Stripe::Issuing::PersonalizationDesign::UpdateParams::CarrierText))).returns(T.nilable(T.any(String, ::Stripe::Issuing::PersonalizationDesign::UpdateParams::CarrierText)))
}
def carrier_text=(_carrier_text); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
sig { returns(T.nilable(String)) }
def lookup_key; end
sig { params(_lookup_key: T.nilable(String)).returns(T.nilable(String)) }
def lookup_key=(_lookup_key); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Friendly display name. Providing an empty string will set the field to null.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The physical bundle object belonging to this personalization design.
sig { returns(T.nilable(String)) }
def physical_bundle; end
sig { params(_physical_bundle: T.nilable(String)).returns(T.nilable(String)) }
def physical_bundle=(_physical_bundle); end
# Information on whether this personalization design is used to create cards when one is not specified.
sig {
returns(T.nilable(::Stripe::Issuing::PersonalizationDesign::UpdateParams::Preferences))
}
def preferences; end
sig {
params(_preferences: T.nilable(::Stripe::Issuing::PersonalizationDesign::UpdateParams::Preferences)).returns(T.nilable(::Stripe::Issuing::PersonalizationDesign::UpdateParams::Preferences))
}
def preferences=(_preferences); end
# If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
sig { returns(T.nilable(T::Boolean)) }
def transfer_lookup_key; end
sig { params(_transfer_lookup_key: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def transfer_lookup_key=(_transfer_lookup_key); end
sig {
params(card_logo: T.nilable(String), carrier_text: T.nilable(T.any(String, ::Stripe::Issuing::PersonalizationDesign::UpdateParams::CarrierText)), expand: T.nilable(T::Array[String]), lookup_key: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), name: T.nilable(String), physical_bundle: T.nilable(String), preferences: T.nilable(::Stripe::Issuing::PersonalizationDesign::UpdateParams::Preferences), transfer_lookup_key: T.nilable(T::Boolean)).void
}
def initialize(
card_logo: nil,
carrier_text: nil,
expand: nil,
lookup_key: nil,
metadata: nil,
name: nil,
physical_bundle: nil,
preferences: nil,
transfer_lookup_key: nil
); end
end
class ActivateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class DeactivateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class RejectParams < Stripe::RequestParams
class RejectionReasons < Stripe::RequestParams
# The reason(s) the card logo was rejected.
sig { returns(T.nilable(T::Array[String])) }
def card_logo; end
sig {
params(_card_logo: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def card_logo=(_card_logo); end
# The reason(s) the carrier text was rejected.
sig { returns(T.nilable(T::Array[String])) }
def carrier_text; end
sig {
params(_carrier_text: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def carrier_text=(_carrier_text); end
sig {
params(card_logo: T.nilable(T::Array[String]), carrier_text: T.nilable(T::Array[String])).void
}
def initialize(card_logo: nil, carrier_text: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The reason(s) the personalization design was rejected.
sig { returns(::Stripe::Issuing::PersonalizationDesign::RejectParams::RejectionReasons) }
def rejection_reasons; end
sig {
params(_rejection_reasons: ::Stripe::Issuing::PersonalizationDesign::RejectParams::RejectionReasons).returns(::Stripe::Issuing::PersonalizationDesign::RejectParams::RejectionReasons)
}
def rejection_reasons=(_rejection_reasons); end
sig {
params(expand: T.nilable(T::Array[String]), rejection_reasons: ::Stripe::Issuing::PersonalizationDesign::RejectParams::RejectionReasons).void
}
def initialize(expand: nil, rejection_reasons: nil); end
end
# Creates a personalization design object.
sig {
params(params: T.any(::Stripe::Issuing::PersonalizationDesign::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::PersonalizationDesign)
}
def self.create(params = {}, opts = {}); end
# Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::PersonalizationDesign::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates a card personalization object.
sig {
params(personalization_design: String, params: T.any(::Stripe::Issuing::PersonalizationDesign::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::PersonalizationDesign)
}
def self.update(personalization_design, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
# A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.
class PhysicalBundle < APIResource
class Features < Stripe::StripeObject
# The policy for how to use card logo images in a card design with this physical bundle.
sig { returns(String) }
def card_logo; end
# The policy for how to use carrier letter text in a card design with this physical bundle.
sig { returns(String) }
def carrier_text; end
# The policy for how to use a second line on a card with this physical bundle.
sig { returns(String) }
def second_line; end
end
# Attribute for field features
sig { returns(Features) }
def features; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# Friendly display name.
sig { returns(String) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Whether this physical bundle can be used to create cards.
sig { returns(String) }
def status; end
# Whether this physical bundle is a standard Stripe offering or custom-made for you.
sig { returns(String) }
def type; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return physical bundles with the given status.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# Only return physical bundles with the given type.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil,
type: nil
); end
end
# Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::PhysicalBundle::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
# An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe.
class Token < APIResource
class NetworkData < Stripe::StripeObject
class Device < Stripe::StripeObject
# An obfuscated ID derived from the device ID.
sig { returns(T.nilable(String)) }
def device_fingerprint; end
# The IP address of the device at provisioning time.
sig { returns(T.nilable(String)) }
def ip_address; end
# The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal.
sig { returns(T.nilable(String)) }
def location; end
# The name of the device used for tokenization.
sig { returns(T.nilable(String)) }
def name; end
# The phone number of the device used for tokenization.
sig { returns(T.nilable(String)) }
def phone_number; end
# The type of device used for tokenization.
sig { returns(T.nilable(String)) }
def type; end
end
class Mastercard < Stripe::StripeObject
# A unique reference ID from MasterCard to represent the card account number.
sig { returns(T.nilable(String)) }
def card_reference_id; end
# The network-unique identifier for the token.
sig { returns(String) }
def token_reference_id; end
# The ID of the entity requesting tokenization, specific to MasterCard.
sig { returns(String) }
def token_requestor_id; end
# The name of the entity requesting tokenization, if known. This is directly provided from MasterCard.
sig { returns(T.nilable(String)) }
def token_requestor_name; end
end
class Visa < Stripe::StripeObject
# A unique reference ID from Visa to represent the card account number.
sig { returns(String) }
def card_reference_id; end
# The network-unique identifier for the token.
sig { returns(String) }
def token_reference_id; end
# The ID of the entity requesting tokenization, specific to Visa.
sig { returns(String) }
def token_requestor_id; end
# Degree of risk associated with the token between `01` and `99`, with higher number indicating higher risk. A `00` value indicates the token was not scored by Visa.
sig { returns(T.nilable(String)) }
def token_risk_score; end
end
class WalletProvider < Stripe::StripeObject
class CardholderAddress < Stripe::StripeObject
# The street address of the cardholder tokenizing the card.
sig { returns(String) }
def line1; end
# The postal code of the cardholder tokenizing the card.
sig { returns(String) }
def postal_code; end
end
# The wallet provider-given account ID of the digital wallet the token belongs to.
sig { returns(T.nilable(String)) }
def account_id; end
# An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy.
sig { returns(T.nilable(Integer)) }
def account_trust_score; end
# The method used for tokenizing a card.
sig { returns(T.nilable(String)) }
def card_number_source; end
# Attribute for field cardholder_address
sig { returns(T.nilable(CardholderAddress)) }
def cardholder_address; end
# The name of the cardholder tokenizing the card.
sig { returns(T.nilable(String)) }
def cardholder_name; end
# An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy.
sig { returns(T.nilable(Integer)) }
def device_trust_score; end
# The hashed email address of the cardholder's account with the wallet provider.
sig { returns(T.nilable(String)) }
def hashed_account_email_address; end
# The reasons for suggested tokenization given by the card network.
sig { returns(T.nilable(T::Array[String])) }
def reason_codes; end
# The recommendation on responding to the tokenization request.
sig { returns(T.nilable(String)) }
def suggested_decision; end
# The version of the standard for mapping reason codes followed by the wallet provider.
sig { returns(T.nilable(String)) }
def suggested_decision_version; end
end
# Attribute for field device
sig { returns(T.nilable(Device)) }
def device; end
# Attribute for field mastercard
sig { returns(T.nilable(Mastercard)) }
def mastercard; end
# The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network.
sig { returns(String) }
def type; end
# Attribute for field visa
sig { returns(T.nilable(Visa)) }
def visa; end
# Attribute for field wallet_provider
sig { returns(T.nilable(WalletProvider)) }
def wallet_provider; end
end
# Card associated with this token.
sig { returns(T.any(String, Stripe::Issuing::Card)) }
def card; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The hashed ID derived from the device ID from the card network associated with the token.
sig { returns(T.nilable(String)) }
def device_fingerprint; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The last four digits of the token.
sig { returns(T.nilable(String)) }
def last4; end
# 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) }
def livemode; end
# The token service provider / card network associated with the token.
sig { returns(String) }
def network; end
# Attribute for field network_data
sig { returns(T.nilable(NetworkData)) }
def network_data; end
# Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def network_updated_at; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The usage state of the token.
sig { returns(String) }
def status; end
# The digital wallet for this token, if one was used.
sig { returns(T.nilable(String)) }
def wallet_provider; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# The Issuing card identifier to list tokens for.
sig { returns(String) }
def card; end
sig { params(_card: String).returns(String) }
def card=(_card); end
# Only return Issuing tokens that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Issuing::Token::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Issuing::Token::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Issuing::Token::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Select Issuing tokens with the given status.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(card: String, created: T.nilable(T.any(::Stripe::Issuing::Token::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
card: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Specifies which status the token should be updated to.
sig { returns(String) }
def status; end
sig { params(_status: String).returns(String) }
def status=(_status); end
sig { params(expand: T.nilable(T::Array[String]), status: String).void }
def initialize(expand: nil, status: nil); end
end
# Lists all Issuing Token objects for a given card.
sig {
params(params: T.any(::Stripe::Issuing::Token::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Attempts to update the specified Issuing Token object to the status specified.
sig {
params(token: String, params: T.any(::Stripe::Issuing::Token::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Token)
}
def self.update(token, params = {}, opts = {}); end
end
end
end
# typed: true
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
class AmountDetails < Stripe::StripeObject
# The fee charged by the ATM for the cash withdrawal.
sig { returns(T.nilable(Integer)) }
def atm_fee; end
# The amount of cash requested by the cardholder.
sig { returns(T.nilable(Integer)) }
def cashback_amount; end
end
class MerchantData < Stripe::StripeObject
# A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.
sig { returns(String) }
def category; end
# The merchant category code for the seller’s business
sig { returns(String) }
def category_code; end
# City where the seller is located
sig { returns(T.nilable(String)) }
def city; end
# Country where the seller is located
sig { returns(T.nilable(String)) }
def country; end
# Name of the seller
sig { returns(T.nilable(String)) }
def name; end
# Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
sig { returns(String) }
def network_id; end
# Postal code where the seller is located
sig { returns(T.nilable(String)) }
def postal_code; end
# State where the seller is located
sig { returns(T.nilable(String)) }
def state; end
# The seller's tax identification number. Currently populated for French merchants only.
sig { returns(T.nilable(String)) }
def tax_id; end
# An ID assigned by the seller to the location of the sale.
sig { returns(T.nilable(String)) }
def terminal_id; end
# URL provided by the merchant on a 3DS request
sig { returns(T.nilable(String)) }
def url; end
end
class NetworkData < Stripe::StripeObject
# A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations.
sig { returns(T.nilable(String)) }
def authorization_code; end
# The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.
sig { returns(T.nilable(String)) }
def processing_date; end
# Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class PurchaseDetails < Stripe::StripeObject
class Fleet < Stripe::StripeObject
class CardholderPromptData < Stripe::StripeObject
# Driver ID.
sig { returns(T.nilable(String)) }
def driver_id; end
# Odometer reading.
sig { returns(T.nilable(Integer)) }
def odometer; end
# An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
sig { returns(T.nilable(String)) }
def unspecified_id; end
# User ID.
sig { returns(T.nilable(String)) }
def user_id; end
# Vehicle number.
sig { returns(T.nilable(String)) }
def vehicle_number; end
end
class ReportedBreakdown < Stripe::StripeObject
class Fuel < Stripe::StripeObject
# Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
end
class NonFuel < Stripe::StripeObject
# Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
end
class Tax < Stripe::StripeObject
# Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def local_amount_decimal; end
# Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def national_amount_decimal; end
end
# Breakdown of fuel portion of the purchase.
sig { returns(T.nilable(Fuel)) }
def fuel; end
# Breakdown of non-fuel portion of the purchase.
sig { returns(T.nilable(NonFuel)) }
def non_fuel; end
# Information about tax included in this transaction.
sig { returns(T.nilable(Tax)) }
def tax; end
end
# Answers to prompts presented to cardholder at point of sale.
sig { returns(T.nilable(CardholderPromptData)) }
def cardholder_prompt_data; end
# The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
sig { returns(T.nilable(String)) }
def purchase_type; end
# More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
sig { returns(T.nilable(ReportedBreakdown)) }
def reported_breakdown; end
# The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
sig { returns(T.nilable(String)) }
def service_type; end
end
class Flight < Stripe::StripeObject
class Segment < Stripe::StripeObject
# The three-letter IATA airport code of the flight's destination.
sig { returns(T.nilable(String)) }
def arrival_airport_code; end
# The airline carrier code.
sig { returns(T.nilable(String)) }
def carrier; end
# The three-letter IATA airport code that the flight departed from.
sig { returns(T.nilable(String)) }
def departure_airport_code; end
# The flight number.
sig { returns(T.nilable(String)) }
def flight_number; end
# The flight's service class.
sig { returns(T.nilable(String)) }
def service_class; end
# Whether a stopover is allowed on this flight.
sig { returns(T.nilable(T::Boolean)) }
def stopover_allowed; end
end
# The time that the flight departed.
sig { returns(T.nilable(Integer)) }
def departure_at; end
# The name of the passenger.
sig { returns(T.nilable(String)) }
def passenger_name; end
# Whether the ticket is refundable.
sig { returns(T.nilable(T::Boolean)) }
def refundable; end
# The legs of the trip.
sig { returns(T.nilable(T::Array[Segment])) }
def segments; end
# The travel agency that issued the ticket.
sig { returns(T.nilable(String)) }
def travel_agency; end
end
class Fuel < Stripe::StripeObject
# [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
sig { returns(T.nilable(String)) }
def industry_product_code; end
# The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def quantity_decimal; end
# The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
sig { returns(String) }
def type; end
# The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
sig { returns(String) }
def unit; end
# The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
sig { returns(String) }
def unit_cost_decimal; end
end
class Lodging < Stripe::StripeObject
# The time of checking into the lodging.
sig { returns(T.nilable(Integer)) }
def check_in_at; end
# The number of nights stayed at the lodging.
sig { returns(T.nilable(Integer)) }
def nights; end
end
class Receipt < Stripe::StripeObject
# The description of the item. The maximum length of this field is 26 characters.
sig { returns(T.nilable(String)) }
def description; end
# The quantity of the item.
sig { returns(T.nilable(Float)) }
def quantity; end
# The total for this line item in cents.
sig { returns(T.nilable(Integer)) }
def total; end
# The unit cost of the item in cents.
sig { returns(T.nilable(Integer)) }
def unit_cost; end
end
# Fleet-specific information for transactions using Fleet cards.
sig { returns(T.nilable(Fleet)) }
def fleet; end
# Information about the flight that was purchased with this transaction.
sig { returns(T.nilable(Flight)) }
def flight; end
# Information about fuel that was purchased with this transaction.
sig { returns(T.nilable(Fuel)) }
def fuel; end
# Information about lodging that was purchased with this transaction.
sig { returns(T.nilable(Lodging)) }
def lodging; end
# The line items in the purchase.
sig { returns(T.nilable(T::Array[Receipt])) }
def receipt; end
# A merchant-specific order number.
sig { returns(T.nilable(String)) }
def reference; end
end
class Treasury < Stripe::StripeObject
# The Treasury [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) representing this Issuing transaction if it is a refund
sig { returns(T.nilable(String)) }
def received_credit; end
# The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) representing this Issuing transaction if it is a capture
sig { returns(T.nilable(String)) }
def received_debit; end
end
# The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(AmountDetails)) }
def amount_details; end
# The `Authorization` object that led to this transaction.
sig { returns(T.nilable(T.any(String, Stripe::Issuing::Authorization))) }
def authorization; end
# ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction.
sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
def balance_transaction; end
# The card used to make this transaction.
sig { returns(T.any(String, Stripe::Issuing::Card)) }
def card; end
# The cardholder to whom this transaction belongs.
sig { returns(T.nilable(T.any(String, Stripe::Issuing::Cardholder))) }
def cardholder; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# If you've disputed the transaction, the ID of the dispute.
sig { returns(T.nilable(T.any(String, Stripe::Issuing::Dispute))) }
def dispute; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency.
sig { returns(Integer) }
def merchant_amount; end
# The currency with which the merchant is taking payment.
sig { returns(String) }
def merchant_currency; end
# Attribute for field merchant_data
sig { returns(MerchantData) }
def merchant_data; end
# 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::Hash[String, String]) }
def metadata; end
# Details about the transaction, such as processing dates, set by the card network.
sig { returns(T.nilable(NetworkData)) }
def network_data; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Additional purchase information that is optionally provided by the merchant.
sig { returns(T.nilable(PurchaseDetails)) }
def purchase_details; end
# The ID of the [settlement](https://stripe.com/docs/api/issuing/settlements) to which this transaction belongs.
sig { returns(T.nilable(T.any(String, Stripe::Issuing::Settlement))) }
def settlement; end
# [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.
sig { returns(T.nilable(T.any(String, Stripe::Issuing::Token))) }
def token; end
# [Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
sig { returns(T.nilable(Treasury)) }
def treasury; end
# The nature of the transaction.
sig { returns(String) }
def type; end
# The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`.
sig { returns(T.nilable(String)) }
def wallet; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return transactions that belong to the given card.
sig { returns(T.nilable(String)) }
def card; end
sig { params(_card: T.nilable(String)).returns(T.nilable(String)) }
def card=(_card); end
# Only return transactions that belong to the given cardholder.
sig { returns(T.nilable(String)) }
def cardholder; end
sig { params(_cardholder: T.nilable(String)).returns(T.nilable(String)) }
def cardholder=(_cardholder); end
# Only return transactions that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Issuing::Transaction::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Issuing::Transaction::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Issuing::Transaction::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return transactions that are associated with the given settlement.
sig { returns(T.nilable(String)) }
def settlement; end
sig { params(_settlement: T.nilable(String)).returns(T.nilable(String)) }
def settlement=(_settlement); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return transactions that have the given type. One of `capture` or `refund`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(card: T.nilable(String), cardholder: T.nilable(String), created: T.nilable(T.any(::Stripe::Issuing::Transaction::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), settlement: T.nilable(String), starting_after: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
card: nil,
cardholder: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
settlement: nil,
starting_after: nil,
type: nil
); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, metadata: nil); end
end
class RefundParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(Integer)) }
def refund_amount; end
sig { params(_refund_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def refund_amount=(_refund_amount); end
sig { params(expand: T.nilable(T::Array[String]), refund_amount: T.nilable(Integer)).void }
def initialize(expand: nil, refund_amount: nil); end
end
class CreateForceCaptureParams < Stripe::RequestParams
class MerchantData < Stripe::RequestParams
# A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# City where the seller is located
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Country where the seller is located
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Name of the seller
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
sig { returns(T.nilable(String)) }
def network_id; end
sig { params(_network_id: T.nilable(String)).returns(T.nilable(String)) }
def network_id=(_network_id); end
# Postal code where the seller is located
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State where the seller is located
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# An ID assigned by the seller to the location of the sale.
sig { returns(T.nilable(String)) }
def terminal_id; end
sig { params(_terminal_id: T.nilable(String)).returns(T.nilable(String)) }
def terminal_id=(_terminal_id); end
# URL provided by the merchant on a 3DS request
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(category: T.nilable(String), city: T.nilable(String), country: T.nilable(String), name: T.nilable(String), network_id: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), terminal_id: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
category: nil,
city: nil,
country: nil,
name: nil,
network_id: nil,
postal_code: nil,
state: nil,
terminal_id: nil,
url: nil
); end
end
class PurchaseDetails < Stripe::RequestParams
class Fleet < Stripe::RequestParams
class CardholderPromptData < Stripe::RequestParams
# Driver ID.
sig { returns(T.nilable(String)) }
def driver_id; end
sig { params(_driver_id: T.nilable(String)).returns(T.nilable(String)) }
def driver_id=(_driver_id); end
# Odometer reading.
sig { returns(T.nilable(Integer)) }
def odometer; end
sig { params(_odometer: T.nilable(Integer)).returns(T.nilable(Integer)) }
def odometer=(_odometer); end
# An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
sig { returns(T.nilable(String)) }
def unspecified_id; end
sig { params(_unspecified_id: T.nilable(String)).returns(T.nilable(String)) }
def unspecified_id=(_unspecified_id); end
# User ID.
sig { returns(T.nilable(String)) }
def user_id; end
sig { params(_user_id: T.nilable(String)).returns(T.nilable(String)) }
def user_id=(_user_id); end
# Vehicle number.
sig { returns(T.nilable(String)) }
def vehicle_number; end
sig { params(_vehicle_number: T.nilable(String)).returns(T.nilable(String)) }
def vehicle_number=(_vehicle_number); end
sig {
params(driver_id: T.nilable(String), odometer: T.nilable(Integer), unspecified_id: T.nilable(String), user_id: T.nilable(String), vehicle_number: T.nilable(String)).void
}
def initialize(
driver_id: nil,
odometer: nil,
unspecified_id: nil,
user_id: nil,
vehicle_number: nil
); end
end
class ReportedBreakdown < Stripe::RequestParams
class Fuel < Stripe::RequestParams
# Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig { params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class NonFuel < Stripe::RequestParams
# Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig { params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class Tax < Stripe::RequestParams
# Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def local_amount_decimal; end
sig { params(_local_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def local_amount_decimal=(_local_amount_decimal); end
# Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def national_amount_decimal; end
sig {
params(_national_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def national_amount_decimal=(_national_amount_decimal); end
sig {
params(local_amount_decimal: T.nilable(String), national_amount_decimal: T.nilable(String)).void
}
def initialize(local_amount_decimal: nil, national_amount_decimal: nil); end
end
# Breakdown of fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel))
}
def fuel=(_fuel); end
# Breakdown of non-fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel; end
sig {
params(_non_fuel: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel=(_non_fuel); end
# Information about tax included in this transaction.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax))
}
def tax=(_tax); end
sig {
params(fuel: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel), non_fuel: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel), tax: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax)).void
}
def initialize(fuel: nil, non_fuel: nil, tax: nil); end
end
# Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::CardholderPromptData))
}
def cardholder_prompt_data; end
sig {
params(_cardholder_prompt_data: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::CardholderPromptData)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::CardholderPromptData))
}
def cardholder_prompt_data=(_cardholder_prompt_data); end
# The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
sig { returns(T.nilable(String)) }
def purchase_type; end
sig { params(_purchase_type: T.nilable(String)).returns(T.nilable(String)) }
def purchase_type=(_purchase_type); end
# More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown))
}
def reported_breakdown; end
sig {
params(_reported_breakdown: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown))
}
def reported_breakdown=(_reported_breakdown); end
# The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
sig { returns(T.nilable(String)) }
def service_type; end
sig { params(_service_type: T.nilable(String)).returns(T.nilable(String)) }
def service_type=(_service_type); end
sig {
params(cardholder_prompt_data: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::CardholderPromptData), purchase_type: T.nilable(String), reported_breakdown: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown), service_type: T.nilable(String)).void
}
def initialize(
cardholder_prompt_data: nil,
purchase_type: nil,
reported_breakdown: nil,
service_type: nil
); end
end
class Flight < Stripe::RequestParams
class Segment < Stripe::RequestParams
# The three-letter IATA airport code of the flight's destination.
sig { returns(T.nilable(String)) }
def arrival_airport_code; end
sig { params(_arrival_airport_code: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport_code=(_arrival_airport_code); end
# The airline carrier code.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The three-letter IATA airport code that the flight departed from.
sig { returns(T.nilable(String)) }
def departure_airport_code; end
sig { params(_departure_airport_code: T.nilable(String)).returns(T.nilable(String)) }
def departure_airport_code=(_departure_airport_code); end
# The flight number.
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The flight's service class.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
# Whether a stopover is allowed on this flight.
sig { returns(T.nilable(T::Boolean)) }
def stopover_allowed; end
sig {
params(_stopover_allowed: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def stopover_allowed=(_stopover_allowed); end
sig {
params(arrival_airport_code: T.nilable(String), carrier: T.nilable(String), departure_airport_code: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String), stopover_allowed: T.nilable(T::Boolean)).void
}
def initialize(
arrival_airport_code: nil,
carrier: nil,
departure_airport_code: nil,
flight_number: nil,
service_class: nil,
stopover_allowed: nil
); end
end
# The time that the flight departed.
sig { returns(T.nilable(Integer)) }
def departure_at; end
sig { params(_departure_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def departure_at=(_departure_at); end
# The name of the passenger.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# Whether the ticket is refundable.
sig { returns(T.nilable(T::Boolean)) }
def refundable; end
sig { params(_refundable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refundable=(_refundable); end
# The legs of the trip.
sig {
returns(T.nilable(T::Array[::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Flight::Segment]))
}
def segments; end
sig {
params(_segments: T.nilable(T::Array[::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Flight::Segment])).returns(T.nilable(T::Array[::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Flight::Segment]))
}
def segments=(_segments); end
# The travel agency that issued the ticket.
sig { returns(T.nilable(String)) }
def travel_agency; end
sig { params(_travel_agency: T.nilable(String)).returns(T.nilable(String)) }
def travel_agency=(_travel_agency); end
sig {
params(departure_at: T.nilable(Integer), passenger_name: T.nilable(String), refundable: T.nilable(T::Boolean), segments: T.nilable(T::Array[::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Flight::Segment]), travel_agency: T.nilable(String)).void
}
def initialize(
departure_at: nil,
passenger_name: nil,
refundable: nil,
segments: nil,
travel_agency: nil
); end
end
class Fuel < Stripe::RequestParams
# [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
sig { returns(T.nilable(String)) }
def industry_product_code; end
sig { params(_industry_product_code: T.nilable(String)).returns(T.nilable(String)) }
def industry_product_code=(_industry_product_code); end
# The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def quantity_decimal; end
sig { params(_quantity_decimal: T.nilable(String)).returns(T.nilable(String)) }
def quantity_decimal=(_quantity_decimal); end
# The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
# The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_cost_decimal; end
sig { params(_unit_cost_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_cost_decimal=(_unit_cost_decimal); end
sig {
params(industry_product_code: T.nilable(String), quantity_decimal: T.nilable(String), type: T.nilable(String), unit: T.nilable(String), unit_cost_decimal: T.nilable(String)).void
}
def initialize(
industry_product_code: nil,
quantity_decimal: nil,
type: nil,
unit: nil,
unit_cost_decimal: nil
); end
end
class Lodging < Stripe::RequestParams
# The time of checking into the lodging.
sig { returns(T.nilable(Integer)) }
def check_in_at; end
sig { params(_check_in_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def check_in_at=(_check_in_at); end
# The number of nights stayed at the lodging.
sig { returns(T.nilable(Integer)) }
def nights; end
sig { params(_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def nights=(_nights); end
sig { params(check_in_at: T.nilable(Integer), nights: T.nilable(Integer)).void }
def initialize(check_in_at: nil, nights: nil); end
end
class Receipt < Stripe::RequestParams
# Attribute for param field description
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Attribute for param field quantity
sig { returns(T.nilable(String)) }
def quantity; end
sig { params(_quantity: T.nilable(String)).returns(T.nilable(String)) }
def quantity=(_quantity); end
# Attribute for param field total
sig { returns(T.nilable(Integer)) }
def total; end
sig { params(_total: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total=(_total); end
# Attribute for param field unit_cost
sig { returns(T.nilable(Integer)) }
def unit_cost; end
sig { params(_unit_cost: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_cost=(_unit_cost); end
sig {
params(description: T.nilable(String), quantity: T.nilable(String), total: T.nilable(Integer), unit_cost: T.nilable(Integer)).void
}
def initialize(description: nil, quantity: nil, total: nil, unit_cost: nil); end
end
# Fleet-specific information for transactions using Fleet cards.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet))
}
def fleet; end
sig {
params(_fleet: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet))
}
def fleet=(_fleet); end
# Information about the flight that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Flight))
}
def flight; end
sig {
params(_flight: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Flight)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Flight))
}
def flight=(_flight); end
# Information about fuel that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fuel)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fuel))
}
def fuel=(_fuel); end
# Information about lodging that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Lodging))
}
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Lodging)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Lodging))
}
def lodging=(_lodging); end
# The line items in the purchase.
sig {
returns(T.nilable(T::Array[::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Receipt]))
}
def receipt; end
sig {
params(_receipt: T.nilable(T::Array[::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Receipt])).returns(T.nilable(T::Array[::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Receipt]))
}
def receipt=(_receipt); end
# A merchant-specific order number.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
sig {
params(fleet: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fleet), flight: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Flight), fuel: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Fuel), lodging: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Lodging), receipt: T.nilable(T::Array[::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails::Receipt]), reference: T.nilable(String)).void
}
def initialize(
fleet: nil,
flight: nil,
fuel: nil,
lodging: nil,
receipt: nil,
reference: nil
); end
end
# The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Card associated with this transaction.
sig { returns(String) }
def card; end
sig { params(_card: String).returns(String) }
def card=(_card); end
# The currency of the capture. If not provided, defaults to the currency of the card. 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::MerchantData))
}
def merchant_data; end
sig {
params(_merchant_data: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::MerchantData)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::MerchantData))
}
def merchant_data=(_merchant_data); end
# Additional purchase information that is optionally provided by the merchant.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails))
}
def purchase_details; end
sig {
params(_purchase_details: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails))
}
def purchase_details=(_purchase_details); end
sig {
params(amount: Integer, card: String, currency: T.nilable(String), expand: T.nilable(T::Array[String]), merchant_data: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::MerchantData), purchase_details: T.nilable(::Stripe::Issuing::Transaction::CreateForceCaptureParams::PurchaseDetails)).void
}
def initialize(
amount: nil,
card: nil,
currency: nil,
expand: nil,
merchant_data: nil,
purchase_details: nil
); end
end
class CreateUnlinkedRefundParams < Stripe::RequestParams
class MerchantData < Stripe::RequestParams
# A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# City where the seller is located
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Country where the seller is located
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Name of the seller
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
sig { returns(T.nilable(String)) }
def network_id; end
sig { params(_network_id: T.nilable(String)).returns(T.nilable(String)) }
def network_id=(_network_id); end
# Postal code where the seller is located
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State where the seller is located
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# An ID assigned by the seller to the location of the sale.
sig { returns(T.nilable(String)) }
def terminal_id; end
sig { params(_terminal_id: T.nilable(String)).returns(T.nilable(String)) }
def terminal_id=(_terminal_id); end
# URL provided by the merchant on a 3DS request
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(category: T.nilable(String), city: T.nilable(String), country: T.nilable(String), name: T.nilable(String), network_id: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), terminal_id: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
category: nil,
city: nil,
country: nil,
name: nil,
network_id: nil,
postal_code: nil,
state: nil,
terminal_id: nil,
url: nil
); end
end
class PurchaseDetails < Stripe::RequestParams
class Fleet < Stripe::RequestParams
class CardholderPromptData < Stripe::RequestParams
# Driver ID.
sig { returns(T.nilable(String)) }
def driver_id; end
sig { params(_driver_id: T.nilable(String)).returns(T.nilable(String)) }
def driver_id=(_driver_id); end
# Odometer reading.
sig { returns(T.nilable(Integer)) }
def odometer; end
sig { params(_odometer: T.nilable(Integer)).returns(T.nilable(Integer)) }
def odometer=(_odometer); end
# An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
sig { returns(T.nilable(String)) }
def unspecified_id; end
sig { params(_unspecified_id: T.nilable(String)).returns(T.nilable(String)) }
def unspecified_id=(_unspecified_id); end
# User ID.
sig { returns(T.nilable(String)) }
def user_id; end
sig { params(_user_id: T.nilable(String)).returns(T.nilable(String)) }
def user_id=(_user_id); end
# Vehicle number.
sig { returns(T.nilable(String)) }
def vehicle_number; end
sig { params(_vehicle_number: T.nilable(String)).returns(T.nilable(String)) }
def vehicle_number=(_vehicle_number); end
sig {
params(driver_id: T.nilable(String), odometer: T.nilable(Integer), unspecified_id: T.nilable(String), user_id: T.nilable(String), vehicle_number: T.nilable(String)).void
}
def initialize(
driver_id: nil,
odometer: nil,
unspecified_id: nil,
user_id: nil,
vehicle_number: nil
); end
end
class ReportedBreakdown < Stripe::RequestParams
class Fuel < Stripe::RequestParams
# Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig { params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class NonFuel < Stripe::RequestParams
# Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig { params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class Tax < Stripe::RequestParams
# Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def local_amount_decimal; end
sig { params(_local_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def local_amount_decimal=(_local_amount_decimal); end
# Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def national_amount_decimal; end
sig {
params(_national_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def national_amount_decimal=(_national_amount_decimal); end
sig {
params(local_amount_decimal: T.nilable(String), national_amount_decimal: T.nilable(String)).void
}
def initialize(local_amount_decimal: nil, national_amount_decimal: nil); end
end
# Breakdown of fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel))
}
def fuel=(_fuel); end
# Breakdown of non-fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel; end
sig {
params(_non_fuel: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel=(_non_fuel); end
# Information about tax included in this transaction.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax))
}
def tax=(_tax); end
sig {
params(fuel: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel), non_fuel: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel), tax: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax)).void
}
def initialize(fuel: nil, non_fuel: nil, tax: nil); end
end
# Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::CardholderPromptData))
}
def cardholder_prompt_data; end
sig {
params(_cardholder_prompt_data: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::CardholderPromptData)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::CardholderPromptData))
}
def cardholder_prompt_data=(_cardholder_prompt_data); end
# The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
sig { returns(T.nilable(String)) }
def purchase_type; end
sig { params(_purchase_type: T.nilable(String)).returns(T.nilable(String)) }
def purchase_type=(_purchase_type); end
# More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown))
}
def reported_breakdown; end
sig {
params(_reported_breakdown: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown))
}
def reported_breakdown=(_reported_breakdown); end
# The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
sig { returns(T.nilable(String)) }
def service_type; end
sig { params(_service_type: T.nilable(String)).returns(T.nilable(String)) }
def service_type=(_service_type); end
sig {
params(cardholder_prompt_data: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::CardholderPromptData), purchase_type: T.nilable(String), reported_breakdown: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown), service_type: T.nilable(String)).void
}
def initialize(
cardholder_prompt_data: nil,
purchase_type: nil,
reported_breakdown: nil,
service_type: nil
); end
end
class Flight < Stripe::RequestParams
class Segment < Stripe::RequestParams
# The three-letter IATA airport code of the flight's destination.
sig { returns(T.nilable(String)) }
def arrival_airport_code; end
sig { params(_arrival_airport_code: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport_code=(_arrival_airport_code); end
# The airline carrier code.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The three-letter IATA airport code that the flight departed from.
sig { returns(T.nilable(String)) }
def departure_airport_code; end
sig { params(_departure_airport_code: T.nilable(String)).returns(T.nilable(String)) }
def departure_airport_code=(_departure_airport_code); end
# The flight number.
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The flight's service class.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
# Whether a stopover is allowed on this flight.
sig { returns(T.nilable(T::Boolean)) }
def stopover_allowed; end
sig {
params(_stopover_allowed: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def stopover_allowed=(_stopover_allowed); end
sig {
params(arrival_airport_code: T.nilable(String), carrier: T.nilable(String), departure_airport_code: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String), stopover_allowed: T.nilable(T::Boolean)).void
}
def initialize(
arrival_airport_code: nil,
carrier: nil,
departure_airport_code: nil,
flight_number: nil,
service_class: nil,
stopover_allowed: nil
); end
end
# The time that the flight departed.
sig { returns(T.nilable(Integer)) }
def departure_at; end
sig { params(_departure_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def departure_at=(_departure_at); end
# The name of the passenger.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# Whether the ticket is refundable.
sig { returns(T.nilable(T::Boolean)) }
def refundable; end
sig { params(_refundable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refundable=(_refundable); end
# The legs of the trip.
sig {
returns(T.nilable(T::Array[::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Flight::Segment]))
}
def segments; end
sig {
params(_segments: T.nilable(T::Array[::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Flight::Segment])).returns(T.nilable(T::Array[::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Flight::Segment]))
}
def segments=(_segments); end
# The travel agency that issued the ticket.
sig { returns(T.nilable(String)) }
def travel_agency; end
sig { params(_travel_agency: T.nilable(String)).returns(T.nilable(String)) }
def travel_agency=(_travel_agency); end
sig {
params(departure_at: T.nilable(Integer), passenger_name: T.nilable(String), refundable: T.nilable(T::Boolean), segments: T.nilable(T::Array[::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Flight::Segment]), travel_agency: T.nilable(String)).void
}
def initialize(
departure_at: nil,
passenger_name: nil,
refundable: nil,
segments: nil,
travel_agency: nil
); end
end
class Fuel < Stripe::RequestParams
# [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
sig { returns(T.nilable(String)) }
def industry_product_code; end
sig { params(_industry_product_code: T.nilable(String)).returns(T.nilable(String)) }
def industry_product_code=(_industry_product_code); end
# The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def quantity_decimal; end
sig { params(_quantity_decimal: T.nilable(String)).returns(T.nilable(String)) }
def quantity_decimal=(_quantity_decimal); end
# The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
# The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_cost_decimal; end
sig { params(_unit_cost_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_cost_decimal=(_unit_cost_decimal); end
sig {
params(industry_product_code: T.nilable(String), quantity_decimal: T.nilable(String), type: T.nilable(String), unit: T.nilable(String), unit_cost_decimal: T.nilable(String)).void
}
def initialize(
industry_product_code: nil,
quantity_decimal: nil,
type: nil,
unit: nil,
unit_cost_decimal: nil
); end
end
class Lodging < Stripe::RequestParams
# The time of checking into the lodging.
sig { returns(T.nilable(Integer)) }
def check_in_at; end
sig { params(_check_in_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def check_in_at=(_check_in_at); end
# The number of nights stayed at the lodging.
sig { returns(T.nilable(Integer)) }
def nights; end
sig { params(_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def nights=(_nights); end
sig { params(check_in_at: T.nilable(Integer), nights: T.nilable(Integer)).void }
def initialize(check_in_at: nil, nights: nil); end
end
class Receipt < Stripe::RequestParams
# Attribute for param field description
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Attribute for param field quantity
sig { returns(T.nilable(String)) }
def quantity; end
sig { params(_quantity: T.nilable(String)).returns(T.nilable(String)) }
def quantity=(_quantity); end
# Attribute for param field total
sig { returns(T.nilable(Integer)) }
def total; end
sig { params(_total: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total=(_total); end
# Attribute for param field unit_cost
sig { returns(T.nilable(Integer)) }
def unit_cost; end
sig { params(_unit_cost: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_cost=(_unit_cost); end
sig {
params(description: T.nilable(String), quantity: T.nilable(String), total: T.nilable(Integer), unit_cost: T.nilable(Integer)).void
}
def initialize(description: nil, quantity: nil, total: nil, unit_cost: nil); end
end
# Fleet-specific information for transactions using Fleet cards.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet))
}
def fleet; end
sig {
params(_fleet: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet))
}
def fleet=(_fleet); end
# Information about the flight that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Flight))
}
def flight; end
sig {
params(_flight: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Flight)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Flight))
}
def flight=(_flight); end
# Information about fuel that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fuel)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fuel))
}
def fuel=(_fuel); end
# Information about lodging that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Lodging))
}
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Lodging)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Lodging))
}
def lodging=(_lodging); end
# The line items in the purchase.
sig {
returns(T.nilable(T::Array[::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Receipt]))
}
def receipt; end
sig {
params(_receipt: T.nilable(T::Array[::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Receipt])).returns(T.nilable(T::Array[::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Receipt]))
}
def receipt=(_receipt); end
# A merchant-specific order number.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
sig {
params(fleet: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fleet), flight: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Flight), fuel: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Fuel), lodging: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Lodging), receipt: T.nilable(T::Array[::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails::Receipt]), reference: T.nilable(String)).void
}
def initialize(
fleet: nil,
flight: nil,
fuel: nil,
lodging: nil,
receipt: nil,
reference: nil
); end
end
# The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Card associated with this unlinked refund transaction.
sig { returns(String) }
def card; end
sig { params(_card: String).returns(String) }
def card=(_card); end
# The currency of the unlinked refund. If not provided, defaults to the currency of the card. 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::MerchantData))
}
def merchant_data; end
sig {
params(_merchant_data: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::MerchantData)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::MerchantData))
}
def merchant_data=(_merchant_data); end
# Additional purchase information that is optionally provided by the merchant.
sig {
returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails))
}
def purchase_details; end
sig {
params(_purchase_details: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails)).returns(T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails))
}
def purchase_details=(_purchase_details); end
sig {
params(amount: Integer, card: String, currency: T.nilable(String), expand: T.nilable(T::Array[String]), merchant_data: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::MerchantData), purchase_details: T.nilable(::Stripe::Issuing::Transaction::CreateUnlinkedRefundParams::PurchaseDetails)).void
}
def initialize(
amount: nil,
card: nil,
currency: nil,
expand: nil,
merchant_data: nil,
purchase_details: nil
); end
end
# Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::Transaction::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(transaction: String, params: T.any(::Stripe::Issuing::Transaction::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Transaction)
}
def self.update(transaction, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
# A Mandate is a record of the permission that your customer gives you to debit their payment method.
class Mandate < APIResource
class CustomerAcceptance < Stripe::StripeObject
class Offline < Stripe::StripeObject; end
class Online < Stripe::StripeObject
# The customer accepts the mandate from this IP address.
sig { returns(T.nilable(String)) }
def ip_address; end
# The customer accepts the mandate using the user agent of the browser.
sig { returns(T.nilable(String)) }
def user_agent; end
end
# The time that the customer accepts the mandate.
sig { returns(T.nilable(Integer)) }
def accepted_at; end
# Attribute for field offline
sig { returns(T.nilable(Offline)) }
def offline; end
# Attribute for field online
sig { returns(T.nilable(Online)) }
def online; end
# The mandate includes the type of customer acceptance information, such as: `online` or `offline`.
sig { returns(String) }
def type; end
end
class MultiUse < Stripe::StripeObject
# The amount of the payment on a multi use mandate.
sig { returns(T.nilable(Integer)) }
def amount; end
# The currency of the payment on a multi use mandate.
sig { returns(T.nilable(String)) }
def currency; end
end
class PaymentMethodDetails < Stripe::StripeObject
class AcssDebit < Stripe::StripeObject
# List of Stripe products where this mandate can be selected automatically.
sig { returns(T.nilable(T::Array[String])) }
def default_for; end
# Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
# Payment schedule for the mandate.
sig { returns(String) }
def payment_schedule; end
# Transaction type of the mandate.
sig { returns(String) }
def transaction_type; end
end
class AmazonPay < Stripe::StripeObject; end
class AuBecsDebit < Stripe::StripeObject
# The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.
sig { returns(String) }
def url; end
end
class BacsDebit < Stripe::StripeObject
# The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`.
sig { returns(String) }
def network_status; end
# The unique reference identifying the mandate on the Bacs network.
sig { returns(String) }
def reference; end
# When the mandate is revoked on the Bacs network this field displays the reason for the revocation.
sig { returns(T.nilable(String)) }
def revocation_reason; end
# The URL that will contain the mandate that the customer has signed.
sig { returns(String) }
def url; end
end
class Card < Stripe::StripeObject; end
class Cashapp < Stripe::StripeObject; end
class KakaoPay < Stripe::StripeObject; end
class Klarna < Stripe::StripeObject; end
class KrCard < Stripe::StripeObject; end
class Link < Stripe::StripeObject; end
class NaverPay < Stripe::StripeObject; end
class NzBankAccount < Stripe::StripeObject; end
class Paypal < Stripe::StripeObject
# The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
sig { returns(T.nilable(String)) }
def billing_agreement_id; end
# Uniquely identifies this particular PayPal account. You can use this attribute to check whether two PayPal accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
sig { returns(T.nilable(String)) }
def payer_id; end
# Owner's verified email. Values are verified or provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_email; end
end
class Payto < Stripe::StripeObject
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(String) }
def amount_type; end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
# The periodicity at which payments will be collected.
sig { returns(String) }
def payment_schedule; end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
sig { returns(T.nilable(String)) }
def start_date; end
end
class Pix < Stripe::StripeObject
# Determines if the amount includes the IOF tax.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
# Type of amount.
sig { returns(T.nilable(String)) }
def amount_type; end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
sig { returns(T.nilable(String)) }
def end_date; end
# Schedule at which the future payments will be charged.
sig { returns(T.nilable(String)) }
def payment_schedule; end
# Subscription name displayed to buyers in their bank app.
sig { returns(T.nilable(String)) }
def reference; end
# Start date of the mandate, in `YYYY-MM-DD`.
sig { returns(T.nilable(String)) }
def start_date; end
end
class RevolutPay < Stripe::StripeObject; end
class SepaDebit < Stripe::StripeObject
# The unique reference of the mandate.
sig { returns(String) }
def reference; end
# The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.
sig { returns(String) }
def url; end
end
class UsBankAccount < Stripe::StripeObject
# Mandate collection method
sig { returns(T.nilable(String)) }
def collection_method; end
end
# Attribute for field acss_debit
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# Attribute for field amazon_pay
sig { returns(T.nilable(AmazonPay)) }
def amazon_pay; end
# Attribute for field au_becs_debit
sig { returns(T.nilable(AuBecsDebit)) }
def au_becs_debit; end
# Attribute for field bacs_debit
sig { returns(T.nilable(BacsDebit)) }
def bacs_debit; end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# Attribute for field cashapp
sig { returns(T.nilable(Cashapp)) }
def cashapp; end
# Attribute for field kakao_pay
sig { returns(T.nilable(KakaoPay)) }
def kakao_pay; end
# Attribute for field klarna
sig { returns(T.nilable(Klarna)) }
def klarna; end
# Attribute for field kr_card
sig { returns(T.nilable(KrCard)) }
def kr_card; end
# Attribute for field link
sig { returns(T.nilable(Link)) }
def link; end
# Attribute for field naver_pay
sig { returns(T.nilable(NaverPay)) }
def naver_pay; end
# Attribute for field nz_bank_account
sig { returns(T.nilable(NzBankAccount)) }
def nz_bank_account; end
# Attribute for field paypal
sig { returns(T.nilable(Paypal)) }
def paypal; end
# Attribute for field payto
sig { returns(T.nilable(Payto)) }
def payto; end
# Attribute for field pix
sig { returns(T.nilable(Pix)) }
def pix; end
# Attribute for field revolut_pay
sig { returns(T.nilable(RevolutPay)) }
def revolut_pay; end
# Attribute for field sepa_debit
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# This mandate corresponds with a specific payment method type. The `payment_method_details` includes an additional hash with the same name and contains mandate information that's specific to that payment method.
sig { returns(String) }
def type; end
# Attribute for field us_bank_account
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
end
class SingleUse < Stripe::StripeObject
# The amount of the payment on a single use mandate.
sig { returns(Integer) }
def amount; end
# The currency of the payment on a single use mandate.
sig { returns(String) }
def currency; end
end
# Attribute for field customer_acceptance
sig { returns(CustomerAcceptance) }
def customer_acceptance; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# Attribute for field multi_use
sig { returns(T.nilable(MultiUse)) }
def multi_use; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The account (if any) that the mandate is intended for.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
# ID of the payment method associated with this mandate.
sig { returns(T.any(String, Stripe::PaymentMethod)) }
def payment_method; end
# Attribute for field payment_method_details
sig { returns(PaymentMethodDetails) }
def payment_method_details; end
# Attribute for field single_use
sig { returns(T.nilable(SingleUse)) }
def single_use; end
# The mandate status indicates whether or not you can use it to initiate a payment.
sig { returns(String) }
def status; end
# The type of the mandate.
sig { returns(String) }
def type; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The Stripe account ID that the mandates are intended for. Learn more about the [use case for connected accounts payments](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Attribute for param field payment_method
sig { returns(String) }
def payment_method; end
sig { params(_payment_method: String).returns(String) }
def payment_method=(_payment_method); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# The status of the mandates to retrieve. Status indicates whether or not you can use it to initiate a payment, and can have a value of `active`, `pending`, or `inactive`.
sig { returns(String) }
def status; end
sig { params(_status: String).returns(String) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), on_behalf_of: T.nilable(String), payment_method: String, starting_after: T.nilable(String), status: String).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
on_behalf_of: nil,
payment_method: nil,
starting_after: nil,
status: nil
); end
end
# Retrieves a list of Mandates for a given PaymentMethod.
sig {
params(params: T.any(::Stripe::Mandate::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
# typed: 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
class AutomaticTax < Stripe::StripeObject
# Whether Stripe automatically computes tax on this Order.
sig { returns(T::Boolean) }
def enabled; end
# The status of the most recent automated tax calculation for this Order.
sig { returns(T.nilable(String)) }
def status; end
end
class BillingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Billing address for the order.
sig { returns(T.nilable(Address)) }
def address; end
# Email address for the order.
sig { returns(T.nilable(String)) }
def email; end
# Full name for the order.
sig { returns(T.nilable(String)) }
def name; end
# Billing phone number for the order (including extension).
sig { returns(T.nilable(String)) }
def phone; end
end
class Payment < Stripe::StripeObject
class Settings < Stripe::StripeObject
class AutomaticPaymentMethods < Stripe::StripeObject
# Whether this Order has been opted into managing payment method types via the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
sig { returns(T::Boolean) }
def enabled; end
end
class PaymentMethodOptions < Stripe::StripeObject
class AcssDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# A URL for custom mandate text
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
# Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
end
class AfterpayClearpay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# Order identifier shown to the user in Afterpay's online portal. We recommend using a value that helps you answer any questions a customer might have about the payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.
sig { returns(T.nilable(String)) }
def reference; end
# Indicates that you intend to make future payments with the payment method.
#
# Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
#
# When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
#
# If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Alipay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Bancontact < Stripe::StripeObject
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(String) }
def preferred_language; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Card < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(String) }
def capture_method; end
# Indicates that you intend to make future payments with the payment method.
#
# Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
#
# When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
#
# If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class CustomerBalance < Stripe::StripeObject
class BankTransfer < Stripe::StripeObject
class EuBankTransfer < Stripe::StripeObject
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
end
# Attribute for field eu_bank_transfer
sig { returns(T.nilable(EuBankTransfer)) }
def eu_bank_transfer; end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
# The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(T.nilable(String)) }
def type; end
end
# Attribute for field bank_transfer
sig { returns(T.nilable(BankTransfer)) }
def bank_transfer; end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Ideal < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Klarna < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# Preferred locale of the Klarna checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Link < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Oxxo < Stripe::StripeObject
# The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
sig { returns(Integer) }
def expires_after_days; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class P24 < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Paypal < Stripe::StripeObject
class LineItem < Stripe::StripeObject
class Tax < Stripe::StripeObject
# The tax for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def amount; end
# The tax behavior for the line item.
sig { returns(String) }
def behavior; end
end
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
# Descriptive name of the line item.
sig { returns(String) }
def name; end
# Quantity of the line item. Cannot be a negative number.
sig { returns(Integer) }
def quantity; end
# Client facing stock keeping unit, article number or similar.
sig { returns(T.nilable(String)) }
def sku; end
# The Stripe account ID of the connected account that sells the item. This is only needed when using [Separate Charges and Transfers](https://docs.stripe.com/connect/separate-charges-and-transfers).
sig { returns(T.nilable(String)) }
def sold_by; end
# Attribute for field tax
sig { returns(T.nilable(Tax)) }
def tax; end
# Price for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def unit_amount; end
end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# The line items purchased by the customer.
sig { returns(T.nilable(T::Array[LineItem])) }
def line_items; end
# Preferred locale of the PayPal checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference; end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference_id; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
end
class SepaDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
end
class Sofort < Stripe::StripeObject
# Preferred language of the SOFORT authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class WechatPay < Stripe::StripeObject
# The app ID registered with WeChat Pay. Only required when client is ios or android.
sig { returns(T.nilable(String)) }
def app_id; end
# The client type that the end customer will pay from
sig { returns(T.nilable(String)) }
def client; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
# Attribute for field acss_debit
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# Attribute for field afterpay_clearpay
sig { returns(T.nilable(AfterpayClearpay)) }
def afterpay_clearpay; end
# Attribute for field alipay
sig { returns(T.nilable(Alipay)) }
def alipay; end
# Attribute for field bancontact
sig { returns(T.nilable(Bancontact)) }
def bancontact; end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# Attribute for field customer_balance
sig { returns(T.nilable(CustomerBalance)) }
def customer_balance; end
# Attribute for field ideal
sig { returns(T.nilable(Ideal)) }
def ideal; end
# Attribute for field klarna
sig { returns(T.nilable(Klarna)) }
def klarna; end
# Attribute for field link
sig { returns(T.nilable(Link)) }
def link; end
# Attribute for field oxxo
sig { returns(T.nilable(Oxxo)) }
def oxxo; end
# Attribute for field p24
sig { returns(T.nilable(P24)) }
def p24; end
# Attribute for field paypal
sig { returns(T.nilable(Paypal)) }
def paypal; end
# Attribute for field sepa_debit
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# Attribute for field sofort
sig { returns(T.nilable(Sofort)) }
def sofort; end
# Attribute for field wechat_pay
sig { returns(T.nilable(WechatPay)) }
def wechat_pay; end
end
class TransferData < Stripe::StripeObject
# The amount that will be transferred automatically when the order is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
sig { returns(T.nilable(Integer)) }
def amount; end
# ID of the Connected account receiving the transfer.
sig { returns(T.any(String, Stripe::Account)) }
def destination; end
end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
# Indicates whether order has been opted into using [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) to manage payment method types.
sig { returns(T.nilable(AutomaticPaymentMethods)) }
def automatic_payment_methods; end
# PaymentMethod-specific configuration to provide to the order's PaymentIntent.
sig { returns(T.nilable(PaymentMethodOptions)) }
def payment_method_options; end
# The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
# The URL to redirect the customer to after they authenticate their payment.
sig { returns(T.nilable(String)) }
def return_url; end
# For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
# Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
# Provides configuration for completing a transfer for the order after it is paid.
sig { returns(T.nilable(TransferData)) }
def transfer_data; end
end
# ID of the payment intent associated with this order. Null when the order is `open`.
sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
def payment_intent; end
# Settings describing how the order should configure generated PaymentIntents.
sig { returns(T.nilable(Settings)) }
def settings; end
# The status of the underlying payment associated with this order, if any. Null when the order is `open`.
sig { returns(T.nilable(String)) }
def status; end
end
class ShippingCost < Stripe::StripeObject
class Tax < Stripe::StripeObject
# Amount of tax applied for this rate.
sig { returns(Integer) }
def amount; end
# Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
#
# Related guide: [Tax rates](/billing/taxes/tax-rates)
sig { returns(Stripe::TaxRate) }
def rate; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(T.nilable(String)) }
def taxability_reason; end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(T.nilable(Integer)) }
def taxable_amount; end
end
# Total shipping cost before any discounts or taxes are applied.
sig { returns(Integer) }
def amount_subtotal; end
# Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
sig { returns(Integer) }
def amount_tax; end
# Total shipping cost after discounts and taxes are applied.
sig { returns(Integer) }
def amount_total; end
# The ID of the ShippingRate for this order.
sig { returns(T.nilable(T.any(String, Stripe::ShippingRate))) }
def shipping_rate; end
# The taxes applied to the shipping rate.
sig { returns(T.nilable(T::Array[Tax])) }
def taxes; end
end
class ShippingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Recipient shipping address. Required if the order includes products that are shippable.
sig { returns(T.nilable(Address)) }
def address; end
# Recipient name.
sig { returns(T.nilable(String)) }
def name; end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
end
class TaxDetails < Stripe::StripeObject
class TaxId < Stripe::StripeObject
# The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
sig { returns(String) }
def type; end
# The value of the tax ID.
sig { returns(T.nilable(String)) }
def value; end
end
# Describes the purchaser's tax exemption status. One of `none`, `exempt`, or `reverse`.
sig { returns(String) }
def tax_exempt; end
# The purchaser's tax IDs to be used in calculation of tax for this Order.
sig { returns(T::Array[TaxId]) }
def tax_ids; end
end
class TotalDetails < Stripe::StripeObject
class Breakdown < Stripe::StripeObject
class Discount < Stripe::StripeObject
# The amount discounted.
sig { returns(Integer) }
def amount; end
# 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)
sig { returns(Stripe::Discount) }
def discount; end
end
class Tax < Stripe::StripeObject
# Amount of tax applied for this rate.
sig { returns(Integer) }
def amount; end
# Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
#
# Related guide: [Tax rates](/billing/taxes/tax-rates)
sig { returns(Stripe::TaxRate) }
def rate; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(T.nilable(String)) }
def taxability_reason; end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(T.nilable(Integer)) }
def taxable_amount; end
end
# The aggregated discounts.
sig { returns(T::Array[Discount]) }
def discounts; end
# The aggregated tax amounts by rate.
sig { returns(T::Array[Tax]) }
def taxes; end
end
# This is the sum of all the discounts.
sig { returns(Integer) }
def amount_discount; end
# This is the sum of all the shipping amounts.
sig { returns(T.nilable(Integer)) }
def amount_shipping; end
# This is the sum of all the tax amounts.
sig { returns(Integer) }
def amount_tax; end
# Attribute for field breakdown
sig { returns(T.nilable(Breakdown)) }
def breakdown; end
end
# Order cost before any discounts or taxes are applied. A positive integer representing the subtotal of the order in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).
sig { returns(Integer) }
def amount_subtotal; end
# Total order cost after discounts and taxes are applied. A positive integer representing the cost of the order in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). To submit an order, the total must be either 0 or at least $0.50 USD or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts).
sig { returns(Integer) }
def amount_total; end
# ID of the Connect application that created the Order, if any.
sig { returns(T.nilable(T.any(String, Stripe::Application))) }
def application; end
# Attribute for field automatic_tax
sig { returns(T.nilable(AutomaticTax)) }
def automatic_tax; end
# Customer billing details associated with the order.
sig { returns(T.nilable(BillingDetails)) }
def billing_details; end
# The client secret of this Order. Used for client-side retrieval using a publishable key.
#
# The client secret can be used to complete a payment for an Order from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
#
# Refer to our docs for [creating and processing an order](https://stripe.com/docs/orders-beta/create-and-process) to learn about how client_secret should be handled.
sig { returns(T.nilable(String)) }
def client_secret; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# The customer which this orders belongs to.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# The discounts applied to the order. Use `expand[]=discounts` to expand each discount.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::Discount)])) }
def discounts; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# A recent IP address of the purchaser used for tax reporting and tax location inference.
sig { returns(T.nilable(String)) }
def ip_address; end
# A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost. There is a maximum of 100 line items.
sig { returns(T.nilable(Stripe::ListObject)) }
def line_items; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Attribute for field payment
sig { returns(Payment) }
def payment; end
# The details of the customer cost of shipping, including the customer chosen ShippingRate.
sig { returns(T.nilable(ShippingCost)) }
def shipping_cost; end
# Customer shipping information associated with the order.
sig { returns(T.nilable(ShippingDetails)) }
def shipping_details; end
# The overall status of the order.
sig { returns(String) }
def status; end
# Attribute for field tax_details
sig { returns(T.nilable(TaxDetails)) }
def tax_details; end
# Attribute for field total_details
sig { returns(TotalDetails) }
def total_details; end
class ListParams < Stripe::RequestParams
# Only return orders for the given customer.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
customer: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
# Enable automatic tax calculation which will automatically compute tax rates on this order.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The billing address provided by the customer.
sig { returns(T.nilable(::Stripe::Order::CreateParams::BillingDetails::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::Order::CreateParams::BillingDetails::Address)).returns(T.nilable(::Stripe::Order::CreateParams::BillingDetails::Address))
}
def address=(_address); end
# The billing email provided by the customer.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The billing name provided by the customer.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The billing phone number provided by the customer.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::Order::CreateParams::BillingDetails::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil); end
end
class Discount < Stripe::RequestParams
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
class LineItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
sig { params(coupon: T.nilable(String), discount: T.nilable(String)).void }
def initialize(coupon: nil, discount: nil); end
end
class PriceData < Stripe::RequestParams
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# ID of the [Product](https://docs.stripe.com/api/products) this [Price](https://docs.stripe.com/api/prices) belongs to.
#
# Use this to implement a variable-pricing model in your integration. This is required if `product_data` is not specified.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: T.nilable(String), product: T.nilable(String), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class ProductData < Stripe::RequestParams
class PackageDimensions < Stripe::RequestParams
# Height, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def height; end
sig { params(_height: Float).returns(Float) }
def height=(_height); end
# Length, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def length; end
sig { params(_length: Float).returns(Float) }
def length=(_length); end
# Weight, in ounces. Maximum precision is 2 decimal places.
sig { returns(Float) }
def weight; end
sig { params(_weight: Float).returns(Float) }
def weight=(_weight); end
# Width, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def width; end
sig { params(_width: Float).returns(Float) }
def width=(_width); end
sig { params(height: Float, length: Float, weight: Float, width: Float).void }
def initialize(height: nil, length: nil, weight: nil, width: nil); end
end
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# A unique identifier for this product.
#
# `product_data` automatically creates a Product with this ID. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates. If any of the fields in the existing Product are different from the values in `product_data`, `product_data` updates the existing Product with the new information. So set `product_data[id]` to the same string every time you sell the same product, but don't re-use the same string for different products.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def images; end
sig {
params(_images: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def images=(_images); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The dimensions of this product for shipping purposes.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::CreateParams::LineItem::ProductData::PackageDimensions)))
}
def package_dimensions; end
sig {
params(_package_dimensions: T.nilable(T.any(String, ::Stripe::Order::CreateParams::LineItem::ProductData::PackageDimensions))).returns(T.nilable(T.any(String, ::Stripe::Order::CreateParams::LineItem::ProductData::PackageDimensions)))
}
def package_dimensions=(_package_dimensions); end
# Whether this product is shipped (i.e., physical goods).
sig { returns(T.nilable(T::Boolean)) }
def shippable; end
sig { params(_shippable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def shippable=(_shippable); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A URL of a publicly-accessible webpage for this product.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(description: T.nilable(String), id: String, images: T.nilable(T.any(String, T::Array[String])), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: String, package_dimensions: T.nilable(T.any(String, ::Stripe::Order::CreateParams::LineItem::ProductData::PackageDimensions)), shippable: T.nilable(T::Boolean), tax_code: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
description: nil,
id: nil,
images: nil,
metadata: nil,
name: nil,
package_dimensions: nil,
shippable: nil,
tax_code: nil,
url: nil
); end
end
# The description for the line item. Will default to the name of the associated product.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The discounts applied to this line item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Order::CreateParams::LineItem::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Order::CreateParams::LineItem::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Order::CreateParams::LineItem::Discount])))
}
def discounts=(_discounts); end
# The ID of a [Price](https://docs.stripe.com/api/prices) to add to the Order.
#
# The `price` parameter is an alternative to using the `product` parameter. If each of your products are sold at a single price, you can set `Product.default_price` and then pass the `product` parameter when creating a line item. If your products are sold at several possible prices, use the `price` parameter to explicitly specify which one to use.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new Price object inline.
#
# The `price_data` parameter is an alternative to using the `product` or `price` parameters. If you create a Product upfront and configure a `Product.default_price`, pass the `product` parameter when creating a line item. If you prefer not to define Products upfront, or if you charge variable prices, pass the `price_data` parameter to describe the price for this line item.
#
# Each time you pass `price_data` we create a Price for the Product. This Price is hidden in both the Dashboard and API lists and cannot be reused.
sig { returns(T.nilable(::Stripe::Order::CreateParams::LineItem::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Order::CreateParams::LineItem::PriceData)).returns(T.nilable(::Stripe::Order::CreateParams::LineItem::PriceData))
}
def price_data=(_price_data); end
# The ID of a [Product](https://docs.stripe.com/api/products) to add to the Order.
#
# The Product must have a `default_price` specified. Otherwise, specify the price by passing the `price` or `price_data` parameter.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Defines a [Product](https://docs.stripe.com/api/products) inline and adds it to the Order.
#
# `product_data` is an alternative to the `product` parameter. If you created a Product upfront, use the `product` parameter to refer to the existing Product. But if you prefer not to create Products upfront, pass the `product_data` parameter to define a Product inline as part of configuring the Order.
#
# `product_data` automatically creates a Product, just as if you had manually created the Product. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates.
sig { returns(T.nilable(::Stripe::Order::CreateParams::LineItem::ProductData)) }
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::Order::CreateParams::LineItem::ProductData)).returns(T.nilable(::Stripe::Order::CreateParams::LineItem::ProductData))
}
def product_data=(_product_data); end
# The quantity of the line item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates applied to this line item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::Order::CreateParams::LineItem::Discount])), price: T.nilable(String), price_data: T.nilable(::Stripe::Order::CreateParams::LineItem::PriceData), product: T.nilable(String), product_data: T.nilable(::Stripe::Order::CreateParams::LineItem::ProductData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
description: nil,
discounts: nil,
price: nil,
price_data: nil,
product: nil,
product_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class Payment < Stripe::RequestParams
class Settings < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
mandate_options: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class AfterpayClearpay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# An internal identifier or reference this payment corresponds to. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Indicates that you intend to make future payments with the payment method.
#
# Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
#
# When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
#
# If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), reference: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, reference: nil, setup_future_usage: nil); end
end
class Alipay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class Card < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with the payment method.
#
# Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
#
# When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
#
# If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for the eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
sig {
params(_requested_address_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested_address_types=(_requested_address_types); end
# The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
}
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(bank_transfer: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
end
class Ideal < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Klarna < Stripe::RequestParams
class OnDemand < Stripe::RequestParams
# Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def average_amount; end
sig { params(_average_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def average_amount=(_average_amount); end
# The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def maximum_amount; end
sig { params(_maximum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_amount=(_maximum_amount); end
# The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Interval at which the customer is making purchases
sig { returns(T.nilable(String)) }
def purchase_interval; end
sig { params(_purchase_interval: T.nilable(String)).returns(T.nilable(String)) }
def purchase_interval=(_purchase_interval); end
# The number of `purchase_interval` between charges
sig { returns(T.nilable(Integer)) }
def purchase_interval_count; end
sig {
params(_purchase_interval_count: T.nilable(Integer)).returns(T.nilable(Integer))
}
def purchase_interval_count=(_purchase_interval_count); end
sig {
params(average_amount: T.nilable(Integer), maximum_amount: T.nilable(Integer), minimum_amount: T.nilable(Integer), purchase_interval: T.nilable(String), purchase_interval_count: T.nilable(Integer)).void
}
def initialize(
average_amount: nil,
maximum_amount: nil,
minimum_amount: nil,
purchase_interval: nil,
purchase_interval_count: nil
); end
end
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing; end
sig {
params(_next_billing: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription::NextBilling)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription::NextBilling), reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# On-demand details if setting up or charging an on-demand payment.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand; end
sig {
params(_on_demand: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::OnDemand)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand=(_on_demand); end
# Preferred language of the Klarna authorization page that the customer is redirected to
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Subscription details if setting up or charging a subscription.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(capture_method: T.nilable(String), on_demand: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::OnDemand), preferred_locale: T.nilable(String), setup_future_usage: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(
capture_method: nil,
on_demand: nil,
preferred_locale: nil,
setup_future_usage: nil,
subscriptions: nil
); end
end
class Link < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
sig { params(_persistent_token: T.nilable(String)).returns(T.nilable(String)) }
def persistent_token=(_persistent_token); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), persistent_token: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(
capture_method: nil,
persistent_token: nil,
setup_future_usage: nil
); end
end
class Oxxo < Stripe::RequestParams
# The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class P24 < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Confirm that the payer has accepted the P24 terms and conditions.
sig { returns(T.nilable(T::Boolean)) }
def tos_shown_and_accepted; end
sig {
params(_tos_shown_and_accepted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def tos_shown_and_accepted=(_tos_shown_and_accepted); end
sig {
params(setup_future_usage: T.nilable(String), tos_shown_and_accepted: T.nilable(T::Boolean)).void
}
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
end
class Paypal < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The tax for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The tax behavior for the line item.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(amount: Integer, behavior: String).void }
def initialize(amount: nil, behavior: nil); end
end
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Descriptive name of the line item.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Quantity of the line item. Must be a positive number.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Client facing stock keeping unit, article number or similar.
sig { returns(T.nilable(String)) }
def sku; end
sig { params(_sku: T.nilable(String)).returns(T.nilable(String)) }
def sku=(_sku); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
# The tax information for the line item.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem::Tax)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax=(_tax); end
# Price for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def unit_amount; end
sig { params(_unit_amount: Integer).returns(Integer) }
def unit_amount=(_unit_amount); end
sig {
params(category: T.nilable(String), description: T.nilable(String), name: String, quantity: Integer, sku: T.nilable(String), sold_by: T.nilable(String), tax: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem::Tax), unit_amount: Integer).void
}
def initialize(
category: nil,
description: nil,
name: nil,
quantity: nil,
sku: nil,
sold_by: nil,
tax: nil,
unit_amount: nil
); end
end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# The line items purchased by the customer.
sig {
returns(T.nilable(T::Array[::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem])).returns(T.nilable(T::Array[::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items=(_line_items); end
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference_id; end
sig { params(_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def reference_id=(_reference_id); end
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
sig { returns(T.nilable(String)) }
def risk_correlation_id; end
sig { params(_risk_correlation_id: T.nilable(String)).returns(T.nilable(String)) }
def risk_correlation_id=(_risk_correlation_id); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(capture_method: T.nilable(String), line_items: T.nilable(T::Array[::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem]), preferred_locale: T.nilable(String), reference: T.nilable(String), reference_id: T.nilable(String), risk_correlation_id: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String)), subsellers: T.nilable(T::Array[String])).void
}
def initialize(
capture_method: nil,
line_items: nil,
preferred_locale: nil,
reference: nil,
reference_id: nil,
risk_correlation_id: nil,
setup_future_usage: nil,
subsellers: nil
); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Sofort < Stripe::RequestParams
# Language shown to the payer on redirect.
sig { returns(T.nilable(T.any(String, String))) }
def preferred_language; end
sig {
params(_preferred_language: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(T.any(String, String)), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class WechatPay < Stripe::RequestParams
# The app ID registered with WeChat Pay. Only required when client is ios or android.
sig { returns(T.nilable(String)) }
def app_id; end
sig { params(_app_id: T.nilable(String)).returns(T.nilable(String)) }
def app_id=(_app_id); end
# The client type that the end customer will pay from
sig { returns(T.nilable(String)) }
def client; end
sig { params(_client: T.nilable(String)).returns(T.nilable(String)) }
def client=(_client); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(app_id: T.nilable(String), client: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
end
# If paying by `acss_debit`, this sub-hash contains details about the ACSS Debit payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If paying by `afterpay_clearpay`, this sub-hash contains details about the AfterpayClearpay payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::AfterpayClearpay)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If paying by `alipay`, this sub-hash contains details about the Alipay payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Alipay))
}
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Alipay)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Alipay))
}
def alipay=(_alipay); end
# If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Bancontact)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Bancontact))
}
def bancontact=(_bancontact); end
# If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Card))
}
def card=(_card); end
# If paying by `customer_balance`, this sub-hash contains details about the Customer Balance payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If paying by `ideal`, this sub-hash contains details about the iDEAL payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Ideal))
}
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Ideal)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Ideal))
}
def ideal=(_ideal); end
# If paying by `klarna`, this sub-hash contains details about the Klarna payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# If paying by `link`, this sub-hash contains details about the Link payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Link))
}
def link; end
sig {
params(_link: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Link)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Link))
}
def link=(_link); end
# If paying by `oxxo`, this sub-hash contains details about the OXXO payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Oxxo))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Oxxo)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Oxxo))
}
def oxxo=(_oxxo); end
# If paying by `p24`, this sub-hash contains details about the P24 payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::P24))
}
def p24; end
sig {
params(_p24: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::P24)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::P24))
}
def p24=(_p24); end
# If paying by `paypal`, this sub-hash contains details about the PayPal payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
# If paying by `sepa_debit`, this sub-hash contains details about the SEPA Debit payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If paying by `sofort`, this sub-hash contains details about the Sofort payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Sofort))
}
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Sofort)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Sofort))
}
def sofort=(_sofort); end
# If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::WechatPay)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::WechatPay))
}
def wechat_pay=(_wechat_pay); end
sig {
params(acss_debit: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit), afterpay_clearpay: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::AfterpayClearpay), alipay: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Alipay), bancontact: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Bancontact), card: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Card), customer_balance: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance), ideal: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Ideal), klarna: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna), link: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Link), oxxo: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Oxxo), p24: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::P24), paypal: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal), sepa_debit: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit), sofort: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::Sofort), wechat_pay: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions::WechatPay)).void
}
def initialize(
acss_debit: nil,
afterpay_clearpay: nil,
alipay: nil,
bancontact: nil,
card: nil,
customer_balance: nil,
ideal: nil,
klarna: nil,
link: nil,
oxxo: nil,
p24: nil,
paypal: nil,
sepa_debit: nil,
sofort: nil,
wechat_pay: nil
); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when the order is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# ID of the Connected account receiving the transfer.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# PaymentMethod-specific configuration to provide to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
# The URL to redirect the customer to after they authenticate their payment.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# Provides configuration for completing a transfer for the order after it is paid.
sig { returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::TransferData)).returns(T.nilable(::Stripe::Order::CreateParams::Payment::Settings::TransferData))
}
def transfer_data=(_transfer_data); end
sig {
params(application_fee_amount: T.nilable(Integer), payment_method_options: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), return_url: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::Order::CreateParams::Payment::Settings::TransferData)).void
}
def initialize(
application_fee_amount: nil,
payment_method_options: nil,
payment_method_types: nil,
return_url: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil
); end
end
# Settings describing how the order should configure generated PaymentIntents.
sig { returns(::Stripe::Order::CreateParams::Payment::Settings) }
def settings; end
sig {
params(_settings: ::Stripe::Order::CreateParams::Payment::Settings).returns(::Stripe::Order::CreateParams::Payment::Settings)
}
def settings=(_settings); end
sig { params(settings: ::Stripe::Order::CreateParams::Payment::Settings).void }
def initialize(settings: nil); end
end
class ShippingCost < Stripe::RequestParams
class ShippingRateData < Stripe::RequestParams
class DeliveryEstimate < Stripe::RequestParams
class Maximum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
class Minimum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum; end
sig {
params(_maximum: T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum)).returns(T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum=(_maximum); end
# The lower bound of the estimated range. If empty, represents no lower bound.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum; end
sig {
params(_minimum: T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum)).returns(T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum=(_minimum); end
sig {
params(maximum: T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum), minimum: T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum)).void
}
def initialize(maximum: nil, minimum: nil); end
end
class FixedAmount < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig { params(amount: Integer, tax_behavior: T.nilable(String)).void }
def initialize(amount: nil, tax_behavior: nil); end
end
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(amount: Integer, currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions])).void
}
def initialize(amount: nil, currency: nil, currency_options: nil); end
end
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate; end
sig {
params(_delivery_estimate: T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate)).returns(T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate=(_delivery_estimate); end
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
sig {
returns(T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::FixedAmount))
}
def fixed_amount; end
sig {
params(_fixed_amount: T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::FixedAmount)).returns(T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::FixedAmount))
}
def fixed_amount=(_fixed_amount); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The type of calculation to use on the shipping rate.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(delivery_estimate: T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate), display_name: String, fixed_amount: T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData::FixedAmount), metadata: T.nilable(T::Hash[String, String]), tax_behavior: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
delivery_estimate: nil,
display_name: nil,
fixed_amount: nil,
metadata: nil,
tax_behavior: nil,
tax_code: nil,
type: nil
); end
end
# The ID of the shipping rate to use for this order.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
# Parameters to create a new ad-hoc shipping rate for this order.
sig { returns(T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData)) }
def shipping_rate_data; end
sig {
params(_shipping_rate_data: T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData)).returns(T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData))
}
def shipping_rate_data=(_shipping_rate_data); end
sig {
params(shipping_rate: T.nilable(String), shipping_rate_data: T.nilable(::Stripe::Order::CreateParams::ShippingCost::ShippingRateData)).void
}
def initialize(shipping_rate: nil, shipping_rate_data: nil); end
end
class ShippingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The shipping address for the order.
sig { returns(::Stripe::Order::CreateParams::ShippingDetails::Address) }
def address; end
sig {
params(_address: ::Stripe::Order::CreateParams::ShippingDetails::Address).returns(::Stripe::Order::CreateParams::ShippingDetails::Address)
}
def address=(_address); end
# The name of the recipient of the order.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The phone number (including extension) for the recipient of the order.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: ::Stripe::Order::CreateParams::ShippingDetails::Address, name: String, phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
class TaxDetails < Stripe::RequestParams
class TaxId < Stripe::RequestParams
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Value of the tax ID.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(type: String, value: String).void }
def initialize(type: nil, value: nil); end
end
# The purchaser's tax exemption status. One of `none`, `exempt`, or `reverse`.
sig { returns(T.nilable(T.any(String, String))) }
def tax_exempt; end
sig {
params(_tax_exempt: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def tax_exempt=(_tax_exempt); end
# The purchaser's tax IDs to be used for this order.
sig { returns(T.nilable(T::Array[::Stripe::Order::CreateParams::TaxDetails::TaxId])) }
def tax_ids; end
sig {
params(_tax_ids: T.nilable(T::Array[::Stripe::Order::CreateParams::TaxDetails::TaxId])).returns(T.nilable(T::Array[::Stripe::Order::CreateParams::TaxDetails::TaxId]))
}
def tax_ids=(_tax_ids); end
sig {
params(tax_exempt: T.nilable(T.any(String, String)), tax_ids: T.nilable(T::Array[::Stripe::Order::CreateParams::TaxDetails::TaxId])).void
}
def initialize(tax_exempt: nil, tax_ids: nil); end
end
# Settings for automatic tax calculation for this order.
sig { returns(T.nilable(::Stripe::Order::CreateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::Order::CreateParams::AutomaticTax)).returns(T.nilable(::Stripe::Order::CreateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Billing details for the customer. If a customer is provided, this will be automatically populated with values from that customer if override values are not provided.
sig { returns(T.nilable(T.any(String, ::Stripe::Order::CreateParams::BillingDetails))) }
def billing_details; end
sig {
params(_billing_details: T.nilable(T.any(String, ::Stripe::Order::CreateParams::BillingDetails))).returns(T.nilable(T.any(String, ::Stripe::Order::CreateParams::BillingDetails)))
}
def billing_details=(_billing_details); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The customer associated with this order.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The coupons, promotion codes, and/or discounts to apply to the order.
sig { returns(T.nilable(T.any(String, T::Array[::Stripe::Order::CreateParams::Discount]))) }
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Order::CreateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Order::CreateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The IP address of the purchaser for this order.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost.
sig { returns(T::Array[::Stripe::Order::CreateParams::LineItem]) }
def line_items; end
sig {
params(_line_items: T::Array[::Stripe::Order::CreateParams::LineItem]).returns(T::Array[::Stripe::Order::CreateParams::LineItem])
}
def line_items=(_line_items); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Payment information associated with the order, including payment settings.
sig { returns(T.nilable(::Stripe::Order::CreateParams::Payment)) }
def payment; end
sig {
params(_payment: T.nilable(::Stripe::Order::CreateParams::Payment)).returns(T.nilable(::Stripe::Order::CreateParams::Payment))
}
def payment=(_payment); end
# Settings for the customer cost of shipping for this order.
sig { returns(T.nilable(T.any(String, ::Stripe::Order::CreateParams::ShippingCost))) }
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(T.any(String, ::Stripe::Order::CreateParams::ShippingCost))).returns(T.nilable(T.any(String, ::Stripe::Order::CreateParams::ShippingCost)))
}
def shipping_cost=(_shipping_cost); end
# Shipping details for the order.
sig { returns(T.nilable(T.any(String, ::Stripe::Order::CreateParams::ShippingDetails))) }
def shipping_details; end
sig {
params(_shipping_details: T.nilable(T.any(String, ::Stripe::Order::CreateParams::ShippingDetails))).returns(T.nilable(T.any(String, ::Stripe::Order::CreateParams::ShippingDetails)))
}
def shipping_details=(_shipping_details); end
# Additional tax details about the purchaser to be used for this order.
sig { returns(T.nilable(::Stripe::Order::CreateParams::TaxDetails)) }
def tax_details; end
sig {
params(_tax_details: T.nilable(::Stripe::Order::CreateParams::TaxDetails)).returns(T.nilable(::Stripe::Order::CreateParams::TaxDetails))
}
def tax_details=(_tax_details); end
sig {
params(automatic_tax: T.nilable(::Stripe::Order::CreateParams::AutomaticTax), billing_details: T.nilable(T.any(String, ::Stripe::Order::CreateParams::BillingDetails)), currency: String, customer: T.nilable(String), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::Order::CreateParams::Discount])), expand: T.nilable(T::Array[String]), ip_address: T.nilable(String), line_items: T::Array[::Stripe::Order::CreateParams::LineItem], metadata: T.nilable(T::Hash[String, String]), payment: T.nilable(::Stripe::Order::CreateParams::Payment), shipping_cost: T.nilable(T.any(String, ::Stripe::Order::CreateParams::ShippingCost)), shipping_details: T.nilable(T.any(String, ::Stripe::Order::CreateParams::ShippingDetails)), tax_details: T.nilable(::Stripe::Order::CreateParams::TaxDetails)).void
}
def initialize(
automatic_tax: nil,
billing_details: nil,
currency: nil,
customer: nil,
description: nil,
discounts: nil,
expand: nil,
ip_address: nil,
line_items: nil,
metadata: nil,
payment: nil,
shipping_cost: nil,
shipping_details: nil,
tax_details: nil
); end
end
class UpdateParams < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
# Enable automatic tax calculation which will automatically compute tax rates on this order.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The billing address provided by the customer.
sig { returns(T.nilable(::Stripe::Order::UpdateParams::BillingDetails::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::Order::UpdateParams::BillingDetails::Address)).returns(T.nilable(::Stripe::Order::UpdateParams::BillingDetails::Address))
}
def address=(_address); end
# The billing email provided by the customer.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The billing name provided by the customer.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The billing phone number provided by the customer.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::Order::UpdateParams::BillingDetails::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil); end
end
class Discount < Stripe::RequestParams
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
class LineItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
sig { params(coupon: T.nilable(String), discount: T.nilable(String)).void }
def initialize(coupon: nil, discount: nil); end
end
class PriceData < Stripe::RequestParams
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# ID of the [Product](https://docs.stripe.com/api/products) this [Price](https://docs.stripe.com/api/prices) belongs to.
#
# Use this to implement a variable-pricing model in your integration. This is required if `product_data` is not specified.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: T.nilable(String), product: T.nilable(String), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class ProductData < Stripe::RequestParams
class PackageDimensions < Stripe::RequestParams
# Height, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def height; end
sig { params(_height: Float).returns(Float) }
def height=(_height); end
# Length, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def length; end
sig { params(_length: Float).returns(Float) }
def length=(_length); end
# Weight, in ounces. Maximum precision is 2 decimal places.
sig { returns(Float) }
def weight; end
sig { params(_weight: Float).returns(Float) }
def weight=(_weight); end
# Width, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def width; end
sig { params(_width: Float).returns(Float) }
def width=(_width); end
sig { params(height: Float, length: Float, weight: Float, width: Float).void }
def initialize(height: nil, length: nil, weight: nil, width: nil); end
end
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# A unique identifier for this product.
#
# `product_data` automatically creates a Product with this ID. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates. If any of the fields in the existing Product are different from the values in `product_data`, `product_data` updates the existing Product with the new information. So set `product_data[id]` to the same string every time you sell the same product, but don't re-use the same string for different products.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def images; end
sig {
params(_images: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def images=(_images); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The dimensions of this product for shipping purposes.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::LineItem::ProductData::PackageDimensions)))
}
def package_dimensions; end
sig {
params(_package_dimensions: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::LineItem::ProductData::PackageDimensions))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::LineItem::ProductData::PackageDimensions)))
}
def package_dimensions=(_package_dimensions); end
# Whether this product is shipped (i.e., physical goods).
sig { returns(T.nilable(T::Boolean)) }
def shippable; end
sig { params(_shippable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def shippable=(_shippable); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A URL of a publicly-accessible webpage for this product.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(description: T.nilable(String), id: String, images: T.nilable(T.any(String, T::Array[String])), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: String, package_dimensions: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::LineItem::ProductData::PackageDimensions)), shippable: T.nilable(T::Boolean), tax_code: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
description: nil,
id: nil,
images: nil,
metadata: nil,
name: nil,
package_dimensions: nil,
shippable: nil,
tax_code: nil,
url: nil
); end
end
# The description for the line item. Will default to the name of the associated product.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The discounts applied to this line item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Order::UpdateParams::LineItem::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Order::UpdateParams::LineItem::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Order::UpdateParams::LineItem::Discount])))
}
def discounts=(_discounts); end
# The ID of an existing line item on the order.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The ID of a [Price](https://docs.stripe.com/api/prices) to add to the Order.
#
# The `price` parameter is an alternative to using the `product` parameter. If each of your products are sold at a single price, you can set `Product.default_price` and then pass the `product` parameter when creating a line item. If your products are sold at several possible prices, use the `price` parameter to explicitly specify which one to use.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new Price object inline.
#
# The `price_data` parameter is an alternative to using the `product` or `price` parameters. If you create a Product upfront and configure a `Product.default_price`, pass the `product` parameter when creating a line item. If you prefer not to define Products upfront, or if you charge variable prices, pass the `price_data` parameter to describe the price for this line item.
#
# Each time you pass `price_data` we create a Price for the Product. This Price is hidden in both the Dashboard and API lists and cannot be reused.
sig { returns(T.nilable(::Stripe::Order::UpdateParams::LineItem::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Order::UpdateParams::LineItem::PriceData)).returns(T.nilable(::Stripe::Order::UpdateParams::LineItem::PriceData))
}
def price_data=(_price_data); end
# The ID of a [Product](https://docs.stripe.com/api/products) to add to the Order.
#
# The Product must have a `default_price` specified. Otherwise, specify the price by passing the `price` or `price_data` parameter.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Defines a [Product](https://docs.stripe.com/api/products) inline and adds it to the Order.
#
# `product_data` is an alternative to the `product` parameter. If you created a Product upfront, use the `product` parameter to refer to the existing Product. But if you prefer not to create Products upfront, pass the `product_data` parameter to define a Product inline as part of configuring the Order.
#
# `product_data` automatically creates a Product, just as if you had manually created the Product. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates.
sig { returns(T.nilable(::Stripe::Order::UpdateParams::LineItem::ProductData)) }
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::Order::UpdateParams::LineItem::ProductData)).returns(T.nilable(::Stripe::Order::UpdateParams::LineItem::ProductData))
}
def product_data=(_product_data); end
# The quantity of the line item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates applied to this line item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::Order::UpdateParams::LineItem::Discount])), id: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::Order::UpdateParams::LineItem::PriceData), product: T.nilable(String), product_data: T.nilable(::Stripe::Order::UpdateParams::LineItem::ProductData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
description: nil,
discounts: nil,
id: nil,
price: nil,
price_data: nil,
product: nil,
product_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class Payment < Stripe::RequestParams
class Settings < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
mandate_options: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class AfterpayClearpay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# An internal identifier or reference this payment corresponds to. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Indicates that you intend to make future payments with the payment method.
#
# Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
#
# When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
#
# If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), reference: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, reference: nil, setup_future_usage: nil); end
end
class Alipay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class Card < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with the payment method.
#
# Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
#
# When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
#
# If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for the eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
sig {
params(_requested_address_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested_address_types=(_requested_address_types); end
# The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
}
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(bank_transfer: T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
end
class Ideal < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Klarna < Stripe::RequestParams
class OnDemand < Stripe::RequestParams
# Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def average_amount; end
sig { params(_average_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def average_amount=(_average_amount); end
# The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def maximum_amount; end
sig { params(_maximum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_amount=(_maximum_amount); end
# The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Interval at which the customer is making purchases
sig { returns(T.nilable(String)) }
def purchase_interval; end
sig { params(_purchase_interval: T.nilable(String)).returns(T.nilable(String)) }
def purchase_interval=(_purchase_interval); end
# The number of `purchase_interval` between charges
sig { returns(T.nilable(Integer)) }
def purchase_interval_count; end
sig {
params(_purchase_interval_count: T.nilable(Integer)).returns(T.nilable(Integer))
}
def purchase_interval_count=(_purchase_interval_count); end
sig {
params(average_amount: T.nilable(Integer), maximum_amount: T.nilable(Integer), minimum_amount: T.nilable(Integer), purchase_interval: T.nilable(String), purchase_interval_count: T.nilable(Integer)).void
}
def initialize(
average_amount: nil,
maximum_amount: nil,
minimum_amount: nil,
purchase_interval: nil,
purchase_interval_count: nil
); end
end
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing; end
sig {
params(_next_billing: T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription::NextBilling)).returns(T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription::NextBilling), reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# On-demand details if setting up or charging an on-demand payment.
sig {
returns(T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand; end
sig {
params(_on_demand: T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::OnDemand)).returns(T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand=(_on_demand); end
# Preferred language of the Klarna authorization page that the customer is redirected to
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Subscription details if setting up or charging a subscription.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(capture_method: T.nilable(String), on_demand: T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::OnDemand), preferred_locale: T.nilable(String), setup_future_usage: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(
capture_method: nil,
on_demand: nil,
preferred_locale: nil,
setup_future_usage: nil,
subscriptions: nil
); end
end
class Link < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
sig { params(_persistent_token: T.nilable(String)).returns(T.nilable(String)) }
def persistent_token=(_persistent_token); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), persistent_token: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(
capture_method: nil,
persistent_token: nil,
setup_future_usage: nil
); end
end
class Oxxo < Stripe::RequestParams
# The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class P24 < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Confirm that the payer has accepted the P24 terms and conditions.
sig { returns(T.nilable(T::Boolean)) }
def tos_shown_and_accepted; end
sig {
params(_tos_shown_and_accepted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def tos_shown_and_accepted=(_tos_shown_and_accepted); end
sig {
params(setup_future_usage: T.nilable(String), tos_shown_and_accepted: T.nilable(T::Boolean)).void
}
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
end
class Paypal < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The tax for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The tax behavior for the line item.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(amount: Integer, behavior: String).void }
def initialize(amount: nil, behavior: nil); end
end
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Descriptive name of the line item.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Quantity of the line item. Must be a positive number.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Client facing stock keeping unit, article number or similar.
sig { returns(T.nilable(String)) }
def sku; end
sig { params(_sku: T.nilable(String)).returns(T.nilable(String)) }
def sku=(_sku); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
# The tax information for the line item.
sig {
returns(T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem::Tax)).returns(T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax=(_tax); end
# Price for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def unit_amount; end
sig { params(_unit_amount: Integer).returns(Integer) }
def unit_amount=(_unit_amount); end
sig {
params(category: T.nilable(String), description: T.nilable(String), name: String, quantity: Integer, sku: T.nilable(String), sold_by: T.nilable(String), tax: T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem::Tax), unit_amount: Integer).void
}
def initialize(
category: nil,
description: nil,
name: nil,
quantity: nil,
sku: nil,
sold_by: nil,
tax: nil,
unit_amount: nil
); end
end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# The line items purchased by the customer.
sig {
returns(T.nilable(T::Array[::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem])).returns(T.nilable(T::Array[::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items=(_line_items); end
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference_id; end
sig { params(_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def reference_id=(_reference_id); end
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
sig { returns(T.nilable(String)) }
def risk_correlation_id; end
sig { params(_risk_correlation_id: T.nilable(String)).returns(T.nilable(String)) }
def risk_correlation_id=(_risk_correlation_id); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(capture_method: T.nilable(String), line_items: T.nilable(T::Array[::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem]), preferred_locale: T.nilable(String), reference: T.nilable(String), reference_id: T.nilable(String), risk_correlation_id: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String)), subsellers: T.nilable(T::Array[String])).void
}
def initialize(
capture_method: nil,
line_items: nil,
preferred_locale: nil,
reference: nil,
reference_id: nil,
risk_correlation_id: nil,
setup_future_usage: nil,
subsellers: nil
); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Sofort < Stripe::RequestParams
# Language shown to the payer on redirect.
sig { returns(T.nilable(T.any(String, String))) }
def preferred_language; end
sig {
params(_preferred_language: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(T.any(String, String)), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class WechatPay < Stripe::RequestParams
# The app ID registered with WeChat Pay. Only required when client is ios or android.
sig { returns(T.nilable(String)) }
def app_id; end
sig { params(_app_id: T.nilable(String)).returns(T.nilable(String)) }
def app_id=(_app_id); end
# The client type that the end customer will pay from
sig { returns(T.nilable(String)) }
def client; end
sig { params(_client: T.nilable(String)).returns(T.nilable(String)) }
def client=(_client); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(app_id: T.nilable(String), client: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
end
# If paying by `acss_debit`, this sub-hash contains details about the ACSS Debit payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit=(_acss_debit); end
# If paying by `afterpay_clearpay`, this sub-hash contains details about the AfterpayClearpay payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::AfterpayClearpay)))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::AfterpayClearpay))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::AfterpayClearpay)))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If paying by `alipay`, this sub-hash contains details about the Alipay payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Alipay)))
}
def alipay; end
sig {
params(_alipay: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Alipay))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Alipay)))
}
def alipay=(_alipay); end
# If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Bancontact)))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Bancontact))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Bancontact)))
}
def bancontact=(_bancontact); end
# If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Card)))
}
def card; end
sig {
params(_card: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Card))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Card)))
}
def card=(_card); end
# If paying by `customer_balance`, this sub-hash contains details about the Customer Balance payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance=(_customer_balance); end
# If paying by `ideal`, this sub-hash contains details about the iDEAL payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Ideal)))
}
def ideal; end
sig {
params(_ideal: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Ideal))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Ideal)))
}
def ideal=(_ideal); end
# If paying by `klarna`, this sub-hash contains details about the Klarna payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna)))
}
def klarna; end
sig {
params(_klarna: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna)))
}
def klarna=(_klarna); end
# If paying by `link`, this sub-hash contains details about the Link payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Link)))
}
def link; end
sig {
params(_link: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Link))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Link)))
}
def link=(_link); end
# If paying by `oxxo`, this sub-hash contains details about the OXXO payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Oxxo)))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Oxxo))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Oxxo)))
}
def oxxo=(_oxxo); end
# If paying by `p24`, this sub-hash contains details about the P24 payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::P24)))
}
def p24; end
sig {
params(_p24: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::P24))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::P24)))
}
def p24=(_p24); end
# If paying by `paypal`, this sub-hash contains details about the PayPal payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal)))
}
def paypal; end
sig {
params(_paypal: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal)))
}
def paypal=(_paypal); end
# If paying by `sepa_debit`, this sub-hash contains details about the SEPA Debit payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit=(_sepa_debit); end
# If paying by `sofort`, this sub-hash contains details about the Sofort payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Sofort)))
}
def sofort; end
sig {
params(_sofort: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Sofort))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Sofort)))
}
def sofort=(_sofort); end
# If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::WechatPay)))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::WechatPay))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::WechatPay)))
}
def wechat_pay=(_wechat_pay); end
sig {
params(acss_debit: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit)), afterpay_clearpay: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::AfterpayClearpay)), alipay: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Alipay)), bancontact: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Bancontact)), card: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Card)), customer_balance: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance)), ideal: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Ideal)), klarna: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna)), link: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Link)), oxxo: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Oxxo)), p24: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::P24)), paypal: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal)), sepa_debit: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit)), sofort: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::Sofort)), wechat_pay: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions::WechatPay))).void
}
def initialize(
acss_debit: nil,
afterpay_clearpay: nil,
alipay: nil,
bancontact: nil,
card: nil,
customer_balance: nil,
ideal: nil,
klarna: nil,
link: nil,
oxxo: nil,
p24: nil,
paypal: nil,
sepa_debit: nil,
sofort: nil,
wechat_pay: nil
); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when the order is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# ID of the Connected account receiving the transfer.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.
sig { returns(T.nilable(T.any(String, Integer))) }
def application_fee_amount; end
sig {
params(_application_fee_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def application_fee_amount=(_application_fee_amount); end
# PaymentMethod-specific configuration to provide to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions)).returns(T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
# The URL to redirect the customer to after they authenticate their payment.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# Provides configuration for completing a transfer for the order after it is paid.
sig {
returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::TransferData)))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::TransferData))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::TransferData)))
}
def transfer_data=(_transfer_data); end
sig {
params(application_fee_amount: T.nilable(T.any(String, Integer)), payment_method_options: T.nilable(::Stripe::Order::UpdateParams::Payment::Settings::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), return_url: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::Payment::Settings::TransferData))).void
}
def initialize(
application_fee_amount: nil,
payment_method_options: nil,
payment_method_types: nil,
return_url: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil
); end
end
# Settings describing how the order should configure generated PaymentIntents.
sig { returns(::Stripe::Order::UpdateParams::Payment::Settings) }
def settings; end
sig {
params(_settings: ::Stripe::Order::UpdateParams::Payment::Settings).returns(::Stripe::Order::UpdateParams::Payment::Settings)
}
def settings=(_settings); end
sig { params(settings: ::Stripe::Order::UpdateParams::Payment::Settings).void }
def initialize(settings: nil); end
end
class ShippingCost < Stripe::RequestParams
class ShippingRateData < Stripe::RequestParams
class DeliveryEstimate < Stripe::RequestParams
class Maximum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
class Minimum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
sig {
returns(T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum; end
sig {
params(_maximum: T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum)).returns(T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum=(_maximum); end
# The lower bound of the estimated range. If empty, represents no lower bound.
sig {
returns(T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum; end
sig {
params(_minimum: T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum)).returns(T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum=(_minimum); end
sig {
params(maximum: T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum), minimum: T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum)).void
}
def initialize(maximum: nil, minimum: nil); end
end
class FixedAmount < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig { params(amount: Integer, tax_behavior: T.nilable(String)).void }
def initialize(amount: nil, tax_behavior: nil); end
end
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(amount: Integer, currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions])).void
}
def initialize(amount: nil, currency: nil, currency_options: nil); end
end
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig {
returns(T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate; end
sig {
params(_delivery_estimate: T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate)).returns(T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate=(_delivery_estimate); end
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
sig {
returns(T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::FixedAmount))
}
def fixed_amount; end
sig {
params(_fixed_amount: T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::FixedAmount)).returns(T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::FixedAmount))
}
def fixed_amount=(_fixed_amount); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The type of calculation to use on the shipping rate.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(delivery_estimate: T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate), display_name: String, fixed_amount: T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData::FixedAmount), metadata: T.nilable(T::Hash[String, String]), tax_behavior: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
delivery_estimate: nil,
display_name: nil,
fixed_amount: nil,
metadata: nil,
tax_behavior: nil,
tax_code: nil,
type: nil
); end
end
# The ID of the shipping rate to use for this order.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
# Parameters to create a new ad-hoc shipping rate for this order.
sig { returns(T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData)) }
def shipping_rate_data; end
sig {
params(_shipping_rate_data: T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData)).returns(T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData))
}
def shipping_rate_data=(_shipping_rate_data); end
sig {
params(shipping_rate: T.nilable(String), shipping_rate_data: T.nilable(::Stripe::Order::UpdateParams::ShippingCost::ShippingRateData)).void
}
def initialize(shipping_rate: nil, shipping_rate_data: nil); end
end
class ShippingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The shipping address for the order.
sig { returns(::Stripe::Order::UpdateParams::ShippingDetails::Address) }
def address; end
sig {
params(_address: ::Stripe::Order::UpdateParams::ShippingDetails::Address).returns(::Stripe::Order::UpdateParams::ShippingDetails::Address)
}
def address=(_address); end
# The name of the recipient of the order.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The phone number (including extension) for the recipient of the order.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: ::Stripe::Order::UpdateParams::ShippingDetails::Address, name: String, phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
class TaxDetails < Stripe::RequestParams
class TaxId < Stripe::RequestParams
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Value of the tax ID.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(type: String, value: String).void }
def initialize(type: nil, value: nil); end
end
# The purchaser's tax exemption status. One of `none`, `exempt`, or `reverse`.
sig { returns(T.nilable(T.any(String, String))) }
def tax_exempt; end
sig {
params(_tax_exempt: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def tax_exempt=(_tax_exempt); end
# The purchaser's tax IDs to be used for this order.
sig { returns(T.nilable(T::Array[::Stripe::Order::UpdateParams::TaxDetails::TaxId])) }
def tax_ids; end
sig {
params(_tax_ids: T.nilable(T::Array[::Stripe::Order::UpdateParams::TaxDetails::TaxId])).returns(T.nilable(T::Array[::Stripe::Order::UpdateParams::TaxDetails::TaxId]))
}
def tax_ids=(_tax_ids); end
sig {
params(tax_exempt: T.nilable(T.any(String, String)), tax_ids: T.nilable(T::Array[::Stripe::Order::UpdateParams::TaxDetails::TaxId])).void
}
def initialize(tax_exempt: nil, tax_ids: nil); end
end
# Settings for automatic tax calculation for this order.
sig { returns(T.nilable(::Stripe::Order::UpdateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::Order::UpdateParams::AutomaticTax)).returns(T.nilable(::Stripe::Order::UpdateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Billing details for the customer. If a customer is provided, this will be automatically populated with values from that customer if override values are not provided.
sig { returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::BillingDetails))) }
def billing_details; end
sig {
params(_billing_details: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::BillingDetails))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::BillingDetails)))
}
def billing_details=(_billing_details); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The customer associated with this order.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The coupons, promotion codes, and/or discounts to apply to the order. Pass the empty string `""` to unset this field.
sig { returns(T.nilable(T.any(String, T::Array[::Stripe::Order::UpdateParams::Discount]))) }
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Order::UpdateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Order::UpdateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The IP address of the purchaser for this order.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost.
sig { returns(T.nilable(T::Array[::Stripe::Order::UpdateParams::LineItem])) }
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::Order::UpdateParams::LineItem])).returns(T.nilable(T::Array[::Stripe::Order::UpdateParams::LineItem]))
}
def line_items=(_line_items); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Payment information associated with the order, including payment settings.
sig { returns(T.nilable(::Stripe::Order::UpdateParams::Payment)) }
def payment; end
sig {
params(_payment: T.nilable(::Stripe::Order::UpdateParams::Payment)).returns(T.nilable(::Stripe::Order::UpdateParams::Payment))
}
def payment=(_payment); end
# Settings for the customer cost of shipping for this order.
sig { returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::ShippingCost))) }
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::ShippingCost))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::ShippingCost)))
}
def shipping_cost=(_shipping_cost); end
# Shipping details for the order.
sig { returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::ShippingDetails))) }
def shipping_details; end
sig {
params(_shipping_details: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::ShippingDetails))).returns(T.nilable(T.any(String, ::Stripe::Order::UpdateParams::ShippingDetails)))
}
def shipping_details=(_shipping_details); end
# Additional tax details about the purchaser to be used for this order.
sig { returns(T.nilable(::Stripe::Order::UpdateParams::TaxDetails)) }
def tax_details; end
sig {
params(_tax_details: T.nilable(::Stripe::Order::UpdateParams::TaxDetails)).returns(T.nilable(::Stripe::Order::UpdateParams::TaxDetails))
}
def tax_details=(_tax_details); end
sig {
params(automatic_tax: T.nilable(::Stripe::Order::UpdateParams::AutomaticTax), billing_details: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::BillingDetails)), currency: T.nilable(String), customer: T.nilable(String), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::Order::UpdateParams::Discount])), expand: T.nilable(T::Array[String]), ip_address: T.nilable(String), line_items: T.nilable(T::Array[::Stripe::Order::UpdateParams::LineItem]), metadata: T.nilable(T.any(String, T::Hash[String, String])), payment: T.nilable(::Stripe::Order::UpdateParams::Payment), shipping_cost: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::ShippingCost)), shipping_details: T.nilable(T.any(String, ::Stripe::Order::UpdateParams::ShippingDetails)), tax_details: T.nilable(::Stripe::Order::UpdateParams::TaxDetails)).void
}
def initialize(
automatic_tax: nil,
billing_details: nil,
currency: nil,
customer: nil,
description: nil,
discounts: nil,
expand: nil,
ip_address: nil,
line_items: nil,
metadata: nil,
payment: nil,
shipping_cost: nil,
shipping_details: nil,
tax_details: nil
); end
end
class ListLineItemsParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ReopenParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class SubmitParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# `expected_total` should always be set to the order's `amount_total` field. If they don't match, submitting the order will fail. This helps detect race conditions where something else concurrently modifies the order.
sig { returns(Integer) }
def expected_total; end
sig { params(_expected_total: Integer).returns(Integer) }
def expected_total=(_expected_total); end
sig { params(expand: T.nilable(T::Array[String]), expected_total: Integer).void }
def initialize(expand: nil, expected_total: nil); end
end
# Cancels the order as well as the payment intent if one is attached.
sig {
params(params: T.any(::Stripe::Order::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order)
}
def cancel(params = {}, opts = {}); end
# Cancels the order as well as the payment intent if one is attached.
sig {
params(id: String, params: T.any(::Stripe::Order::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order)
}
def self.cancel(id, params = {}, opts = {}); end
# Creates a new open order object.
sig {
params(params: T.any(::Stripe::Order::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order)
}
def self.create(params = {}, opts = {}); end
# Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.
sig {
params(params: T.any(::Stripe::Order::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# When retrieving an order, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
sig {
params(params: T.any(::Stripe::Order::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list_line_items(params = {}, opts = {}); end
# When retrieving an order, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
sig {
params(id: String, params: T.any(::Stripe::Order::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list_line_items(id, params = {}, opts = {}); end
# Reopens a submitted order.
sig {
params(params: T.any(::Stripe::Order::ReopenParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order)
}
def reopen(params = {}, opts = {}); end
# Reopens a submitted order.
sig {
params(id: String, params: T.any(::Stripe::Order::ReopenParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order)
}
def self.reopen(id, params = {}, opts = {}); end
# Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://docs.stripe.com/api#reopen_order) method is called.
sig {
params(params: T.any(::Stripe::Order::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order)
}
def submit(params = {}, opts = {}); end
# Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://docs.stripe.com/api#reopen_order) method is called.
sig {
params(id: String, params: T.any(::Stripe::Order::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order)
}
def self.submit(id, params = {}, opts = {}); end
# Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(id: String, params: T.any(::Stripe::Order::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order)
}
def self.update(id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# A Payment Attempt Record represents an individual attempt at making a payment, on or off Stripe.
# Each payment attempt tries to collect a fixed amount of money from a fixed customer and payment
# method. Payment Attempt Records are attached to Payment Records. Only one attempt per Payment Record
# can have guaranteed funds.
class PaymentAttemptRecord < APIResource
class Amount < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
sig { returns(Integer) }
def value; end
end
class AmountAuthorized < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
sig { returns(Integer) }
def value; end
end
class AmountCanceled < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
sig { returns(Integer) }
def value; end
end
class AmountFailed < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
sig { returns(Integer) }
def value; end
end
class AmountGuaranteed < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
sig { returns(Integer) }
def value; end
end
class AmountRefunded < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
sig { returns(Integer) }
def value; end
end
class AmountRequested < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
sig { returns(Integer) }
def value; end
end
class CustomerDetails < Stripe::StripeObject
# ID of the Stripe Customer associated with this payment.
sig { returns(T.nilable(String)) }
def customer; end
# The customer's email address.
sig { returns(T.nilable(String)) }
def email; end
# The customer's name.
sig { returns(T.nilable(String)) }
def name; end
# The customer's phone number.
sig { returns(T.nilable(String)) }
def phone; end
end
class PaymentMethodDetails < Stripe::StripeObject
class AchCreditTransfer < Stripe::StripeObject
# Account number to transfer funds to.
sig { returns(T.nilable(String)) }
def account_number; end
# Name of the bank associated with the routing number.
sig { returns(T.nilable(String)) }
def bank_name; end
# Routing transit number for the bank account to transfer funds to.
sig { returns(T.nilable(String)) }
def routing_number; end
# SWIFT code of the bank associated with the routing number.
sig { returns(T.nilable(String)) }
def swift_code; end
end
class AchDebit < Stripe::StripeObject
# Type of entity that holds the account. This can be either `individual` or `company`.
sig { returns(T.nilable(String)) }
def account_holder_type; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(T.nilable(String)) }
def country; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# Routing transit number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
end
class AcssDebit < Stripe::StripeObject
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Institution number of the bank account
sig { returns(T.nilable(String)) }
def institution_number; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(String)) }
def mandate; end
# Transit number of the bank account.
sig { returns(T.nilable(String)) }
def transit_number; end
end
class Affirm < Stripe::StripeObject
# ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
sig { returns(T.nilable(String)) }
def location; end
# ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
sig { returns(T.nilable(String)) }
def reader; end
# The Affirm transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class AfterpayClearpay < Stripe::StripeObject
# The Afterpay order ID associated with this payment intent.
sig { returns(T.nilable(String)) }
def order_id; end
# Order identifier shown to the merchant in Afterpay’s online portal.
sig { returns(T.nilable(String)) }
def reference; end
end
class Alipay < Stripe::StripeObject
# Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
sig { returns(T.nilable(String)) }
def buyer_id; end
# Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Transaction ID of this particular Alipay transaction.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Alma < Stripe::StripeObject
class Installments < Stripe::StripeObject
# The number of installments.
sig { returns(Integer) }
def count; end
end
# Attribute for field installments
sig { returns(T.nilable(Installments)) }
def installments; end
# The Alma transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class AmazonPay < Stripe::StripeObject
class Funding < Stripe::StripeObject
class Card < Stripe::StripeObject
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(T.nilable(String)) }
def brand; end
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def brand_product; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# Two-digit number representing the card's expiration month.
sig { returns(T.nilable(Integer)) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(T.nilable(Integer)) }
def exp_year; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# funding type of the underlying payment method.
sig { returns(T.nilable(String)) }
def type; end
end
# Attribute for field funding
sig { returns(T.nilable(Funding)) }
def funding; end
# The Amazon Pay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class AuBecsDebit < Stripe::StripeObject
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(String)) }
def mandate; end
end
class BacsDebit < Stripe::StripeObject
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(String)) }
def mandate; end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
end
class Bancontact < Stripe::StripeObject
# Bank code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_code; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Bank Identifier Code of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bic; end
# The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def generated_sepa_debit; end
# The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def generated_sepa_debit_mandate; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def iban_last4; end
# Preferred language of the Bancontact authorization page that the customer is redirected to.
# Can be one of `en`, `de`, `fr`, or `nl`
sig { returns(T.nilable(String)) }
def preferred_language; end
# Owner's verified full name. Values are verified or provided by Bancontact directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class Billie < Stripe::StripeObject
# The Billie transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class BillingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# A representation of a physical address.
sig { returns(Address) }
def address; end
# The billing email associated with the method of payment.
sig { returns(T.nilable(String)) }
def email; end
# The billing name associated with the method of payment.
sig { returns(T.nilable(String)) }
def name; end
# The billing phone number associated with the method of payment.
sig { returns(T.nilable(String)) }
def phone; end
end
class Blik < Stripe::StripeObject
# A unique and immutable identifier assigned by BLIK to every buyer.
sig { returns(T.nilable(String)) }
def buyer_id; end
end
class Boleto < Stripe::StripeObject
# The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
end
class Card < Stripe::StripeObject
class Checks < Stripe::StripeObject
# Attribute for field address_line1_check
sig { returns(T.nilable(String)) }
def address_line1_check; end
# Attribute for field address_postal_code_check
sig { returns(T.nilable(String)) }
def address_postal_code_check; end
# Attribute for field cvc_check
sig { returns(T.nilable(String)) }
def cvc_check; end
end
class NetworkToken < Stripe::StripeObject
# Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction.
sig { returns(T::Boolean) }
def used; end
end
class ThreeDSecure < Stripe::StripeObject
# Attribute for field authentication_flow
sig { returns(T.nilable(String)) }
def authentication_flow; end
# Attribute for field result
sig { returns(T.nilable(String)) }
def result; end
# Attribute for field result_reason
sig { returns(T.nilable(String)) }
def result_reason; end
# Attribute for field version
sig { returns(T.nilable(String)) }
def version; end
end
class Wallet < Stripe::StripeObject
class ApplePay < Stripe::StripeObject
# Type of the apple_pay transaction, one of `apple_pay` or `apple_pay_later`.
sig { returns(String) }
def type; end
end
class GooglePay < Stripe::StripeObject; end
# Attribute for field apple_pay
sig { returns(T.nilable(ApplePay)) }
def apple_pay; end
# (For tokenized numbers only.) The last four digits of the device account number.
sig { returns(T.nilable(String)) }
def dynamic_last4; end
# Attribute for field google_pay
sig { returns(T.nilable(GooglePay)) }
def google_pay; end
# The type of the card wallet, one of `apple_pay` or `google_pay`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.
sig { returns(String) }
def type; end
end
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(String) }
def brand; end
# When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.
sig { returns(T.nilable(Integer)) }
def capture_before; end
# Check results by Card networks on Card address and CVC at time of payment.
sig { returns(T.nilable(Checks)) }
def checks; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(String) }
def funding; end
# The last four digits of the card.
sig { returns(String) }
def last4; end
# True if this payment was marked as MOTO and out of scope for SCA.
sig { returns(T.nilable(T::Boolean)) }
def moto; end
# Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
sig { returns(T.nilable(String)) }
def network; end
# If this card has network token credentials, this contains the details of the network token credentials.
sig { returns(T.nilable(NetworkToken)) }
def network_token; end
# This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
sig { returns(T.nilable(String)) }
def network_transaction_id; end
# Populated if this transaction used 3D Secure authentication.
sig { returns(T.nilable(ThreeDSecure)) }
def three_d_secure; end
# If this Card is part of a card wallet, this contains the details of the card wallet.
sig { returns(T.nilable(Wallet)) }
def wallet; end
end
class CardPresent < Stripe::StripeObject
class Offline < Stripe::StripeObject
# Time at which the payment was collected while offline
sig { returns(T.nilable(Integer)) }
def stored_at; end
# The method used to process this payment method offline. Only deferred is allowed.
sig { returns(T.nilable(String)) }
def type; end
end
class Receipt < Stripe::StripeObject
# The type of account being debited or credited
sig { returns(T.nilable(String)) }
def account_type; end
# The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.
sig { returns(T.nilable(String)) }
def application_cryptogram; end
# The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip.
sig { returns(T.nilable(String)) }
def application_preferred_name; end
# Identifier for this transaction.
sig { returns(T.nilable(String)) }
def authorization_code; end
# EMV tag 8A. A code returned by the card issuer.
sig { returns(T.nilable(String)) }
def authorization_response_code; end
# Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.
sig { returns(T.nilable(String)) }
def cardholder_verification_method; end
# Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.
sig { returns(T.nilable(String)) }
def dedicated_file_name; end
# A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.
sig { returns(T.nilable(String)) }
def terminal_verification_results; end
# An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.
sig { returns(T.nilable(String)) }
def transaction_status_information; end
end
class Wallet < Stripe::StripeObject
# The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.
sig { returns(String) }
def type; end
end
# The authorized amount
sig { returns(T.nilable(Integer)) }
def amount_authorized; end
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(T.nilable(String)) }
def brand; end
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.
sig { returns(T.nilable(String)) }
def brand_product; end
# When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.
sig { returns(T.nilable(Integer)) }
def capture_before; end
# The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
sig { returns(T.nilable(String)) }
def cardholder_name; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# Authorization response cryptogram.
sig { returns(T.nilable(String)) }
def emv_auth_data; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
sig { returns(T.nilable(String)) }
def generated_card; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
sig { returns(T::Boolean) }
def incremental_authorization_supported; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
# Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
sig { returns(T.nilable(String)) }
def network; end
# This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
sig { returns(T.nilable(String)) }
def network_transaction_id; end
# Details about payments collected offline.
sig { returns(T.nilable(Offline)) }
def offline; end
# Defines whether the authorized amount can be over-captured or not
sig { returns(T::Boolean) }
def overcapture_supported; end
# The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
# How card details were read in this transaction.
sig { returns(T.nilable(String)) }
def read_method; end
# A collection of fields required to be displayed on receipts. Only required for EMV transactions.
sig { returns(T.nilable(Receipt)) }
def receipt; end
# Attribute for field wallet
sig { returns(T.nilable(Wallet)) }
def wallet; end
end
class Cashapp < Stripe::StripeObject
# A unique and immutable identifier assigned by Cash App to every buyer.
sig { returns(T.nilable(String)) }
def buyer_id; end
# A public identifier for buyers using Cash App.
sig { returns(T.nilable(String)) }
def cashtag; end
# A unique and immutable identifier of payments assigned by Cash App
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Crypto < Stripe::StripeObject
# The wallet address of the customer.
sig { returns(T.nilable(String)) }
def buyer_address; end
# The blockchain network that the transaction was sent on.
sig { returns(T.nilable(String)) }
def network; end
# The token currency that the transaction was sent with.
sig { returns(T.nilable(String)) }
def token_currency; end
# The blockchain transaction hash of the crypto payment.
sig { returns(T.nilable(String)) }
def transaction_hash; end
end
class Custom < Stripe::StripeObject
# Display name for the custom (user-defined) payment method type used to make this payment.
sig { returns(String) }
def display_name; end
# The custom payment method type associated with this payment.
sig { returns(T.nilable(String)) }
def type; end
end
class CustomerBalance < Stripe::StripeObject; end
class Eps < Stripe::StripeObject
# The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.
sig { returns(T.nilable(String)) }
def bank; end
# Owner's verified full name. Values are verified or provided by EPS directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
# EPS rarely provides this information so the attribute is usually empty.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class Fpx < Stripe::StripeObject
# Account holder type, if provided. Can be one of `individual` or `company`.
sig { returns(T.nilable(String)) }
def account_holder_type; end
# The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
sig { returns(String) }
def bank; end
# Unique transaction id generated by FPX for every request from the merchant
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Giropay < Stripe::StripeObject
# Bank code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_code; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Bank Identifier Code of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bic; end
# Owner's verified full name. Values are verified or provided by Giropay directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
# Giropay rarely provides this information so the attribute is usually empty.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class Gopay < Stripe::StripeObject; end
class Grabpay < Stripe::StripeObject
# Unique transaction id generated by GrabPay
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class IdBankTransfer < Stripe::StripeObject
# Account number of the bank account to transfer funds to.
sig { returns(String) }
def account_number; end
# Bank where the account is located.
sig { returns(String) }
def bank; end
# Local bank code of the bank.
sig { returns(T.nilable(String)) }
def bank_code; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
sig { returns(T.nilable(String)) }
def display_name; end
end
class Ideal < Stripe::StripeObject
# The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
sig { returns(T.nilable(String)) }
def bank; end
# The Bank Identifier Code of the customer's bank.
sig { returns(T.nilable(String)) }
def bic; end
# The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def generated_sepa_debit; end
# The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def generated_sepa_debit_mandate; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def iban_last4; end
# Owner's verified full name. Values are verified or provided by iDEAL directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class InteracPresent < Stripe::StripeObject
class Receipt < Stripe::StripeObject
# The type of account being debited or credited
sig { returns(T.nilable(String)) }
def account_type; end
# The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.
sig { returns(T.nilable(String)) }
def application_cryptogram; end
# The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip.
sig { returns(T.nilable(String)) }
def application_preferred_name; end
# Identifier for this transaction.
sig { returns(T.nilable(String)) }
def authorization_code; end
# EMV tag 8A. A code returned by the card issuer.
sig { returns(T.nilable(String)) }
def authorization_response_code; end
# Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.
sig { returns(T.nilable(String)) }
def cardholder_verification_method; end
# Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.
sig { returns(T.nilable(String)) }
def dedicated_file_name; end
# A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.
sig { returns(T.nilable(String)) }
def terminal_verification_results; end
# An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.
sig { returns(T.nilable(String)) }
def transaction_status_information; end
end
# Card brand. Can be `interac`, `mastercard` or `visa`.
sig { returns(T.nilable(String)) }
def brand; end
# The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
sig { returns(T.nilable(String)) }
def cardholder_name; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# Authorization response cryptogram.
sig { returns(T.nilable(String)) }
def emv_auth_data; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
sig { returns(T.nilable(String)) }
def generated_card; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
# Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
sig { returns(T.nilable(String)) }
def network; end
# This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
sig { returns(T.nilable(String)) }
def network_transaction_id; end
# The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
# How card details were read in this transaction.
sig { returns(T.nilable(String)) }
def read_method; end
# A collection of fields required to be displayed on receipts. Only required for EMV transactions.
sig { returns(T.nilable(Receipt)) }
def receipt; end
end
class KakaoPay < Stripe::StripeObject
# A unique identifier for the buyer as determined by the local payment processor.
sig { returns(T.nilable(String)) }
def buyer_id; end
# The Kakao Pay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Klarna < Stripe::StripeObject
class PayerDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# The payer address country
sig { returns(T.nilable(String)) }
def country; end
end
# The payer's address
sig { returns(T.nilable(Address)) }
def address; end
end
# The payer details for this transaction.
sig { returns(T.nilable(PayerDetails)) }
def payer_details; end
# The Klarna payment method used for this transaction.
# Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`
sig { returns(T.nilable(String)) }
def payment_method_category; end
# Preferred language of the Klarna authorization page that the customer is redirected to.
# Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`
sig { returns(T.nilable(String)) }
def preferred_locale; end
end
class Konbini < Stripe::StripeObject
class Store < Stripe::StripeObject
# The name of the convenience store chain where the payment was completed.
sig { returns(T.nilable(String)) }
def chain; end
end
# If the payment succeeded, this contains the details of the convenience store where the payment was completed.
sig { returns(T.nilable(Store)) }
def store; end
end
class KrCard < Stripe::StripeObject
# The local credit or debit card brand.
sig { returns(T.nilable(String)) }
def brand; end
# A unique identifier for the buyer as determined by the local payment processor.
sig { returns(T.nilable(String)) }
def buyer_id; end
# The last four digits of the card. This may not be present for American Express cards.
sig { returns(T.nilable(String)) }
def last4; end
# The Korean Card transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Link < Stripe::StripeObject
# Two-letter ISO code representing the funding source country beneath the Link payment.
# You could use this attribute to get a sense of international fees.
sig { returns(T.nilable(String)) }
def country; end
end
class MbWay < Stripe::StripeObject; end
class Mobilepay < Stripe::StripeObject
class Card < Stripe::StripeObject
# Brand of the card used in the transaction
sig { returns(T.nilable(String)) }
def brand; end
# Two-letter ISO code representing the country of the card
sig { returns(T.nilable(String)) }
def country; end
# Two digit number representing the card's expiration month
sig { returns(T.nilable(Integer)) }
def exp_month; end
# Two digit number representing the card's expiration year
sig { returns(T.nilable(Integer)) }
def exp_year; end
# The last 4 digits of the card
sig { returns(T.nilable(String)) }
def last4; end
end
# Internal card details
sig { returns(T.nilable(Card)) }
def card; end
end
class Multibanco < Stripe::StripeObject
# Entity number associated with this Multibanco payment.
sig { returns(T.nilable(String)) }
def entity; end
# Reference number associated with this Multibanco payment.
sig { returns(T.nilable(String)) }
def reference; end
end
class NaverPay < Stripe::StripeObject
# A unique identifier for the buyer as determined by the local payment processor.
sig { returns(T.nilable(String)) }
def buyer_id; end
# The Naver Pay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class NzBankAccount < Stripe::StripeObject
# The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
# The name of the bank.
sig { returns(String) }
def bank_name; end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
# Last four digits of the bank account number.
sig { returns(String) }
def last4; end
# The suffix of the bank account number.
sig { returns(T.nilable(String)) }
def suffix; end
end
class Oxxo < Stripe::StripeObject
# OXXO reference number
sig { returns(T.nilable(String)) }
def number; end
end
class P24 < Stripe::StripeObject
# The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`.
sig { returns(T.nilable(String)) }
def bank; end
# Unique reference for this Przelewy24 payment.
sig { returns(T.nilable(String)) }
def reference; end
# Owner's verified full name. Values are verified or provided by Przelewy24 directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
# Przelewy24 rarely provides this information so the attribute is usually empty.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class PayByBank < Stripe::StripeObject; end
class Payco < Stripe::StripeObject
# A unique identifier for the buyer as determined by the local payment processor.
sig { returns(T.nilable(String)) }
def buyer_id; end
# The Payco transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Paynow < Stripe::StripeObject
# ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
sig { returns(T.nilable(String)) }
def location; end
# ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
sig { returns(T.nilable(String)) }
def reader; end
# Reference number associated with this PayNow payment
sig { returns(T.nilable(String)) }
def reference; end
end
class Paypal < Stripe::StripeObject
class SellerProtection < Stripe::StripeObject
# An array of conditions that are covered for the transaction, if applicable.
sig { returns(T.nilable(T::Array[String])) }
def dispute_categories; end
# Indicates whether the transaction is eligible for PayPal's seller protection.
sig { returns(String) }
def status; end
end
class Shipping < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class VerifiedAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def country; end
# Owner's email. Values are provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def payer_email; end
# PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
sig { returns(T.nilable(String)) }
def payer_id; end
# Owner's full name. Values provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def payer_name; end
# The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.
sig { returns(T.nilable(SellerProtection)) }
def seller_protection; end
# The shipping address for the customer, as supplied by the merchant at the point of payment
# execution. This shipping address will not be updated if the merchant updates the shipping
# address on the PaymentIntent after the PaymentIntent was successfully confirmed.
sig { returns(T.nilable(Shipping)) }
def shipping; end
# A unique ID generated by PayPal for this transaction.
sig { returns(T.nilable(String)) }
def transaction_id; end
# The shipping address for the customer, as supplied by the merchant at the point of payment
# execution. This shipping address will not be updated if the merchant updates the shipping
# address on the PaymentIntent after the PaymentIntent was successfully confirmed.
sig { returns(T.nilable(VerifiedAddress)) }
def verified_address; end
# Owner's verified email. Values are verified or provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_email; end
# Owner's verified full name. Values are verified or provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class Paypay < Stripe::StripeObject; end
class Payto < Stripe::StripeObject
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(String)) }
def mandate; end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
end
class Pix < Stripe::StripeObject
# Unique transaction id generated by BCB
sig { returns(T.nilable(String)) }
def bank_transaction_id; end
# ID of the multi use Mandate generated by the PaymentIntent
sig { returns(T.nilable(String)) }
def mandate; end
end
class Promptpay < Stripe::StripeObject
# Bill reference generated by PromptPay
sig { returns(T.nilable(String)) }
def reference; end
end
class Qris < Stripe::StripeObject; end
class Rechnung < Stripe::StripeObject; end
class RevolutPay < Stripe::StripeObject
class Funding < Stripe::StripeObject
class Card < Stripe::StripeObject
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(T.nilable(String)) }
def brand; end
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def brand_product; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# Two-digit number representing the card's expiration month.
sig { returns(T.nilable(Integer)) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(T.nilable(Integer)) }
def exp_year; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# funding type of the underlying payment method.
sig { returns(T.nilable(String)) }
def type; end
end
# Attribute for field funding
sig { returns(T.nilable(Funding)) }
def funding; end
# The Revolut Pay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class SamsungPay < Stripe::StripeObject
# A unique identifier for the buyer as determined by the local payment processor.
sig { returns(T.nilable(String)) }
def buyer_id; end
# The Samsung Pay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Satispay < Stripe::StripeObject
# The Satispay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class SepaCreditTransfer < Stripe::StripeObject
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Bank Identifier Code of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bic; end
# IBAN of the bank account to transfer funds to.
sig { returns(T.nilable(String)) }
def iban; end
end
class SepaDebit < Stripe::StripeObject
# Bank code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_code; end
# Branch code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def branch_code; end
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(T.nilable(String)) }
def country; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def last4; end
# Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve).
sig { returns(T.nilable(String)) }
def mandate; end
end
class Shopeepay < Stripe::StripeObject; end
class Sofort < Stripe::StripeObject
# Bank code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_code; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Bank Identifier Code of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bic; end
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(T.nilable(String)) }
def country; end
# The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def generated_sepa_debit; end
# The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def generated_sepa_debit_mandate; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def iban_last4; end
# Preferred language of the SOFORT authorization page that the customer is redirected to.
# Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`
sig { returns(T.nilable(String)) }
def preferred_language; end
# Owner's verified full name. Values are verified or provided by SOFORT directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class StripeAccount < Stripe::StripeObject; end
class StripeBalance < Stripe::StripeObject
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(String) }
def source_type; end
end
class Swish < Stripe::StripeObject
# Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer
sig { returns(T.nilable(String)) }
def fingerprint; end
# Payer bank reference number for the payment
sig { returns(T.nilable(String)) }
def payment_reference; end
# The last four digits of the Swish account phone number
sig { returns(T.nilable(String)) }
def verified_phone_last4; end
end
class Twint < Stripe::StripeObject; end
class UsBankAccount < Stripe::StripeObject
# Attribute for field account_holder_type
sig { returns(T.nilable(String)) }
def account_holder_type; end
# Attribute for field account_type
sig { returns(T.nilable(String)) }
def account_type; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def mandate; end
# Reference number to locate ACH payments with customer’s bank.
sig { returns(T.nilable(String)) }
def payment_reference; end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
end
class Wechat < Stripe::StripeObject; end
class WechatPay < Stripe::StripeObject
# Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
sig { returns(T.nilable(String)) }
def location; end
# ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
sig { returns(T.nilable(String)) }
def reader; end
# Transaction ID of this particular WeChat Pay transaction.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Zip < Stripe::StripeObject; end
# Attribute for field ach_credit_transfer
sig { returns(T.nilable(AchCreditTransfer)) }
def ach_credit_transfer; end
# Attribute for field ach_debit
sig { returns(T.nilable(AchDebit)) }
def ach_debit; end
# Attribute for field acss_debit
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# Attribute for field affirm
sig { returns(T.nilable(Affirm)) }
def affirm; end
# Attribute for field afterpay_clearpay
sig { returns(T.nilable(AfterpayClearpay)) }
def afterpay_clearpay; end
# Attribute for field alipay
sig { returns(T.nilable(Alipay)) }
def alipay; end
# Attribute for field alma
sig { returns(T.nilable(Alma)) }
def alma; end
# Attribute for field amazon_pay
sig { returns(T.nilable(AmazonPay)) }
def amazon_pay; end
# Attribute for field au_becs_debit
sig { returns(T.nilable(AuBecsDebit)) }
def au_becs_debit; end
# Attribute for field bacs_debit
sig { returns(T.nilable(BacsDebit)) }
def bacs_debit; end
# Attribute for field bancontact
sig { returns(T.nilable(Bancontact)) }
def bancontact; end
# Attribute for field billie
sig { returns(T.nilable(Billie)) }
def billie; end
# The billing details associated with the method of payment.
sig { returns(T.nilable(BillingDetails)) }
def billing_details; end
# Attribute for field blik
sig { returns(T.nilable(Blik)) }
def blik; end
# Attribute for field boleto
sig { returns(T.nilable(Boleto)) }
def boleto; end
# Details of the card used for this payment attempt.
sig { returns(T.nilable(Card)) }
def card; end
# Attribute for field card_present
sig { returns(T.nilable(CardPresent)) }
def card_present; end
# Attribute for field cashapp
sig { returns(T.nilable(Cashapp)) }
def cashapp; end
# Attribute for field crypto
sig { returns(T.nilable(Crypto)) }
def crypto; end
# Custom Payment Methods represent Payment Method types not modeled directly in
# the Stripe API. This resource consists of details about the custom payment method
# used for this payment attempt.
sig { returns(T.nilable(Custom)) }
def custom; end
# Attribute for field customer_balance
sig { returns(T.nilable(CustomerBalance)) }
def customer_balance; end
# Attribute for field eps
sig { returns(T.nilable(Eps)) }
def eps; end
# Attribute for field fpx
sig { returns(T.nilable(Fpx)) }
def fpx; end
# Attribute for field giropay
sig { returns(T.nilable(Giropay)) }
def giropay; end
# Attribute for field gopay
sig { returns(T.nilable(Gopay)) }
def gopay; end
# Attribute for field grabpay
sig { returns(T.nilable(Grabpay)) }
def grabpay; end
# Attribute for field id_bank_transfer
sig { returns(T.nilable(IdBankTransfer)) }
def id_bank_transfer; end
# Attribute for field ideal
sig { returns(T.nilable(Ideal)) }
def ideal; end
# Attribute for field interac_present
sig { returns(T.nilable(InteracPresent)) }
def interac_present; end
# Attribute for field kakao_pay
sig { returns(T.nilable(KakaoPay)) }
def kakao_pay; end
# Attribute for field klarna
sig { returns(T.nilable(Klarna)) }
def klarna; end
# Attribute for field konbini
sig { returns(T.nilable(Konbini)) }
def konbini; end
# Attribute for field kr_card
sig { returns(T.nilable(KrCard)) }
def kr_card; end
# Attribute for field link
sig { returns(T.nilable(Link)) }
def link; end
# Attribute for field mb_way
sig { returns(T.nilable(MbWay)) }
def mb_way; end
# Attribute for field mobilepay
sig { returns(T.nilable(Mobilepay)) }
def mobilepay; end
# Attribute for field multibanco
sig { returns(T.nilable(Multibanco)) }
def multibanco; end
# Attribute for field naver_pay
sig { returns(T.nilable(NaverPay)) }
def naver_pay; end
# Attribute for field nz_bank_account
sig { returns(T.nilable(NzBankAccount)) }
def nz_bank_account; end
# Attribute for field oxxo
sig { returns(T.nilable(Oxxo)) }
def oxxo; end
# Attribute for field p24
sig { returns(T.nilable(P24)) }
def p24; end
# Attribute for field pay_by_bank
sig { returns(T.nilable(PayByBank)) }
def pay_by_bank; end
# Attribute for field payco
sig { returns(T.nilable(Payco)) }
def payco; end
# ID of the Stripe PaymentMethod used to make this payment.
sig { returns(T.nilable(String)) }
def payment_method; end
# Attribute for field paynow
sig { returns(T.nilable(Paynow)) }
def paynow; end
# Attribute for field paypal
sig { returns(T.nilable(Paypal)) }
def paypal; end
# Attribute for field paypay
sig { returns(T.nilable(Paypay)) }
def paypay; end
# Attribute for field payto
sig { returns(T.nilable(Payto)) }
def payto; end
# Attribute for field pix
sig { returns(T.nilable(Pix)) }
def pix; end
# Attribute for field promptpay
sig { returns(T.nilable(Promptpay)) }
def promptpay; end
# Attribute for field qris
sig { returns(T.nilable(Qris)) }
def qris; end
# Attribute for field rechnung
sig { returns(T.nilable(Rechnung)) }
def rechnung; end
# Attribute for field revolut_pay
sig { returns(T.nilable(RevolutPay)) }
def revolut_pay; end
# Attribute for field samsung_pay
sig { returns(T.nilable(SamsungPay)) }
def samsung_pay; end
# Attribute for field satispay
sig { returns(T.nilable(Satispay)) }
def satispay; end
# Attribute for field sepa_credit_transfer
sig { returns(T.nilable(SepaCreditTransfer)) }
def sepa_credit_transfer; end
# Attribute for field sepa_debit
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# Attribute for field shopeepay
sig { returns(T.nilable(Shopeepay)) }
def shopeepay; end
# Attribute for field sofort
sig { returns(T.nilable(Sofort)) }
def sofort; end
# Attribute for field stripe_account
sig { returns(T.nilable(StripeAccount)) }
def stripe_account; end
# Attribute for field stripe_balance
sig { returns(T.nilable(StripeBalance)) }
def stripe_balance; end
# Attribute for field swish
sig { returns(T.nilable(Swish)) }
def swish; end
# Attribute for field twint
sig { returns(T.nilable(Twint)) }
def twint; end
# The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type) for the full list of possible types.
# An additional hash is included on `payment_method_details` with a name matching this value.
# It contains information specific to the payment method.
sig { returns(String) }
def type; end
# Details of the US Bank Account used for this payment attempt.
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
# Attribute for field wechat
sig { returns(T.nilable(Wechat)) }
def wechat; end
# Attribute for field wechat_pay
sig { returns(T.nilable(WechatPay)) }
def wechat_pay; end
# Attribute for field zip
sig { returns(T.nilable(Zip)) }
def zip; end
end
class ProcessorDetails < Stripe::StripeObject
class Custom < Stripe::StripeObject
# An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
sig { returns(String) }
def payment_reference; end
end
# Custom processors represent payment processors not modeled directly in
# the Stripe API. This resource consists of details about the custom processor
# used for this payment attempt.
sig { returns(T.nilable(Custom)) }
def custom; end
# The processor used for this payment attempt.
sig { returns(String) }
def type; end
end
class ShippingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# A representation of a physical address.
sig { returns(Address) }
def address; end
# The shipping recipient's name.
sig { returns(T.nilable(String)) }
def name; end
# The shipping recipient's phone number.
sig { returns(T.nilable(String)) }
def phone; end
end
# A representation of an amount of money, consisting of an amount and a currency.
sig { returns(Amount) }
def amount; end
# A representation of an amount of money, consisting of an amount and a currency.
sig { returns(AmountAuthorized) }
def amount_authorized; end
# A representation of an amount of money, consisting of an amount and a currency.
sig { returns(AmountCanceled) }
def amount_canceled; end
# A representation of an amount of money, consisting of an amount and a currency.
sig { returns(AmountFailed) }
def amount_failed; end
# A representation of an amount of money, consisting of an amount and a currency.
sig { returns(AmountGuaranteed) }
def amount_guaranteed; end
# A representation of an amount of money, consisting of an amount and a currency.
sig { returns(AmountRefunded) }
def amount_refunded; end
# A representation of an amount of money, consisting of an amount and a currency.
sig { returns(AmountRequested) }
def amount_requested; end
# ID of the Connect application that created the PaymentAttemptRecord.
sig { returns(T.nilable(String)) }
def application; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Customer information for this payment.
sig { returns(T.nilable(CustomerDetails)) }
def customer_details; end
# Indicates whether the customer was present in your checkout flow during this payment.
sig { returns(T.nilable(String)) }
def customer_presence; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Information about the Payment Method debited for this payment.
sig { returns(T.nilable(PaymentMethodDetails)) }
def payment_method_details; end
# ID of the Payment Record this Payment Attempt Record belongs to.
sig { returns(T.nilable(String)) }
def payment_record; end
# Processor information associated with this payment.
sig { returns(ProcessorDetails) }
def processor_details; end
# Indicates who reported the payment.
sig { returns(String) }
def reported_by; end
# Shipping information for this payment.
sig { returns(T.nilable(ShippingDetails)) }
def shipping_details; end
class ListParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The ID of the Payment Record.
sig { returns(String) }
def payment_record; end
sig { params(_payment_record: String).returns(String) }
def payment_record=(_payment_record); end
sig {
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_record: String).void
}
def initialize(expand: nil, limit: nil, payment_record: nil); end
end
# List all the Payment Attempt Records attached to the specified Payment Record.
sig {
params(params: T.any(::Stripe::PaymentAttemptRecord::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
# typed: 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
class AmountDetails < Stripe::StripeObject
class Shipping < Stripe::StripeObject
# Portion of the amount that is for shipping.
sig { returns(T.nilable(Integer)) }
def amount; end
# The postal code that represents the shipping source.
sig { returns(T.nilable(String)) }
def from_postal_code; end
# The postal code that represents the shipping destination.
sig { returns(T.nilable(String)) }
def to_postal_code; end
end
class Tax < Stripe::StripeObject
# Total portion of the amount that is for tax.
sig { returns(T.nilable(Integer)) }
def total_tax_amount; end
end
class Tip < Stripe::StripeObject
# Portion of the amount that corresponds to a tip.
sig { returns(T.nilable(Integer)) }
def amount; end
end
# The total discount applied on the transaction.
sig { returns(T.nilable(Integer)) }
def discount_amount; end
# A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
sig { returns(T.nilable(Stripe::ListObject)) }
def line_items; end
# Attribute for field shipping
sig { returns(T.nilable(Shipping)) }
def shipping; end
# Attribute for field tax
sig { returns(T.nilable(Tax)) }
def tax; end
# Attribute for field tip
sig { returns(T.nilable(Tip)) }
def tip; end
end
class AutomaticPaymentMethods < Stripe::StripeObject
# Controls whether this PaymentIntent will accept redirect-based payment methods.
#
# Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment.
sig { returns(T.nilable(String)) }
def allow_redirects; end
# Automatically calculates compatible payment methods
sig { returns(T::Boolean) }
def enabled; end
end
class Hooks < Stripe::StripeObject
class Inputs < Stripe::StripeObject
class Tax < Stripe::StripeObject
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
sig { returns(String) }
def calculation; end
end
# Attribute for field tax
sig { returns(T.nilable(Tax)) }
def tax; end
end
# Attribute for field inputs
sig { returns(T.nilable(Inputs)) }
def inputs; end
end
class LastPaymentError < Stripe::StripeObject
# For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.
sig { returns(T.nilable(String)) }
def advice_code; end
# For card errors, the ID of the failed charge.
sig { returns(T.nilable(String)) }
def charge; end
# For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
sig { returns(T.nilable(String)) }
def code; end
# For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.
sig { returns(T.nilable(String)) }
def decline_code; end
# A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.
sig { returns(T.nilable(String)) }
def doc_url; end
# A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
sig { returns(T.nilable(String)) }
def message; end
# For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
sig { returns(T.nilable(String)) }
def network_advice_code; end
# For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
sig { returns(T.nilable(String)) }
def network_decline_code; end
# If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
sig { returns(T.nilable(String)) }
def param; end
# 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)
sig { returns(T.nilable(Stripe::PaymentIntent)) }
def payment_intent; end
# 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).
sig { returns(T.nilable(Stripe::PaymentMethod)) }
def payment_method; end
# If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
sig { returns(T.nilable(String)) }
def payment_method_type; end
# A URL to the request log entry in your dashboard.
sig { returns(T.nilable(String)) }
def request_log_url; end
# A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
# For example, you can 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 when you're ready to collect your customer's payment credentials.
# Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
# The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/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) might need to be run through
# [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection
# to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).
# If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),
# it automatically attaches the resulting payment method to that Customer after successful setup.
# 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 to prevent saving invalid or unoptimized payment methods.
#
# By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
#
# Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)
sig { returns(T.nilable(Stripe::SetupIntent)) }
def setup_intent; end
# Attribute for field source
sig {
returns(T.nilable(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source)))
}
def source; end
# The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`
sig { returns(String) }
def type; end
end
class NextAction < Stripe::StripeObject
class AlipayHandleRedirect < Stripe::StripeObject
# The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App.
sig { returns(T.nilable(String)) }
def native_data; end
# The native URL you must redirect your customer to in order to authenticate the payment in an iOS App.
sig { returns(T.nilable(String)) }
def native_url; end
# If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
sig { returns(T.nilable(String)) }
def return_url; end
# The URL you must redirect your customer to in order to authenticate the payment.
sig { returns(T.nilable(String)) }
def url; end
end
class BoletoDisplayDetails < Stripe::StripeObject
# The timestamp after which the boleto expires.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher.
sig { returns(T.nilable(String)) }
def hosted_voucher_url; end
# The boleto number.
sig { returns(T.nilable(String)) }
def number; end
# The URL to the downloadable boleto voucher PDF.
sig { returns(T.nilable(String)) }
def pdf; end
end
class CardAwaitNotification < Stripe::StripeObject
# The time that payment will be attempted. If customer approval is required, they need to provide approval before this time.
sig { returns(T.nilable(Integer)) }
def charge_attempt_at; end
# For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required.
sig { returns(T.nilable(T::Boolean)) }
def customer_approval_required; end
end
class CashappHandleRedirectOrDisplayQrCode < Stripe::StripeObject
class QrCode < Stripe::StripeObject
# The date (unix timestamp) when the QR code expires.
sig { returns(Integer) }
def expires_at; end
# The image_url_png string used to render QR code
sig { returns(String) }
def image_url_png; end
# The image_url_svg string used to render QR code
sig { returns(String) }
def image_url_svg; end
end
# The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.
sig { returns(String) }
def hosted_instructions_url; end
# The url for mobile redirect based auth
sig { returns(String) }
def mobile_auth_url; end
# Attribute for field qr_code
sig { returns(QrCode) }
def qr_code; end
end
class DisplayBankTransferInstructions < Stripe::StripeObject
class FinancialAddress < Stripe::StripeObject
class Aba < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field account_holder_address
sig { returns(AccountHolderAddress) }
def account_holder_address; end
# The account holder name
sig { returns(String) }
def account_holder_name; end
# The ABA account number
sig { returns(String) }
def account_number; end
# The account type
sig { returns(String) }
def account_type; end
# Attribute for field bank_address
sig { returns(BankAddress) }
def bank_address; end
# The bank name
sig { returns(String) }
def bank_name; end
# The ABA routing number
sig { returns(String) }
def routing_number; end
end
class Iban < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field account_holder_address
sig { returns(AccountHolderAddress) }
def account_holder_address; end
# The name of the person or business that owns the bank account
sig { returns(String) }
def account_holder_name; end
# Attribute for field bank_address
sig { returns(BankAddress) }
def bank_address; end
# The BIC/SWIFT code of the account.
sig { returns(String) }
def bic; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
# The IBAN of the account.
sig { returns(String) }
def iban; end
end
class SortCode < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field account_holder_address
sig { returns(AccountHolderAddress) }
def account_holder_address; end
# The name of the person or business that owns the bank account
sig { returns(String) }
def account_holder_name; end
# The account number
sig { returns(String) }
def account_number; end
# Attribute for field bank_address
sig { returns(BankAddress) }
def bank_address; end
# The six-digit sort code
sig { returns(String) }
def sort_code; end
end
class Spei < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field account_holder_address
sig { returns(AccountHolderAddress) }
def account_holder_address; end
# The account holder name
sig { returns(String) }
def account_holder_name; end
# Attribute for field bank_address
sig { returns(BankAddress) }
def bank_address; end
# The three-digit bank code
sig { returns(String) }
def bank_code; end
# The short banking institution name
sig { returns(String) }
def bank_name; end
# The CLABE number
sig { returns(String) }
def clabe; end
end
class Swift < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field account_holder_address
sig { returns(AccountHolderAddress) }
def account_holder_address; end
# The account holder name
sig { returns(String) }
def account_holder_name; end
# The account number
sig { returns(String) }
def account_number; end
# The account type
sig { returns(String) }
def account_type; end
# Attribute for field bank_address
sig { returns(BankAddress) }
def bank_address; end
# The bank name
sig { returns(String) }
def bank_name; end
# The SWIFT code
sig { returns(String) }
def swift_code; end
end
class Zengin < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field account_holder_address
sig { returns(AccountHolderAddress) }
def account_holder_address; end
# The account holder name
sig { returns(T.nilable(String)) }
def account_holder_name; end
# The account number
sig { returns(T.nilable(String)) }
def account_number; end
# The bank account type. In Japan, this can only be `futsu` or `toza`.
sig { returns(T.nilable(String)) }
def account_type; end
# Attribute for field bank_address
sig { returns(BankAddress) }
def bank_address; end
# The bank code of the account
sig { returns(T.nilable(String)) }
def bank_code; end
# The bank name of the account
sig { returns(T.nilable(String)) }
def bank_name; end
# The branch code of the account
sig { returns(T.nilable(String)) }
def branch_code; end
# The branch name of the account
sig { returns(T.nilable(String)) }
def branch_name; end
end
# ABA Records contain U.S. bank account details per the ABA format.
sig { returns(T.nilable(Aba)) }
def aba; end
# Iban Records contain E.U. bank account details per the SEPA format.
sig { returns(T.nilable(Iban)) }
def iban; end
# Sort Code Records contain U.K. bank account details per the sort code format.
sig { returns(T.nilable(SortCode)) }
def sort_code; end
# SPEI Records contain Mexico bank account details per the SPEI format.
sig { returns(T.nilable(Spei)) }
def spei; end
# The payment networks supported by this FinancialAddress
sig { returns(T.nilable(T::Array[String])) }
def supported_networks; end
# SWIFT Records contain U.S. bank account details per the SWIFT format.
sig { returns(T.nilable(Swift)) }
def swift; end
# The type of financial address
sig { returns(String) }
def type; end
# Zengin Records contain Japan bank account details per the Zengin format.
sig { returns(T.nilable(Zengin)) }
def zengin; end
end
# The remaining amount that needs to be transferred to complete the payment.
sig { returns(T.nilable(Integer)) }
def amount_remaining; end
# 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(T.nilable(String)) }
def currency; end
# A list of financial addresses that can be used to fund the customer balance
sig { returns(T.nilable(T::Array[FinancialAddress])) }
def financial_addresses; end
# A link to a hosted page that guides your customer through completing the transfer.
sig { returns(T.nilable(String)) }
def hosted_instructions_url; end
# A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer.
sig { returns(T.nilable(String)) }
def reference; end
# Type of bank transfer
sig { returns(String) }
def type; end
end
class KonbiniDisplayDetails < Stripe::StripeObject
class Stores < Stripe::StripeObject
class Familymart < Stripe::StripeObject
# The confirmation number.
sig { returns(T.nilable(String)) }
def confirmation_number; end
# The payment code.
sig { returns(String) }
def payment_code; end
end
class Lawson < Stripe::StripeObject
# The confirmation number.
sig { returns(T.nilable(String)) }
def confirmation_number; end
# The payment code.
sig { returns(String) }
def payment_code; end
end
class Ministop < Stripe::StripeObject
# The confirmation number.
sig { returns(T.nilable(String)) }
def confirmation_number; end
# The payment code.
sig { returns(String) }
def payment_code; end
end
class Seicomart < Stripe::StripeObject
# The confirmation number.
sig { returns(T.nilable(String)) }
def confirmation_number; end
# The payment code.
sig { returns(String) }
def payment_code; end
end
# FamilyMart instruction details.
sig { returns(T.nilable(Familymart)) }
def familymart; end
# Lawson instruction details.
sig { returns(T.nilable(Lawson)) }
def lawson; end
# Ministop instruction details.
sig { returns(T.nilable(Ministop)) }
def ministop; end
# Seicomart instruction details.
sig { returns(T.nilable(Seicomart)) }
def seicomart; end
end
# The timestamp at which the pending Konbini payment expires.
sig { returns(Integer) }
def expires_at; end
# The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher.
sig { returns(T.nilable(String)) }
def hosted_voucher_url; end
# Attribute for field stores
sig { returns(Stores) }
def stores; end
end
class MultibancoDisplayDetails < Stripe::StripeObject
# Entity number associated with this Multibanco payment.
sig { returns(T.nilable(String)) }
def entity; end
# The timestamp at which the Multibanco voucher expires.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher.
sig { returns(T.nilable(String)) }
def hosted_voucher_url; end
# Reference number associated with this Multibanco payment.
sig { returns(T.nilable(String)) }
def reference; end
end
class OxxoDisplayDetails < Stripe::StripeObject
# The timestamp after which the OXXO voucher expires.
sig { returns(T.nilable(Integer)) }
def expires_after; end
# The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher.
sig { returns(T.nilable(String)) }
def hosted_voucher_url; end
# OXXO reference number.
sig { returns(T.nilable(String)) }
def number; end
end
class PaynowDisplayQrCode < Stripe::StripeObject
# The raw data string used to generate QR code, it should be used together with QR code library.
sig { returns(String) }
def data; end
# The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code.
sig { returns(T.nilable(String)) }
def hosted_instructions_url; end
# The image_url_png string used to render QR code
sig { returns(String) }
def image_url_png; end
# The image_url_svg string used to render QR code
sig { returns(String) }
def image_url_svg; end
end
class PixDisplayQrCode < Stripe::StripeObject
# The raw data string used to generate QR code, it should be used together with QR code library.
sig { returns(T.nilable(String)) }
def data; end
# The date (unix timestamp) when the PIX expires.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# The URL to the hosted pix instructions page, which allows customers to view the pix QR code.
sig { returns(T.nilable(String)) }
def hosted_instructions_url; end
# The image_url_png string used to render png QR code
sig { returns(T.nilable(String)) }
def image_url_png; end
# The image_url_svg string used to render svg QR code
sig { returns(T.nilable(String)) }
def image_url_svg; end
end
class PromptpayDisplayQrCode < Stripe::StripeObject
# The raw data string used to generate QR code, it should be used together with QR code library.
sig { returns(String) }
def data; end
# The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code.
sig { returns(String) }
def hosted_instructions_url; end
# The PNG path used to render the QR code, can be used as the source in an HTML img tag
sig { returns(String) }
def image_url_png; end
# The SVG path used to render the QR code, can be used as the source in an HTML img tag
sig { returns(String) }
def image_url_svg; end
end
class RedirectToUrl < Stripe::StripeObject
# If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
sig { returns(T.nilable(String)) }
def return_url; end
# The URL you must redirect your customer to in order to authenticate the payment.
sig { returns(T.nilable(String)) }
def url; end
end
class SwishHandleRedirectOrDisplayQrCode < Stripe::StripeObject
class QrCode < Stripe::StripeObject
# The raw data string used to generate QR code, it should be used together with QR code library.
sig { returns(String) }
def data; end
# The image_url_png string used to render QR code
sig { returns(String) }
def image_url_png; end
# The image_url_svg string used to render QR code
sig { returns(String) }
def image_url_svg; end
end
# The URL to the hosted Swish instructions page, which allows customers to view the QR code.
sig { returns(String) }
def hosted_instructions_url; end
# The url for mobile redirect based auth (for internal use only and not typically available in standard API requests).
sig { returns(String) }
def mobile_auth_url; end
# Attribute for field qr_code
sig { returns(QrCode) }
def qr_code; end
end
class VerifyWithMicrodeposits < Stripe::StripeObject
# The timestamp when the microdeposits are expected to land.
sig { returns(Integer) }
def arrival_date; end
# The URL for the hosted verification page, which allows customers to verify their bank account.
sig { returns(String) }
def hosted_verification_url; end
# The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
sig { returns(T.nilable(String)) }
def microdeposit_type; end
end
class WechatPayDisplayQrCode < Stripe::StripeObject
# The data being used to generate QR code
sig { returns(String) }
def data; end
# The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code.
sig { returns(String) }
def hosted_instructions_url; end
# The base64 image data for a pre-generated QR code
sig { returns(String) }
def image_data_url; end
# The image_url_png string used to render QR code
sig { returns(String) }
def image_url_png; end
# The image_url_svg string used to render QR code
sig { returns(String) }
def image_url_svg; end
end
class WechatPayRedirectToAndroidApp < Stripe::StripeObject
# app_id is the APP ID registered on WeChat open platform
sig { returns(String) }
def app_id; end
# nonce_str is a random string
sig { returns(String) }
def nonce_str; end
# package is static value
sig { returns(String) }
def package; end
# an unique merchant ID assigned by WeChat Pay
sig { returns(String) }
def partner_id; end
# an unique trading ID assigned by WeChat Pay
sig { returns(String) }
def prepay_id; end
# A signature
sig { returns(String) }
def sign; end
# Specifies the current time in epoch format
sig { returns(String) }
def timestamp; end
end
class WechatPayRedirectToIosApp < Stripe::StripeObject
# An universal link that redirect to WeChat Pay app
sig { returns(String) }
def native_url; end
end
# Attribute for field alipay_handle_redirect
sig { returns(T.nilable(AlipayHandleRedirect)) }
def alipay_handle_redirect; end
# Attribute for field boleto_display_details
sig { returns(T.nilable(BoletoDisplayDetails)) }
def boleto_display_details; end
# Attribute for field card_await_notification
sig { returns(T.nilable(CardAwaitNotification)) }
def card_await_notification; end
# Attribute for field cashapp_handle_redirect_or_display_qr_code
sig { returns(T.nilable(CashappHandleRedirectOrDisplayQrCode)) }
def cashapp_handle_redirect_or_display_qr_code; end
# Attribute for field display_bank_transfer_instructions
sig { returns(T.nilable(DisplayBankTransferInstructions)) }
def display_bank_transfer_instructions; end
# Attribute for field konbini_display_details
sig { returns(T.nilable(KonbiniDisplayDetails)) }
def konbini_display_details; end
# Attribute for field multibanco_display_details
sig { returns(T.nilable(MultibancoDisplayDetails)) }
def multibanco_display_details; end
# Attribute for field oxxo_display_details
sig { returns(T.nilable(OxxoDisplayDetails)) }
def oxxo_display_details; end
# Attribute for field paynow_display_qr_code
sig { returns(T.nilable(PaynowDisplayQrCode)) }
def paynow_display_qr_code; end
# Attribute for field pix_display_qr_code
sig { returns(T.nilable(PixDisplayQrCode)) }
def pix_display_qr_code; end
# Attribute for field promptpay_display_qr_code
sig { returns(T.nilable(PromptpayDisplayQrCode)) }
def promptpay_display_qr_code; end
# Attribute for field redirect_to_url
sig { returns(T.nilable(RedirectToUrl)) }
def redirect_to_url; end
# Attribute for field swish_handle_redirect_or_display_qr_code
sig { returns(T.nilable(SwishHandleRedirectOrDisplayQrCode)) }
def swish_handle_redirect_or_display_qr_code; end
# Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.
sig { returns(String) }
def type; end
# When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.
sig { returns(T.nilable(T::Hash[String, T.untyped])) }
def use_stripe_sdk; end
# Attribute for field verify_with_microdeposits
sig { returns(T.nilable(VerifyWithMicrodeposits)) }
def verify_with_microdeposits; end
# Attribute for field wechat_pay_display_qr_code
sig { returns(T.nilable(WechatPayDisplayQrCode)) }
def wechat_pay_display_qr_code; end
# Attribute for field wechat_pay_redirect_to_android_app
sig { returns(T.nilable(WechatPayRedirectToAndroidApp)) }
def wechat_pay_redirect_to_android_app; end
# Attribute for field wechat_pay_redirect_to_ios_app
sig { returns(T.nilable(WechatPayRedirectToIosApp)) }
def wechat_pay_redirect_to_ios_app; end
end
class PaymentDetails < Stripe::StripeObject
class CarRental < Stripe::StripeObject
class Affiliate < Stripe::StripeObject
# The name of the affiliate that originated the purchase.
sig { returns(T.nilable(String)) }
def name; end
end
class Delivery < Stripe::StripeObject
class Recipient < Stripe::StripeObject
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
# Attribute for field recipient
sig { returns(T.nilable(Recipient)) }
def recipient; end
end
class Distance < Stripe::StripeObject
# Distance traveled.
sig { returns(T.nilable(Integer)) }
def amount; end
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`
sig { returns(T.nilable(String)) }
def unit; end
end
class Driver < Stripe::StripeObject
# Driver's identification number.
sig { returns(T.nilable(String)) }
def driver_identification_number; end
# Driver's tax number.
sig { returns(T.nilable(String)) }
def driver_tax_number; end
# Full name of the driver on the reservation.
sig { returns(T.nilable(String)) }
def name; end
end
class PickupAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class ReturnAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field affiliate
sig { returns(T.nilable(Affiliate)) }
def affiliate; end
# The booking number associated with the car rental.
sig { returns(String) }
def booking_number; end
# Class code of the car.
sig { returns(T.nilable(String)) }
def car_class_code; end
# Make of the car.
sig { returns(T.nilable(String)) }
def car_make; end
# Model of the car.
sig { returns(T.nilable(String)) }
def car_model; end
# The name of the rental car company.
sig { returns(T.nilable(String)) }
def company; end
# The customer service phone number of the car rental company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
# Number of days the car is being rented.
sig { returns(Integer) }
def days_rented; end
# Attribute for field delivery
sig { returns(T.nilable(Delivery)) }
def delivery; end
# Attribute for field distance
sig { returns(T.nilable(Distance)) }
def distance; end
# The details of the drivers associated with the trip.
sig { returns(T.nilable(T::Array[Driver])) }
def drivers; end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
# Indicates if the customer did not keep nor cancel their booking.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
# Attribute for field pickup_address
sig { returns(T.nilable(PickupAddress)) }
def pickup_address; end
# Car pick-up time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def pickup_at; end
# Name of the pickup location.
sig { returns(T.nilable(String)) }
def pickup_location_name; end
# Rental rate.
sig { returns(T.nilable(Integer)) }
def rate_amount; end
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
sig { returns(T.nilable(String)) }
def rate_interval; end
# The full name of the person or entity renting the car.
sig { returns(T.nilable(String)) }
def renter_name; end
# Attribute for field return_address
sig { returns(T.nilable(ReturnAddress)) }
def return_address; end
# Car return time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def return_at; end
# Name of the return location.
sig { returns(T.nilable(String)) }
def return_location_name; end
# Indicates whether the goods or services are tax-exempt or tax is not collected.
sig { returns(T.nilable(T::Boolean)) }
def tax_exempt; end
# The vehicle identification number of the car.
sig { returns(T.nilable(String)) }
def vehicle_identification_number; end
end
class EventDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class Affiliate < Stripe::StripeObject
# The name of the affiliate that originated the purchase.
sig { returns(T.nilable(String)) }
def name; end
end
class Delivery < Stripe::StripeObject
class Recipient < Stripe::StripeObject
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
# Attribute for field recipient
sig { returns(T.nilable(Recipient)) }
def recipient; end
end
# Indicates if the tickets are digitally checked when entering the venue.
sig { returns(T.nilable(T::Boolean)) }
def access_controlled_venue; end
# Attribute for field address
sig { returns(T.nilable(Address)) }
def address; end
# Attribute for field affiliate
sig { returns(T.nilable(Affiliate)) }
def affiliate; end
# The name of the company
sig { returns(T.nilable(String)) }
def company; end
# Attribute for field delivery
sig { returns(T.nilable(Delivery)) }
def delivery; end
# Event end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
# Type of the event entertainment (concert, sports event etc)
sig { returns(T.nilable(String)) }
def genre; end
# The name of the event.
sig { returns(T.nilable(String)) }
def name; end
# Event start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
end
class Subscription < Stripe::StripeObject
class Affiliate < Stripe::StripeObject
# The name of the affiliate that originated the purchase.
sig { returns(T.nilable(String)) }
def name; end
end
class BillingInterval < Stripe::StripeObject
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(T.nilable(Integer)) }
def count; end
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(T.nilable(String)) }
def interval; end
end
# Attribute for field affiliate
sig { returns(T.nilable(Affiliate)) }
def affiliate; end
# Info whether the subscription will be auto renewed upon expiry.
sig { returns(T.nilable(T::Boolean)) }
def auto_renewal; end
# Attribute for field billing_interval
sig { returns(T.nilable(BillingInterval)) }
def billing_interval; end
# Subscription end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
# Name of the product on subscription. e.g. Apple Music Subscription.
sig { returns(T.nilable(String)) }
def name; end
# Subscription start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
end
# Attribute for field car_rental
sig { returns(T.nilable(CarRental)) }
def car_rental; end
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
sig { returns(T.nilable(String)) }
def customer_reference; end
# Attribute for field event_details
sig { returns(T.nilable(EventDetails)) }
def event_details; end
# A unique value assigned by the business to identify the transaction.
sig { returns(T.nilable(String)) }
def order_reference; end
# Attribute for field subscription
sig { returns(T.nilable(Subscription)) }
def subscription; end
end
class PaymentMethodConfigurationDetails < Stripe::StripeObject
# ID of the payment method configuration used.
sig { returns(String) }
def id; end
# ID of the parent payment method configuration used.
sig { returns(T.nilable(String)) }
def parent; end
end
class PaymentMethodOptions < Stripe::StripeObject
class AcssDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# A URL for custom mandate text
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
# Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
end
class Affirm < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# Preferred language of the Affirm authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class AfterpayClearpay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.
# This field differs from the statement descriptor and item name.
sig { returns(T.nilable(String)) }
def reference; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Alipay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Alma < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
end
class AmazonPay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class AuBecsDebit < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
end
class BacsDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
end
class Bancontact < Stripe::StripeObject
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(String) }
def preferred_language; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Billie < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
end
class Blik < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Boleto < Stripe::StripeObject
# The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.
sig { returns(Integer) }
def expires_after_days; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Card < Stripe::StripeObject
class Installments < Stripe::StripeObject
class AvailablePlan < Stripe::StripeObject
# For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.
sig { returns(T.nilable(Integer)) }
def count; end
# For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.
# One of `month`.
sig { returns(T.nilable(String)) }
def interval; end
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
sig { returns(String) }
def type; end
end
class Plan < Stripe::StripeObject
# For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.
sig { returns(T.nilable(Integer)) }
def count; end
# For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.
# One of `month`.
sig { returns(T.nilable(String)) }
def interval; end
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
sig { returns(String) }
def type; end
end
# Installment plans that may be selected for this PaymentIntent.
sig { returns(T.nilable(T::Array[AvailablePlan])) }
def available_plans; end
# Whether Installments are enabled for this PaymentIntent.
sig { returns(T::Boolean) }
def enabled; end
# Installment plan selected for this PaymentIntent.
sig { returns(T.nilable(Plan)) }
def plan; end
end
class MandateOptions < Stripe::StripeObject
# Amount to be charged for future payments.
sig { returns(Integer) }
def amount; end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(String) }
def amount_type; end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
sig { returns(String) }
def interval; end
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
sig { returns(T.nilable(Integer)) }
def interval_count; end
# Unique identifier for the mandate or subscription.
sig { returns(String) }
def reference; end
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
sig { returns(Integer) }
def start_date; end
# Specifies the type of mandates supported. Possible values are `india`.
sig { returns(T.nilable(T::Array[String])) }
def supported_types; end
end
class StatementDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(T.nilable(Address)) }
def address; end
# Phone number
sig { returns(T.nilable(String)) }
def phone; end
end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# Installment details for this payment.
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
sig { returns(T.nilable(Installments)) }
def installments; end
# Configuration options for setting up an eMandate for cards issued in India.
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
# Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_decremental_authorization; end
# Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_extended_authorization; end
# Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_incremental_authorization; end
# Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_multicapture; end
# Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_overcapture; end
# Request partial authorization on this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_partial_authorization; end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
# When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).
sig { returns(T.nilable(T::Boolean)) }
def require_cvc_recollection; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kana; end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kanji; end
# Attribute for field statement_details
sig { returns(T.nilable(StatementDetails)) }
def statement_details; end
end
class CardPresent < Stripe::StripeObject
class Routing < Stripe::StripeObject
# Requested routing priority
sig { returns(T.nilable(String)) }
def requested_priority; end
end
# Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)
sig { returns(T.nilable(T::Boolean)) }
def request_extended_authorization; end
# Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
sig { returns(T.nilable(T::Boolean)) }
def request_incremental_authorization_support; end
# Attribute for field routing
sig { returns(T.nilable(Routing)) }
def routing; end
end
class Cashapp < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Crypto < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class CustomerBalance < Stripe::StripeObject
class BankTransfer < Stripe::StripeObject
class EuBankTransfer < Stripe::StripeObject
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
end
# Attribute for field eu_bank_transfer
sig { returns(T.nilable(EuBankTransfer)) }
def eu_bank_transfer; end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
# The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(T.nilable(String)) }
def type; end
end
# Attribute for field bank_transfer
sig { returns(T.nilable(BankTransfer)) }
def bank_transfer; end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Eps < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Fpx < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Giropay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Gopay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Grabpay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class IdBankTransfer < Stripe::StripeObject
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now till 2678400 seconds (31 days) from now.
sig { returns(T.nilable(Integer)) }
def expires_after; end
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now until 30 days from now. If unset, it defaults to 1 days from now.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Ideal < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class InteracPresent < Stripe::StripeObject; end
class KakaoPay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Klarna < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# Preferred locale of the Klarna checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Konbini < Stripe::StripeObject
# An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores.
sig { returns(T.nilable(String)) }
def confirmation_number; end
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
# The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# A product descriptor of up to 22 characters, which will appear to customers at the convenience store.
sig { returns(T.nilable(String)) }
def product_description; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class KrCard < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Link < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class MbWay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Mobilepay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Multibanco < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class NaverPay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class NzBankAccount < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
end
class Oxxo < Stripe::StripeObject
# The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
sig { returns(Integer) }
def expires_after_days; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class P24 < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class PayByBank < Stripe::StripeObject; end
class Payco < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
end
class Paynow < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Paypal < Stripe::StripeObject
class LineItem < Stripe::StripeObject
class Tax < Stripe::StripeObject
# The tax for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def amount; end
# The tax behavior for the line item.
sig { returns(String) }
def behavior; end
end
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
# Descriptive name of the line item.
sig { returns(String) }
def name; end
# Quantity of the line item. Cannot be a negative number.
sig { returns(Integer) }
def quantity; end
# Client facing stock keeping unit, article number or similar.
sig { returns(T.nilable(String)) }
def sku; end
# The Stripe account ID of the connected account that sells the item. This is only needed when using [Separate Charges and Transfers](https://docs.stripe.com/connect/separate-charges-and-transfers).
sig { returns(T.nilable(String)) }
def sold_by; end
# Attribute for field tax
sig { returns(T.nilable(Tax)) }
def tax; end
# Price for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def unit_amount; end
end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# The line items purchased by the customer.
sig { returns(T.nilable(T::Array[LineItem])) }
def line_items; end
# Preferred locale of the PayPal checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference; end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference_id; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
end
class Paypay < Stripe::StripeObject; end
class Payto < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Pix < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
# Determines if the amount includes the IOF tax.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
# Type of amount.
sig { returns(T.nilable(String)) }
def amount_type; end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
sig { returns(T.nilable(String)) }
def currency; end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
sig { returns(T.nilable(String)) }
def end_date; end
# Schedule at which the future payments will be charged.
sig { returns(T.nilable(String)) }
def payment_schedule; end
# Subscription name displayed to buyers in their bank app.
sig { returns(T.nilable(String)) }
def reference; end
# Start date of the mandate, in `YYYY-MM-DD`.
sig { returns(T.nilable(String)) }
def start_date; end
end
# Determines if the amount includes the IOF tax.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
# The number of seconds (between 10 and 1209600) after which Pix payment will expire.
sig { returns(T.nilable(Integer)) }
def expires_after_seconds; end
# The timestamp at which the Pix expires.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Promptpay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Qris < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Rechnung < Stripe::StripeObject; end
class RevolutPay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class SamsungPay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
end
class Satispay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
end
class SepaDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
end
class Shopeepay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Sofort < Stripe::StripeObject
# Preferred language of the SOFORT authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class StripeBalance < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Swish < Stripe::StripeObject
# A reference for this payment to be displayed in the Swish app.
sig { returns(T.nilable(String)) }
def reference; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Twint < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class UsBankAccount < Stripe::StripeObject
class FinancialConnections < Stripe::StripeObject
class Filters < Stripe::StripeObject
# The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
# The institution to use to filter for possible accounts to link.
sig { returns(T.nilable(String)) }
def institution; end
end
class ManualEntry < Stripe::StripeObject
# Settings for configuring manual entry of account details.
sig { returns(T.nilable(String)) }
def mode; end
end
# Attribute for field filters
sig { returns(T.nilable(Filters)) }
def filters; end
# Attribute for field manual_entry
sig { returns(T.nilable(ManualEntry)) }
def manual_entry; end
# The list of permissions to request. The `payment_method` permission must be included.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
# Data features requested to be retrieved upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
end
class MandateOptions < Stripe::StripeObject
# Mandate collection method
sig { returns(T.nilable(String)) }
def collection_method; end
end
# Attribute for field financial_connections
sig { returns(T.nilable(FinancialConnections)) }
def financial_connections; end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Preferred transaction settlement speed
sig { returns(T.nilable(String)) }
def preferred_settlement_speed; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
end
class WechatPay < Stripe::StripeObject
# The app ID registered with WeChat Pay. Only required when client is ios or android.
sig { returns(T.nilable(String)) }
def app_id; end
# The client type that the end customer will pay from
sig { returns(T.nilable(String)) }
def client; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
class Zip < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
end
# Attribute for field acss_debit
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# Attribute for field affirm
sig { returns(T.nilable(Affirm)) }
def affirm; end
# Attribute for field afterpay_clearpay
sig { returns(T.nilable(AfterpayClearpay)) }
def afterpay_clearpay; end
# Attribute for field alipay
sig { returns(T.nilable(Alipay)) }
def alipay; end
# Attribute for field alma
sig { returns(T.nilable(Alma)) }
def alma; end
# Attribute for field amazon_pay
sig { returns(T.nilable(AmazonPay)) }
def amazon_pay; end
# Attribute for field au_becs_debit
sig { returns(T.nilable(AuBecsDebit)) }
def au_becs_debit; end
# Attribute for field bacs_debit
sig { returns(T.nilable(BacsDebit)) }
def bacs_debit; end
# Attribute for field bancontact
sig { returns(T.nilable(Bancontact)) }
def bancontact; end
# Attribute for field billie
sig { returns(T.nilable(Billie)) }
def billie; end
# Attribute for field blik
sig { returns(T.nilable(Blik)) }
def blik; end
# Attribute for field boleto
sig { returns(T.nilable(Boleto)) }
def boleto; end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# Attribute for field card_present
sig { returns(T.nilable(CardPresent)) }
def card_present; end
# Attribute for field cashapp
sig { returns(T.nilable(Cashapp)) }
def cashapp; end
# Attribute for field crypto
sig { returns(T.nilable(Crypto)) }
def crypto; end
# Attribute for field customer_balance
sig { returns(T.nilable(CustomerBalance)) }
def customer_balance; end
# Attribute for field eps
sig { returns(T.nilable(Eps)) }
def eps; end
# Attribute for field fpx
sig { returns(T.nilable(Fpx)) }
def fpx; end
# Attribute for field giropay
sig { returns(T.nilable(Giropay)) }
def giropay; end
# Attribute for field gopay
sig { returns(T.nilable(Gopay)) }
def gopay; end
# Attribute for field grabpay
sig { returns(T.nilable(Grabpay)) }
def grabpay; end
# Attribute for field id_bank_transfer
sig { returns(T.nilable(IdBankTransfer)) }
def id_bank_transfer; end
# Attribute for field ideal
sig { returns(T.nilable(Ideal)) }
def ideal; end
# Attribute for field interac_present
sig { returns(T.nilable(InteracPresent)) }
def interac_present; end
# Attribute for field kakao_pay
sig { returns(T.nilable(KakaoPay)) }
def kakao_pay; end
# Attribute for field klarna
sig { returns(T.nilable(Klarna)) }
def klarna; end
# Attribute for field konbini
sig { returns(T.nilable(Konbini)) }
def konbini; end
# Attribute for field kr_card
sig { returns(T.nilable(KrCard)) }
def kr_card; end
# Attribute for field link
sig { returns(T.nilable(Link)) }
def link; end
# Attribute for field mb_way
sig { returns(T.nilable(MbWay)) }
def mb_way; end
# Attribute for field mobilepay
sig { returns(T.nilable(Mobilepay)) }
def mobilepay; end
# Attribute for field multibanco
sig { returns(T.nilable(Multibanco)) }
def multibanco; end
# Attribute for field naver_pay
sig { returns(T.nilable(NaverPay)) }
def naver_pay; end
# Attribute for field nz_bank_account
sig { returns(T.nilable(NzBankAccount)) }
def nz_bank_account; end
# Attribute for field oxxo
sig { returns(T.nilable(Oxxo)) }
def oxxo; end
# Attribute for field p24
sig { returns(T.nilable(P24)) }
def p24; end
# Attribute for field pay_by_bank
sig { returns(T.nilable(PayByBank)) }
def pay_by_bank; end
# Attribute for field payco
sig { returns(T.nilable(Payco)) }
def payco; end
# Attribute for field paynow
sig { returns(T.nilable(Paynow)) }
def paynow; end
# Attribute for field paypal
sig { returns(T.nilable(Paypal)) }
def paypal; end
# Attribute for field paypay
sig { returns(T.nilable(Paypay)) }
def paypay; end
# Attribute for field payto
sig { returns(T.nilable(Payto)) }
def payto; end
# Attribute for field pix
sig { returns(T.nilable(Pix)) }
def pix; end
# Attribute for field promptpay
sig { returns(T.nilable(Promptpay)) }
def promptpay; end
# Attribute for field qris
sig { returns(T.nilable(Qris)) }
def qris; end
# Attribute for field rechnung
sig { returns(T.nilable(Rechnung)) }
def rechnung; end
# Attribute for field revolut_pay
sig { returns(T.nilable(RevolutPay)) }
def revolut_pay; end
# Attribute for field samsung_pay
sig { returns(T.nilable(SamsungPay)) }
def samsung_pay; end
# Attribute for field satispay
sig { returns(T.nilable(Satispay)) }
def satispay; end
# Attribute for field sepa_debit
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# Attribute for field shopeepay
sig { returns(T.nilable(Shopeepay)) }
def shopeepay; end
# Attribute for field sofort
sig { returns(T.nilable(Sofort)) }
def sofort; end
# Attribute for field stripe_balance
sig { returns(T.nilable(StripeBalance)) }
def stripe_balance; end
# Attribute for field swish
sig { returns(T.nilable(Swish)) }
def swish; end
# Attribute for field twint
sig { returns(T.nilable(Twint)) }
def twint; end
# Attribute for field us_bank_account
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
# Attribute for field wechat_pay
sig { returns(T.nilable(WechatPay)) }
def wechat_pay; end
# Attribute for field zip
sig { returns(T.nilable(Zip)) }
def zip; end
end
class PresentmentDetails < Stripe::StripeObject
# Amount intended to be collected by this payment, denominated in `presentment_currency`.
sig { returns(Integer) }
def presentment_amount; end
# Currency presented to the customer during payment.
sig { returns(String) }
def presentment_currency; end
end
class Processing < Stripe::StripeObject
class Card < Stripe::StripeObject
class CustomerNotification < Stripe::StripeObject
# Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank.
sig { returns(T.nilable(T::Boolean)) }
def approval_requested; end
# If customer approval is required, they need to provide approval before this time.
sig { returns(T.nilable(Integer)) }
def completes_at; end
end
# Attribute for field customer_notification
sig { returns(T.nilable(CustomerNotification)) }
def customer_notification; end
end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# Type of the payment method for which payment is in `processing` state, one of `card`.
sig { returns(String) }
def type; end
end
class Shipping < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(T.nilable(Address)) }
def address; end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
# Recipient name.
sig { returns(T.nilable(String)) }
def name; end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
end
class TransferData < Stripe::StripeObject
# The amount transferred to the destination account. This transfer will occur automatically after the payment succeeds. If no amount is specified, by default the entire payment amount is transferred to the destination account.
# The amount must be less than or equal to the [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount), and must be a positive integer
# representing how much to transfer in the smallest currency unit (e.g., 100 cents to charge $1.00).
sig { returns(T.nilable(Integer)) }
def amount; end
# The account (if any) that the payment is attributed to for tax reporting, and where funds from the payment are transferred to after payment success.
sig { returns(T.any(String, Stripe::Account)) }
def destination; end
end
# Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
sig { returns(Integer) }
def amount; end
# Amount that can be captured from this PaymentIntent.
sig { returns(Integer) }
def amount_capturable; end
# Attribute for field amount_details
sig { returns(T.nilable(AmountDetails)) }
def amount_details; end
# Amount that this PaymentIntent collects.
sig { returns(Integer) }
def amount_received; end
# ID of the Connect application that created the PaymentIntent.
sig { returns(T.nilable(T.any(String, Stripe::Application))) }
def application; end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
# Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)
sig { returns(T.nilable(AutomaticPaymentMethods)) }
def automatic_payment_methods; end
# Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def canceled_at; end
# Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, `automatic`, or `expired`).
sig { returns(T.nilable(String)) }
def cancellation_reason; end
# Controls when the funds will be captured from the customer's account.
sig { returns(String) }
def capture_method; end
# The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.
#
# The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
#
# Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled.
sig { returns(T.nilable(String)) }
def client_secret; end
# Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.
sig { returns(String) }
def confirmation_method; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# ID of the Customer this PaymentIntent belongs to, if one exists.
#
# Payment methods attached to other Customers cannot be used with this PaymentIntent.
#
# If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# ID of the Account this PaymentIntent belongs to, if one exists.
#
# Payment methods attached to other Accounts cannot be used with this PaymentIntent.
#
# If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead.
sig { returns(T.nilable(String)) }
def customer_account; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# The list of payment method types to exclude from use with this payment.
sig { returns(T.nilable(T::Array[String])) }
def excluded_payment_method_types; end
# The FX Quote used for the PaymentIntent.
sig { returns(T.nilable(String)) }
def fx_quote; end
# Attribute for field hooks
sig { returns(T.nilable(Hooks)) }
def hooks; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.
sig { returns(T.nilable(LastPaymentError)) }
def last_payment_error; end
# ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted.
sig { returns(T.nilable(T.any(String, Stripe::Charge))) }
def latest_charge; end
# 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) }
def livemode; end
# 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. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).
sig { returns(T::Hash[String, String]) }
def metadata; end
# If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
sig { returns(T.nilable(NextAction)) }
def next_action; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def on_behalf_of; end
# Attribute for field payment_details
sig { returns(T.nilable(PaymentDetails)) }
def payment_details; end
# ID of the payment method used in this PaymentIntent.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def payment_method; end
# Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent.
sig { returns(T.nilable(PaymentMethodConfigurationDetails)) }
def payment_method_configuration_details; end
# Payment-method-specific configuration for this PaymentIntent.
sig { returns(T.nilable(PaymentMethodOptions)) }
def payment_method_options; end
# The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. A comprehensive list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
sig { returns(T::Array[String]) }
def payment_method_types; end
# Attribute for field presentment_details
sig { returns(T.nilable(PresentmentDetails)) }
def presentment_details; end
# If present, this property tells you about the processing state of the payment.
sig { returns(T.nilable(Processing)) }
def processing; end
# Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
sig { returns(T.nilable(String)) }
def receipt_email; end
# ID of the review associated with this PaymentIntent, if any.
sig { returns(T.nilable(T.any(String, Stripe::Review))) }
def review; end
# Indicates whether confirmation for this PaymentIntent using a secret key is `required` or `optional`.
sig { returns(T.nilable(String)) }
def secret_key_confirmation; end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# Shipping information for this PaymentIntent.
sig { returns(T.nilable(Shipping)) }
def shipping; end
# This is a legacy field that will be removed in the future. It is the ID of the Source object that is associated with this PaymentIntent, if one was supplied.
sig {
returns(T.nilable(T.any(String, T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source))))
}
def source; end
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
# Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses).
sig { returns(String) }
def status; end
# The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(TransferData)) }
def transfer_data; end
# A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).
sig { returns(T.nilable(String)) }
def transfer_group; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.
sig { returns(T.nilable(T.any(::Stripe::PaymentIntent::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::PaymentIntent::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::PaymentIntent::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return PaymentIntents for the customer that this customer ID specifies.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Only return PaymentIntents for the account that this ID specifies.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::PaymentIntent::ListParams::Created, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class AmountDetails < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class Card < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class CardPresent < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class Klarna < Stripe::RequestParams
# URL to an image for the product. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def image_url; end
sig { params(_image_url: T.nilable(String)).returns(T.nilable(String)) }
def image_url=(_image_url); end
# URL to the product page. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def product_url; end
sig { params(_product_url: T.nilable(String)).returns(T.nilable(String)) }
def product_url=(_product_url); end
# Reference for the subscription this line item is for.
sig { returns(T.nilable(String)) }
def subscription_reference; end
sig { params(_subscription_reference: T.nilable(String)).returns(T.nilable(String)) }
def subscription_reference=(_subscription_reference); end
sig {
params(image_url: T.nilable(String), product_url: T.nilable(String), subscription_reference: T.nilable(String)).void
}
def initialize(image_url: nil, product_url: nil, subscription_reference: nil); end
end
class Paypal < Stripe::RequestParams
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
sig {
params(category: T.nilable(String), description: T.nilable(String), sold_by: T.nilable(String)).void
}
def initialize(category: nil, description: nil, sold_by: nil); end
end
# This sub-hash contains line item details that are specific to `card` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card=(_card); end
# This sub-hash contains line item details that are specific to `card_present` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present=(_card_present); end
# This sub-hash contains line item details that are specific to `klarna` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# This sub-hash contains line item details that are specific to `paypal` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
sig {
params(card: T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent), klarna: T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna), paypal: T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).void
}
def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end
end
class Tax < Stripe::RequestParams
# The total tax on an item. Non-negative integer.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The amount an item was discounted for. Positive integer.
sig { returns(T.nilable(Integer)) }
def discount_amount; end
sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def discount_amount=(_discount_amount); end
# Payment method-specific information for line items.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# Unique identifier of the product. At most 12 characters long.
sig { returns(T.nilable(String)) }
def product_code; end
sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) }
def product_code=(_product_code); end
# Name of the product. At most 100 characters long.
sig { returns(String) }
def product_name; end
sig { params(_product_name: String).returns(String) }
def product_name=(_product_name); end
# Number of items of the product. Positive integer.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Contains information about the tax on the item.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::Tax)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::Tax))
}
def tax=(_tax); end
# Cost of the product. Non-negative integer.
sig { returns(Integer) }
def unit_cost; end
sig { params(_unit_cost: Integer).returns(Integer) }
def unit_cost=(_unit_cost); end
# A unit of measure for the line item, such as gallons, feet, meters, etc.
sig { returns(T.nilable(String)) }
def unit_of_measure; end
sig { params(_unit_of_measure: T.nilable(String)).returns(T.nilable(String)) }
def unit_of_measure=(_unit_of_measure); end
sig {
params(discount_amount: T.nilable(Integer), payment_method_options: T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::PaymentMethodOptions), product_code: T.nilable(String), product_name: String, quantity: Integer, tax: T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem::Tax), unit_cost: Integer, unit_of_measure: T.nilable(String)).void
}
def initialize(
discount_amount: nil,
payment_method_options: nil,
product_code: nil,
product_name: nil,
quantity: nil,
tax: nil,
unit_cost: nil,
unit_of_measure: nil
); end
end
class Shipping < Stripe::RequestParams
# Portion of the amount that is for shipping.
sig { returns(T.nilable(T.any(String, Integer))) }
def amount; end
sig {
params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def amount=(_amount); end
# The postal code that represents the shipping source.
sig { returns(T.nilable(String)) }
def from_postal_code; end
sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def from_postal_code=(_from_postal_code); end
# The postal code that represents the shipping destination.
sig { returns(T.nilable(String)) }
def to_postal_code; end
sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def to_postal_code=(_to_postal_code); end
sig {
params(amount: T.nilable(T.any(String, Integer)), from_postal_code: T.nilable(String), to_postal_code: T.nilable(String)).void
}
def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end
end
class Tax < Stripe::RequestParams
# Total portion of the amount that is for tax.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The total discount applied on the transaction.
sig { returns(T.nilable(T.any(String, Integer))) }
def discount_amount; end
sig {
params(_discount_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def discount_amount=(_discount_amount); end
# A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem])))
}
def line_items; end
sig {
params(_line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem])))
}
def line_items=(_line_items); end
# Contains information about the shipping portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::AmountDetails::Shipping)))
}
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::AmountDetails::Shipping))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::AmountDetails::Shipping)))
}
def shipping=(_shipping); end
# Contains information about the tax portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::AmountDetails::Tax)))
}
def tax; end
sig {
params(_tax: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::AmountDetails::Tax))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::AmountDetails::Tax)))
}
def tax=(_tax); end
sig {
params(discount_amount: T.nilable(T.any(String, Integer)), line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::CreateParams::AmountDetails::LineItem])), shipping: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::AmountDetails::Shipping)), tax: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::AmountDetails::Tax))).void
}
def initialize(discount_amount: nil, line_items: nil, shipping: nil, tax: nil); end
end
class AutomaticPaymentMethods < Stripe::RequestParams
# Controls whether this PaymentIntent will accept redirect-based payment methods.
#
# Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment.
sig { returns(T.nilable(String)) }
def allow_redirects; end
sig { params(_allow_redirects: T.nilable(String)).returns(T.nilable(String)) }
def allow_redirects=(_allow_redirects); end
# Whether this feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(allow_redirects: T.nilable(String), enabled: T::Boolean).void }
def initialize(allow_redirects: nil, enabled: nil); end
end
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
sig { returns(String) }
def calculation; end
sig { params(_calculation: String).returns(String) }
def calculation=(_calculation); end
sig { params(calculation: String).void }
def initialize(calculation: nil); end
end
# Tax arguments for automations
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::Hooks::Inputs::Tax)) }
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntent::CreateParams::Hooks::Inputs::Tax)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::Hooks::Inputs::Tax))
}
def tax=(_tax); end
sig {
params(tax: T.nilable(::Stripe::PaymentIntent::CreateParams::Hooks::Inputs::Tax)).void
}
def initialize(tax: nil); end
end
# Arguments passed in automations
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::Hooks::Inputs)) }
def inputs; end
sig {
params(_inputs: T.nilable(::Stripe::PaymentIntent::CreateParams::Hooks::Inputs)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::Hooks::Inputs))
}
def inputs=(_inputs); end
sig { params(inputs: T.nilable(::Stripe::PaymentIntent::CreateParams::Hooks::Inputs)).void }
def initialize(inputs: nil); end
end
class MandateData < Stripe::RequestParams
class CustomerAcceptance < Stripe::RequestParams
class Offline < Stripe::RequestParams; end
class Online < Stripe::RequestParams
# The IP address from which the Mandate was accepted by the customer.
sig { returns(String) }
def ip_address; end
sig { params(_ip_address: String).returns(String) }
def ip_address=(_ip_address); end
# The user agent of the browser from which the Mandate was accepted by the customer.
sig { returns(String) }
def user_agent; end
sig { params(_user_agent: String).returns(String) }
def user_agent=(_user_agent); end
sig { params(ip_address: String, user_agent: String).void }
def initialize(ip_address: nil, user_agent: nil); end
end
# The time at which the customer accepted the Mandate.
sig { returns(T.nilable(Integer)) }
def accepted_at; end
sig { params(_accepted_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def accepted_at=(_accepted_at); end
# If this is a Mandate accepted offline, this hash contains details about the offline acceptance.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::MandateData::CustomerAcceptance::Offline))
}
def offline; end
sig {
params(_offline: T.nilable(::Stripe::PaymentIntent::CreateParams::MandateData::CustomerAcceptance::Offline)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::MandateData::CustomerAcceptance::Offline))
}
def offline=(_offline); end
# If this is a Mandate accepted online, this hash contains details about the online acceptance.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::MandateData::CustomerAcceptance::Online))
}
def online; end
sig {
params(_online: T.nilable(::Stripe::PaymentIntent::CreateParams::MandateData::CustomerAcceptance::Online)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::MandateData::CustomerAcceptance::Online))
}
def online=(_online); end
# The type of customer acceptance information included with the Mandate. One of `online` or `offline`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(accepted_at: T.nilable(Integer), offline: T.nilable(::Stripe::PaymentIntent::CreateParams::MandateData::CustomerAcceptance::Offline), online: T.nilable(::Stripe::PaymentIntent::CreateParams::MandateData::CustomerAcceptance::Online), type: String).void
}
def initialize(accepted_at: nil, offline: nil, online: nil, type: nil); end
end
# This hash contains details about the customer acceptance of the Mandate.
sig { returns(::Stripe::PaymentIntent::CreateParams::MandateData::CustomerAcceptance) }
def customer_acceptance; end
sig {
params(_customer_acceptance: ::Stripe::PaymentIntent::CreateParams::MandateData::CustomerAcceptance).returns(::Stripe::PaymentIntent::CreateParams::MandateData::CustomerAcceptance)
}
def customer_acceptance=(_customer_acceptance); end
sig {
params(customer_acceptance: ::Stripe::PaymentIntent::CreateParams::MandateData::CustomerAcceptance).void
}
def initialize(customer_acceptance: nil); end
end
class PaymentDetails < Stripe::RequestParams
class CarRental < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Distance < Stripe::RequestParams
# Distance traveled.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
sig { params(amount: T.nilable(Integer), unit: T.nilable(String)).void }
def initialize(amount: nil, unit: nil); end
end
class Driver < Stripe::RequestParams
# Driver's identification number.
sig { returns(T.nilable(String)) }
def driver_identification_number; end
sig {
params(_driver_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def driver_identification_number=(_driver_identification_number); end
# Driver's tax number.
sig { returns(T.nilable(String)) }
def driver_tax_number; end
sig { params(_driver_tax_number: T.nilable(String)).returns(T.nilable(String)) }
def driver_tax_number=(_driver_tax_number); end
# Full name of the person or entity on the car reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(driver_identification_number: T.nilable(String), driver_tax_number: T.nilable(String), name: String).void
}
def initialize(
driver_identification_number: nil,
driver_tax_number: nil,
name: nil
); end
end
class PickupAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class ReturnAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the car rental.
sig { returns(String) }
def booking_number; end
sig { params(_booking_number: String).returns(String) }
def booking_number=(_booking_number); end
# Class code of the car.
sig { returns(T.nilable(String)) }
def car_class_code; end
sig { params(_car_class_code: T.nilable(String)).returns(T.nilable(String)) }
def car_class_code=(_car_class_code); end
# Make of the car.
sig { returns(T.nilable(String)) }
def car_make; end
sig { params(_car_make: T.nilable(String)).returns(T.nilable(String)) }
def car_make=(_car_make); end
# Model of the car.
sig { returns(T.nilable(String)) }
def car_model; end
sig { params(_car_model: T.nilable(String)).returns(T.nilable(String)) }
def car_model=(_car_model); end
# The name of the rental car company.
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# The customer service phone number of the car rental company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# Number of days the car is being rented.
sig { returns(Integer) }
def days_rented; end
sig { params(_days_rented: Integer).returns(Integer) }
def days_rented=(_days_rented); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Delivery)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Delivery))
}
def delivery=(_delivery); end
# The details of the distance traveled during the rental period.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Distance))
}
def distance; end
sig {
params(_distance: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Distance)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Distance))
}
def distance=(_distance); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Driver]))
}
def drivers; end
sig {
params(_drivers: T.nilable(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Driver])).returns(T.nilable(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Driver]))
}
def drivers=(_drivers); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates if the customer did not keep nor cancel their booking.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# Car pick-up address.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address; end
sig {
params(_pickup_address: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::PickupAddress)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address=(_pickup_address); end
# Car pick-up time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def pickup_at; end
sig { params(_pickup_at: Integer).returns(Integer) }
def pickup_at=(_pickup_at); end
# Name of the pickup location.
sig { returns(T.nilable(String)) }
def pickup_location_name; end
sig { params(_pickup_location_name: T.nilable(String)).returns(T.nilable(String)) }
def pickup_location_name=(_pickup_location_name); end
# Rental rate.
sig { returns(T.nilable(Integer)) }
def rate_amount; end
sig { params(_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def rate_amount=(_rate_amount); end
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
sig { returns(T.nilable(String)) }
def rate_interval; end
sig { params(_rate_interval: T.nilable(String)).returns(T.nilable(String)) }
def rate_interval=(_rate_interval); end
# The name of the person or entity renting the car.
sig { returns(T.nilable(String)) }
def renter_name; end
sig { params(_renter_name: T.nilable(String)).returns(T.nilable(String)) }
def renter_name=(_renter_name); end
# Car return address.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address; end
sig {
params(_return_address: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::ReturnAddress)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address=(_return_address); end
# Car return time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def return_at; end
sig { params(_return_at: Integer).returns(Integer) }
def return_at=(_return_at); end
# Name of the return location.
sig { returns(T.nilable(String)) }
def return_location_name; end
sig { params(_return_location_name: T.nilable(String)).returns(T.nilable(String)) }
def return_location_name=(_return_location_name); end
# Indicates whether the goods or services are tax-exempt or tax is not collected.
sig { returns(T.nilable(T::Boolean)) }
def tax_exempt; end
sig { params(_tax_exempt: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def tax_exempt=(_tax_exempt); end
# The vehicle identification number.
sig { returns(T.nilable(String)) }
def vehicle_identification_number; end
sig {
params(_vehicle_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def vehicle_identification_number=(_vehicle_identification_number); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Affiliate), booking_number: String, car_class_code: T.nilable(String), car_make: T.nilable(String), car_model: T.nilable(String), company: T.nilable(String), customer_service_phone_number: T.nilable(String), days_rented: Integer, delivery: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Delivery), distance: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Distance), drivers: T.nilable(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::Driver]), extra_charges: T.nilable(T::Array[String]), no_show: T.nilable(T::Boolean), pickup_address: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::PickupAddress), pickup_at: Integer, pickup_location_name: T.nilable(String), rate_amount: T.nilable(Integer), rate_interval: T.nilable(String), renter_name: T.nilable(String), return_address: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental::ReturnAddress), return_at: Integer, return_location_name: T.nilable(String), tax_exempt: T.nilable(T::Boolean), vehicle_identification_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
booking_number: nil,
car_class_code: nil,
car_make: nil,
car_model: nil,
company: nil,
customer_service_phone_number: nil,
days_rented: nil,
delivery: nil,
distance: nil,
drivers: nil,
extra_charges: nil,
no_show: nil,
pickup_address: nil,
pickup_at: nil,
pickup_location_name: nil,
rate_amount: nil,
rate_interval: nil,
renter_name: nil,
return_address: nil,
return_at: nil,
return_location_name: nil,
tax_exempt: nil,
vehicle_identification_number: nil
); end
end
class EventDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
# Indicates if the tickets are digitally checked when entering the venue.
sig { returns(T.nilable(T::Boolean)) }
def access_controlled_venue; end
sig {
params(_access_controlled_venue: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def access_controlled_venue=(_access_controlled_venue); end
# The event location's address.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails::Address)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails::Address))
}
def address=(_address); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate=(_affiliate); end
# The name of the company
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails::Delivery)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails::Delivery))
}
def delivery=(_delivery); end
# Event end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Type of the event entertainment (concert, sports event etc)
sig { returns(T.nilable(String)) }
def genre; end
sig { params(_genre: T.nilable(String)).returns(T.nilable(String)) }
def genre=(_genre); end
# The name of the event.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Event start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(access_controlled_venue: T.nilable(T::Boolean), address: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails::Address), affiliate: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails::Affiliate), company: T.nilable(String), delivery: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails::Delivery), ends_at: T.nilable(Integer), genre: T.nilable(String), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
access_controlled_venue: nil,
address: nil,
affiliate: nil,
company: nil,
delivery: nil,
ends_at: nil,
genre: nil,
name: nil,
starts_at: nil
); end
end
class Flight < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the flight reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Segment < Stripe::RequestParams
# The flight segment amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The International Air Transport Association (IATA) airport code for the arrival airport.
sig { returns(T.nilable(String)) }
def arrival_airport; end
sig { params(_arrival_airport: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport=(_arrival_airport); end
# The arrival time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def arrives_at; end
sig { params(_arrives_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def arrives_at=(_arrives_at); end
# The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The departure time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def departs_at; end
sig { params(_departs_at: Integer).returns(Integer) }
def departs_at=(_departs_at); end
# The International Air Transport Association (IATA) airport code for the departure airport.
sig { returns(T.nilable(String)) }
def departure_airport; end
sig { params(_departure_airport: T.nilable(String)).returns(T.nilable(String)) }
def departure_airport=(_departure_airport); end
# The flight number associated with the segment
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The fare class for the segment.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
sig {
params(amount: T.nilable(Integer), arrival_airport: T.nilable(String), arrives_at: T.nilable(Integer), carrier: T.nilable(String), departs_at: Integer, departure_airport: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String)).void
}
def initialize(
amount: nil,
arrival_airport: nil,
arrives_at: nil,
carrier: nil,
departs_at: nil,
departure_airport: nil,
flight_number: nil,
service_class: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Affiliate))
}
def affiliate=(_affiliate); end
# The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
sig { returns(T.nilable(String)) }
def agency_number; end
sig { params(_agency_number: T.nilable(String)).returns(T.nilable(String)) }
def agency_number=(_agency_number); end
# The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Delivery)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Delivery))
}
def delivery=(_delivery); end
# The name of the person or entity on the reservation.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# The details of the passengers in the travel reservation.
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Passenger])).returns(T.nilable(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Passenger]))
}
def passengers=(_passengers); end
# The individual flight segments associated with the trip.
sig {
returns(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Segment])
}
def segments; end
sig {
params(_segments: T::Array[::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Segment]).returns(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Segment])
}
def segments=(_segments); end
# The ticket number associated with the travel reservation.
sig { returns(T.nilable(String)) }
def ticket_number; end
sig { params(_ticket_number: T.nilable(String)).returns(T.nilable(String)) }
def ticket_number=(_ticket_number); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Affiliate), agency_number: T.nilable(String), carrier: T.nilable(String), delivery: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Delivery), passenger_name: T.nilable(String), passengers: T.nilable(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Passenger]), segments: T::Array[::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight::Segment], ticket_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
agency_number: nil,
carrier: nil,
delivery: nil,
passenger_name: nil,
passengers: nil,
segments: nil,
ticket_number: nil
); end
end
class Lodging < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the lodging reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
# The lodging location's address.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Address)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Address))
}
def address=(_address); end
# The number of adults on the booking
sig { returns(T.nilable(Integer)) }
def adults; end
sig { params(_adults: T.nilable(Integer)).returns(T.nilable(Integer)) }
def adults=(_adults); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the lodging reservation.
sig { returns(T.nilable(String)) }
def booking_number; end
sig { params(_booking_number: T.nilable(String)).returns(T.nilable(String)) }
def booking_number=(_booking_number); end
# The lodging category
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Lodging check-in time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkin_at; end
sig { params(_checkin_at: Integer).returns(Integer) }
def checkin_at=(_checkin_at); end
# Lodging check-out time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkout_at; end
sig { params(_checkout_at: Integer).returns(Integer) }
def checkout_at=(_checkout_at); end
# The customer service phone number of the lodging company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# The daily lodging room rate.
sig { returns(T.nilable(Integer)) }
def daily_room_rate_amount; end
sig { params(_daily_room_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def daily_room_rate_amount=(_daily_room_rate_amount); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Delivery)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Delivery))
}
def delivery=(_delivery); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates whether the lodging location is compliant with the Fire Safety Act.
sig { returns(T.nilable(T::Boolean)) }
def fire_safety_act_compliance; end
sig {
params(_fire_safety_act_compliance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def fire_safety_act_compliance=(_fire_safety_act_compliance); end
# The name of the lodging location.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Indicates if the customer did not keep their booking while failing to cancel the reservation.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# The number of rooms on the booking
sig { returns(T.nilable(Integer)) }
def number_of_rooms; end
sig { params(_number_of_rooms: T.nilable(Integer)).returns(T.nilable(Integer)) }
def number_of_rooms=(_number_of_rooms); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Passenger])).returns(T.nilable(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Passenger]))
}
def passengers=(_passengers); end
# The phone number of the lodging location.
sig { returns(T.nilable(String)) }
def property_phone_number; end
sig { params(_property_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def property_phone_number=(_property_phone_number); end
# The room class for this purchase.
sig { returns(T.nilable(String)) }
def room_class; end
sig { params(_room_class: T.nilable(String)).returns(T.nilable(String)) }
def room_class=(_room_class); end
# The number of room nights
sig { returns(T.nilable(Integer)) }
def room_nights; end
sig { params(_room_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def room_nights=(_room_nights); end
# The total tax amount associating with the room reservation.
sig { returns(T.nilable(Integer)) }
def total_room_tax_amount; end
sig { params(_total_room_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_room_tax_amount=(_total_room_tax_amount); end
# The total tax amount
sig { returns(T.nilable(Integer)) }
def total_tax_amount; end
sig { params(_total_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_tax_amount=(_total_tax_amount); end
sig {
params(address: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Address), adults: T.nilable(Integer), affiliate: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Affiliate), booking_number: T.nilable(String), category: T.nilable(String), checkin_at: Integer, checkout_at: Integer, customer_service_phone_number: T.nilable(String), daily_room_rate_amount: T.nilable(Integer), delivery: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Delivery), extra_charges: T.nilable(T::Array[String]), fire_safety_act_compliance: T.nilable(T::Boolean), name: T.nilable(String), no_show: T.nilable(T::Boolean), number_of_rooms: T.nilable(Integer), passengers: T.nilable(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging::Passenger]), property_phone_number: T.nilable(String), room_class: T.nilable(String), room_nights: T.nilable(Integer), total_room_tax_amount: T.nilable(Integer), total_tax_amount: T.nilable(Integer)).void
}
def initialize(
address: nil,
adults: nil,
affiliate: nil,
booking_number: nil,
category: nil,
checkin_at: nil,
checkout_at: nil,
customer_service_phone_number: nil,
daily_room_rate_amount: nil,
delivery: nil,
extra_charges: nil,
fire_safety_act_compliance: nil,
name: nil,
no_show: nil,
number_of_rooms: nil,
passengers: nil,
property_phone_number: nil,
room_class: nil,
room_nights: nil,
total_room_tax_amount: nil,
total_tax_amount: nil
); end
end
class Subscription < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class BillingInterval < Stripe::RequestParams
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def count; end
sig { params(_count: Integer).returns(Integer) }
def count=(_count); end
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig { params(count: Integer, interval: String).void }
def initialize(count: nil, interval: nil); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Subscription::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate=(_affiliate); end
# Info whether the subscription will be auto renewed upon expiry.
sig { returns(T.nilable(T::Boolean)) }
def auto_renewal; end
sig { params(_auto_renewal: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_renewal=(_auto_renewal); end
# Subscription billing details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval; end
sig {
params(_billing_interval: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Subscription::BillingInterval)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval=(_billing_interval); end
# Subscription end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Name of the product on subscription. e.g. Apple Music Subscription
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Subscription start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Subscription::Affiliate), auto_renewal: T.nilable(T::Boolean), billing_interval: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Subscription::BillingInterval), ends_at: T.nilable(Integer), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
affiliate: nil,
auto_renewal: nil,
billing_interval: nil,
ends_at: nil,
name: nil,
starts_at: nil
); end
end
# Car rental details for this PaymentIntent.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental)) }
def car_rental; end
sig {
params(_car_rental: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental))
}
def car_rental=(_car_rental); end
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
sig { returns(T.nilable(String)) }
def customer_reference; end
sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) }
def customer_reference=(_customer_reference); end
# Event details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails))
}
def event_details; end
sig {
params(_event_details: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails))
}
def event_details=(_event_details); end
# Flight reservation details for this PaymentIntent
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight)) }
def flight; end
sig {
params(_flight: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight))
}
def flight=(_flight); end
# Lodging reservation details for this PaymentIntent
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging)) }
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging))
}
def lodging=(_lodging); end
# A unique value assigned by the business to identify the transaction.
sig { returns(T.nilable(String)) }
def order_reference; end
sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) }
def order_reference=(_order_reference); end
# Subscription details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Subscription))
}
def subscription; end
sig {
params(_subscription: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Subscription)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Subscription))
}
def subscription=(_subscription); end
sig {
params(car_rental: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::CarRental), customer_reference: T.nilable(String), event_details: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::EventDetails), flight: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Flight), lodging: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Lodging), order_reference: T.nilable(String), subscription: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails::Subscription)).void
}
def initialize(
car_rental: nil,
customer_reference: nil,
event_details: nil,
flight: nil,
lodging: nil,
order_reference: nil,
subscription: nil
); end
end
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Institution number of the customer's bank.
sig { returns(String) }
def institution_number; end
sig { params(_institution_number: String).returns(String) }
def institution_number=(_institution_number); end
# Transit number of the customer's bank.
sig { returns(String) }
def transit_number; end
sig { params(_transit_number: String).returns(String) }
def transit_number=(_transit_number); end
sig {
params(account_number: String, institution_number: String, transit_number: String).void
}
def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(String) }
def bsb_number; end
sig { params(_bsb_number: String).returns(String) }
def bsb_number=(_bsb_number); end
sig { params(account_number: String, bsb_number: String).void }
def initialize(account_number: nil, bsb_number: nil); end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
sig { params(_sort_code: T.nilable(String)).returns(T.nilable(String)) }
def sort_code=(_sort_code); end
sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
def initialize(account_number: nil, sort_code: nil); end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodData::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodData::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodData::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodData::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
sig { params(_tax_id: String).returns(String) }
def tax_id=(_tax_id); end
sig { params(tax_id: String).void }
def initialize(tax_id: nil); end
end
class Cashapp < Stripe::RequestParams; end
class Crypto < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The customer's bank.
sig { returns(String) }
def bank; end
sig { params(_bank: String).returns(String) }
def bank=(_bank); end
sig { params(account_holder_type: T.nilable(String), bank: String).void }
def initialize(account_holder_type: nil, bank: nil); end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Klarna::Dob))
}
def dob; end
sig {
params(_dob: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Klarna::Dob)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Klarna::Dob))
}
def dob=(_dob); end
sig {
params(dob: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Klarna::Dob)).void
}
def initialize(dob: nil); end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
sig { returns(T.nilable(String)) }
def funding; end
sig { params(_funding: T.nilable(String)).returns(T.nilable(String)) }
def funding=(_funding); end
sig { params(funding: T.nilable(String)).void }
def initialize(funding: nil); end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
sig { params(_bank_code: String).returns(String) }
def bank_code=(_bank_code); end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
sig { params(_branch_code: String).returns(String) }
def branch_code=(_branch_code); end
# Attribute for param field reference
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# The suffix of the bank account number.
sig { returns(String) }
def suffix; end
sig { params(_suffix: String).returns(String) }
def suffix=(_suffix); end
sig {
params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
); end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Paypay < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig { returns(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Rechnung::Dob) }
def dob; end
sig {
params(_dob: ::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Rechnung::Dob).returns(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Rechnung::Dob)
}
def dob=(_dob); end
sig {
params(dob: ::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Rechnung::Dob).void
}
def initialize(dob: nil); end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
sig { returns(String) }
def iban; end
sig { params(_iban: String).returns(String) }
def iban=(_iban); end
sig { params(iban: String).void }
def initialize(iban: nil); end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
sig { params(account: T.nilable(String), source_type: T.nilable(String)).void }
def initialize(account: nil, source_type: nil); end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig {
params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String))
}
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AcssDebit)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Affirm)) }
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Affirm)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Affirm))
}
def affirm=(_affirm); end
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AfterpayClearpay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Alipay)) }
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Alipay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Alipay))
}
def alipay=(_alipay); end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Alma)) }
def alma; end
sig {
params(_alma: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Alma)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Alma))
}
def alma=(_alma); end
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AmazonPay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AuBecsDebit)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::BacsDebit)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Bancontact)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Bancontact))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Billie)) }
def billie; end
sig {
params(_billie: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Billie)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Billie))
}
def billie=(_billie); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::BillingDetails)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Blik)) }
def blik; end
sig {
params(_blik: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Blik)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Blik))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Boleto)) }
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Boleto)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Boleto))
}
def boleto=(_boleto); end
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Cashapp))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Cashapp)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Cashapp))
}
def cashapp=(_cashapp); end
# If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Crypto)) }
def crypto; end
sig {
params(_crypto: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Crypto)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Crypto))
}
def crypto=(_crypto); end
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::CustomerBalance)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Eps)) }
def eps; end
sig {
params(_eps: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Eps)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Eps))
}
def eps=(_eps); end
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Fpx)) }
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Fpx)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Fpx))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Giropay))
}
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Giropay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Giropay))
}
def giropay=(_giropay); end
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Gopay)) }
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Gopay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Gopay))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Grabpay))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Grabpay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Grabpay))
}
def grabpay=(_grabpay); end
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::IdBankTransfer)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Ideal)) }
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Ideal)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Ideal))
}
def ideal=(_ideal); end
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::InteracPresent))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::InteracPresent)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::InteracPresent))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::KakaoPay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Klarna)) }
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Klarna)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Klarna))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Konbini))
}
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Konbini)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Konbini))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::KrCard)) }
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::KrCard)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::KrCard))
}
def kr_card=(_kr_card); end
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Link)) }
def link; end
sig {
params(_link: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Link)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Link))
}
def link=(_link); end
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::MbWay)) }
def mb_way; end
sig {
params(_mb_way: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::MbWay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::MbWay))
}
def mb_way=(_mb_way); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Mobilepay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Mobilepay))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Multibanco)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Multibanco))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::NaverPay))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::NaverPay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::NaverPay))
}
def naver_pay=(_naver_pay); end
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::NzBankAccount)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Oxxo)) }
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Oxxo)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Oxxo))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::P24)) }
def p24; end
sig {
params(_p24: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::P24)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::P24))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::PayByBank)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Payco)) }
def payco; end
sig {
params(_payco: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Payco)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Payco))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Paynow)) }
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Paynow)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Paynow))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Paypal)) }
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Paypal)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Paypal))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Paypay)) }
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Paypay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Paypay))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Payto)) }
def payto; end
sig {
params(_payto: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Payto)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Payto))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Pix)) }
def pix; end
sig {
params(_pix: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Pix)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Pix))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Promptpay))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Promptpay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Promptpay))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Qris)) }
def qris; end
sig {
params(_qris: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Qris)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Qris))
}
def qris=(_qris); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::RadarOptions))
}
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::RadarOptions)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::RadarOptions))
}
def radar_options=(_radar_options); end
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Rechnung))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Rechnung)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Rechnung))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::RevolutPay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::SamsungPay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Satispay))
}
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Satispay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Satispay))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::SepaDebit)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Shopeepay))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Shopeepay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Shopeepay))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Sofort)) }
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Sofort)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Sofort))
}
def sofort=(_sofort); end
# This hash contains details about the Stripe balance payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::StripeBalance)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Swish)) }
def swish; end
sig {
params(_swish: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Swish)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Swish))
}
def swish=(_swish); end
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Twint)) }
def twint; end
sig {
params(_twint: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Twint)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Twint))
}
def twint=(_twint); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::UsBankAccount)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::WechatPay)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Zip)) }
def zip; end
sig {
params(_zip: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Zip)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Cashapp), crypto: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Crypto), customer_balance: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Giropay), gopay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Gopay), grabpay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Grabpay), id_bank_transfer: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::IdBankTransfer), ideal: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Link), mb_way: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::MbWay), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Paypal), paypay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Paypay), payto: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Payto), pix: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Promptpay), qris: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Qris), radar_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::RadarOptions), rechnung: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Rechnung), revolut_pay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::SepaDebit), shopeepay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Shopeepay), sofort: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Sofort), stripe_balance: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::StripeBalance), swish: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
mandate_options: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class Affirm < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Preferred language of the Affirm authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), preferred_locale: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, preferred_locale: nil, setup_future_usage: nil); end
end
class AfterpayClearpay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.
# This field differs from the statement descriptor and item name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), reference: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, reference: nil, setup_future_usage: nil); end
end
class Alipay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Alma < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class AmazonPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class AuBecsDebit < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(setup_future_usage: nil, target_date: nil); end
end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class Billie < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Blik < Stripe::RequestParams
# The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.
sig { returns(T.nilable(String)) }
def code; end
sig { params(_code: T.nilable(String)).returns(T.nilable(String)) }
def code=(_code); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(code: T.nilable(String), setup_future_usage: T.nilable(String)).void }
def initialize(code: nil, setup_future_usage: nil); end
end
class Boleto < Stripe::RequestParams
# The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
class Plan < Stripe::RequestParams
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
sig { returns(T.nilable(Integer)) }
def count; end
sig { params(_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def count=(_count); end
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
# One of `month`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(count: T.nilable(Integer), interval: T.nilable(String), type: String).void
}
def initialize(count: nil, interval: nil, type: nil); end
end
# Setting to true enables installments for this PaymentIntent.
# This will cause the response to contain a list of available installment plans.
# Setting to false will prevent any selected plan from applying to a charge.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# The selected installment plan to use for this payment attempt.
# This parameter can only be provided during confirmation.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan; end
sig {
params(_plan: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::Installments::Plan))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan=(_plan); end
sig {
params(enabled: T.nilable(T::Boolean), plan: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::Installments::Plan))).void
}
def initialize(enabled: nil, plan: nil); end
end
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(String) }
def amount_type; end
sig { params(_amount_type: String).returns(String) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Unique identifier for the mandate or subscription.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
sig { returns(Integer) }
def start_date; end
sig { params(_start_date: Integer).returns(Integer) }
def start_date=(_start_date); end
# Specifies the type of mandates supported. Possible values are `india`.
sig { returns(T.nilable(T::Array[String])) }
def supported_types; end
sig {
params(_supported_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def supported_types=(_supported_types); end
sig {
params(amount: Integer, amount_type: String, description: T.nilable(String), end_date: T.nilable(Integer), interval: String, interval_count: T.nilable(Integer), reference: String, start_date: Integer, supported_types: T.nilable(T::Array[String])).void
}
def initialize(
amount: nil,
amount_type: nil,
description: nil,
end_date: nil,
interval: nil,
interval_count: nil,
reference: nil,
start_date: nil,
supported_types: nil
); end
end
class StatementDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Please pass in an address that is within your Stripe user account country
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::StatementDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::StatementDetails::Address)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::StatementDetails::Address))
}
def address=(_address); end
# Phone number (e.g., a toll-free number that customers can call)
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::StatementDetails::Address), phone: T.nilable(String)).void
}
def initialize(address: nil, phone: nil); end
end
class ThreeDSecure < Stripe::RequestParams
class NetworkOptions < Stripe::RequestParams
class CartesBancaires < Stripe::RequestParams
# The cryptogram calculation algorithm used by the card Issuer's ACS
# to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
# messageExtension: CB-AVALGO
sig { returns(String) }
def cb_avalgo; end
sig { params(_cb_avalgo: String).returns(String) }
def cb_avalgo=(_cb_avalgo); end
# The exemption indicator returned from Cartes Bancaires in the ARes.
# message extension: CB-EXEMPTION; string (4 characters)
# This is a 3 byte bitmap (low significant byte first and most significant
# bit first) that has been Base64 encoded
sig { returns(T.nilable(String)) }
def cb_exemption; end
sig { params(_cb_exemption: T.nilable(String)).returns(T.nilable(String)) }
def cb_exemption=(_cb_exemption); end
# The risk score returned from Cartes Bancaires in the ARes.
# message extension: CB-SCORE; numeric value 0-99
sig { returns(T.nilable(Integer)) }
def cb_score; end
sig { params(_cb_score: T.nilable(Integer)).returns(T.nilable(Integer)) }
def cb_score=(_cb_score); end
sig {
params(cb_avalgo: String, cb_exemption: T.nilable(String), cb_score: T.nilable(Integer)).void
}
def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil); end
end
# Cartes Bancaires-specific 3DS fields.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires; end
sig {
params(_cartes_bancaires: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires=(_cartes_bancaires); end
sig {
params(cartes_bancaires: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).void
}
def initialize(cartes_bancaires: nil); end
end
# The `transStatus` returned from the card Issuer’s ACS in the ARes.
sig { returns(T.nilable(String)) }
def ares_trans_status; end
sig { params(_ares_trans_status: T.nilable(String)).returns(T.nilable(String)) }
def ares_trans_status=(_ares_trans_status); end
# The cryptogram, also known as the "authentication value" (AAV, CAVV or
# AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
# (Most 3D Secure providers will return the base64-encoded version, which
# is what you should specify here.)
sig { returns(String) }
def cryptogram; end
sig { params(_cryptogram: String).returns(String) }
def cryptogram=(_cryptogram); end
# The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
# provider and indicates what degree of authentication was performed.
sig { returns(T.nilable(String)) }
def electronic_commerce_indicator; end
sig {
params(_electronic_commerce_indicator: T.nilable(String)).returns(T.nilable(String))
}
def electronic_commerce_indicator=(_electronic_commerce_indicator); end
# The exemption requested via 3DS and accepted by the issuer at authentication time.
sig { returns(T.nilable(String)) }
def exemption_indicator; end
sig { params(_exemption_indicator: T.nilable(String)).returns(T.nilable(String)) }
def exemption_indicator=(_exemption_indicator); end
# Network specific 3DS fields. Network specific arguments require an
# explicit card brand choice. The parameter `payment_method_options.card.network``
# must be populated accordingly
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options; end
sig {
params(_network_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options=(_network_options); end
# The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
# AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
sig { returns(T.nilable(String)) }
def requestor_challenge_indicator; end
sig {
params(_requestor_challenge_indicator: T.nilable(String)).returns(T.nilable(String))
}
def requestor_challenge_indicator=(_requestor_challenge_indicator); end
# For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
# Transaction ID (dsTransID).
sig { returns(String) }
def transaction_id; end
sig { params(_transaction_id: String).returns(String) }
def transaction_id=(_transaction_id); end
# The version of 3D Secure that was performed.
sig { returns(String) }
def version; end
sig { params(_version: String).returns(String) }
def version=(_version); end
sig {
params(ares_trans_status: T.nilable(String), cryptogram: String, electronic_commerce_indicator: T.nilable(String), exemption_indicator: T.nilable(String), network_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions), requestor_challenge_indicator: T.nilable(String), transaction_id: String, version: String).void
}
def initialize(
ares_trans_status: nil,
cryptogram: nil,
electronic_commerce_indicator: nil,
exemption_indicator: nil,
network_options: nil,
requestor_challenge_indicator: nil,
transaction_id: nil,
version: nil
); end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.
sig { returns(T.nilable(String)) }
def cvc_token; end
sig { params(_cvc_token: T.nilable(String)).returns(T.nilable(String)) }
def cvc_token=(_cvc_token); end
# Installment configuration for payments attempted on this PaymentIntent.
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::Installments))
}
def installments; end
sig {
params(_installments: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::Installments)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::Installments))
}
def installments=(_installments); end
# Configuration options for setting up an eMandate for cards issued in India.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options=(_mandate_options); end
# When specified, this parameter indicates that a transaction will be marked
# as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
# parameter can only be provided during confirmation.
sig { returns(T.nilable(T::Boolean)) }
def moto; end
sig { params(_moto: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def moto=(_moto); end
# Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
# Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_decremental_authorization; end
sig {
params(_request_decremental_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_decremental_authorization=(_request_decremental_authorization); end
# Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_extended_authorization; end
sig {
params(_request_extended_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_extended_authorization=(_request_extended_authorization); end
# Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_incremental_authorization; end
sig {
params(_request_incremental_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_incremental_authorization=(_request_incremental_authorization); end
# Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_multicapture; end
sig { params(_request_multicapture: T.nilable(String)).returns(T.nilable(String)) }
def request_multicapture=(_request_multicapture); end
# Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_overcapture; end
sig { params(_request_overcapture: T.nilable(String)).returns(T.nilable(String)) }
def request_overcapture=(_request_overcapture); end
# Request partial authorization on this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_partial_authorization; end
sig {
params(_request_partial_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_partial_authorization=(_request_partial_authorization); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
# When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).
sig { returns(T.nilable(T::Boolean)) }
def require_cvc_recollection; end
sig {
params(_require_cvc_recollection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def require_cvc_recollection=(_require_cvc_recollection); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kana; end
sig {
params(_statement_descriptor_suffix_kana: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_suffix_kana=(_statement_descriptor_suffix_kana); end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kanji; end
sig {
params(_statement_descriptor_suffix_kanji: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_suffix_kanji=(_statement_descriptor_suffix_kanji); end
# Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::StatementDetails)))
}
def statement_details; end
sig {
params(_statement_details: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::StatementDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::StatementDetails)))
}
def statement_details=(_statement_details); end
# If 3D Secure authentication was performed with a third-party provider,
# the authentication details to use for this payment.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure; end
sig {
params(_three_d_secure: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure=(_three_d_secure); end
sig {
params(capture_method: T.nilable(String), cvc_token: T.nilable(String), installments: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::Installments), mandate_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::MandateOptions), moto: T.nilable(T::Boolean), network: T.nilable(String), request_decremental_authorization: T.nilable(String), request_extended_authorization: T.nilable(String), request_incremental_authorization: T.nilable(String), request_multicapture: T.nilable(String), request_overcapture: T.nilable(String), request_partial_authorization: T.nilable(String), request_three_d_secure: T.nilable(String), require_cvc_recollection: T.nilable(T::Boolean), setup_future_usage: T.nilable(T.any(String, String)), statement_descriptor_suffix_kana: T.nilable(String), statement_descriptor_suffix_kanji: T.nilable(String), statement_details: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::StatementDetails)), three_d_secure: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure)).void
}
def initialize(
capture_method: nil,
cvc_token: nil,
installments: nil,
mandate_options: nil,
moto: nil,
network: nil,
request_decremental_authorization: nil,
request_extended_authorization: nil,
request_incremental_authorization: nil,
request_multicapture: nil,
request_overcapture: nil,
request_partial_authorization: nil,
request_three_d_secure: nil,
require_cvc_recollection: nil,
setup_future_usage: nil,
statement_descriptor_suffix_kana: nil,
statement_descriptor_suffix_kanji: nil,
statement_details: nil,
three_d_secure: nil
); end
end
class CardPresent < Stripe::RequestParams
class Routing < Stripe::RequestParams
# Routing requested priority
sig { returns(T.nilable(String)) }
def requested_priority; end
sig { params(_requested_priority: T.nilable(String)).returns(T.nilable(String)) }
def requested_priority=(_requested_priority); end
sig { params(requested_priority: T.nilable(String)).void }
def initialize(requested_priority: nil); end
end
# Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)
sig { returns(T.nilable(T::Boolean)) }
def request_extended_authorization; end
sig {
params(_request_extended_authorization: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def request_extended_authorization=(_request_extended_authorization); end
# Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
sig { returns(T.nilable(T::Boolean)) }
def request_incremental_authorization_support; end
sig {
params(_request_incremental_authorization_support: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def request_incremental_authorization_support=(
_request_incremental_authorization_support
); end
# Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CardPresent::Routing))
}
def routing; end
sig {
params(_routing: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CardPresent::Routing)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CardPresent::Routing))
}
def routing=(_routing); end
sig {
params(request_extended_authorization: T.nilable(T::Boolean), request_incremental_authorization_support: T.nilable(T::Boolean), routing: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CardPresent::Routing)).void
}
def initialize(
request_extended_authorization: nil,
request_incremental_authorization_support: nil,
routing: nil
); end
end
class Cashapp < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Crypto < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for the eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
sig {
params(_requested_address_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested_address_types=(_requested_address_types); end
# The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
}
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(bank_transfer: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
end
class Eps < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Fpx < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Giropay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Gopay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Grabpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class IdBankTransfer < Stripe::RequestParams
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from 5 minutes from now until 31 days from now. If unset, it defaults to 3 days from now.
sig { returns(T.nilable(Integer)) }
def expires_after; end
sig { params(_expires_after: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after=(_expires_after); end
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now until 30 days from now. If unset, it defaults to 1 days from now.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after: T.nilable(Integer), expires_at: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after: nil, expires_at: nil, setup_future_usage: nil); end
end
class Ideal < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Klarna < Stripe::RequestParams
class OnDemand < Stripe::RequestParams
# Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def average_amount; end
sig { params(_average_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def average_amount=(_average_amount); end
# The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def maximum_amount; end
sig { params(_maximum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_amount=(_maximum_amount); end
# The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Interval at which the customer is making purchases
sig { returns(T.nilable(String)) }
def purchase_interval; end
sig { params(_purchase_interval: T.nilable(String)).returns(T.nilable(String)) }
def purchase_interval=(_purchase_interval); end
# The number of `purchase_interval` between charges
sig { returns(T.nilable(Integer)) }
def purchase_interval_count; end
sig { params(_purchase_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def purchase_interval_count=(_purchase_interval_count); end
sig {
params(average_amount: T.nilable(Integer), maximum_amount: T.nilable(Integer), minimum_amount: T.nilable(Integer), purchase_interval: T.nilable(String), purchase_interval_count: T.nilable(Integer)).void
}
def initialize(
average_amount: nil,
maximum_amount: nil,
minimum_amount: nil,
purchase_interval: nil,
purchase_interval_count: nil
); end
end
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing; end
sig {
params(_next_billing: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling), reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# On-demand details if setting up or charging an on-demand payment.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand; end
sig {
params(_on_demand: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna::OnDemand)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand=(_on_demand); end
# Preferred language of the Klarna authorization page that the customer is redirected to
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Subscription details if setting up or charging a subscription.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(capture_method: T.nilable(String), on_demand: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna::OnDemand), preferred_locale: T.nilable(String), setup_future_usage: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(
capture_method: nil,
on_demand: nil,
preferred_locale: nil,
setup_future_usage: nil,
subscriptions: nil
); end
end
class Konbini < Stripe::RequestParams
# An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number.
sig { returns(T.nilable(String)) }
def confirmation_number; end
sig { params(_confirmation_number: T.nilable(String)).returns(T.nilable(String)) }
def confirmation_number=(_confirmation_number); end
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
sig { returns(T.nilable(T.any(String, Integer))) }
def expires_after_days; end
sig {
params(_expires_after_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expires_after_days=(_expires_after_days); end
# The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.
sig { returns(T.nilable(T.any(String, Integer))) }
def expires_at; end
sig {
params(_expires_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expires_at=(_expires_at); end
# A product descriptor of up to 22 characters, which will appear to customers at the convenience store.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(confirmation_number: T.nilable(String), expires_after_days: T.nilable(T.any(String, Integer)), expires_at: T.nilable(T.any(String, Integer)), product_description: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(
confirmation_number: nil,
expires_after_days: nil,
expires_at: nil,
product_description: nil,
setup_future_usage: nil
); end
end
class KrCard < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Link < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
sig { params(_persistent_token: T.nilable(String)).returns(T.nilable(String)) }
def persistent_token=(_persistent_token); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), persistent_token: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, persistent_token: nil, setup_future_usage: nil); end
end
class MbWay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Mobilepay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Multibanco < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class NaverPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class NzBankAccount < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(setup_future_usage: nil, target_date: nil); end
end
class Oxxo < Stripe::RequestParams
# The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class P24 < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Confirm that the payer has accepted the P24 terms and conditions.
sig { returns(T.nilable(T::Boolean)) }
def tos_shown_and_accepted; end
sig {
params(_tos_shown_and_accepted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def tos_shown_and_accepted=(_tos_shown_and_accepted); end
sig {
params(setup_future_usage: T.nilable(String), tos_shown_and_accepted: T.nilable(T::Boolean)).void
}
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Paynow < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Paypal < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The tax for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The tax behavior for the line item.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(amount: Integer, behavior: String).void }
def initialize(amount: nil, behavior: nil); end
end
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Descriptive name of the line item.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Quantity of the line item. Must be a positive number.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Client facing stock keeping unit, article number or similar.
sig { returns(T.nilable(String)) }
def sku; end
sig { params(_sku: T.nilable(String)).returns(T.nilable(String)) }
def sku=(_sku); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
# The tax information for the line item.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypal::LineItem::Tax)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax=(_tax); end
# Price for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def unit_amount; end
sig { params(_unit_amount: Integer).returns(Integer) }
def unit_amount=(_unit_amount); end
sig {
params(category: T.nilable(String), description: T.nilable(String), name: String, quantity: Integer, sku: T.nilable(String), sold_by: T.nilable(String), tax: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypal::LineItem::Tax), unit_amount: Integer).void
}
def initialize(
category: nil,
description: nil,
name: nil,
quantity: nil,
sku: nil,
sold_by: nil,
tax: nil,
unit_amount: nil
); end
end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# The line items purchased by the customer.
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypal::LineItem])).returns(T.nilable(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items=(_line_items); end
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference_id; end
sig { params(_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def reference_id=(_reference_id); end
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
sig { returns(T.nilable(String)) }
def risk_correlation_id; end
sig { params(_risk_correlation_id: T.nilable(String)).returns(T.nilable(String)) }
def risk_correlation_id=(_risk_correlation_id); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(capture_method: T.nilable(String), line_items: T.nilable(T::Array[::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypal::LineItem]), preferred_locale: T.nilable(String), reference: T.nilable(String), reference_id: T.nilable(String), risk_correlation_id: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String)), subsellers: T.nilable(T::Array[String])).void
}
def initialize(
capture_method: nil,
line_items: nil,
preferred_locale: nil,
reference: nil,
reference_id: nil,
risk_correlation_id: nil,
setup_future_usage: nil,
subsellers: nil
); end
end
class Paypay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
sig { params(_payments_per_period: T.nilable(Integer)).returns(T.nilable(Integer)) }
def payments_per_period=(_payments_per_period); end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
sig { params(_purpose: T.nilable(String)).returns(T.nilable(String)) }
def purpose=(_purpose); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), payments_per_period: T.nilable(Integer), purpose: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil
); end
end
# Additional fields for Mandate creation. Only `purpose` field is configurable for PayTo PaymentIntent with `setup_future_usage=none`. Other fields are only applicable to PayTo PaymentIntent with `setup_future_usage=off_session`
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Payto::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Payto::MandateOptions), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(mandate_options: nil, setup_future_usage: nil); end
end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Type of amount. Defaults to `maximum`.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), amount_type: T.nilable(String), currency: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), reference: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
amount_type: nil,
currency: nil,
end_date: nil,
payment_schedule: nil,
reference: nil,
start_date: nil
); end
end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
sig { returns(T.nilable(Integer)) }
def expires_after_seconds; end
sig { params(_expires_after_seconds: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_seconds=(_expires_after_seconds); end
# The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# Additional fields for mandate creation. Only applicable when `setup_future_usage=off_session`.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(amount_includes_iof: T.nilable(String), expires_after_seconds: T.nilable(Integer), expires_at: T.nilable(Integer), mandate_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Pix::MandateOptions), setup_future_usage: T.nilable(String)).void
}
def initialize(
amount_includes_iof: nil,
expires_after_seconds: nil,
expires_at: nil,
mandate_options: nil,
setup_future_usage: nil
); end
end
class Promptpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Qris < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Rechnung < Stripe::RequestParams; end
class RevolutPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class SamsungPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Satispay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Shopeepay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Sofort < Stripe::RequestParams
# Language shown to the payer on redirect.
sig { returns(T.nilable(T.any(String, String))) }
def preferred_language; end
sig {
params(_preferred_language: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(T.any(String, String)), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class StripeBalance < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Swish < Stripe::RequestParams
# A reference for this payment to be displayed in the Swish app.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(reference: T.nilable(String), setup_future_usage: T.nilable(String)).void }
def initialize(reference: nil, setup_future_usage: nil); end
end
class Twint < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
class ManualEntry < Stripe::RequestParams
# Settings for configuring manual entry of account details.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
sig { params(mode: String).void }
def initialize(mode: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# Customize manual entry behavior
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry; end
sig {
params(_manual_entry: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry=(_manual_entry); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(filters: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), manual_entry: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
}
def initialize(
filters: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
); end
end
class MandateOptions < Stripe::RequestParams
# The method used to collect offline mandate customer acceptance.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
sig { params(collection_method: T.nilable(String)).void }
def initialize(collection_method: nil); end
end
class Networks < Stripe::RequestParams
# Triggers validations to run across the selected networks
sig { returns(T.nilable(T::Array[String])) }
def requested; end
sig {
params(_requested: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested=(_requested); end
sig { params(requested: T.nilable(T::Array[String])).void }
def initialize(requested: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Additional fields for network related functions
sig {
returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks; end
sig {
params(_networks: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::Networks)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks=(_networks); end
# Preferred transaction settlement speed
sig { returns(T.nilable(T.any(String, String))) }
def preferred_settlement_speed; end
sig {
params(_preferred_settlement_speed: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred_settlement_speed=(_preferred_settlement_speed); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::Networks), preferred_settlement_speed: T.nilable(T.any(String, String)), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
financial_connections: nil,
mandate_options: nil,
networks: nil,
preferred_settlement_speed: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class WechatPay < Stripe::RequestParams
# The app ID registered with WeChat Pay. Only required when client is ios or android.
sig { returns(T.nilable(String)) }
def app_id; end
sig { params(_app_id: T.nilable(String)).returns(T.nilable(String)) }
def app_id=(_app_id); end
# The client type that the end customer will pay from
sig { returns(T.nilable(String)) }
def client; end
sig { params(_client: T.nilable(String)).returns(T.nilable(String)) }
def client=(_client); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(app_id: T.nilable(String), client: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
end
class Zip < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
# If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AcssDebit)))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AcssDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AcssDebit)))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Affirm)))
}
def affirm; end
sig {
params(_affirm: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Affirm))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Affirm)))
}
def affirm=(_affirm); end
# If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AfterpayClearpay)))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AfterpayClearpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AfterpayClearpay)))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Alipay)))
}
def alipay; end
sig {
params(_alipay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Alipay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Alipay)))
}
def alipay=(_alipay); end
# If this is a `alma` PaymentMethod, this sub-hash contains details about the Alma payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Alma)))
}
def alma; end
sig {
params(_alma: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Alma))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Alma)))
}
def alma=(_alma); end
# If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AmazonPay)))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AmazonPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AmazonPay)))
}
def amazon_pay=(_amazon_pay); end
# If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AuBecsDebit)))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AuBecsDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AuBecsDebit)))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::BacsDebit)))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::BacsDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::BacsDebit)))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Bancontact)))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Bancontact))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Bancontact)))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this sub-hash contains details about the Billie payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Billie)))
}
def billie; end
sig {
params(_billie: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Billie))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Billie)))
}
def billie=(_billie); end
# If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Blik)))
}
def blik; end
sig {
params(_blik: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Blik))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Blik)))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Boleto)))
}
def boleto; end
sig {
params(_boleto: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Boleto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Boleto)))
}
def boleto=(_boleto); end
# Configuration for any card payments attempted on this PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card)))
}
def card; end
sig {
params(_card: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card)))
}
def card=(_card); end
# If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CardPresent)))
}
def card_present; end
sig {
params(_card_present: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CardPresent))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CardPresent)))
}
def card_present=(_card_present); end
# If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Cashapp)))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Cashapp))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Cashapp)))
}
def cashapp=(_cashapp); end
# If this is a `crypto` PaymentMethod, this sub-hash contains details about the Crypto payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Crypto)))
}
def crypto; end
sig {
params(_crypto: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Crypto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Crypto)))
}
def crypto=(_crypto); end
# If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CustomerBalance))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance=(_customer_balance); end
# If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Eps)))
}
def eps; end
sig {
params(_eps: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Eps))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Eps)))
}
def eps=(_eps); end
# If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Fpx)))
}
def fpx; end
sig {
params(_fpx: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Fpx))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Fpx)))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Giropay)))
}
def giropay; end
sig {
params(_giropay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Giropay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Giropay)))
}
def giropay=(_giropay); end
# If this is a `gopay` PaymentMethod, this sub-hash contains details about the Gopay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Gopay)))
}
def gopay; end
sig {
params(_gopay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Gopay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Gopay)))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Grabpay)))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Grabpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Grabpay)))
}
def grabpay=(_grabpay); end
# If this is a `id_bank_transfer` PaymentMethod, this sub-hash contains details about the Indonesia Bank Transfer payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::IdBankTransfer))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Ideal)))
}
def ideal; end
sig {
params(_ideal: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Ideal))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Ideal)))
}
def ideal=(_ideal); end
# If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::InteracPresent)))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::InteracPresent))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::InteracPresent)))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::KakaoPay)))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::KakaoPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::KakaoPay)))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna)))
}
def klarna; end
sig {
params(_klarna: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna)))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Konbini)))
}
def konbini; end
sig {
params(_konbini: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Konbini))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Konbini)))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this sub-hash contains details about the KR Card payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::KrCard)))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::KrCard))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::KrCard)))
}
def kr_card=(_kr_card); end
# If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Link)))
}
def link; end
sig {
params(_link: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Link))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Link)))
}
def link=(_link); end
# If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::MbWay)))
}
def mb_way; end
sig {
params(_mb_way: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::MbWay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::MbWay)))
}
def mb_way=(_mb_way); end
# If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Mobilepay)))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Mobilepay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Mobilepay)))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Multibanco)))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Multibanco))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Multibanco)))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this sub-hash contains details about the Naver Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::NaverPay)))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::NaverPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::NaverPay)))
}
def naver_pay=(_naver_pay); end
# If this is a `nz_bank_account` PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::NzBankAccount)))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::NzBankAccount))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::NzBankAccount)))
}
def nz_bank_account=(_nz_bank_account); end
# If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Oxxo)))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Oxxo))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Oxxo)))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::P24)))
}
def p24; end
sig {
params(_p24: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::P24))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::P24)))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this sub-hash contains details about the PayByBank payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::PayByBank)))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::PayByBank))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::PayByBank)))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this sub-hash contains details about the PAYCO payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Payco)))
}
def payco; end
sig {
params(_payco: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Payco))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Payco)))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paynow)))
}
def paynow; end
sig {
params(_paynow: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paynow))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paynow)))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypal)))
}
def paypal; end
sig {
params(_paypal: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypal))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypal)))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this sub-hash contains details about the PayPay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypay)))
}
def paypay; end
sig {
params(_paypay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypay)))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Payto)))
}
def payto; end
sig {
params(_payto: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Payto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Payto)))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Pix)))
}
def pix; end
sig {
params(_pix: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Pix))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Pix)))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Promptpay)))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Promptpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Promptpay)))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this sub-hash contains details about the QRIS payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Qris)))
}
def qris; end
sig {
params(_qris: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Qris))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Qris)))
}
def qris=(_qris); end
# If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Rechnung)))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Rechnung))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Rechnung)))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::RevolutPay)))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::RevolutPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::RevolutPay)))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SamsungPay)))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SamsungPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SamsungPay)))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Satispay)))
}
def satispay; end
sig {
params(_satispay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Satispay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Satispay)))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SepaDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit=(_sepa_debit); end
# If this is a `shopeepay` PaymentMethod, this sub-hash contains details about the ShopeePay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Shopeepay)))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Shopeepay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Shopeepay)))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Sofort)))
}
def sofort; end
sig {
params(_sofort: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Sofort))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Sofort)))
}
def sofort=(_sofort); end
# If this is a `stripe_balance` PaymentMethod, this sub-hash contains details about the Stripe Balance payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::StripeBalance)))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::StripeBalance))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::StripeBalance)))
}
def stripe_balance=(_stripe_balance); end
# If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Swish)))
}
def swish; end
sig {
params(_swish: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Swish))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Swish)))
}
def swish=(_swish); end
# If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Twint)))
}
def twint; end
sig {
params(_twint: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Twint))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Twint)))
}
def twint=(_twint); end
# If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
# If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::WechatPay)))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::WechatPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::WechatPay)))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Zip)))
}
def zip; end
sig {
params(_zip: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Zip))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Zip)))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AcssDebit)), affirm: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Affirm)), afterpay_clearpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AfterpayClearpay)), alipay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Alipay)), alma: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Alma)), amazon_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AmazonPay)), au_becs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AuBecsDebit)), bacs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::BacsDebit)), bancontact: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Bancontact)), billie: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Billie)), blik: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Blik)), boleto: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Boleto)), card: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card)), card_present: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CardPresent)), cashapp: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Cashapp)), crypto: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Crypto)), customer_balance: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CustomerBalance)), eps: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Eps)), fpx: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Fpx)), giropay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Giropay)), gopay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Gopay)), grabpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Grabpay)), id_bank_transfer: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::IdBankTransfer)), ideal: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Ideal)), interac_present: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::InteracPresent)), kakao_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::KakaoPay)), klarna: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna)), konbini: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Konbini)), kr_card: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::KrCard)), link: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Link)), mb_way: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::MbWay)), mobilepay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Mobilepay)), multibanco: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Multibanco)), naver_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::NaverPay)), nz_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::NzBankAccount)), oxxo: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Oxxo)), p24: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::P24)), pay_by_bank: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::PayByBank)), payco: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Payco)), paynow: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paynow)), paypal: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypal)), paypay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypay)), payto: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Payto)), pix: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Pix)), promptpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Promptpay)), qris: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Qris)), rechnung: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Rechnung)), revolut_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::RevolutPay)), samsung_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SamsungPay)), satispay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Satispay)), sepa_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SepaDebit)), shopeepay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Shopeepay)), sofort: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Sofort)), stripe_balance: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::StripeBalance)), swish: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Swish)), twint: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Twint)), us_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount)), wechat_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::WechatPay)), zip: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Zip))).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
blik: nil,
boleto: nil,
card: nil,
card_present: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address.
sig { returns(::Stripe::PaymentIntent::CreateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::PaymentIntent::CreateParams::Shipping::Address).returns(::Stripe::PaymentIntent::CreateParams::Shipping::Address)
}
def address=(_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
sig { params(_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def tracking_number=(_tracking_number); end
sig {
params(address: ::Stripe::PaymentIntent::CreateParams::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
}
def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
# The amount is capped at the total transaction amount and if no amount is set,
# the full amount is transferred.
#
# If you intend to collect a fee and you need a more robust reporting experience, using
# [application_fee_amount](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-application_fee_amount)
# might be a better fit for your integration.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# If specified, successful charges will be attributed to the destination
# account for tax reporting, and the funds from charges will be transferred
# to the destination account. The ID of the resulting transfer will be
# returned on the successful charge's `transfer` field.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Provides industry-specific information about the amount.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails)) }
def amount_details; end
sig {
params(_amount_details: T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails))
}
def amount_details=(_amount_details); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::AutomaticPaymentMethods)) }
def automatic_payment_methods; end
sig {
params(_automatic_payment_methods: T.nilable(::Stripe::PaymentIntent::CreateParams::AutomaticPaymentMethods)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::AutomaticPaymentMethods))
}
def automatic_payment_methods=(_automatic_payment_methods); end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm).
sig { returns(T.nilable(T::Boolean)) }
def confirm; end
sig { params(_confirm: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def confirm=(_confirm); end
# Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.
sig { returns(T.nilable(String)) }
def confirmation_method; end
sig { params(_confirmation_method: T.nilable(String)).returns(T.nilable(String)) }
def confirmation_method=(_confirmation_method); end
# ID of the ConfirmationToken used to confirm this PaymentIntent.
#
# If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.
sig { returns(T.nilable(String)) }
def confirmation_token; end
sig { params(_confirmation_token: T.nilable(String)).returns(T.nilable(String)) }
def confirmation_token=(_confirmation_token); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# ID of the Customer this PaymentIntent belongs to, if one exists.
#
# Payment methods attached to other Customers cannot be used with this PaymentIntent.
#
# If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# ID of the Account this PaymentIntent belongs to, if one exists.
#
# Payment methods attached to other Accounts cannot be used with this PaymentIntent.
#
# If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
sig { returns(T.nilable(T::Boolean)) }
def error_on_requires_action; end
sig {
params(_error_on_requires_action: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def error_on_requires_action=(_error_on_requires_action); end
# The list of payment method types to exclude from use with this payment.
sig { returns(T.nilable(T::Array[String])) }
def excluded_payment_method_types; end
sig {
params(_excluded_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def excluded_payment_method_types=(_excluded_payment_method_types); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.
sig { returns(T.nilable(String)) }
def fx_quote; end
sig { params(_fx_quote: T.nilable(String)).returns(T.nilable(String)) }
def fx_quote=(_fx_quote); end
# Automations to be run during the PaymentIntent lifecycle
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::Hooks)) }
def hooks; end
sig {
params(_hooks: T.nilable(::Stripe::PaymentIntent::CreateParams::Hooks)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::Hooks))
}
def hooks=(_hooks); end
# ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
sig { returns(T.nilable(String)) }
def mandate; end
sig { params(_mandate: T.nilable(String)).returns(T.nilable(String)) }
def mandate=(_mandate); end
# This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
sig { returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::MandateData))) }
def mandate_data; end
sig {
params(_mandate_data: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::MandateData))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::MandateData)))
}
def mandate_data=(_mandate_data); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
sig { returns(T.nilable(T.any(T::Boolean, String))) }
def off_session; end
sig {
params(_off_session: T.nilable(T.any(T::Boolean, String))).returns(T.nilable(T.any(T::Boolean, String)))
}
def off_session=(_off_session); end
# The Stripe account ID that these funds are intended for. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Provides industry-specific information about the charge.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails)) }
def payment_details; end
sig {
params(_payment_details: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails))
}
def payment_details=(_payment_details); end
# ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent.
#
# If you don't provide the `payment_method` parameter or the `source` parameter with `confirm=true`, `source` automatically populates with `customer.default_source` to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward.
# If the payment method is attached to a Customer, you must also provide the ID of that Customer as the [customer](https://stripe.com/docs/api#create_payment_intent-customer) parameter of this PaymentIntent.
# end
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent.
sig { returns(T.nilable(String)) }
def payment_method_configuration; end
sig { params(_payment_method_configuration: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_configuration=(_payment_method_configuration); end
# If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
# in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)
# property on the PaymentIntent.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData)) }
def payment_method_data; end
sig {
params(_payment_method_data: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData))
}
def payment_method_data=(_payment_method_data); end
# Payment method-specific configuration for this PaymentIntent.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions)) }
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
# Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::RadarOptions)) }
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::PaymentIntent::CreateParams::RadarOptions)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::RadarOptions))
}
def radar_options=(_radar_options); end
# Email address to send the receipt to. If you specify `receipt_email` for a payment in live mode, you send a receipt regardless of your [email settings](https://dashboard.stripe.com/account/emails).
sig { returns(T.nilable(String)) }
def receipt_email; end
sig { params(_receipt_email: T.nilable(String)).returns(T.nilable(String)) }
def receipt_email=(_receipt_email); end
# The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# Indicates whether confirmation for this PaymentIntent using a secret key is `required` or `optional`.
sig { returns(T.nilable(String)) }
def secret_key_confirmation; end
sig { params(_secret_key_confirmation: T.nilable(String)).returns(T.nilable(String)) }
def secret_key_confirmation=(_secret_key_confirmation); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Shipping information for this PaymentIntent.
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::Shipping)) }
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::PaymentIntent::CreateParams::Shipping)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::Shipping))
}
def shipping=(_shipping); end
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# The parameters that you can use to automatically create a Transfer.
# Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::PaymentIntent::CreateParams::TransferData)).returns(T.nilable(::Stripe::PaymentIntent::CreateParams::TransferData))
}
def transfer_data=(_transfer_data); end
# A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
# Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
sig { returns(T.nilable(T::Boolean)) }
def use_stripe_sdk; end
sig { params(_use_stripe_sdk: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def use_stripe_sdk=(_use_stripe_sdk); end
sig {
params(amount: Integer, amount_details: T.nilable(::Stripe::PaymentIntent::CreateParams::AmountDetails), application_fee_amount: T.nilable(Integer), automatic_payment_methods: T.nilable(::Stripe::PaymentIntent::CreateParams::AutomaticPaymentMethods), capture_method: T.nilable(String), confirm: T.nilable(T::Boolean), confirmation_method: T.nilable(String), confirmation_token: T.nilable(String), currency: String, customer: T.nilable(String), customer_account: T.nilable(String), description: T.nilable(String), error_on_requires_action: T.nilable(T::Boolean), excluded_payment_method_types: T.nilable(T::Array[String]), expand: T.nilable(T::Array[String]), fx_quote: T.nilable(String), hooks: T.nilable(::Stripe::PaymentIntent::CreateParams::Hooks), mandate: T.nilable(String), mandate_data: T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::MandateData)), metadata: T.nilable(T::Hash[String, String]), off_session: T.nilable(T.any(T::Boolean, String)), on_behalf_of: T.nilable(String), payment_details: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentDetails), payment_method: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), radar_options: T.nilable(::Stripe::PaymentIntent::CreateParams::RadarOptions), receipt_email: T.nilable(String), return_url: T.nilable(String), secret_key_confirmation: T.nilable(String), setup_future_usage: T.nilable(String), shipping: T.nilable(::Stripe::PaymentIntent::CreateParams::Shipping), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::PaymentIntent::CreateParams::TransferData), transfer_group: T.nilable(String), use_stripe_sdk: T.nilable(T::Boolean)).void
}
def initialize(
amount: nil,
amount_details: nil,
application_fee_amount: nil,
automatic_payment_methods: nil,
capture_method: nil,
confirm: nil,
confirmation_method: nil,
confirmation_token: nil,
currency: nil,
customer: nil,
customer_account: nil,
description: nil,
error_on_requires_action: nil,
excluded_payment_method_types: nil,
expand: nil,
fx_quote: nil,
hooks: nil,
mandate: nil,
mandate_data: nil,
metadata: nil,
off_session: nil,
on_behalf_of: nil,
payment_details: nil,
payment_method: nil,
payment_method_configuration: nil,
payment_method_data: nil,
payment_method_options: nil,
payment_method_types: nil,
radar_options: nil,
receipt_email: nil,
return_url: nil,
secret_key_confirmation: nil,
setup_future_usage: nil,
shipping: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil,
transfer_group: nil,
use_stripe_sdk: nil
); end
end
class UpdateParams < Stripe::RequestParams
class AmountDetails < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class Card < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class CardPresent < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class Klarna < Stripe::RequestParams
# URL to an image for the product. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def image_url; end
sig { params(_image_url: T.nilable(String)).returns(T.nilable(String)) }
def image_url=(_image_url); end
# URL to the product page. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def product_url; end
sig { params(_product_url: T.nilable(String)).returns(T.nilable(String)) }
def product_url=(_product_url); end
# Reference for the subscription this line item is for.
sig { returns(T.nilable(String)) }
def subscription_reference; end
sig { params(_subscription_reference: T.nilable(String)).returns(T.nilable(String)) }
def subscription_reference=(_subscription_reference); end
sig {
params(image_url: T.nilable(String), product_url: T.nilable(String), subscription_reference: T.nilable(String)).void
}
def initialize(image_url: nil, product_url: nil, subscription_reference: nil); end
end
class Paypal < Stripe::RequestParams
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
sig {
params(category: T.nilable(String), description: T.nilable(String), sold_by: T.nilable(String)).void
}
def initialize(category: nil, description: nil, sold_by: nil); end
end
# This sub-hash contains line item details that are specific to `card` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card=(_card); end
# This sub-hash contains line item details that are specific to `card_present` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present=(_card_present); end
# This sub-hash contains line item details that are specific to `klarna` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# This sub-hash contains line item details that are specific to `paypal` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
sig {
params(card: T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent), klarna: T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna), paypal: T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).void
}
def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end
end
class Tax < Stripe::RequestParams
# The total tax on an item. Non-negative integer.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The amount an item was discounted for. Positive integer.
sig { returns(T.nilable(Integer)) }
def discount_amount; end
sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def discount_amount=(_discount_amount); end
# Payment method-specific information for line items.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# Unique identifier of the product. At most 12 characters long.
sig { returns(T.nilable(String)) }
def product_code; end
sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) }
def product_code=(_product_code); end
# Name of the product. At most 100 characters long.
sig { returns(String) }
def product_name; end
sig { params(_product_name: String).returns(String) }
def product_name=(_product_name); end
# Number of items of the product. Positive integer.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Contains information about the tax on the item.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::Tax)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::Tax))
}
def tax=(_tax); end
# Cost of the product. Non-negative integer.
sig { returns(Integer) }
def unit_cost; end
sig { params(_unit_cost: Integer).returns(Integer) }
def unit_cost=(_unit_cost); end
# A unit of measure for the line item, such as gallons, feet, meters, etc.
sig { returns(T.nilable(String)) }
def unit_of_measure; end
sig { params(_unit_of_measure: T.nilable(String)).returns(T.nilable(String)) }
def unit_of_measure=(_unit_of_measure); end
sig {
params(discount_amount: T.nilable(Integer), payment_method_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions), product_code: T.nilable(String), product_name: String, quantity: Integer, tax: T.nilable(::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem::Tax), unit_cost: Integer, unit_of_measure: T.nilable(String)).void
}
def initialize(
discount_amount: nil,
payment_method_options: nil,
product_code: nil,
product_name: nil,
quantity: nil,
tax: nil,
unit_cost: nil,
unit_of_measure: nil
); end
end
class Shipping < Stripe::RequestParams
# Portion of the amount that is for shipping.
sig { returns(T.nilable(T.any(String, Integer))) }
def amount; end
sig {
params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def amount=(_amount); end
# The postal code that represents the shipping source.
sig { returns(T.nilable(String)) }
def from_postal_code; end
sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def from_postal_code=(_from_postal_code); end
# The postal code that represents the shipping destination.
sig { returns(T.nilable(String)) }
def to_postal_code; end
sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def to_postal_code=(_to_postal_code); end
sig {
params(amount: T.nilable(T.any(String, Integer)), from_postal_code: T.nilable(String), to_postal_code: T.nilable(String)).void
}
def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end
end
class Tax < Stripe::RequestParams
# Total portion of the amount that is for tax.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The total discount applied on the transaction.
sig { returns(T.nilable(T.any(String, Integer))) }
def discount_amount; end
sig {
params(_discount_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def discount_amount=(_discount_amount); end
# A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem])))
}
def line_items; end
sig {
params(_line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem])))
}
def line_items=(_line_items); end
# Contains information about the shipping portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::AmountDetails::Shipping)))
}
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::AmountDetails::Shipping))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::AmountDetails::Shipping)))
}
def shipping=(_shipping); end
# Contains information about the tax portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::AmountDetails::Tax)))
}
def tax; end
sig {
params(_tax: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::AmountDetails::Tax))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::AmountDetails::Tax)))
}
def tax=(_tax); end
sig {
params(discount_amount: T.nilable(T.any(String, Integer)), line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::UpdateParams::AmountDetails::LineItem])), shipping: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::AmountDetails::Shipping)), tax: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::AmountDetails::Tax))).void
}
def initialize(discount_amount: nil, line_items: nil, shipping: nil, tax: nil); end
end
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
sig { returns(String) }
def calculation; end
sig { params(_calculation: String).returns(String) }
def calculation=(_calculation); end
sig { params(calculation: String).void }
def initialize(calculation: nil); end
end
# Tax arguments for automations
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::Hooks::Inputs::Tax)) }
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntent::UpdateParams::Hooks::Inputs::Tax)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::Hooks::Inputs::Tax))
}
def tax=(_tax); end
sig {
params(tax: T.nilable(::Stripe::PaymentIntent::UpdateParams::Hooks::Inputs::Tax)).void
}
def initialize(tax: nil); end
end
# Arguments passed in automations
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::Hooks::Inputs)) }
def inputs; end
sig {
params(_inputs: T.nilable(::Stripe::PaymentIntent::UpdateParams::Hooks::Inputs)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::Hooks::Inputs))
}
def inputs=(_inputs); end
sig { params(inputs: T.nilable(::Stripe::PaymentIntent::UpdateParams::Hooks::Inputs)).void }
def initialize(inputs: nil); end
end
class MandateData < Stripe::RequestParams
class CustomerAcceptance < Stripe::RequestParams
class Online < Stripe::RequestParams
# The IP address from which the Mandate was accepted by the customer.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# The user agent of the browser from which the Mandate was accepted by the customer.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig { params(ip_address: T.nilable(String), user_agent: T.nilable(String)).void }
def initialize(ip_address: nil, user_agent: nil); end
end
# If this is a Mandate accepted online, this hash contains details about the online acceptance.
sig {
returns(::Stripe::PaymentIntent::UpdateParams::MandateData::CustomerAcceptance::Online)
}
def online; end
sig {
params(_online: ::Stripe::PaymentIntent::UpdateParams::MandateData::CustomerAcceptance::Online).returns(::Stripe::PaymentIntent::UpdateParams::MandateData::CustomerAcceptance::Online)
}
def online=(_online); end
# The type of customer acceptance information included with the Mandate.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(online: ::Stripe::PaymentIntent::UpdateParams::MandateData::CustomerAcceptance::Online, type: String).void
}
def initialize(online: nil, type: nil); end
end
# This hash contains details about the customer acceptance of the Mandate.
sig { returns(::Stripe::PaymentIntent::UpdateParams::MandateData::CustomerAcceptance) }
def customer_acceptance; end
sig {
params(_customer_acceptance: ::Stripe::PaymentIntent::UpdateParams::MandateData::CustomerAcceptance).returns(::Stripe::PaymentIntent::UpdateParams::MandateData::CustomerAcceptance)
}
def customer_acceptance=(_customer_acceptance); end
sig {
params(customer_acceptance: ::Stripe::PaymentIntent::UpdateParams::MandateData::CustomerAcceptance).void
}
def initialize(customer_acceptance: nil); end
end
class PaymentDetails < Stripe::RequestParams
class CarRental < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Distance < Stripe::RequestParams
# Distance traveled.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
sig { params(amount: T.nilable(Integer), unit: T.nilable(String)).void }
def initialize(amount: nil, unit: nil); end
end
class Driver < Stripe::RequestParams
# Driver's identification number.
sig { returns(T.nilable(String)) }
def driver_identification_number; end
sig {
params(_driver_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def driver_identification_number=(_driver_identification_number); end
# Driver's tax number.
sig { returns(T.nilable(String)) }
def driver_tax_number; end
sig { params(_driver_tax_number: T.nilable(String)).returns(T.nilable(String)) }
def driver_tax_number=(_driver_tax_number); end
# Full name of the person or entity on the car reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(driver_identification_number: T.nilable(String), driver_tax_number: T.nilable(String), name: String).void
}
def initialize(
driver_identification_number: nil,
driver_tax_number: nil,
name: nil
); end
end
class PickupAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class ReturnAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the car rental.
sig { returns(String) }
def booking_number; end
sig { params(_booking_number: String).returns(String) }
def booking_number=(_booking_number); end
# Class code of the car.
sig { returns(T.nilable(String)) }
def car_class_code; end
sig { params(_car_class_code: T.nilable(String)).returns(T.nilable(String)) }
def car_class_code=(_car_class_code); end
# Make of the car.
sig { returns(T.nilable(String)) }
def car_make; end
sig { params(_car_make: T.nilable(String)).returns(T.nilable(String)) }
def car_make=(_car_make); end
# Model of the car.
sig { returns(T.nilable(String)) }
def car_model; end
sig { params(_car_model: T.nilable(String)).returns(T.nilable(String)) }
def car_model=(_car_model); end
# The name of the rental car company.
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# The customer service phone number of the car rental company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# Number of days the car is being rented.
sig { returns(Integer) }
def days_rented; end
sig { params(_days_rented: Integer).returns(Integer) }
def days_rented=(_days_rented); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Delivery)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Delivery))
}
def delivery=(_delivery); end
# The details of the distance traveled during the rental period.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Distance))
}
def distance; end
sig {
params(_distance: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Distance)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Distance))
}
def distance=(_distance); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Driver]))
}
def drivers; end
sig {
params(_drivers: T.nilable(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Driver])).returns(T.nilable(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Driver]))
}
def drivers=(_drivers); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates if the customer did not keep nor cancel their booking.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# Car pick-up address.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address; end
sig {
params(_pickup_address: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::PickupAddress)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address=(_pickup_address); end
# Car pick-up time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def pickup_at; end
sig { params(_pickup_at: Integer).returns(Integer) }
def pickup_at=(_pickup_at); end
# Name of the pickup location.
sig { returns(T.nilable(String)) }
def pickup_location_name; end
sig { params(_pickup_location_name: T.nilable(String)).returns(T.nilable(String)) }
def pickup_location_name=(_pickup_location_name); end
# Rental rate.
sig { returns(T.nilable(Integer)) }
def rate_amount; end
sig { params(_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def rate_amount=(_rate_amount); end
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
sig { returns(T.nilable(String)) }
def rate_interval; end
sig { params(_rate_interval: T.nilable(String)).returns(T.nilable(String)) }
def rate_interval=(_rate_interval); end
# The name of the person or entity renting the car.
sig { returns(T.nilable(String)) }
def renter_name; end
sig { params(_renter_name: T.nilable(String)).returns(T.nilable(String)) }
def renter_name=(_renter_name); end
# Car return address.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address; end
sig {
params(_return_address: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::ReturnAddress)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address=(_return_address); end
# Car return time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def return_at; end
sig { params(_return_at: Integer).returns(Integer) }
def return_at=(_return_at); end
# Name of the return location.
sig { returns(T.nilable(String)) }
def return_location_name; end
sig { params(_return_location_name: T.nilable(String)).returns(T.nilable(String)) }
def return_location_name=(_return_location_name); end
# Indicates whether the goods or services are tax-exempt or tax is not collected.
sig { returns(T.nilable(T::Boolean)) }
def tax_exempt; end
sig { params(_tax_exempt: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def tax_exempt=(_tax_exempt); end
# The vehicle identification number.
sig { returns(T.nilable(String)) }
def vehicle_identification_number; end
sig {
params(_vehicle_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def vehicle_identification_number=(_vehicle_identification_number); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Affiliate), booking_number: String, car_class_code: T.nilable(String), car_make: T.nilable(String), car_model: T.nilable(String), company: T.nilable(String), customer_service_phone_number: T.nilable(String), days_rented: Integer, delivery: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Delivery), distance: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Distance), drivers: T.nilable(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::Driver]), extra_charges: T.nilable(T::Array[String]), no_show: T.nilable(T::Boolean), pickup_address: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::PickupAddress), pickup_at: Integer, pickup_location_name: T.nilable(String), rate_amount: T.nilable(Integer), rate_interval: T.nilable(String), renter_name: T.nilable(String), return_address: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental::ReturnAddress), return_at: Integer, return_location_name: T.nilable(String), tax_exempt: T.nilable(T::Boolean), vehicle_identification_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
booking_number: nil,
car_class_code: nil,
car_make: nil,
car_model: nil,
company: nil,
customer_service_phone_number: nil,
days_rented: nil,
delivery: nil,
distance: nil,
drivers: nil,
extra_charges: nil,
no_show: nil,
pickup_address: nil,
pickup_at: nil,
pickup_location_name: nil,
rate_amount: nil,
rate_interval: nil,
renter_name: nil,
return_address: nil,
return_at: nil,
return_location_name: nil,
tax_exempt: nil,
vehicle_identification_number: nil
); end
end
class EventDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
# Indicates if the tickets are digitally checked when entering the venue.
sig { returns(T.nilable(T::Boolean)) }
def access_controlled_venue; end
sig {
params(_access_controlled_venue: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def access_controlled_venue=(_access_controlled_venue); end
# The event location's address.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails::Address)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails::Address))
}
def address=(_address); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate=(_affiliate); end
# The name of the company
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails::Delivery)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails::Delivery))
}
def delivery=(_delivery); end
# Event end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Type of the event entertainment (concert, sports event etc)
sig { returns(T.nilable(String)) }
def genre; end
sig { params(_genre: T.nilable(String)).returns(T.nilable(String)) }
def genre=(_genre); end
# The name of the event.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Event start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(access_controlled_venue: T.nilable(T::Boolean), address: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails::Address), affiliate: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails::Affiliate), company: T.nilable(String), delivery: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails::Delivery), ends_at: T.nilable(Integer), genre: T.nilable(String), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
access_controlled_venue: nil,
address: nil,
affiliate: nil,
company: nil,
delivery: nil,
ends_at: nil,
genre: nil,
name: nil,
starts_at: nil
); end
end
class Flight < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the flight reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Segment < Stripe::RequestParams
# The flight segment amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The International Air Transport Association (IATA) airport code for the arrival airport.
sig { returns(T.nilable(String)) }
def arrival_airport; end
sig { params(_arrival_airport: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport=(_arrival_airport); end
# The arrival time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def arrives_at; end
sig { params(_arrives_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def arrives_at=(_arrives_at); end
# The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The departure time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def departs_at; end
sig { params(_departs_at: Integer).returns(Integer) }
def departs_at=(_departs_at); end
# The International Air Transport Association (IATA) airport code for the departure airport.
sig { returns(T.nilable(String)) }
def departure_airport; end
sig { params(_departure_airport: T.nilable(String)).returns(T.nilable(String)) }
def departure_airport=(_departure_airport); end
# The flight number associated with the segment
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The fare class for the segment.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
sig {
params(amount: T.nilable(Integer), arrival_airport: T.nilable(String), arrives_at: T.nilable(Integer), carrier: T.nilable(String), departs_at: Integer, departure_airport: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String)).void
}
def initialize(
amount: nil,
arrival_airport: nil,
arrives_at: nil,
carrier: nil,
departs_at: nil,
departure_airport: nil,
flight_number: nil,
service_class: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Affiliate))
}
def affiliate=(_affiliate); end
# The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
sig { returns(T.nilable(String)) }
def agency_number; end
sig { params(_agency_number: T.nilable(String)).returns(T.nilable(String)) }
def agency_number=(_agency_number); end
# The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Delivery)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Delivery))
}
def delivery=(_delivery); end
# The name of the person or entity on the reservation.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# The details of the passengers in the travel reservation.
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Passenger])).returns(T.nilable(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Passenger]))
}
def passengers=(_passengers); end
# The individual flight segments associated with the trip.
sig {
returns(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Segment])
}
def segments; end
sig {
params(_segments: T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Segment]).returns(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Segment])
}
def segments=(_segments); end
# The ticket number associated with the travel reservation.
sig { returns(T.nilable(String)) }
def ticket_number; end
sig { params(_ticket_number: T.nilable(String)).returns(T.nilable(String)) }
def ticket_number=(_ticket_number); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Affiliate), agency_number: T.nilable(String), carrier: T.nilable(String), delivery: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Delivery), passenger_name: T.nilable(String), passengers: T.nilable(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Passenger]), segments: T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight::Segment], ticket_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
agency_number: nil,
carrier: nil,
delivery: nil,
passenger_name: nil,
passengers: nil,
segments: nil,
ticket_number: nil
); end
end
class Lodging < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the lodging reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
# The lodging location's address.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Address)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Address))
}
def address=(_address); end
# The number of adults on the booking
sig { returns(T.nilable(Integer)) }
def adults; end
sig { params(_adults: T.nilable(Integer)).returns(T.nilable(Integer)) }
def adults=(_adults); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the lodging reservation.
sig { returns(T.nilable(String)) }
def booking_number; end
sig { params(_booking_number: T.nilable(String)).returns(T.nilable(String)) }
def booking_number=(_booking_number); end
# The lodging category
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Lodging check-in time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkin_at; end
sig { params(_checkin_at: Integer).returns(Integer) }
def checkin_at=(_checkin_at); end
# Lodging check-out time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkout_at; end
sig { params(_checkout_at: Integer).returns(Integer) }
def checkout_at=(_checkout_at); end
# The customer service phone number of the lodging company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# The daily lodging room rate.
sig { returns(T.nilable(Integer)) }
def daily_room_rate_amount; end
sig { params(_daily_room_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def daily_room_rate_amount=(_daily_room_rate_amount); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Delivery)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Delivery))
}
def delivery=(_delivery); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates whether the lodging location is compliant with the Fire Safety Act.
sig { returns(T.nilable(T::Boolean)) }
def fire_safety_act_compliance; end
sig {
params(_fire_safety_act_compliance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def fire_safety_act_compliance=(_fire_safety_act_compliance); end
# The name of the lodging location.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Indicates if the customer did not keep their booking while failing to cancel the reservation.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# The number of rooms on the booking
sig { returns(T.nilable(Integer)) }
def number_of_rooms; end
sig { params(_number_of_rooms: T.nilable(Integer)).returns(T.nilable(Integer)) }
def number_of_rooms=(_number_of_rooms); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Passenger])).returns(T.nilable(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Passenger]))
}
def passengers=(_passengers); end
# The phone number of the lodging location.
sig { returns(T.nilable(String)) }
def property_phone_number; end
sig { params(_property_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def property_phone_number=(_property_phone_number); end
# The room class for this purchase.
sig { returns(T.nilable(String)) }
def room_class; end
sig { params(_room_class: T.nilable(String)).returns(T.nilable(String)) }
def room_class=(_room_class); end
# The number of room nights
sig { returns(T.nilable(Integer)) }
def room_nights; end
sig { params(_room_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def room_nights=(_room_nights); end
# The total tax amount associating with the room reservation.
sig { returns(T.nilable(Integer)) }
def total_room_tax_amount; end
sig { params(_total_room_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_room_tax_amount=(_total_room_tax_amount); end
# The total tax amount
sig { returns(T.nilable(Integer)) }
def total_tax_amount; end
sig { params(_total_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_tax_amount=(_total_tax_amount); end
sig {
params(address: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Address), adults: T.nilable(Integer), affiliate: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Affiliate), booking_number: T.nilable(String), category: T.nilable(String), checkin_at: Integer, checkout_at: Integer, customer_service_phone_number: T.nilable(String), daily_room_rate_amount: T.nilable(Integer), delivery: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Delivery), extra_charges: T.nilable(T::Array[String]), fire_safety_act_compliance: T.nilable(T::Boolean), name: T.nilable(String), no_show: T.nilable(T::Boolean), number_of_rooms: T.nilable(Integer), passengers: T.nilable(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging::Passenger]), property_phone_number: T.nilable(String), room_class: T.nilable(String), room_nights: T.nilable(Integer), total_room_tax_amount: T.nilable(Integer), total_tax_amount: T.nilable(Integer)).void
}
def initialize(
address: nil,
adults: nil,
affiliate: nil,
booking_number: nil,
category: nil,
checkin_at: nil,
checkout_at: nil,
customer_service_phone_number: nil,
daily_room_rate_amount: nil,
delivery: nil,
extra_charges: nil,
fire_safety_act_compliance: nil,
name: nil,
no_show: nil,
number_of_rooms: nil,
passengers: nil,
property_phone_number: nil,
room_class: nil,
room_nights: nil,
total_room_tax_amount: nil,
total_tax_amount: nil
); end
end
class Subscription < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class BillingInterval < Stripe::RequestParams
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def count; end
sig { params(_count: Integer).returns(Integer) }
def count=(_count); end
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig { params(count: Integer, interval: String).void }
def initialize(count: nil, interval: nil); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Subscription::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate=(_affiliate); end
# Info whether the subscription will be auto renewed upon expiry.
sig { returns(T.nilable(T::Boolean)) }
def auto_renewal; end
sig { params(_auto_renewal: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_renewal=(_auto_renewal); end
# Subscription billing details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval; end
sig {
params(_billing_interval: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Subscription::BillingInterval)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval=(_billing_interval); end
# Subscription end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Name of the product on subscription. e.g. Apple Music Subscription
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Subscription start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Subscription::Affiliate), auto_renewal: T.nilable(T::Boolean), billing_interval: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Subscription::BillingInterval), ends_at: T.nilable(Integer), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
affiliate: nil,
auto_renewal: nil,
billing_interval: nil,
ends_at: nil,
name: nil,
starts_at: nil
); end
end
# Car rental details for this PaymentIntent.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental)) }
def car_rental; end
sig {
params(_car_rental: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental))
}
def car_rental=(_car_rental); end
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
sig { returns(T.nilable(String)) }
def customer_reference; end
sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) }
def customer_reference=(_customer_reference); end
# Event details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails))
}
def event_details; end
sig {
params(_event_details: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails))
}
def event_details=(_event_details); end
# Flight reservation details for this PaymentIntent
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight)) }
def flight; end
sig {
params(_flight: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight))
}
def flight=(_flight); end
# Lodging reservation details for this PaymentIntent
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging)) }
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging))
}
def lodging=(_lodging); end
# A unique value assigned by the business to identify the transaction.
sig { returns(T.nilable(String)) }
def order_reference; end
sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) }
def order_reference=(_order_reference); end
# Subscription details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Subscription))
}
def subscription; end
sig {
params(_subscription: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Subscription)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Subscription))
}
def subscription=(_subscription); end
sig {
params(car_rental: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::CarRental), customer_reference: T.nilable(String), event_details: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::EventDetails), flight: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Flight), lodging: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Lodging), order_reference: T.nilable(String), subscription: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentDetails::Subscription)).void
}
def initialize(
car_rental: nil,
customer_reference: nil,
event_details: nil,
flight: nil,
lodging: nil,
order_reference: nil,
subscription: nil
); end
end
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Institution number of the customer's bank.
sig { returns(String) }
def institution_number; end
sig { params(_institution_number: String).returns(String) }
def institution_number=(_institution_number); end
# Transit number of the customer's bank.
sig { returns(String) }
def transit_number; end
sig { params(_transit_number: String).returns(String) }
def transit_number=(_transit_number); end
sig {
params(account_number: String, institution_number: String, transit_number: String).void
}
def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(String) }
def bsb_number; end
sig { params(_bsb_number: String).returns(String) }
def bsb_number=(_bsb_number); end
sig { params(account_number: String, bsb_number: String).void }
def initialize(account_number: nil, bsb_number: nil); end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
sig { params(_sort_code: T.nilable(String)).returns(T.nilable(String)) }
def sort_code=(_sort_code); end
sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
def initialize(account_number: nil, sort_code: nil); end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
sig { params(_tax_id: String).returns(String) }
def tax_id=(_tax_id); end
sig { params(tax_id: String).void }
def initialize(tax_id: nil); end
end
class Cashapp < Stripe::RequestParams; end
class Crypto < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The customer's bank.
sig { returns(String) }
def bank; end
sig { params(_bank: String).returns(String) }
def bank=(_bank); end
sig { params(account_holder_type: T.nilable(String), bank: String).void }
def initialize(account_holder_type: nil, bank: nil); end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Klarna::Dob))
}
def dob; end
sig {
params(_dob: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Klarna::Dob)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Klarna::Dob))
}
def dob=(_dob); end
sig {
params(dob: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Klarna::Dob)).void
}
def initialize(dob: nil); end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
sig { returns(T.nilable(String)) }
def funding; end
sig { params(_funding: T.nilable(String)).returns(T.nilable(String)) }
def funding=(_funding); end
sig { params(funding: T.nilable(String)).void }
def initialize(funding: nil); end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
sig { params(_bank_code: String).returns(String) }
def bank_code=(_bank_code); end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
sig { params(_branch_code: String).returns(String) }
def branch_code=(_branch_code); end
# Attribute for param field reference
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# The suffix of the bank account number.
sig { returns(String) }
def suffix; end
sig { params(_suffix: String).returns(String) }
def suffix=(_suffix); end
sig {
params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
); end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Paypay < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig { returns(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Rechnung::Dob) }
def dob; end
sig {
params(_dob: ::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Rechnung::Dob).returns(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Rechnung::Dob)
}
def dob=(_dob); end
sig {
params(dob: ::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Rechnung::Dob).void
}
def initialize(dob: nil); end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
sig { returns(String) }
def iban; end
sig { params(_iban: String).returns(String) }
def iban=(_iban); end
sig { params(iban: String).void }
def initialize(iban: nil); end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
sig { params(account: T.nilable(String), source_type: T.nilable(String)).void }
def initialize(account: nil, source_type: nil); end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig {
params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String))
}
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AcssDebit)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Affirm)) }
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Affirm)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Affirm))
}
def affirm=(_affirm); end
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AfterpayClearpay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Alipay)) }
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Alipay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Alipay))
}
def alipay=(_alipay); end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Alma)) }
def alma; end
sig {
params(_alma: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Alma)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Alma))
}
def alma=(_alma); end
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AmazonPay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AuBecsDebit)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::BacsDebit)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Bancontact)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Bancontact))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Billie)) }
def billie; end
sig {
params(_billie: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Billie)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Billie))
}
def billie=(_billie); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::BillingDetails)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Blik)) }
def blik; end
sig {
params(_blik: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Blik)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Blik))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Boleto)) }
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Boleto)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Boleto))
}
def boleto=(_boleto); end
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Cashapp))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Cashapp)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Cashapp))
}
def cashapp=(_cashapp); end
# If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Crypto)) }
def crypto; end
sig {
params(_crypto: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Crypto)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Crypto))
}
def crypto=(_crypto); end
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::CustomerBalance)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Eps)) }
def eps; end
sig {
params(_eps: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Eps)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Eps))
}
def eps=(_eps); end
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Fpx)) }
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Fpx)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Fpx))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Giropay))
}
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Giropay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Giropay))
}
def giropay=(_giropay); end
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Gopay)) }
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Gopay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Gopay))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Grabpay))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Grabpay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Grabpay))
}
def grabpay=(_grabpay); end
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::IdBankTransfer)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Ideal)) }
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Ideal)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Ideal))
}
def ideal=(_ideal); end
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::InteracPresent))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::InteracPresent)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::InteracPresent))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::KakaoPay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Klarna)) }
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Klarna)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Klarna))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Konbini))
}
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Konbini)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Konbini))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::KrCard)) }
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::KrCard)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::KrCard))
}
def kr_card=(_kr_card); end
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Link)) }
def link; end
sig {
params(_link: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Link)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Link))
}
def link=(_link); end
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::MbWay)) }
def mb_way; end
sig {
params(_mb_way: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::MbWay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::MbWay))
}
def mb_way=(_mb_way); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Mobilepay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Mobilepay))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Multibanco)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Multibanco))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::NaverPay))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::NaverPay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::NaverPay))
}
def naver_pay=(_naver_pay); end
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::NzBankAccount)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Oxxo)) }
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Oxxo)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Oxxo))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::P24)) }
def p24; end
sig {
params(_p24: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::P24)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::P24))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::PayByBank)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Payco)) }
def payco; end
sig {
params(_payco: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Payco)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Payco))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Paynow)) }
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Paynow)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Paynow))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Paypal)) }
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Paypal)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Paypal))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Paypay)) }
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Paypay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Paypay))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Payto)) }
def payto; end
sig {
params(_payto: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Payto)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Payto))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Pix)) }
def pix; end
sig {
params(_pix: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Pix)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Pix))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Promptpay))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Promptpay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Promptpay))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Qris)) }
def qris; end
sig {
params(_qris: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Qris)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Qris))
}
def qris=(_qris); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::RadarOptions))
}
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::RadarOptions)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::RadarOptions))
}
def radar_options=(_radar_options); end
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Rechnung))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Rechnung)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Rechnung))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::RevolutPay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::SamsungPay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Satispay))
}
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Satispay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Satispay))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::SepaDebit)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Shopeepay))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Shopeepay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Shopeepay))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Sofort)) }
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Sofort)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Sofort))
}
def sofort=(_sofort); end
# This hash contains details about the Stripe balance payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::StripeBalance)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Swish)) }
def swish; end
sig {
params(_swish: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Swish)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Swish))
}
def swish=(_swish); end
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Twint)) }
def twint; end
sig {
params(_twint: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Twint)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Twint))
}
def twint=(_twint); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::UsBankAccount)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::WechatPay)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Zip)) }
def zip; end
sig {
params(_zip: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Zip)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Cashapp), crypto: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Crypto), customer_balance: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Giropay), gopay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Gopay), grabpay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Grabpay), id_bank_transfer: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::IdBankTransfer), ideal: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Link), mb_way: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::MbWay), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Paypal), paypay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Paypay), payto: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Payto), pix: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Promptpay), qris: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Qris), radar_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::RadarOptions), rechnung: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Rechnung), revolut_pay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::SepaDebit), shopeepay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Shopeepay), sofort: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Sofort), stripe_balance: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::StripeBalance), swish: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
mandate_options: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class Affirm < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Preferred language of the Affirm authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), preferred_locale: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, preferred_locale: nil, setup_future_usage: nil); end
end
class AfterpayClearpay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.
# This field differs from the statement descriptor and item name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), reference: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, reference: nil, setup_future_usage: nil); end
end
class Alipay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Alma < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class AmazonPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class AuBecsDebit < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(setup_future_usage: nil, target_date: nil); end
end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class Billie < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Blik < Stripe::RequestParams
# The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.
sig { returns(T.nilable(String)) }
def code; end
sig { params(_code: T.nilable(String)).returns(T.nilable(String)) }
def code=(_code); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(code: T.nilable(String), setup_future_usage: T.nilable(String)).void }
def initialize(code: nil, setup_future_usage: nil); end
end
class Boleto < Stripe::RequestParams
# The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
class Plan < Stripe::RequestParams
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
sig { returns(T.nilable(Integer)) }
def count; end
sig { params(_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def count=(_count); end
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
# One of `month`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(count: T.nilable(Integer), interval: T.nilable(String), type: String).void
}
def initialize(count: nil, interval: nil, type: nil); end
end
# Setting to true enables installments for this PaymentIntent.
# This will cause the response to contain a list of available installment plans.
# Setting to false will prevent any selected plan from applying to a charge.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# The selected installment plan to use for this payment attempt.
# This parameter can only be provided during confirmation.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan; end
sig {
params(_plan: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::Installments::Plan))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan=(_plan); end
sig {
params(enabled: T.nilable(T::Boolean), plan: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::Installments::Plan))).void
}
def initialize(enabled: nil, plan: nil); end
end
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(String) }
def amount_type; end
sig { params(_amount_type: String).returns(String) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Unique identifier for the mandate or subscription.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
sig { returns(Integer) }
def start_date; end
sig { params(_start_date: Integer).returns(Integer) }
def start_date=(_start_date); end
# Specifies the type of mandates supported. Possible values are `india`.
sig { returns(T.nilable(T::Array[String])) }
def supported_types; end
sig {
params(_supported_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def supported_types=(_supported_types); end
sig {
params(amount: Integer, amount_type: String, description: T.nilable(String), end_date: T.nilable(Integer), interval: String, interval_count: T.nilable(Integer), reference: String, start_date: Integer, supported_types: T.nilable(T::Array[String])).void
}
def initialize(
amount: nil,
amount_type: nil,
description: nil,
end_date: nil,
interval: nil,
interval_count: nil,
reference: nil,
start_date: nil,
supported_types: nil
); end
end
class StatementDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Please pass in an address that is within your Stripe user account country
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::StatementDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::StatementDetails::Address)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::StatementDetails::Address))
}
def address=(_address); end
# Phone number (e.g., a toll-free number that customers can call)
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::StatementDetails::Address), phone: T.nilable(String)).void
}
def initialize(address: nil, phone: nil); end
end
class ThreeDSecure < Stripe::RequestParams
class NetworkOptions < Stripe::RequestParams
class CartesBancaires < Stripe::RequestParams
# The cryptogram calculation algorithm used by the card Issuer's ACS
# to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
# messageExtension: CB-AVALGO
sig { returns(String) }
def cb_avalgo; end
sig { params(_cb_avalgo: String).returns(String) }
def cb_avalgo=(_cb_avalgo); end
# The exemption indicator returned from Cartes Bancaires in the ARes.
# message extension: CB-EXEMPTION; string (4 characters)
# This is a 3 byte bitmap (low significant byte first and most significant
# bit first) that has been Base64 encoded
sig { returns(T.nilable(String)) }
def cb_exemption; end
sig { params(_cb_exemption: T.nilable(String)).returns(T.nilable(String)) }
def cb_exemption=(_cb_exemption); end
# The risk score returned from Cartes Bancaires in the ARes.
# message extension: CB-SCORE; numeric value 0-99
sig { returns(T.nilable(Integer)) }
def cb_score; end
sig { params(_cb_score: T.nilable(Integer)).returns(T.nilable(Integer)) }
def cb_score=(_cb_score); end
sig {
params(cb_avalgo: String, cb_exemption: T.nilable(String), cb_score: T.nilable(Integer)).void
}
def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil); end
end
# Cartes Bancaires-specific 3DS fields.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires; end
sig {
params(_cartes_bancaires: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires=(_cartes_bancaires); end
sig {
params(cartes_bancaires: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).void
}
def initialize(cartes_bancaires: nil); end
end
# The `transStatus` returned from the card Issuer’s ACS in the ARes.
sig { returns(T.nilable(String)) }
def ares_trans_status; end
sig { params(_ares_trans_status: T.nilable(String)).returns(T.nilable(String)) }
def ares_trans_status=(_ares_trans_status); end
# The cryptogram, also known as the "authentication value" (AAV, CAVV or
# AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
# (Most 3D Secure providers will return the base64-encoded version, which
# is what you should specify here.)
sig { returns(String) }
def cryptogram; end
sig { params(_cryptogram: String).returns(String) }
def cryptogram=(_cryptogram); end
# The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
# provider and indicates what degree of authentication was performed.
sig { returns(T.nilable(String)) }
def electronic_commerce_indicator; end
sig {
params(_electronic_commerce_indicator: T.nilable(String)).returns(T.nilable(String))
}
def electronic_commerce_indicator=(_electronic_commerce_indicator); end
# The exemption requested via 3DS and accepted by the issuer at authentication time.
sig { returns(T.nilable(String)) }
def exemption_indicator; end
sig { params(_exemption_indicator: T.nilable(String)).returns(T.nilable(String)) }
def exemption_indicator=(_exemption_indicator); end
# Network specific 3DS fields. Network specific arguments require an
# explicit card brand choice. The parameter `payment_method_options.card.network``
# must be populated accordingly
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options; end
sig {
params(_network_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options=(_network_options); end
# The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
# AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
sig { returns(T.nilable(String)) }
def requestor_challenge_indicator; end
sig {
params(_requestor_challenge_indicator: T.nilable(String)).returns(T.nilable(String))
}
def requestor_challenge_indicator=(_requestor_challenge_indicator); end
# For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
# Transaction ID (dsTransID).
sig { returns(String) }
def transaction_id; end
sig { params(_transaction_id: String).returns(String) }
def transaction_id=(_transaction_id); end
# The version of 3D Secure that was performed.
sig { returns(String) }
def version; end
sig { params(_version: String).returns(String) }
def version=(_version); end
sig {
params(ares_trans_status: T.nilable(String), cryptogram: String, electronic_commerce_indicator: T.nilable(String), exemption_indicator: T.nilable(String), network_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions), requestor_challenge_indicator: T.nilable(String), transaction_id: String, version: String).void
}
def initialize(
ares_trans_status: nil,
cryptogram: nil,
electronic_commerce_indicator: nil,
exemption_indicator: nil,
network_options: nil,
requestor_challenge_indicator: nil,
transaction_id: nil,
version: nil
); end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.
sig { returns(T.nilable(String)) }
def cvc_token; end
sig { params(_cvc_token: T.nilable(String)).returns(T.nilable(String)) }
def cvc_token=(_cvc_token); end
# Installment configuration for payments attempted on this PaymentIntent.
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::Installments))
}
def installments; end
sig {
params(_installments: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::Installments)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::Installments))
}
def installments=(_installments); end
# Configuration options for setting up an eMandate for cards issued in India.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options=(_mandate_options); end
# When specified, this parameter indicates that a transaction will be marked
# as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
# parameter can only be provided during confirmation.
sig { returns(T.nilable(T::Boolean)) }
def moto; end
sig { params(_moto: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def moto=(_moto); end
# Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
# Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_decremental_authorization; end
sig {
params(_request_decremental_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_decremental_authorization=(_request_decremental_authorization); end
# Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_extended_authorization; end
sig {
params(_request_extended_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_extended_authorization=(_request_extended_authorization); end
# Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_incremental_authorization; end
sig {
params(_request_incremental_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_incremental_authorization=(_request_incremental_authorization); end
# Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_multicapture; end
sig { params(_request_multicapture: T.nilable(String)).returns(T.nilable(String)) }
def request_multicapture=(_request_multicapture); end
# Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_overcapture; end
sig { params(_request_overcapture: T.nilable(String)).returns(T.nilable(String)) }
def request_overcapture=(_request_overcapture); end
# Request partial authorization on this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_partial_authorization; end
sig {
params(_request_partial_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_partial_authorization=(_request_partial_authorization); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
# When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).
sig { returns(T.nilable(T::Boolean)) }
def require_cvc_recollection; end
sig {
params(_require_cvc_recollection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def require_cvc_recollection=(_require_cvc_recollection); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kana; end
sig {
params(_statement_descriptor_suffix_kana: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_suffix_kana=(_statement_descriptor_suffix_kana); end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kanji; end
sig {
params(_statement_descriptor_suffix_kanji: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_suffix_kanji=(_statement_descriptor_suffix_kanji); end
# Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::StatementDetails)))
}
def statement_details; end
sig {
params(_statement_details: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::StatementDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::StatementDetails)))
}
def statement_details=(_statement_details); end
# If 3D Secure authentication was performed with a third-party provider,
# the authentication details to use for this payment.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure; end
sig {
params(_three_d_secure: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure=(_three_d_secure); end
sig {
params(capture_method: T.nilable(String), cvc_token: T.nilable(String), installments: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::Installments), mandate_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::MandateOptions), moto: T.nilable(T::Boolean), network: T.nilable(String), request_decremental_authorization: T.nilable(String), request_extended_authorization: T.nilable(String), request_incremental_authorization: T.nilable(String), request_multicapture: T.nilable(String), request_overcapture: T.nilable(String), request_partial_authorization: T.nilable(String), request_three_d_secure: T.nilable(String), require_cvc_recollection: T.nilable(T::Boolean), setup_future_usage: T.nilable(T.any(String, String)), statement_descriptor_suffix_kana: T.nilable(String), statement_descriptor_suffix_kanji: T.nilable(String), statement_details: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::StatementDetails)), three_d_secure: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure)).void
}
def initialize(
capture_method: nil,
cvc_token: nil,
installments: nil,
mandate_options: nil,
moto: nil,
network: nil,
request_decremental_authorization: nil,
request_extended_authorization: nil,
request_incremental_authorization: nil,
request_multicapture: nil,
request_overcapture: nil,
request_partial_authorization: nil,
request_three_d_secure: nil,
require_cvc_recollection: nil,
setup_future_usage: nil,
statement_descriptor_suffix_kana: nil,
statement_descriptor_suffix_kanji: nil,
statement_details: nil,
three_d_secure: nil
); end
end
class CardPresent < Stripe::RequestParams
class Routing < Stripe::RequestParams
# Routing requested priority
sig { returns(T.nilable(String)) }
def requested_priority; end
sig { params(_requested_priority: T.nilable(String)).returns(T.nilable(String)) }
def requested_priority=(_requested_priority); end
sig { params(requested_priority: T.nilable(String)).void }
def initialize(requested_priority: nil); end
end
# Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)
sig { returns(T.nilable(T::Boolean)) }
def request_extended_authorization; end
sig {
params(_request_extended_authorization: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def request_extended_authorization=(_request_extended_authorization); end
# Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
sig { returns(T.nilable(T::Boolean)) }
def request_incremental_authorization_support; end
sig {
params(_request_incremental_authorization_support: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def request_incremental_authorization_support=(
_request_incremental_authorization_support
); end
# Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CardPresent::Routing))
}
def routing; end
sig {
params(_routing: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CardPresent::Routing)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CardPresent::Routing))
}
def routing=(_routing); end
sig {
params(request_extended_authorization: T.nilable(T::Boolean), request_incremental_authorization_support: T.nilable(T::Boolean), routing: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CardPresent::Routing)).void
}
def initialize(
request_extended_authorization: nil,
request_incremental_authorization_support: nil,
routing: nil
); end
end
class Cashapp < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Crypto < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for the eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
sig {
params(_requested_address_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested_address_types=(_requested_address_types); end
# The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
}
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(bank_transfer: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
end
class Eps < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Fpx < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Giropay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Gopay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Grabpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class IdBankTransfer < Stripe::RequestParams
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from 5 minutes from now until 31 days from now. If unset, it defaults to 3 days from now.
sig { returns(T.nilable(Integer)) }
def expires_after; end
sig { params(_expires_after: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after=(_expires_after); end
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now until 30 days from now. If unset, it defaults to 1 days from now.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after: T.nilable(Integer), expires_at: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after: nil, expires_at: nil, setup_future_usage: nil); end
end
class Ideal < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Klarna < Stripe::RequestParams
class OnDemand < Stripe::RequestParams
# Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def average_amount; end
sig { params(_average_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def average_amount=(_average_amount); end
# The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def maximum_amount; end
sig { params(_maximum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_amount=(_maximum_amount); end
# The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Interval at which the customer is making purchases
sig { returns(T.nilable(String)) }
def purchase_interval; end
sig { params(_purchase_interval: T.nilable(String)).returns(T.nilable(String)) }
def purchase_interval=(_purchase_interval); end
# The number of `purchase_interval` between charges
sig { returns(T.nilable(Integer)) }
def purchase_interval_count; end
sig { params(_purchase_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def purchase_interval_count=(_purchase_interval_count); end
sig {
params(average_amount: T.nilable(Integer), maximum_amount: T.nilable(Integer), minimum_amount: T.nilable(Integer), purchase_interval: T.nilable(String), purchase_interval_count: T.nilable(Integer)).void
}
def initialize(
average_amount: nil,
maximum_amount: nil,
minimum_amount: nil,
purchase_interval: nil,
purchase_interval_count: nil
); end
end
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing; end
sig {
params(_next_billing: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling), reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# On-demand details if setting up or charging an on-demand payment.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand; end
sig {
params(_on_demand: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna::OnDemand)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand=(_on_demand); end
# Preferred language of the Klarna authorization page that the customer is redirected to
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Subscription details if setting up or charging a subscription.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(capture_method: T.nilable(String), on_demand: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna::OnDemand), preferred_locale: T.nilable(String), setup_future_usage: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(
capture_method: nil,
on_demand: nil,
preferred_locale: nil,
setup_future_usage: nil,
subscriptions: nil
); end
end
class Konbini < Stripe::RequestParams
# An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number.
sig { returns(T.nilable(String)) }
def confirmation_number; end
sig { params(_confirmation_number: T.nilable(String)).returns(T.nilable(String)) }
def confirmation_number=(_confirmation_number); end
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
sig { returns(T.nilable(T.any(String, Integer))) }
def expires_after_days; end
sig {
params(_expires_after_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expires_after_days=(_expires_after_days); end
# The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.
sig { returns(T.nilable(T.any(String, Integer))) }
def expires_at; end
sig {
params(_expires_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expires_at=(_expires_at); end
# A product descriptor of up to 22 characters, which will appear to customers at the convenience store.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(confirmation_number: T.nilable(String), expires_after_days: T.nilable(T.any(String, Integer)), expires_at: T.nilable(T.any(String, Integer)), product_description: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(
confirmation_number: nil,
expires_after_days: nil,
expires_at: nil,
product_description: nil,
setup_future_usage: nil
); end
end
class KrCard < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Link < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
sig { params(_persistent_token: T.nilable(String)).returns(T.nilable(String)) }
def persistent_token=(_persistent_token); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), persistent_token: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, persistent_token: nil, setup_future_usage: nil); end
end
class MbWay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Mobilepay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Multibanco < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class NaverPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class NzBankAccount < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(setup_future_usage: nil, target_date: nil); end
end
class Oxxo < Stripe::RequestParams
# The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class P24 < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Confirm that the payer has accepted the P24 terms and conditions.
sig { returns(T.nilable(T::Boolean)) }
def tos_shown_and_accepted; end
sig {
params(_tos_shown_and_accepted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def tos_shown_and_accepted=(_tos_shown_and_accepted); end
sig {
params(setup_future_usage: T.nilable(String), tos_shown_and_accepted: T.nilable(T::Boolean)).void
}
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Paynow < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Paypal < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The tax for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The tax behavior for the line item.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(amount: Integer, behavior: String).void }
def initialize(amount: nil, behavior: nil); end
end
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Descriptive name of the line item.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Quantity of the line item. Must be a positive number.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Client facing stock keeping unit, article number or similar.
sig { returns(T.nilable(String)) }
def sku; end
sig { params(_sku: T.nilable(String)).returns(T.nilable(String)) }
def sku=(_sku); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
# The tax information for the line item.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypal::LineItem::Tax)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax=(_tax); end
# Price for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def unit_amount; end
sig { params(_unit_amount: Integer).returns(Integer) }
def unit_amount=(_unit_amount); end
sig {
params(category: T.nilable(String), description: T.nilable(String), name: String, quantity: Integer, sku: T.nilable(String), sold_by: T.nilable(String), tax: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypal::LineItem::Tax), unit_amount: Integer).void
}
def initialize(
category: nil,
description: nil,
name: nil,
quantity: nil,
sku: nil,
sold_by: nil,
tax: nil,
unit_amount: nil
); end
end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# The line items purchased by the customer.
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypal::LineItem])).returns(T.nilable(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items=(_line_items); end
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference_id; end
sig { params(_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def reference_id=(_reference_id); end
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
sig { returns(T.nilable(String)) }
def risk_correlation_id; end
sig { params(_risk_correlation_id: T.nilable(String)).returns(T.nilable(String)) }
def risk_correlation_id=(_risk_correlation_id); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(capture_method: T.nilable(String), line_items: T.nilable(T::Array[::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypal::LineItem]), preferred_locale: T.nilable(String), reference: T.nilable(String), reference_id: T.nilable(String), risk_correlation_id: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String)), subsellers: T.nilable(T::Array[String])).void
}
def initialize(
capture_method: nil,
line_items: nil,
preferred_locale: nil,
reference: nil,
reference_id: nil,
risk_correlation_id: nil,
setup_future_usage: nil,
subsellers: nil
); end
end
class Paypay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
sig { params(_payments_per_period: T.nilable(Integer)).returns(T.nilable(Integer)) }
def payments_per_period=(_payments_per_period); end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
sig { params(_purpose: T.nilable(String)).returns(T.nilable(String)) }
def purpose=(_purpose); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), payments_per_period: T.nilable(Integer), purpose: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil
); end
end
# Additional fields for Mandate creation. Only `purpose` field is configurable for PayTo PaymentIntent with `setup_future_usage=none`. Other fields are only applicable to PayTo PaymentIntent with `setup_future_usage=off_session`
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Payto::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Payto::MandateOptions), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(mandate_options: nil, setup_future_usage: nil); end
end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Type of amount. Defaults to `maximum`.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), amount_type: T.nilable(String), currency: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), reference: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
amount_type: nil,
currency: nil,
end_date: nil,
payment_schedule: nil,
reference: nil,
start_date: nil
); end
end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
sig { returns(T.nilable(Integer)) }
def expires_after_seconds; end
sig { params(_expires_after_seconds: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_seconds=(_expires_after_seconds); end
# The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# Additional fields for mandate creation. Only applicable when `setup_future_usage=off_session`.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(amount_includes_iof: T.nilable(String), expires_after_seconds: T.nilable(Integer), expires_at: T.nilable(Integer), mandate_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Pix::MandateOptions), setup_future_usage: T.nilable(String)).void
}
def initialize(
amount_includes_iof: nil,
expires_after_seconds: nil,
expires_at: nil,
mandate_options: nil,
setup_future_usage: nil
); end
end
class Promptpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Qris < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Rechnung < Stripe::RequestParams; end
class RevolutPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class SamsungPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Satispay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Shopeepay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Sofort < Stripe::RequestParams
# Language shown to the payer on redirect.
sig { returns(T.nilable(T.any(String, String))) }
def preferred_language; end
sig {
params(_preferred_language: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(T.any(String, String)), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class StripeBalance < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Swish < Stripe::RequestParams
# A reference for this payment to be displayed in the Swish app.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(reference: T.nilable(String), setup_future_usage: T.nilable(String)).void }
def initialize(reference: nil, setup_future_usage: nil); end
end
class Twint < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
class ManualEntry < Stripe::RequestParams
# Settings for configuring manual entry of account details.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
sig { params(mode: String).void }
def initialize(mode: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# Customize manual entry behavior
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry; end
sig {
params(_manual_entry: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry=(_manual_entry); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(filters: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), manual_entry: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
}
def initialize(
filters: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
); end
end
class MandateOptions < Stripe::RequestParams
# The method used to collect offline mandate customer acceptance.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
sig { params(collection_method: T.nilable(String)).void }
def initialize(collection_method: nil); end
end
class Networks < Stripe::RequestParams
# Triggers validations to run across the selected networks
sig { returns(T.nilable(T::Array[String])) }
def requested; end
sig {
params(_requested: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested=(_requested); end
sig { params(requested: T.nilable(T::Array[String])).void }
def initialize(requested: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Additional fields for network related functions
sig {
returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks; end
sig {
params(_networks: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks=(_networks); end
# Preferred transaction settlement speed
sig { returns(T.nilable(T.any(String, String))) }
def preferred_settlement_speed; end
sig {
params(_preferred_settlement_speed: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred_settlement_speed=(_preferred_settlement_speed); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks), preferred_settlement_speed: T.nilable(T.any(String, String)), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
financial_connections: nil,
mandate_options: nil,
networks: nil,
preferred_settlement_speed: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class WechatPay < Stripe::RequestParams
# The app ID registered with WeChat Pay. Only required when client is ios or android.
sig { returns(T.nilable(String)) }
def app_id; end
sig { params(_app_id: T.nilable(String)).returns(T.nilable(String)) }
def app_id=(_app_id); end
# The client type that the end customer will pay from
sig { returns(T.nilable(String)) }
def client; end
sig { params(_client: T.nilable(String)).returns(T.nilable(String)) }
def client=(_client); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(app_id: T.nilable(String), client: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
end
class Zip < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
# If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AcssDebit)))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AcssDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AcssDebit)))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Affirm)))
}
def affirm; end
sig {
params(_affirm: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Affirm))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Affirm)))
}
def affirm=(_affirm); end
# If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AfterpayClearpay)))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AfterpayClearpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AfterpayClearpay)))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Alipay)))
}
def alipay; end
sig {
params(_alipay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Alipay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Alipay)))
}
def alipay=(_alipay); end
# If this is a `alma` PaymentMethod, this sub-hash contains details about the Alma payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Alma)))
}
def alma; end
sig {
params(_alma: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Alma))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Alma)))
}
def alma=(_alma); end
# If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AmazonPay)))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AmazonPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AmazonPay)))
}
def amazon_pay=(_amazon_pay); end
# If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AuBecsDebit)))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AuBecsDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AuBecsDebit)))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::BacsDebit)))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::BacsDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::BacsDebit)))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Bancontact)))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Bancontact))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Bancontact)))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this sub-hash contains details about the Billie payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Billie)))
}
def billie; end
sig {
params(_billie: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Billie))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Billie)))
}
def billie=(_billie); end
# If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Blik)))
}
def blik; end
sig {
params(_blik: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Blik))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Blik)))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Boleto)))
}
def boleto; end
sig {
params(_boleto: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Boleto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Boleto)))
}
def boleto=(_boleto); end
# Configuration for any card payments attempted on this PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card)))
}
def card; end
sig {
params(_card: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card)))
}
def card=(_card); end
# If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CardPresent)))
}
def card_present; end
sig {
params(_card_present: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CardPresent))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CardPresent)))
}
def card_present=(_card_present); end
# If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Cashapp)))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Cashapp))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Cashapp)))
}
def cashapp=(_cashapp); end
# If this is a `crypto` PaymentMethod, this sub-hash contains details about the Crypto payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Crypto)))
}
def crypto; end
sig {
params(_crypto: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Crypto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Crypto)))
}
def crypto=(_crypto); end
# If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CustomerBalance))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance=(_customer_balance); end
# If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Eps)))
}
def eps; end
sig {
params(_eps: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Eps))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Eps)))
}
def eps=(_eps); end
# If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Fpx)))
}
def fpx; end
sig {
params(_fpx: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Fpx))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Fpx)))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Giropay)))
}
def giropay; end
sig {
params(_giropay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Giropay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Giropay)))
}
def giropay=(_giropay); end
# If this is a `gopay` PaymentMethod, this sub-hash contains details about the Gopay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Gopay)))
}
def gopay; end
sig {
params(_gopay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Gopay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Gopay)))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Grabpay)))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Grabpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Grabpay)))
}
def grabpay=(_grabpay); end
# If this is a `id_bank_transfer` PaymentMethod, this sub-hash contains details about the Indonesia Bank Transfer payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::IdBankTransfer))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Ideal)))
}
def ideal; end
sig {
params(_ideal: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Ideal))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Ideal)))
}
def ideal=(_ideal); end
# If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::InteracPresent)))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::InteracPresent))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::InteracPresent)))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::KakaoPay)))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::KakaoPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::KakaoPay)))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna)))
}
def klarna; end
sig {
params(_klarna: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna)))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Konbini)))
}
def konbini; end
sig {
params(_konbini: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Konbini))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Konbini)))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this sub-hash contains details about the KR Card payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::KrCard)))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::KrCard))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::KrCard)))
}
def kr_card=(_kr_card); end
# If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Link)))
}
def link; end
sig {
params(_link: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Link))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Link)))
}
def link=(_link); end
# If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::MbWay)))
}
def mb_way; end
sig {
params(_mb_way: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::MbWay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::MbWay)))
}
def mb_way=(_mb_way); end
# If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Mobilepay)))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Mobilepay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Mobilepay)))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Multibanco)))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Multibanco))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Multibanco)))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this sub-hash contains details about the Naver Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::NaverPay)))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::NaverPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::NaverPay)))
}
def naver_pay=(_naver_pay); end
# If this is a `nz_bank_account` PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::NzBankAccount)))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::NzBankAccount))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::NzBankAccount)))
}
def nz_bank_account=(_nz_bank_account); end
# If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Oxxo)))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Oxxo))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Oxxo)))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::P24)))
}
def p24; end
sig {
params(_p24: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::P24))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::P24)))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this sub-hash contains details about the PayByBank payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::PayByBank)))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::PayByBank))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::PayByBank)))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this sub-hash contains details about the PAYCO payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Payco)))
}
def payco; end
sig {
params(_payco: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Payco))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Payco)))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paynow)))
}
def paynow; end
sig {
params(_paynow: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paynow))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paynow)))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypal)))
}
def paypal; end
sig {
params(_paypal: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypal))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypal)))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this sub-hash contains details about the PayPay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypay)))
}
def paypay; end
sig {
params(_paypay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypay)))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Payto)))
}
def payto; end
sig {
params(_payto: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Payto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Payto)))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Pix)))
}
def pix; end
sig {
params(_pix: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Pix))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Pix)))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Promptpay)))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Promptpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Promptpay)))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this sub-hash contains details about the QRIS payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Qris)))
}
def qris; end
sig {
params(_qris: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Qris))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Qris)))
}
def qris=(_qris); end
# If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Rechnung)))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Rechnung))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Rechnung)))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::RevolutPay)))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::RevolutPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::RevolutPay)))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SamsungPay)))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SamsungPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SamsungPay)))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Satispay)))
}
def satispay; end
sig {
params(_satispay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Satispay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Satispay)))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SepaDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit=(_sepa_debit); end
# If this is a `shopeepay` PaymentMethod, this sub-hash contains details about the ShopeePay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Shopeepay)))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Shopeepay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Shopeepay)))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Sofort)))
}
def sofort; end
sig {
params(_sofort: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Sofort))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Sofort)))
}
def sofort=(_sofort); end
# If this is a `stripe_balance` PaymentMethod, this sub-hash contains details about the Stripe Balance payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::StripeBalance)))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::StripeBalance))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::StripeBalance)))
}
def stripe_balance=(_stripe_balance); end
# If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Swish)))
}
def swish; end
sig {
params(_swish: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Swish))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Swish)))
}
def swish=(_swish); end
# If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Twint)))
}
def twint; end
sig {
params(_twint: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Twint))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Twint)))
}
def twint=(_twint); end
# If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
# If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::WechatPay)))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::WechatPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::WechatPay)))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Zip)))
}
def zip; end
sig {
params(_zip: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Zip))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Zip)))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AcssDebit)), affirm: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Affirm)), afterpay_clearpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AfterpayClearpay)), alipay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Alipay)), alma: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Alma)), amazon_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AmazonPay)), au_becs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AuBecsDebit)), bacs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::BacsDebit)), bancontact: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Bancontact)), billie: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Billie)), blik: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Blik)), boleto: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Boleto)), card: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card)), card_present: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CardPresent)), cashapp: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Cashapp)), crypto: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Crypto)), customer_balance: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CustomerBalance)), eps: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Eps)), fpx: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Fpx)), giropay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Giropay)), gopay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Gopay)), grabpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Grabpay)), id_bank_transfer: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::IdBankTransfer)), ideal: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Ideal)), interac_present: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::InteracPresent)), kakao_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::KakaoPay)), klarna: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna)), konbini: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Konbini)), kr_card: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::KrCard)), link: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Link)), mb_way: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::MbWay)), mobilepay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Mobilepay)), multibanco: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Multibanco)), naver_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::NaverPay)), nz_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::NzBankAccount)), oxxo: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Oxxo)), p24: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::P24)), pay_by_bank: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::PayByBank)), payco: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Payco)), paynow: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paynow)), paypal: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypal)), paypay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypay)), payto: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Payto)), pix: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Pix)), promptpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Promptpay)), qris: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Qris)), rechnung: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Rechnung)), revolut_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::RevolutPay)), samsung_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SamsungPay)), satispay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Satispay)), sepa_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SepaDebit)), shopeepay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Shopeepay)), sofort: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Sofort)), stripe_balance: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::StripeBalance)), swish: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Swish)), twint: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Twint)), us_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount)), wechat_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::WechatPay)), zip: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Zip))).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
blik: nil,
boleto: nil,
card: nil,
card_present: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address.
sig { returns(::Stripe::PaymentIntent::UpdateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::PaymentIntent::UpdateParams::Shipping::Address).returns(::Stripe::PaymentIntent::UpdateParams::Shipping::Address)
}
def address=(_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
sig { params(_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def tracking_number=(_tracking_number); end
sig {
params(address: ::Stripe::PaymentIntent::UpdateParams::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
}
def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
sig { params(amount: T.nilable(Integer)).void }
def initialize(amount: nil); end
end
# Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Provides industry-specific information about the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::AmountDetails)))
}
def amount_details; end
sig {
params(_amount_details: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::AmountDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::AmountDetails)))
}
def amount_details=(_amount_details); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(T.any(String, Integer))) }
def application_fee_amount; end
sig {
params(_application_fee_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def application_fee_amount=(_application_fee_amount); end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# ID of the Customer this PaymentIntent belongs to, if one exists.
#
# Payment methods attached to other Customers cannot be used with this PaymentIntent.
#
# If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# ID of the Account this PaymentIntent belongs to, if one exists.
#
# Payment methods attached to other Accounts cannot be used with this PaymentIntent.
#
# If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The list of payment method types to exclude from use with this payment.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def excluded_payment_method_types; end
sig {
params(_excluded_payment_method_types: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def excluded_payment_method_types=(_excluded_payment_method_types); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.
sig { returns(T.nilable(String)) }
def fx_quote; end
sig { params(_fx_quote: T.nilable(String)).returns(T.nilable(String)) }
def fx_quote=(_fx_quote); end
# Automations to be run during the PaymentIntent lifecycle
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::Hooks)) }
def hooks; end
sig {
params(_hooks: T.nilable(::Stripe::PaymentIntent::UpdateParams::Hooks)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::Hooks))
}
def hooks=(_hooks); end
# This hash contains details about the Mandate to create.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::MandateData)) }
def mandate_data; end
sig {
params(_mandate_data: T.nilable(::Stripe::PaymentIntent::UpdateParams::MandateData)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::MandateData))
}
def mandate_data=(_mandate_data); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Provides industry-specific information about the charge.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentDetails)))
}
def payment_details; end
sig {
params(_payment_details: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentDetails)))
}
def payment_details=(_payment_details); end
# Attribute for param field payment_method
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent.
sig { returns(T.nilable(String)) }
def payment_method_configuration; end
sig { params(_payment_method_configuration: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_configuration=(_payment_method_configuration); end
# If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
# in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)
# property on the PaymentIntent.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData)) }
def payment_method_data; end
sig {
params(_payment_method_data: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData))
}
def payment_method_data=(_payment_method_data); end
# Payment-method-specific configuration for this PaymentIntent.
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions)) }
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
# Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
sig { returns(T.nilable(String)) }
def receipt_email; end
sig { params(_receipt_email: T.nilable(String)).returns(T.nilable(String)) }
def receipt_email=(_receipt_email); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Shipping information for this PaymentIntent.
sig { returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::Shipping))) }
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::Shipping))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::Shipping)))
}
def shipping=(_shipping); end
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::PaymentIntent::UpdateParams::TransferData)).returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::TransferData))
}
def transfer_data=(_transfer_data); end
# A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(amount: T.nilable(Integer), amount_details: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::AmountDetails)), application_fee_amount: T.nilable(T.any(String, Integer)), capture_method: T.nilable(String), currency: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), description: T.nilable(String), excluded_payment_method_types: T.nilable(T.any(String, T::Array[String])), expand: T.nilable(T::Array[String]), fx_quote: T.nilable(String), hooks: T.nilable(::Stripe::PaymentIntent::UpdateParams::Hooks), mandate_data: T.nilable(::Stripe::PaymentIntent::UpdateParams::MandateData), metadata: T.nilable(T.any(String, T::Hash[String, String])), payment_details: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentDetails)), payment_method: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), receipt_email: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String)), shipping: T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::Shipping)), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::PaymentIntent::UpdateParams::TransferData), transfer_group: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_details: nil,
application_fee_amount: nil,
capture_method: nil,
currency: nil,
customer: nil,
customer_account: nil,
description: nil,
excluded_payment_method_types: nil,
expand: nil,
fx_quote: nil,
hooks: nil,
mandate_data: nil,
metadata: nil,
payment_details: nil,
payment_method: nil,
payment_method_configuration: nil,
payment_method_data: nil,
payment_method_options: nil,
payment_method_types: nil,
receipt_email: nil,
setup_future_usage: nil,
shipping: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil,
transfer_group: nil
); end
end
class SearchParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
sig { returns(T.nilable(String)) }
def page; end
sig { params(_page: T.nilable(String)).returns(T.nilable(String)) }
def page=(_page); end
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for payment intents](https://stripe.com/docs/search#query-fields-for-payment-intents).
sig { returns(String) }
def query; end
sig { params(_query: String).returns(String) }
def query=(_query); end
sig {
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
}
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
end
class ApplyCustomerBalanceParams < Stripe::RequestParams
# Amount that you intend to apply to this PaymentIntent from the customer’s cash balance. If the PaymentIntent was created by an Invoice, the full amount of the PaymentIntent is applied regardless of this parameter.
#
# A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent.
#
# When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(amount: T.nilable(Integer), currency: T.nilable(String), expand: T.nilable(T::Array[String])).void
}
def initialize(amount: nil, currency: nil, expand: nil); end
end
class CancelParams < Stripe::RequestParams
# Reason for canceling this PaymentIntent. Possible values are: `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`
sig { returns(T.nilable(String)) }
def cancellation_reason; end
sig { params(_cancellation_reason: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_reason=(_cancellation_reason); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(cancellation_reason: T.nilable(String), expand: T.nilable(T::Array[String])).void
}
def initialize(cancellation_reason: nil, expand: nil); end
end
class CaptureParams < Stripe::RequestParams
class AmountDetails < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class Card < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class CardPresent < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class Klarna < Stripe::RequestParams
# URL to an image for the product. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def image_url; end
sig { params(_image_url: T.nilable(String)).returns(T.nilable(String)) }
def image_url=(_image_url); end
# URL to the product page. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def product_url; end
sig { params(_product_url: T.nilable(String)).returns(T.nilable(String)) }
def product_url=(_product_url); end
# Reference for the subscription this line item is for.
sig { returns(T.nilable(String)) }
def subscription_reference; end
sig { params(_subscription_reference: T.nilable(String)).returns(T.nilable(String)) }
def subscription_reference=(_subscription_reference); end
sig {
params(image_url: T.nilable(String), product_url: T.nilable(String), subscription_reference: T.nilable(String)).void
}
def initialize(image_url: nil, product_url: nil, subscription_reference: nil); end
end
class Paypal < Stripe::RequestParams
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
sig {
params(category: T.nilable(String), description: T.nilable(String), sold_by: T.nilable(String)).void
}
def initialize(category: nil, description: nil, sold_by: nil); end
end
# This sub-hash contains line item details that are specific to `card` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card=(_card); end
# This sub-hash contains line item details that are specific to `card_present` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present=(_card_present); end
# This sub-hash contains line item details that are specific to `klarna` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# This sub-hash contains line item details that are specific to `paypal` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
sig {
params(card: T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent), klarna: T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna), paypal: T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).void
}
def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end
end
class Tax < Stripe::RequestParams
# The total tax on an item. Non-negative integer.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The amount an item was discounted for. Positive integer.
sig { returns(T.nilable(Integer)) }
def discount_amount; end
sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def discount_amount=(_discount_amount); end
# Payment method-specific information for line items.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# Unique identifier of the product. At most 12 characters long.
sig { returns(T.nilable(String)) }
def product_code; end
sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) }
def product_code=(_product_code); end
# Name of the product. At most 100 characters long.
sig { returns(String) }
def product_name; end
sig { params(_product_name: String).returns(String) }
def product_name=(_product_name); end
# Number of items of the product. Positive integer.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Contains information about the tax on the item.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::Tax)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::Tax))
}
def tax=(_tax); end
# Cost of the product. Non-negative integer.
sig { returns(Integer) }
def unit_cost; end
sig { params(_unit_cost: Integer).returns(Integer) }
def unit_cost=(_unit_cost); end
# A unit of measure for the line item, such as gallons, feet, meters, etc.
sig { returns(T.nilable(String)) }
def unit_of_measure; end
sig { params(_unit_of_measure: T.nilable(String)).returns(T.nilable(String)) }
def unit_of_measure=(_unit_of_measure); end
sig {
params(discount_amount: T.nilable(Integer), payment_method_options: T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions), product_code: T.nilable(String), product_name: String, quantity: Integer, tax: T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem::Tax), unit_cost: Integer, unit_of_measure: T.nilable(String)).void
}
def initialize(
discount_amount: nil,
payment_method_options: nil,
product_code: nil,
product_name: nil,
quantity: nil,
tax: nil,
unit_cost: nil,
unit_of_measure: nil
); end
end
class Shipping < Stripe::RequestParams
# Portion of the amount that is for shipping.
sig { returns(T.nilable(T.any(String, Integer))) }
def amount; end
sig {
params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def amount=(_amount); end
# The postal code that represents the shipping source.
sig { returns(T.nilable(String)) }
def from_postal_code; end
sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def from_postal_code=(_from_postal_code); end
# The postal code that represents the shipping destination.
sig { returns(T.nilable(String)) }
def to_postal_code; end
sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def to_postal_code=(_to_postal_code); end
sig {
params(amount: T.nilable(T.any(String, Integer)), from_postal_code: T.nilable(String), to_postal_code: T.nilable(String)).void
}
def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end
end
class Tax < Stripe::RequestParams
# Total portion of the amount that is for tax.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The total discount applied on the transaction.
sig { returns(T.nilable(T.any(String, Integer))) }
def discount_amount; end
sig {
params(_discount_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def discount_amount=(_discount_amount); end
# A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem])))
}
def line_items; end
sig {
params(_line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem])))
}
def line_items=(_line_items); end
# Contains information about the shipping portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CaptureParams::AmountDetails::Shipping)))
}
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::PaymentIntent::CaptureParams::AmountDetails::Shipping))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CaptureParams::AmountDetails::Shipping)))
}
def shipping=(_shipping); end
# Contains information about the tax portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CaptureParams::AmountDetails::Tax)))
}
def tax; end
sig {
params(_tax: T.nilable(T.any(String, ::Stripe::PaymentIntent::CaptureParams::AmountDetails::Tax))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CaptureParams::AmountDetails::Tax)))
}
def tax=(_tax); end
sig {
params(discount_amount: T.nilable(T.any(String, Integer)), line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::CaptureParams::AmountDetails::LineItem])), shipping: T.nilable(T.any(String, ::Stripe::PaymentIntent::CaptureParams::AmountDetails::Shipping)), tax: T.nilable(T.any(String, ::Stripe::PaymentIntent::CaptureParams::AmountDetails::Tax))).void
}
def initialize(discount_amount: nil, line_items: nil, shipping: nil, tax: nil); end
end
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
sig { returns(String) }
def calculation; end
sig { params(_calculation: String).returns(String) }
def calculation=(_calculation); end
sig { params(calculation: String).void }
def initialize(calculation: nil); end
end
# Tax arguments for automations
sig { returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::Hooks::Inputs::Tax)) }
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntent::CaptureParams::Hooks::Inputs::Tax)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::Hooks::Inputs::Tax))
}
def tax=(_tax); end
sig {
params(tax: T.nilable(::Stripe::PaymentIntent::CaptureParams::Hooks::Inputs::Tax)).void
}
def initialize(tax: nil); end
end
# Arguments passed in automations
sig { returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::Hooks::Inputs)) }
def inputs; end
sig {
params(_inputs: T.nilable(::Stripe::PaymentIntent::CaptureParams::Hooks::Inputs)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::Hooks::Inputs))
}
def inputs=(_inputs); end
sig {
params(inputs: T.nilable(::Stripe::PaymentIntent::CaptureParams::Hooks::Inputs)).void
}
def initialize(inputs: nil); end
end
class PaymentDetails < Stripe::RequestParams
class CarRental < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Distance < Stripe::RequestParams
# Distance traveled.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
sig { params(amount: T.nilable(Integer), unit: T.nilable(String)).void }
def initialize(amount: nil, unit: nil); end
end
class Driver < Stripe::RequestParams
# Driver's identification number.
sig { returns(T.nilable(String)) }
def driver_identification_number; end
sig {
params(_driver_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def driver_identification_number=(_driver_identification_number); end
# Driver's tax number.
sig { returns(T.nilable(String)) }
def driver_tax_number; end
sig { params(_driver_tax_number: T.nilable(String)).returns(T.nilable(String)) }
def driver_tax_number=(_driver_tax_number); end
# Full name of the person or entity on the car reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(driver_identification_number: T.nilable(String), driver_tax_number: T.nilable(String), name: String).void
}
def initialize(
driver_identification_number: nil,
driver_tax_number: nil,
name: nil
); end
end
class PickupAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class ReturnAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the car rental.
sig { returns(String) }
def booking_number; end
sig { params(_booking_number: String).returns(String) }
def booking_number=(_booking_number); end
# Class code of the car.
sig { returns(T.nilable(String)) }
def car_class_code; end
sig { params(_car_class_code: T.nilable(String)).returns(T.nilable(String)) }
def car_class_code=(_car_class_code); end
# Make of the car.
sig { returns(T.nilable(String)) }
def car_make; end
sig { params(_car_make: T.nilable(String)).returns(T.nilable(String)) }
def car_make=(_car_make); end
# Model of the car.
sig { returns(T.nilable(String)) }
def car_model; end
sig { params(_car_model: T.nilable(String)).returns(T.nilable(String)) }
def car_model=(_car_model); end
# The name of the rental car company.
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# The customer service phone number of the car rental company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# Number of days the car is being rented.
sig { returns(Integer) }
def days_rented; end
sig { params(_days_rented: Integer).returns(Integer) }
def days_rented=(_days_rented); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Delivery)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Delivery))
}
def delivery=(_delivery); end
# The details of the distance traveled during the rental period.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Distance))
}
def distance; end
sig {
params(_distance: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Distance)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Distance))
}
def distance=(_distance); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Driver]))
}
def drivers; end
sig {
params(_drivers: T.nilable(T::Array[::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Driver])).returns(T.nilable(T::Array[::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Driver]))
}
def drivers=(_drivers); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates if the customer did not keep nor cancel their booking.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# Car pick-up address.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address; end
sig {
params(_pickup_address: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::PickupAddress)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address=(_pickup_address); end
# Car pick-up time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def pickup_at; end
sig { params(_pickup_at: Integer).returns(Integer) }
def pickup_at=(_pickup_at); end
# Name of the pickup location.
sig { returns(T.nilable(String)) }
def pickup_location_name; end
sig { params(_pickup_location_name: T.nilable(String)).returns(T.nilable(String)) }
def pickup_location_name=(_pickup_location_name); end
# Rental rate.
sig { returns(T.nilable(Integer)) }
def rate_amount; end
sig { params(_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def rate_amount=(_rate_amount); end
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
sig { returns(T.nilable(String)) }
def rate_interval; end
sig { params(_rate_interval: T.nilable(String)).returns(T.nilable(String)) }
def rate_interval=(_rate_interval); end
# The name of the person or entity renting the car.
sig { returns(T.nilable(String)) }
def renter_name; end
sig { params(_renter_name: T.nilable(String)).returns(T.nilable(String)) }
def renter_name=(_renter_name); end
# Car return address.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address; end
sig {
params(_return_address: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::ReturnAddress)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address=(_return_address); end
# Car return time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def return_at; end
sig { params(_return_at: Integer).returns(Integer) }
def return_at=(_return_at); end
# Name of the return location.
sig { returns(T.nilable(String)) }
def return_location_name; end
sig { params(_return_location_name: T.nilable(String)).returns(T.nilable(String)) }
def return_location_name=(_return_location_name); end
# Indicates whether the goods or services are tax-exempt or tax is not collected.
sig { returns(T.nilable(T::Boolean)) }
def tax_exempt; end
sig { params(_tax_exempt: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def tax_exempt=(_tax_exempt); end
# The vehicle identification number.
sig { returns(T.nilable(String)) }
def vehicle_identification_number; end
sig {
params(_vehicle_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def vehicle_identification_number=(_vehicle_identification_number); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Affiliate), booking_number: String, car_class_code: T.nilable(String), car_make: T.nilable(String), car_model: T.nilable(String), company: T.nilable(String), customer_service_phone_number: T.nilable(String), days_rented: Integer, delivery: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Delivery), distance: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Distance), drivers: T.nilable(T::Array[::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::Driver]), extra_charges: T.nilable(T::Array[String]), no_show: T.nilable(T::Boolean), pickup_address: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::PickupAddress), pickup_at: Integer, pickup_location_name: T.nilable(String), rate_amount: T.nilable(Integer), rate_interval: T.nilable(String), renter_name: T.nilable(String), return_address: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental::ReturnAddress), return_at: Integer, return_location_name: T.nilable(String), tax_exempt: T.nilable(T::Boolean), vehicle_identification_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
booking_number: nil,
car_class_code: nil,
car_make: nil,
car_model: nil,
company: nil,
customer_service_phone_number: nil,
days_rented: nil,
delivery: nil,
distance: nil,
drivers: nil,
extra_charges: nil,
no_show: nil,
pickup_address: nil,
pickup_at: nil,
pickup_location_name: nil,
rate_amount: nil,
rate_interval: nil,
renter_name: nil,
return_address: nil,
return_at: nil,
return_location_name: nil,
tax_exempt: nil,
vehicle_identification_number: nil
); end
end
class EventDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
# Indicates if the tickets are digitally checked when entering the venue.
sig { returns(T.nilable(T::Boolean)) }
def access_controlled_venue; end
sig {
params(_access_controlled_venue: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def access_controlled_venue=(_access_controlled_venue); end
# The event location's address.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails::Address)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails::Address))
}
def address=(_address); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate=(_affiliate); end
# The name of the company
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails::Delivery)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails::Delivery))
}
def delivery=(_delivery); end
# Event end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Type of the event entertainment (concert, sports event etc)
sig { returns(T.nilable(String)) }
def genre; end
sig { params(_genre: T.nilable(String)).returns(T.nilable(String)) }
def genre=(_genre); end
# The name of the event.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Event start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(access_controlled_venue: T.nilable(T::Boolean), address: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails::Address), affiliate: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails::Affiliate), company: T.nilable(String), delivery: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails::Delivery), ends_at: T.nilable(Integer), genre: T.nilable(String), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
access_controlled_venue: nil,
address: nil,
affiliate: nil,
company: nil,
delivery: nil,
ends_at: nil,
genre: nil,
name: nil,
starts_at: nil
); end
end
class Flight < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the flight reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Segment < Stripe::RequestParams
# The flight segment amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The International Air Transport Association (IATA) airport code for the arrival airport.
sig { returns(T.nilable(String)) }
def arrival_airport; end
sig { params(_arrival_airport: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport=(_arrival_airport); end
# The arrival time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def arrives_at; end
sig { params(_arrives_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def arrives_at=(_arrives_at); end
# The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The departure time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def departs_at; end
sig { params(_departs_at: Integer).returns(Integer) }
def departs_at=(_departs_at); end
# The International Air Transport Association (IATA) airport code for the departure airport.
sig { returns(T.nilable(String)) }
def departure_airport; end
sig { params(_departure_airport: T.nilable(String)).returns(T.nilable(String)) }
def departure_airport=(_departure_airport); end
# The flight number associated with the segment
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The fare class for the segment.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
sig {
params(amount: T.nilable(Integer), arrival_airport: T.nilable(String), arrives_at: T.nilable(Integer), carrier: T.nilable(String), departs_at: Integer, departure_airport: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String)).void
}
def initialize(
amount: nil,
arrival_airport: nil,
arrives_at: nil,
carrier: nil,
departs_at: nil,
departure_airport: nil,
flight_number: nil,
service_class: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Affiliate))
}
def affiliate=(_affiliate); end
# The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
sig { returns(T.nilable(String)) }
def agency_number; end
sig { params(_agency_number: T.nilable(String)).returns(T.nilable(String)) }
def agency_number=(_agency_number); end
# The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Delivery)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Delivery))
}
def delivery=(_delivery); end
# The name of the person or entity on the reservation.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# The details of the passengers in the travel reservation.
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Passenger])).returns(T.nilable(T::Array[::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Passenger]))
}
def passengers=(_passengers); end
# The individual flight segments associated with the trip.
sig {
returns(T::Array[::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Segment])
}
def segments; end
sig {
params(_segments: T::Array[::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Segment]).returns(T::Array[::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Segment])
}
def segments=(_segments); end
# The ticket number associated with the travel reservation.
sig { returns(T.nilable(String)) }
def ticket_number; end
sig { params(_ticket_number: T.nilable(String)).returns(T.nilable(String)) }
def ticket_number=(_ticket_number); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Affiliate), agency_number: T.nilable(String), carrier: T.nilable(String), delivery: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Delivery), passenger_name: T.nilable(String), passengers: T.nilable(T::Array[::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Passenger]), segments: T::Array[::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight::Segment], ticket_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
agency_number: nil,
carrier: nil,
delivery: nil,
passenger_name: nil,
passengers: nil,
segments: nil,
ticket_number: nil
); end
end
class Lodging < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the lodging reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
# The lodging location's address.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Address)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Address))
}
def address=(_address); end
# The number of adults on the booking
sig { returns(T.nilable(Integer)) }
def adults; end
sig { params(_adults: T.nilable(Integer)).returns(T.nilable(Integer)) }
def adults=(_adults); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the lodging reservation.
sig { returns(T.nilable(String)) }
def booking_number; end
sig { params(_booking_number: T.nilable(String)).returns(T.nilable(String)) }
def booking_number=(_booking_number); end
# The lodging category
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Lodging check-in time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkin_at; end
sig { params(_checkin_at: Integer).returns(Integer) }
def checkin_at=(_checkin_at); end
# Lodging check-out time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkout_at; end
sig { params(_checkout_at: Integer).returns(Integer) }
def checkout_at=(_checkout_at); end
# The customer service phone number of the lodging company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# The daily lodging room rate.
sig { returns(T.nilable(Integer)) }
def daily_room_rate_amount; end
sig { params(_daily_room_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def daily_room_rate_amount=(_daily_room_rate_amount); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Delivery)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Delivery))
}
def delivery=(_delivery); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates whether the lodging location is compliant with the Fire Safety Act.
sig { returns(T.nilable(T::Boolean)) }
def fire_safety_act_compliance; end
sig {
params(_fire_safety_act_compliance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def fire_safety_act_compliance=(_fire_safety_act_compliance); end
# The name of the lodging location.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Indicates if the customer did not keep their booking while failing to cancel the reservation.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# The number of rooms on the booking
sig { returns(T.nilable(Integer)) }
def number_of_rooms; end
sig { params(_number_of_rooms: T.nilable(Integer)).returns(T.nilable(Integer)) }
def number_of_rooms=(_number_of_rooms); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Passenger])).returns(T.nilable(T::Array[::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Passenger]))
}
def passengers=(_passengers); end
# The phone number of the lodging location.
sig { returns(T.nilable(String)) }
def property_phone_number; end
sig { params(_property_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def property_phone_number=(_property_phone_number); end
# The room class for this purchase.
sig { returns(T.nilable(String)) }
def room_class; end
sig { params(_room_class: T.nilable(String)).returns(T.nilable(String)) }
def room_class=(_room_class); end
# The number of room nights
sig { returns(T.nilable(Integer)) }
def room_nights; end
sig { params(_room_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def room_nights=(_room_nights); end
# The total tax amount associating with the room reservation.
sig { returns(T.nilable(Integer)) }
def total_room_tax_amount; end
sig { params(_total_room_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_room_tax_amount=(_total_room_tax_amount); end
# The total tax amount
sig { returns(T.nilable(Integer)) }
def total_tax_amount; end
sig { params(_total_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_tax_amount=(_total_tax_amount); end
sig {
params(address: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Address), adults: T.nilable(Integer), affiliate: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Affiliate), booking_number: T.nilable(String), category: T.nilable(String), checkin_at: Integer, checkout_at: Integer, customer_service_phone_number: T.nilable(String), daily_room_rate_amount: T.nilable(Integer), delivery: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Delivery), extra_charges: T.nilable(T::Array[String]), fire_safety_act_compliance: T.nilable(T::Boolean), name: T.nilable(String), no_show: T.nilable(T::Boolean), number_of_rooms: T.nilable(Integer), passengers: T.nilable(T::Array[::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging::Passenger]), property_phone_number: T.nilable(String), room_class: T.nilable(String), room_nights: T.nilable(Integer), total_room_tax_amount: T.nilable(Integer), total_tax_amount: T.nilable(Integer)).void
}
def initialize(
address: nil,
adults: nil,
affiliate: nil,
booking_number: nil,
category: nil,
checkin_at: nil,
checkout_at: nil,
customer_service_phone_number: nil,
daily_room_rate_amount: nil,
delivery: nil,
extra_charges: nil,
fire_safety_act_compliance: nil,
name: nil,
no_show: nil,
number_of_rooms: nil,
passengers: nil,
property_phone_number: nil,
room_class: nil,
room_nights: nil,
total_room_tax_amount: nil,
total_tax_amount: nil
); end
end
class Subscription < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class BillingInterval < Stripe::RequestParams
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def count; end
sig { params(_count: Integer).returns(Integer) }
def count=(_count); end
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig { params(count: Integer, interval: String).void }
def initialize(count: nil, interval: nil); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Subscription::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate=(_affiliate); end
# Info whether the subscription will be auto renewed upon expiry.
sig { returns(T.nilable(T::Boolean)) }
def auto_renewal; end
sig { params(_auto_renewal: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_renewal=(_auto_renewal); end
# Subscription billing details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval; end
sig {
params(_billing_interval: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Subscription::BillingInterval)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval=(_billing_interval); end
# Subscription end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Name of the product on subscription. e.g. Apple Music Subscription
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Subscription start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Subscription::Affiliate), auto_renewal: T.nilable(T::Boolean), billing_interval: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Subscription::BillingInterval), ends_at: T.nilable(Integer), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
affiliate: nil,
auto_renewal: nil,
billing_interval: nil,
ends_at: nil,
name: nil,
starts_at: nil
); end
end
# Car rental details for this PaymentIntent.
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental))
}
def car_rental; end
sig {
params(_car_rental: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental))
}
def car_rental=(_car_rental); end
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
sig { returns(T.nilable(String)) }
def customer_reference; end
sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) }
def customer_reference=(_customer_reference); end
# Event details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails))
}
def event_details; end
sig {
params(_event_details: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails))
}
def event_details=(_event_details); end
# Flight reservation details for this PaymentIntent
sig { returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight)) }
def flight; end
sig {
params(_flight: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight))
}
def flight=(_flight); end
# Lodging reservation details for this PaymentIntent
sig { returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging)) }
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging))
}
def lodging=(_lodging); end
# A unique value assigned by the business to identify the transaction.
sig { returns(T.nilable(String)) }
def order_reference; end
sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) }
def order_reference=(_order_reference); end
# Subscription details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Subscription))
}
def subscription; end
sig {
params(_subscription: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Subscription)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Subscription))
}
def subscription=(_subscription); end
sig {
params(car_rental: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::CarRental), customer_reference: T.nilable(String), event_details: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::EventDetails), flight: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Flight), lodging: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Lodging), order_reference: T.nilable(String), subscription: T.nilable(::Stripe::PaymentIntent::CaptureParams::PaymentDetails::Subscription)).void
}
def initialize(
car_rental: nil,
customer_reference: nil,
event_details: nil,
flight: nil,
lodging: nil,
order_reference: nil,
subscription: nil
); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
sig { params(amount: T.nilable(Integer)).void }
def initialize(amount: nil); end
end
# Provides industry-specific information about the amount.
sig { returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails)) }
def amount_details; end
sig {
params(_amount_details: T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails))
}
def amount_details=(_amount_details); end
# The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Defaults to the full `amount_capturable` if it's not provided.
sig { returns(T.nilable(Integer)) }
def amount_to_capture; end
sig { params(_amount_to_capture: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_to_capture=(_amount_to_capture); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Defaults to `true`. When capturing a PaymentIntent, setting `final_capture` to `false` notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when [multicapture](https://stripe.com/docs/payments/multicapture) is available for PaymentIntents.
sig { returns(T.nilable(T::Boolean)) }
def final_capture; end
sig { params(_final_capture: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def final_capture=(_final_capture); end
# Automations to be run during the PaymentIntent lifecycle
sig { returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::Hooks)) }
def hooks; end
sig {
params(_hooks: T.nilable(::Stripe::PaymentIntent::CaptureParams::Hooks)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::Hooks))
}
def hooks=(_hooks); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Provides industry-specific information about the charge.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CaptureParams::PaymentDetails)))
}
def payment_details; end
sig {
params(_payment_details: T.nilable(T.any(String, ::Stripe::PaymentIntent::CaptureParams::PaymentDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::CaptureParams::PaymentDetails)))
}
def payment_details=(_payment_details); end
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# The parameters that you can use to automatically create a transfer after the payment
# is captured. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::PaymentIntent::CaptureParams::TransferData)).returns(T.nilable(::Stripe::PaymentIntent::CaptureParams::TransferData))
}
def transfer_data=(_transfer_data); end
sig {
params(amount_details: T.nilable(::Stripe::PaymentIntent::CaptureParams::AmountDetails), amount_to_capture: T.nilable(Integer), application_fee_amount: T.nilable(Integer), expand: T.nilable(T::Array[String]), final_capture: T.nilable(T::Boolean), hooks: T.nilable(::Stripe::PaymentIntent::CaptureParams::Hooks), metadata: T.nilable(T.any(String, T::Hash[String, String])), payment_details: T.nilable(T.any(String, ::Stripe::PaymentIntent::CaptureParams::PaymentDetails)), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::PaymentIntent::CaptureParams::TransferData)).void
}
def initialize(
amount_details: nil,
amount_to_capture: nil,
application_fee_amount: nil,
expand: nil,
final_capture: nil,
hooks: nil,
metadata: nil,
payment_details: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil
); end
end
class ConfirmParams < Stripe::RequestParams
class AmountDetails < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class Card < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class CardPresent < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class Klarna < Stripe::RequestParams
# URL to an image for the product. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def image_url; end
sig { params(_image_url: T.nilable(String)).returns(T.nilable(String)) }
def image_url=(_image_url); end
# URL to the product page. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def product_url; end
sig { params(_product_url: T.nilable(String)).returns(T.nilable(String)) }
def product_url=(_product_url); end
# Reference for the subscription this line item is for.
sig { returns(T.nilable(String)) }
def subscription_reference; end
sig { params(_subscription_reference: T.nilable(String)).returns(T.nilable(String)) }
def subscription_reference=(_subscription_reference); end
sig {
params(image_url: T.nilable(String), product_url: T.nilable(String), subscription_reference: T.nilable(String)).void
}
def initialize(image_url: nil, product_url: nil, subscription_reference: nil); end
end
class Paypal < Stripe::RequestParams
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
sig {
params(category: T.nilable(String), description: T.nilable(String), sold_by: T.nilable(String)).void
}
def initialize(category: nil, description: nil, sold_by: nil); end
end
# This sub-hash contains line item details that are specific to `card` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card=(_card); end
# This sub-hash contains line item details that are specific to `card_present` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present=(_card_present); end
# This sub-hash contains line item details that are specific to `klarna` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# This sub-hash contains line item details that are specific to `paypal` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
sig {
params(card: T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent), klarna: T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna), paypal: T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).void
}
def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end
end
class Tax < Stripe::RequestParams
# The total tax on an item. Non-negative integer.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The amount an item was discounted for. Positive integer.
sig { returns(T.nilable(Integer)) }
def discount_amount; end
sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def discount_amount=(_discount_amount); end
# Payment method-specific information for line items.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# Unique identifier of the product. At most 12 characters long.
sig { returns(T.nilable(String)) }
def product_code; end
sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) }
def product_code=(_product_code); end
# Name of the product. At most 100 characters long.
sig { returns(String) }
def product_name; end
sig { params(_product_name: String).returns(String) }
def product_name=(_product_name); end
# Number of items of the product. Positive integer.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Contains information about the tax on the item.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::Tax)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::Tax))
}
def tax=(_tax); end
# Cost of the product. Non-negative integer.
sig { returns(Integer) }
def unit_cost; end
sig { params(_unit_cost: Integer).returns(Integer) }
def unit_cost=(_unit_cost); end
# A unit of measure for the line item, such as gallons, feet, meters, etc.
sig { returns(T.nilable(String)) }
def unit_of_measure; end
sig { params(_unit_of_measure: T.nilable(String)).returns(T.nilable(String)) }
def unit_of_measure=(_unit_of_measure); end
sig {
params(discount_amount: T.nilable(Integer), payment_method_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions), product_code: T.nilable(String), product_name: String, quantity: Integer, tax: T.nilable(::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem::Tax), unit_cost: Integer, unit_of_measure: T.nilable(String)).void
}
def initialize(
discount_amount: nil,
payment_method_options: nil,
product_code: nil,
product_name: nil,
quantity: nil,
tax: nil,
unit_cost: nil,
unit_of_measure: nil
); end
end
class Shipping < Stripe::RequestParams
# Portion of the amount that is for shipping.
sig { returns(T.nilable(T.any(String, Integer))) }
def amount; end
sig {
params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def amount=(_amount); end
# The postal code that represents the shipping source.
sig { returns(T.nilable(String)) }
def from_postal_code; end
sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def from_postal_code=(_from_postal_code); end
# The postal code that represents the shipping destination.
sig { returns(T.nilable(String)) }
def to_postal_code; end
sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def to_postal_code=(_to_postal_code); end
sig {
params(amount: T.nilable(T.any(String, Integer)), from_postal_code: T.nilable(String), to_postal_code: T.nilable(String)).void
}
def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end
end
class Tax < Stripe::RequestParams
# Total portion of the amount that is for tax.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The total discount applied on the transaction.
sig { returns(T.nilable(T.any(String, Integer))) }
def discount_amount; end
sig {
params(_discount_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def discount_amount=(_discount_amount); end
# A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem])))
}
def line_items; end
sig {
params(_line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem])))
}
def line_items=(_line_items); end
# Contains information about the shipping portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::AmountDetails::Shipping)))
}
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::AmountDetails::Shipping))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::AmountDetails::Shipping)))
}
def shipping=(_shipping); end
# Contains information about the tax portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::AmountDetails::Tax)))
}
def tax; end
sig {
params(_tax: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::AmountDetails::Tax))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::AmountDetails::Tax)))
}
def tax=(_tax); end
sig {
params(discount_amount: T.nilable(T.any(String, Integer)), line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::ConfirmParams::AmountDetails::LineItem])), shipping: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::AmountDetails::Shipping)), tax: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::AmountDetails::Tax))).void
}
def initialize(discount_amount: nil, line_items: nil, shipping: nil, tax: nil); end
end
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
sig { returns(String) }
def calculation; end
sig { params(_calculation: String).returns(String) }
def calculation=(_calculation); end
sig { params(calculation: String).void }
def initialize(calculation: nil); end
end
# Tax arguments for automations
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::Hooks::Inputs::Tax)) }
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntent::ConfirmParams::Hooks::Inputs::Tax)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::Hooks::Inputs::Tax))
}
def tax=(_tax); end
sig {
params(tax: T.nilable(::Stripe::PaymentIntent::ConfirmParams::Hooks::Inputs::Tax)).void
}
def initialize(tax: nil); end
end
# Arguments passed in automations
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::Hooks::Inputs)) }
def inputs; end
sig {
params(_inputs: T.nilable(::Stripe::PaymentIntent::ConfirmParams::Hooks::Inputs)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::Hooks::Inputs))
}
def inputs=(_inputs); end
sig {
params(inputs: T.nilable(::Stripe::PaymentIntent::ConfirmParams::Hooks::Inputs)).void
}
def initialize(inputs: nil); end
end
class MandateData < Stripe::RequestParams
class CustomerAcceptance < Stripe::RequestParams
class Offline < Stripe::RequestParams; end
class Online < Stripe::RequestParams
# The IP address from which the Mandate was accepted by the customer.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# The user agent of the browser from which the Mandate was accepted by the customer.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig { params(ip_address: T.nilable(String), user_agent: T.nilable(String)).void }
def initialize(ip_address: nil, user_agent: nil); end
end
# The time at which the customer accepted the Mandate.
sig { returns(T.nilable(Integer)) }
def accepted_at; end
sig { params(_accepted_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def accepted_at=(_accepted_at); end
# If this is a Mandate accepted offline, this hash contains details about the offline acceptance.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::MandateData::CustomerAcceptance::Offline))
}
def offline; end
sig {
params(_offline: T.nilable(::Stripe::PaymentIntent::ConfirmParams::MandateData::CustomerAcceptance::Offline)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::MandateData::CustomerAcceptance::Offline))
}
def offline=(_offline); end
# If this is a Mandate accepted online, this hash contains details about the online acceptance.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::MandateData::CustomerAcceptance::Online))
}
def online; end
sig {
params(_online: T.nilable(::Stripe::PaymentIntent::ConfirmParams::MandateData::CustomerAcceptance::Online)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::MandateData::CustomerAcceptance::Online))
}
def online=(_online); end
# The type of customer acceptance information included with the Mandate. One of `online` or `offline`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(accepted_at: T.nilable(Integer), offline: T.nilable(::Stripe::PaymentIntent::ConfirmParams::MandateData::CustomerAcceptance::Offline), online: T.nilable(::Stripe::PaymentIntent::ConfirmParams::MandateData::CustomerAcceptance::Online), type: String).void
}
def initialize(accepted_at: nil, offline: nil, online: nil, type: nil); end
end
# This hash contains details about the customer acceptance of the Mandate.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::MandateData::CustomerAcceptance))
}
def customer_acceptance; end
sig {
params(_customer_acceptance: T.nilable(::Stripe::PaymentIntent::ConfirmParams::MandateData::CustomerAcceptance)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::MandateData::CustomerAcceptance))
}
def customer_acceptance=(_customer_acceptance); end
sig {
params(customer_acceptance: T.nilable(::Stripe::PaymentIntent::ConfirmParams::MandateData::CustomerAcceptance)).void
}
def initialize(customer_acceptance: nil); end
end
class PaymentDetails < Stripe::RequestParams
class CarRental < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Distance < Stripe::RequestParams
# Distance traveled.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
sig { params(amount: T.nilable(Integer), unit: T.nilable(String)).void }
def initialize(amount: nil, unit: nil); end
end
class Driver < Stripe::RequestParams
# Driver's identification number.
sig { returns(T.nilable(String)) }
def driver_identification_number; end
sig {
params(_driver_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def driver_identification_number=(_driver_identification_number); end
# Driver's tax number.
sig { returns(T.nilable(String)) }
def driver_tax_number; end
sig { params(_driver_tax_number: T.nilable(String)).returns(T.nilable(String)) }
def driver_tax_number=(_driver_tax_number); end
# Full name of the person or entity on the car reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(driver_identification_number: T.nilable(String), driver_tax_number: T.nilable(String), name: String).void
}
def initialize(
driver_identification_number: nil,
driver_tax_number: nil,
name: nil
); end
end
class PickupAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class ReturnAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the car rental.
sig { returns(String) }
def booking_number; end
sig { params(_booking_number: String).returns(String) }
def booking_number=(_booking_number); end
# Class code of the car.
sig { returns(T.nilable(String)) }
def car_class_code; end
sig { params(_car_class_code: T.nilable(String)).returns(T.nilable(String)) }
def car_class_code=(_car_class_code); end
# Make of the car.
sig { returns(T.nilable(String)) }
def car_make; end
sig { params(_car_make: T.nilable(String)).returns(T.nilable(String)) }
def car_make=(_car_make); end
# Model of the car.
sig { returns(T.nilable(String)) }
def car_model; end
sig { params(_car_model: T.nilable(String)).returns(T.nilable(String)) }
def car_model=(_car_model); end
# The name of the rental car company.
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# The customer service phone number of the car rental company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# Number of days the car is being rented.
sig { returns(Integer) }
def days_rented; end
sig { params(_days_rented: Integer).returns(Integer) }
def days_rented=(_days_rented); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Delivery)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Delivery))
}
def delivery=(_delivery); end
# The details of the distance traveled during the rental period.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Distance))
}
def distance; end
sig {
params(_distance: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Distance)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Distance))
}
def distance=(_distance); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Driver]))
}
def drivers; end
sig {
params(_drivers: T.nilable(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Driver])).returns(T.nilable(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Driver]))
}
def drivers=(_drivers); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates if the customer did not keep nor cancel their booking.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# Car pick-up address.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address; end
sig {
params(_pickup_address: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::PickupAddress)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address=(_pickup_address); end
# Car pick-up time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def pickup_at; end
sig { params(_pickup_at: Integer).returns(Integer) }
def pickup_at=(_pickup_at); end
# Name of the pickup location.
sig { returns(T.nilable(String)) }
def pickup_location_name; end
sig { params(_pickup_location_name: T.nilable(String)).returns(T.nilable(String)) }
def pickup_location_name=(_pickup_location_name); end
# Rental rate.
sig { returns(T.nilable(Integer)) }
def rate_amount; end
sig { params(_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def rate_amount=(_rate_amount); end
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
sig { returns(T.nilable(String)) }
def rate_interval; end
sig { params(_rate_interval: T.nilable(String)).returns(T.nilable(String)) }
def rate_interval=(_rate_interval); end
# The name of the person or entity renting the car.
sig { returns(T.nilable(String)) }
def renter_name; end
sig { params(_renter_name: T.nilable(String)).returns(T.nilable(String)) }
def renter_name=(_renter_name); end
# Car return address.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address; end
sig {
params(_return_address: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::ReturnAddress)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address=(_return_address); end
# Car return time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def return_at; end
sig { params(_return_at: Integer).returns(Integer) }
def return_at=(_return_at); end
# Name of the return location.
sig { returns(T.nilable(String)) }
def return_location_name; end
sig { params(_return_location_name: T.nilable(String)).returns(T.nilable(String)) }
def return_location_name=(_return_location_name); end
# Indicates whether the goods or services are tax-exempt or tax is not collected.
sig { returns(T.nilable(T::Boolean)) }
def tax_exempt; end
sig { params(_tax_exempt: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def tax_exempt=(_tax_exempt); end
# The vehicle identification number.
sig { returns(T.nilable(String)) }
def vehicle_identification_number; end
sig {
params(_vehicle_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def vehicle_identification_number=(_vehicle_identification_number); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Affiliate), booking_number: String, car_class_code: T.nilable(String), car_make: T.nilable(String), car_model: T.nilable(String), company: T.nilable(String), customer_service_phone_number: T.nilable(String), days_rented: Integer, delivery: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Delivery), distance: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Distance), drivers: T.nilable(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::Driver]), extra_charges: T.nilable(T::Array[String]), no_show: T.nilable(T::Boolean), pickup_address: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::PickupAddress), pickup_at: Integer, pickup_location_name: T.nilable(String), rate_amount: T.nilable(Integer), rate_interval: T.nilable(String), renter_name: T.nilable(String), return_address: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental::ReturnAddress), return_at: Integer, return_location_name: T.nilable(String), tax_exempt: T.nilable(T::Boolean), vehicle_identification_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
booking_number: nil,
car_class_code: nil,
car_make: nil,
car_model: nil,
company: nil,
customer_service_phone_number: nil,
days_rented: nil,
delivery: nil,
distance: nil,
drivers: nil,
extra_charges: nil,
no_show: nil,
pickup_address: nil,
pickup_at: nil,
pickup_location_name: nil,
rate_amount: nil,
rate_interval: nil,
renter_name: nil,
return_address: nil,
return_at: nil,
return_location_name: nil,
tax_exempt: nil,
vehicle_identification_number: nil
); end
end
class EventDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
# Indicates if the tickets are digitally checked when entering the venue.
sig { returns(T.nilable(T::Boolean)) }
def access_controlled_venue; end
sig {
params(_access_controlled_venue: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def access_controlled_venue=(_access_controlled_venue); end
# The event location's address.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails::Address)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails::Address))
}
def address=(_address); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate=(_affiliate); end
# The name of the company
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails::Delivery)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails::Delivery))
}
def delivery=(_delivery); end
# Event end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Type of the event entertainment (concert, sports event etc)
sig { returns(T.nilable(String)) }
def genre; end
sig { params(_genre: T.nilable(String)).returns(T.nilable(String)) }
def genre=(_genre); end
# The name of the event.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Event start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(access_controlled_venue: T.nilable(T::Boolean), address: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails::Address), affiliate: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails::Affiliate), company: T.nilable(String), delivery: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails::Delivery), ends_at: T.nilable(Integer), genre: T.nilable(String), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
access_controlled_venue: nil,
address: nil,
affiliate: nil,
company: nil,
delivery: nil,
ends_at: nil,
genre: nil,
name: nil,
starts_at: nil
); end
end
class Flight < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the flight reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Segment < Stripe::RequestParams
# The flight segment amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The International Air Transport Association (IATA) airport code for the arrival airport.
sig { returns(T.nilable(String)) }
def arrival_airport; end
sig { params(_arrival_airport: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport=(_arrival_airport); end
# The arrival time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def arrives_at; end
sig { params(_arrives_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def arrives_at=(_arrives_at); end
# The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The departure time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def departs_at; end
sig { params(_departs_at: Integer).returns(Integer) }
def departs_at=(_departs_at); end
# The International Air Transport Association (IATA) airport code for the departure airport.
sig { returns(T.nilable(String)) }
def departure_airport; end
sig { params(_departure_airport: T.nilable(String)).returns(T.nilable(String)) }
def departure_airport=(_departure_airport); end
# The flight number associated with the segment
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The fare class for the segment.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
sig {
params(amount: T.nilable(Integer), arrival_airport: T.nilable(String), arrives_at: T.nilable(Integer), carrier: T.nilable(String), departs_at: Integer, departure_airport: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String)).void
}
def initialize(
amount: nil,
arrival_airport: nil,
arrives_at: nil,
carrier: nil,
departs_at: nil,
departure_airport: nil,
flight_number: nil,
service_class: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Affiliate))
}
def affiliate=(_affiliate); end
# The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
sig { returns(T.nilable(String)) }
def agency_number; end
sig { params(_agency_number: T.nilable(String)).returns(T.nilable(String)) }
def agency_number=(_agency_number); end
# The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Delivery)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Delivery))
}
def delivery=(_delivery); end
# The name of the person or entity on the reservation.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# The details of the passengers in the travel reservation.
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Passenger])).returns(T.nilable(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Passenger]))
}
def passengers=(_passengers); end
# The individual flight segments associated with the trip.
sig {
returns(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Segment])
}
def segments; end
sig {
params(_segments: T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Segment]).returns(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Segment])
}
def segments=(_segments); end
# The ticket number associated with the travel reservation.
sig { returns(T.nilable(String)) }
def ticket_number; end
sig { params(_ticket_number: T.nilable(String)).returns(T.nilable(String)) }
def ticket_number=(_ticket_number); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Affiliate), agency_number: T.nilable(String), carrier: T.nilable(String), delivery: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Delivery), passenger_name: T.nilable(String), passengers: T.nilable(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Passenger]), segments: T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight::Segment], ticket_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
agency_number: nil,
carrier: nil,
delivery: nil,
passenger_name: nil,
passengers: nil,
segments: nil,
ticket_number: nil
); end
end
class Lodging < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the lodging reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
# The lodging location's address.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Address)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Address))
}
def address=(_address); end
# The number of adults on the booking
sig { returns(T.nilable(Integer)) }
def adults; end
sig { params(_adults: T.nilable(Integer)).returns(T.nilable(Integer)) }
def adults=(_adults); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the lodging reservation.
sig { returns(T.nilable(String)) }
def booking_number; end
sig { params(_booking_number: T.nilable(String)).returns(T.nilable(String)) }
def booking_number=(_booking_number); end
# The lodging category
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Lodging check-in time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkin_at; end
sig { params(_checkin_at: Integer).returns(Integer) }
def checkin_at=(_checkin_at); end
# Lodging check-out time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkout_at; end
sig { params(_checkout_at: Integer).returns(Integer) }
def checkout_at=(_checkout_at); end
# The customer service phone number of the lodging company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# The daily lodging room rate.
sig { returns(T.nilable(Integer)) }
def daily_room_rate_amount; end
sig { params(_daily_room_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def daily_room_rate_amount=(_daily_room_rate_amount); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Delivery)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Delivery))
}
def delivery=(_delivery); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates whether the lodging location is compliant with the Fire Safety Act.
sig { returns(T.nilable(T::Boolean)) }
def fire_safety_act_compliance; end
sig {
params(_fire_safety_act_compliance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def fire_safety_act_compliance=(_fire_safety_act_compliance); end
# The name of the lodging location.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Indicates if the customer did not keep their booking while failing to cancel the reservation.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# The number of rooms on the booking
sig { returns(T.nilable(Integer)) }
def number_of_rooms; end
sig { params(_number_of_rooms: T.nilable(Integer)).returns(T.nilable(Integer)) }
def number_of_rooms=(_number_of_rooms); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Passenger])).returns(T.nilable(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Passenger]))
}
def passengers=(_passengers); end
# The phone number of the lodging location.
sig { returns(T.nilable(String)) }
def property_phone_number; end
sig { params(_property_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def property_phone_number=(_property_phone_number); end
# The room class for this purchase.
sig { returns(T.nilable(String)) }
def room_class; end
sig { params(_room_class: T.nilable(String)).returns(T.nilable(String)) }
def room_class=(_room_class); end
# The number of room nights
sig { returns(T.nilable(Integer)) }
def room_nights; end
sig { params(_room_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def room_nights=(_room_nights); end
# The total tax amount associating with the room reservation.
sig { returns(T.nilable(Integer)) }
def total_room_tax_amount; end
sig { params(_total_room_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_room_tax_amount=(_total_room_tax_amount); end
# The total tax amount
sig { returns(T.nilable(Integer)) }
def total_tax_amount; end
sig { params(_total_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_tax_amount=(_total_tax_amount); end
sig {
params(address: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Address), adults: T.nilable(Integer), affiliate: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Affiliate), booking_number: T.nilable(String), category: T.nilable(String), checkin_at: Integer, checkout_at: Integer, customer_service_phone_number: T.nilable(String), daily_room_rate_amount: T.nilable(Integer), delivery: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Delivery), extra_charges: T.nilable(T::Array[String]), fire_safety_act_compliance: T.nilable(T::Boolean), name: T.nilable(String), no_show: T.nilable(T::Boolean), number_of_rooms: T.nilable(Integer), passengers: T.nilable(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging::Passenger]), property_phone_number: T.nilable(String), room_class: T.nilable(String), room_nights: T.nilable(Integer), total_room_tax_amount: T.nilable(Integer), total_tax_amount: T.nilable(Integer)).void
}
def initialize(
address: nil,
adults: nil,
affiliate: nil,
booking_number: nil,
category: nil,
checkin_at: nil,
checkout_at: nil,
customer_service_phone_number: nil,
daily_room_rate_amount: nil,
delivery: nil,
extra_charges: nil,
fire_safety_act_compliance: nil,
name: nil,
no_show: nil,
number_of_rooms: nil,
passengers: nil,
property_phone_number: nil,
room_class: nil,
room_nights: nil,
total_room_tax_amount: nil,
total_tax_amount: nil
); end
end
class Subscription < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class BillingInterval < Stripe::RequestParams
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def count; end
sig { params(_count: Integer).returns(Integer) }
def count=(_count); end
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig { params(count: Integer, interval: String).void }
def initialize(count: nil, interval: nil); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Subscription::Affiliate)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate=(_affiliate); end
# Info whether the subscription will be auto renewed upon expiry.
sig { returns(T.nilable(T::Boolean)) }
def auto_renewal; end
sig { params(_auto_renewal: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_renewal=(_auto_renewal); end
# Subscription billing details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval; end
sig {
params(_billing_interval: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Subscription::BillingInterval)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval=(_billing_interval); end
# Subscription end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Name of the product on subscription. e.g. Apple Music Subscription
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Subscription start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Subscription::Affiliate), auto_renewal: T.nilable(T::Boolean), billing_interval: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Subscription::BillingInterval), ends_at: T.nilable(Integer), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
affiliate: nil,
auto_renewal: nil,
billing_interval: nil,
ends_at: nil,
name: nil,
starts_at: nil
); end
end
# Car rental details for this PaymentIntent.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental))
}
def car_rental; end
sig {
params(_car_rental: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental))
}
def car_rental=(_car_rental); end
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
sig { returns(T.nilable(String)) }
def customer_reference; end
sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) }
def customer_reference=(_customer_reference); end
# Event details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails))
}
def event_details; end
sig {
params(_event_details: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails))
}
def event_details=(_event_details); end
# Flight reservation details for this PaymentIntent
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight)) }
def flight; end
sig {
params(_flight: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight))
}
def flight=(_flight); end
# Lodging reservation details for this PaymentIntent
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging)) }
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging))
}
def lodging=(_lodging); end
# A unique value assigned by the business to identify the transaction.
sig { returns(T.nilable(String)) }
def order_reference; end
sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) }
def order_reference=(_order_reference); end
# Subscription details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Subscription))
}
def subscription; end
sig {
params(_subscription: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Subscription)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Subscription))
}
def subscription=(_subscription); end
sig {
params(car_rental: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::CarRental), customer_reference: T.nilable(String), event_details: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::EventDetails), flight: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Flight), lodging: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Lodging), order_reference: T.nilable(String), subscription: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentDetails::Subscription)).void
}
def initialize(
car_rental: nil,
customer_reference: nil,
event_details: nil,
flight: nil,
lodging: nil,
order_reference: nil,
subscription: nil
); end
end
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Institution number of the customer's bank.
sig { returns(String) }
def institution_number; end
sig { params(_institution_number: String).returns(String) }
def institution_number=(_institution_number); end
# Transit number of the customer's bank.
sig { returns(String) }
def transit_number; end
sig { params(_transit_number: String).returns(String) }
def transit_number=(_transit_number); end
sig {
params(account_number: String, institution_number: String, transit_number: String).void
}
def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(String) }
def bsb_number; end
sig { params(_bsb_number: String).returns(String) }
def bsb_number=(_bsb_number); end
sig { params(account_number: String, bsb_number: String).void }
def initialize(account_number: nil, bsb_number: nil); end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
sig { params(_sort_code: T.nilable(String)).returns(T.nilable(String)) }
def sort_code=(_sort_code); end
sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
def initialize(account_number: nil, sort_code: nil); end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
sig { params(_tax_id: String).returns(String) }
def tax_id=(_tax_id); end
sig { params(tax_id: String).void }
def initialize(tax_id: nil); end
end
class Cashapp < Stripe::RequestParams; end
class Crypto < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The customer's bank.
sig { returns(String) }
def bank; end
sig { params(_bank: String).returns(String) }
def bank=(_bank); end
sig { params(account_holder_type: T.nilable(String), bank: String).void }
def initialize(account_holder_type: nil, bank: nil); end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Klarna::Dob))
}
def dob; end
sig {
params(_dob: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Klarna::Dob)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Klarna::Dob))
}
def dob=(_dob); end
sig {
params(dob: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Klarna::Dob)).void
}
def initialize(dob: nil); end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
sig { returns(T.nilable(String)) }
def funding; end
sig { params(_funding: T.nilable(String)).returns(T.nilable(String)) }
def funding=(_funding); end
sig { params(funding: T.nilable(String)).void }
def initialize(funding: nil); end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
sig { params(_bank_code: String).returns(String) }
def bank_code=(_bank_code); end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
sig { params(_branch_code: String).returns(String) }
def branch_code=(_branch_code); end
# Attribute for param field reference
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# The suffix of the bank account number.
sig { returns(String) }
def suffix; end
sig { params(_suffix: String).returns(String) }
def suffix=(_suffix); end
sig {
params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
); end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Paypay < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig { returns(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Rechnung::Dob) }
def dob; end
sig {
params(_dob: ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Rechnung::Dob).returns(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Rechnung::Dob)
}
def dob=(_dob); end
sig {
params(dob: ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Rechnung::Dob).void
}
def initialize(dob: nil); end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
sig { returns(String) }
def iban; end
sig { params(_iban: String).returns(String) }
def iban=(_iban); end
sig { params(iban: String).void }
def initialize(iban: nil); end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
sig { params(account: T.nilable(String), source_type: T.nilable(String)).void }
def initialize(account: nil, source_type: nil); end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig {
params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String))
}
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AcssDebit)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Affirm))
}
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Affirm)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Affirm))
}
def affirm=(_affirm); end
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AfterpayClearpay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Alipay))
}
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Alipay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Alipay))
}
def alipay=(_alipay); end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Alma)) }
def alma; end
sig {
params(_alma: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Alma)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Alma))
}
def alma=(_alma); end
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AmazonPay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AuBecsDebit)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::BacsDebit)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Bancontact)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Bancontact))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Billie))
}
def billie; end
sig {
params(_billie: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Billie)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Billie))
}
def billie=(_billie); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::BillingDetails)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Blik)) }
def blik; end
sig {
params(_blik: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Blik)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Blik))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Boleto))
}
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Boleto)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Boleto))
}
def boleto=(_boleto); end
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Cashapp))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Cashapp)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Cashapp))
}
def cashapp=(_cashapp); end
# If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Crypto))
}
def crypto; end
sig {
params(_crypto: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Crypto)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Crypto))
}
def crypto=(_crypto); end
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::CustomerBalance)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Eps)) }
def eps; end
sig {
params(_eps: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Eps)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Eps))
}
def eps=(_eps); end
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Fpx)) }
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Fpx)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Fpx))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Giropay))
}
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Giropay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Giropay))
}
def giropay=(_giropay); end
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Gopay)) }
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Gopay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Gopay))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Grabpay))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Grabpay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Grabpay))
}
def grabpay=(_grabpay); end
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::IdBankTransfer)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Ideal)) }
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Ideal)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Ideal))
}
def ideal=(_ideal); end
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::InteracPresent))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::InteracPresent)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::InteracPresent))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::KakaoPay))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::KakaoPay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Klarna)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Klarna))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Konbini))
}
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Konbini)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Konbini))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::KrCard))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::KrCard)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::KrCard))
}
def kr_card=(_kr_card); end
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Link)) }
def link; end
sig {
params(_link: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Link)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Link))
}
def link=(_link); end
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::MbWay)) }
def mb_way; end
sig {
params(_mb_way: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::MbWay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::MbWay))
}
def mb_way=(_mb_way); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Mobilepay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Mobilepay))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Multibanco)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Multibanco))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::NaverPay))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::NaverPay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::NaverPay))
}
def naver_pay=(_naver_pay); end
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::NzBankAccount)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Oxxo)) }
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Oxxo)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Oxxo))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::P24)) }
def p24; end
sig {
params(_p24: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::P24)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::P24))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::PayByBank)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Payco)) }
def payco; end
sig {
params(_payco: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Payco)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Payco))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Paynow))
}
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Paynow)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Paynow))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Paypal)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Paypal))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Paypay))
}
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Paypay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Paypay))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Payto)) }
def payto; end
sig {
params(_payto: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Payto)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Payto))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Pix)) }
def pix; end
sig {
params(_pix: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Pix)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Pix))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Promptpay))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Promptpay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Promptpay))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Qris)) }
def qris; end
sig {
params(_qris: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Qris)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Qris))
}
def qris=(_qris); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::RadarOptions))
}
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::RadarOptions)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::RadarOptions))
}
def radar_options=(_radar_options); end
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Rechnung))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Rechnung)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Rechnung))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::RevolutPay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::SamsungPay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Satispay))
}
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Satispay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Satispay))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::SepaDebit)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Shopeepay))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Shopeepay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Shopeepay))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Sofort))
}
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Sofort)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Sofort))
}
def sofort=(_sofort); end
# This hash contains details about the Stripe balance payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::StripeBalance))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::StripeBalance)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Swish)) }
def swish; end
sig {
params(_swish: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Swish)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Swish))
}
def swish=(_swish); end
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Twint)) }
def twint; end
sig {
params(_twint: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Twint)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Twint))
}
def twint=(_twint); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::UsBankAccount)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::WechatPay)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Zip)) }
def zip; end
sig {
params(_zip: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Zip)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Cashapp), crypto: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Crypto), customer_balance: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Giropay), gopay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Gopay), grabpay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Grabpay), id_bank_transfer: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::IdBankTransfer), ideal: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Link), mb_way: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::MbWay), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Paypal), paypay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Paypay), payto: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Payto), pix: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Promptpay), qris: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Qris), radar_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::RadarOptions), rechnung: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Rechnung), revolut_pay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::SepaDebit), shopeepay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Shopeepay), sofort: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Sofort), stripe_balance: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::StripeBalance), swish: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
mandate_options: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class Affirm < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Preferred language of the Affirm authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), preferred_locale: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, preferred_locale: nil, setup_future_usage: nil); end
end
class AfterpayClearpay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.
# This field differs from the statement descriptor and item name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), reference: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, reference: nil, setup_future_usage: nil); end
end
class Alipay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Alma < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class AmazonPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class AuBecsDebit < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(setup_future_usage: nil, target_date: nil); end
end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class Billie < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Blik < Stripe::RequestParams
# The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.
sig { returns(T.nilable(String)) }
def code; end
sig { params(_code: T.nilable(String)).returns(T.nilable(String)) }
def code=(_code); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(code: T.nilable(String), setup_future_usage: T.nilable(String)).void }
def initialize(code: nil, setup_future_usage: nil); end
end
class Boleto < Stripe::RequestParams
# The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
class Plan < Stripe::RequestParams
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
sig { returns(T.nilable(Integer)) }
def count; end
sig { params(_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def count=(_count); end
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
# One of `month`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(count: T.nilable(Integer), interval: T.nilable(String), type: String).void
}
def initialize(count: nil, interval: nil, type: nil); end
end
# Setting to true enables installments for this PaymentIntent.
# This will cause the response to contain a list of available installment plans.
# Setting to false will prevent any selected plan from applying to a charge.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# The selected installment plan to use for this payment attempt.
# This parameter can only be provided during confirmation.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan; end
sig {
params(_plan: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::Installments::Plan))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan=(_plan); end
sig {
params(enabled: T.nilable(T::Boolean), plan: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::Installments::Plan))).void
}
def initialize(enabled: nil, plan: nil); end
end
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(String) }
def amount_type; end
sig { params(_amount_type: String).returns(String) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Unique identifier for the mandate or subscription.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
sig { returns(Integer) }
def start_date; end
sig { params(_start_date: Integer).returns(Integer) }
def start_date=(_start_date); end
# Specifies the type of mandates supported. Possible values are `india`.
sig { returns(T.nilable(T::Array[String])) }
def supported_types; end
sig {
params(_supported_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def supported_types=(_supported_types); end
sig {
params(amount: Integer, amount_type: String, description: T.nilable(String), end_date: T.nilable(Integer), interval: String, interval_count: T.nilable(Integer), reference: String, start_date: Integer, supported_types: T.nilable(T::Array[String])).void
}
def initialize(
amount: nil,
amount_type: nil,
description: nil,
end_date: nil,
interval: nil,
interval_count: nil,
reference: nil,
start_date: nil,
supported_types: nil
); end
end
class StatementDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Please pass in an address that is within your Stripe user account country
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::StatementDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::StatementDetails::Address)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::StatementDetails::Address))
}
def address=(_address); end
# Phone number (e.g., a toll-free number that customers can call)
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::StatementDetails::Address), phone: T.nilable(String)).void
}
def initialize(address: nil, phone: nil); end
end
class ThreeDSecure < Stripe::RequestParams
class NetworkOptions < Stripe::RequestParams
class CartesBancaires < Stripe::RequestParams
# The cryptogram calculation algorithm used by the card Issuer's ACS
# to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
# messageExtension: CB-AVALGO
sig { returns(String) }
def cb_avalgo; end
sig { params(_cb_avalgo: String).returns(String) }
def cb_avalgo=(_cb_avalgo); end
# The exemption indicator returned from Cartes Bancaires in the ARes.
# message extension: CB-EXEMPTION; string (4 characters)
# This is a 3 byte bitmap (low significant byte first and most significant
# bit first) that has been Base64 encoded
sig { returns(T.nilable(String)) }
def cb_exemption; end
sig { params(_cb_exemption: T.nilable(String)).returns(T.nilable(String)) }
def cb_exemption=(_cb_exemption); end
# The risk score returned from Cartes Bancaires in the ARes.
# message extension: CB-SCORE; numeric value 0-99
sig { returns(T.nilable(Integer)) }
def cb_score; end
sig { params(_cb_score: T.nilable(Integer)).returns(T.nilable(Integer)) }
def cb_score=(_cb_score); end
sig {
params(cb_avalgo: String, cb_exemption: T.nilable(String), cb_score: T.nilable(Integer)).void
}
def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil); end
end
# Cartes Bancaires-specific 3DS fields.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires; end
sig {
params(_cartes_bancaires: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires=(_cartes_bancaires); end
sig {
params(cartes_bancaires: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).void
}
def initialize(cartes_bancaires: nil); end
end
# The `transStatus` returned from the card Issuer’s ACS in the ARes.
sig { returns(T.nilable(String)) }
def ares_trans_status; end
sig { params(_ares_trans_status: T.nilable(String)).returns(T.nilable(String)) }
def ares_trans_status=(_ares_trans_status); end
# The cryptogram, also known as the "authentication value" (AAV, CAVV or
# AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
# (Most 3D Secure providers will return the base64-encoded version, which
# is what you should specify here.)
sig { returns(String) }
def cryptogram; end
sig { params(_cryptogram: String).returns(String) }
def cryptogram=(_cryptogram); end
# The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
# provider and indicates what degree of authentication was performed.
sig { returns(T.nilable(String)) }
def electronic_commerce_indicator; end
sig {
params(_electronic_commerce_indicator: T.nilable(String)).returns(T.nilable(String))
}
def electronic_commerce_indicator=(_electronic_commerce_indicator); end
# The exemption requested via 3DS and accepted by the issuer at authentication time.
sig { returns(T.nilable(String)) }
def exemption_indicator; end
sig { params(_exemption_indicator: T.nilable(String)).returns(T.nilable(String)) }
def exemption_indicator=(_exemption_indicator); end
# Network specific 3DS fields. Network specific arguments require an
# explicit card brand choice. The parameter `payment_method_options.card.network``
# must be populated accordingly
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options; end
sig {
params(_network_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options=(_network_options); end
# The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
# AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
sig { returns(T.nilable(String)) }
def requestor_challenge_indicator; end
sig {
params(_requestor_challenge_indicator: T.nilable(String)).returns(T.nilable(String))
}
def requestor_challenge_indicator=(_requestor_challenge_indicator); end
# For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
# Transaction ID (dsTransID).
sig { returns(String) }
def transaction_id; end
sig { params(_transaction_id: String).returns(String) }
def transaction_id=(_transaction_id); end
# The version of 3D Secure that was performed.
sig { returns(String) }
def version; end
sig { params(_version: String).returns(String) }
def version=(_version); end
sig {
params(ares_trans_status: T.nilable(String), cryptogram: String, electronic_commerce_indicator: T.nilable(String), exemption_indicator: T.nilable(String), network_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions), requestor_challenge_indicator: T.nilable(String), transaction_id: String, version: String).void
}
def initialize(
ares_trans_status: nil,
cryptogram: nil,
electronic_commerce_indicator: nil,
exemption_indicator: nil,
network_options: nil,
requestor_challenge_indicator: nil,
transaction_id: nil,
version: nil
); end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.
sig { returns(T.nilable(String)) }
def cvc_token; end
sig { params(_cvc_token: T.nilable(String)).returns(T.nilable(String)) }
def cvc_token=(_cvc_token); end
# Installment configuration for payments attempted on this PaymentIntent.
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::Installments))
}
def installments; end
sig {
params(_installments: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::Installments)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::Installments))
}
def installments=(_installments); end
# Configuration options for setting up an eMandate for cards issued in India.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options=(_mandate_options); end
# When specified, this parameter indicates that a transaction will be marked
# as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
# parameter can only be provided during confirmation.
sig { returns(T.nilable(T::Boolean)) }
def moto; end
sig { params(_moto: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def moto=(_moto); end
# Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
# Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_decremental_authorization; end
sig {
params(_request_decremental_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_decremental_authorization=(_request_decremental_authorization); end
# Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_extended_authorization; end
sig {
params(_request_extended_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_extended_authorization=(_request_extended_authorization); end
# Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_incremental_authorization; end
sig {
params(_request_incremental_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_incremental_authorization=(_request_incremental_authorization); end
# Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_multicapture; end
sig { params(_request_multicapture: T.nilable(String)).returns(T.nilable(String)) }
def request_multicapture=(_request_multicapture); end
# Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_overcapture; end
sig { params(_request_overcapture: T.nilable(String)).returns(T.nilable(String)) }
def request_overcapture=(_request_overcapture); end
# Request partial authorization on this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_partial_authorization; end
sig {
params(_request_partial_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_partial_authorization=(_request_partial_authorization); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
# When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).
sig { returns(T.nilable(T::Boolean)) }
def require_cvc_recollection; end
sig {
params(_require_cvc_recollection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def require_cvc_recollection=(_require_cvc_recollection); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kana; end
sig {
params(_statement_descriptor_suffix_kana: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_suffix_kana=(_statement_descriptor_suffix_kana); end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kanji; end
sig {
params(_statement_descriptor_suffix_kanji: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_suffix_kanji=(_statement_descriptor_suffix_kanji); end
# Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::StatementDetails)))
}
def statement_details; end
sig {
params(_statement_details: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::StatementDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::StatementDetails)))
}
def statement_details=(_statement_details); end
# If 3D Secure authentication was performed with a third-party provider,
# the authentication details to use for this payment.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure; end
sig {
params(_three_d_secure: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure=(_three_d_secure); end
sig {
params(capture_method: T.nilable(String), cvc_token: T.nilable(String), installments: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::Installments), mandate_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::MandateOptions), moto: T.nilable(T::Boolean), network: T.nilable(String), request_decremental_authorization: T.nilable(String), request_extended_authorization: T.nilable(String), request_incremental_authorization: T.nilable(String), request_multicapture: T.nilable(String), request_overcapture: T.nilable(String), request_partial_authorization: T.nilable(String), request_three_d_secure: T.nilable(String), require_cvc_recollection: T.nilable(T::Boolean), setup_future_usage: T.nilable(T.any(String, String)), statement_descriptor_suffix_kana: T.nilable(String), statement_descriptor_suffix_kanji: T.nilable(String), statement_details: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::StatementDetails)), three_d_secure: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure)).void
}
def initialize(
capture_method: nil,
cvc_token: nil,
installments: nil,
mandate_options: nil,
moto: nil,
network: nil,
request_decremental_authorization: nil,
request_extended_authorization: nil,
request_incremental_authorization: nil,
request_multicapture: nil,
request_overcapture: nil,
request_partial_authorization: nil,
request_three_d_secure: nil,
require_cvc_recollection: nil,
setup_future_usage: nil,
statement_descriptor_suffix_kana: nil,
statement_descriptor_suffix_kanji: nil,
statement_details: nil,
three_d_secure: nil
); end
end
class CardPresent < Stripe::RequestParams
class Routing < Stripe::RequestParams
# Routing requested priority
sig { returns(T.nilable(String)) }
def requested_priority; end
sig { params(_requested_priority: T.nilable(String)).returns(T.nilable(String)) }
def requested_priority=(_requested_priority); end
sig { params(requested_priority: T.nilable(String)).void }
def initialize(requested_priority: nil); end
end
# Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)
sig { returns(T.nilable(T::Boolean)) }
def request_extended_authorization; end
sig {
params(_request_extended_authorization: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def request_extended_authorization=(_request_extended_authorization); end
# Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
sig { returns(T.nilable(T::Boolean)) }
def request_incremental_authorization_support; end
sig {
params(_request_incremental_authorization_support: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def request_incremental_authorization_support=(
_request_incremental_authorization_support
); end
# Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CardPresent::Routing))
}
def routing; end
sig {
params(_routing: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CardPresent::Routing)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CardPresent::Routing))
}
def routing=(_routing); end
sig {
params(request_extended_authorization: T.nilable(T::Boolean), request_incremental_authorization_support: T.nilable(T::Boolean), routing: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CardPresent::Routing)).void
}
def initialize(
request_extended_authorization: nil,
request_incremental_authorization_support: nil,
routing: nil
); end
end
class Cashapp < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Crypto < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for the eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
sig {
params(_requested_address_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested_address_types=(_requested_address_types); end
# The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
}
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(bank_transfer: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
end
class Eps < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Fpx < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Giropay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Gopay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Grabpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class IdBankTransfer < Stripe::RequestParams
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from 5 minutes from now until 31 days from now. If unset, it defaults to 3 days from now.
sig { returns(T.nilable(Integer)) }
def expires_after; end
sig { params(_expires_after: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after=(_expires_after); end
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now until 30 days from now. If unset, it defaults to 1 days from now.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after: T.nilable(Integer), expires_at: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after: nil, expires_at: nil, setup_future_usage: nil); end
end
class Ideal < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Klarna < Stripe::RequestParams
class OnDemand < Stripe::RequestParams
# Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def average_amount; end
sig { params(_average_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def average_amount=(_average_amount); end
# The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def maximum_amount; end
sig { params(_maximum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_amount=(_maximum_amount); end
# The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Interval at which the customer is making purchases
sig { returns(T.nilable(String)) }
def purchase_interval; end
sig { params(_purchase_interval: T.nilable(String)).returns(T.nilable(String)) }
def purchase_interval=(_purchase_interval); end
# The number of `purchase_interval` between charges
sig { returns(T.nilable(Integer)) }
def purchase_interval_count; end
sig { params(_purchase_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def purchase_interval_count=(_purchase_interval_count); end
sig {
params(average_amount: T.nilable(Integer), maximum_amount: T.nilable(Integer), minimum_amount: T.nilable(Integer), purchase_interval: T.nilable(String), purchase_interval_count: T.nilable(Integer)).void
}
def initialize(
average_amount: nil,
maximum_amount: nil,
minimum_amount: nil,
purchase_interval: nil,
purchase_interval_count: nil
); end
end
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing; end
sig {
params(_next_billing: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna::Subscription::NextBilling), reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# On-demand details if setting up or charging an on-demand payment.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand; end
sig {
params(_on_demand: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna::OnDemand)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand=(_on_demand); end
# Preferred language of the Klarna authorization page that the customer is redirected to
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Subscription details if setting up or charging a subscription.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(capture_method: T.nilable(String), on_demand: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna::OnDemand), preferred_locale: T.nilable(String), setup_future_usage: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(
capture_method: nil,
on_demand: nil,
preferred_locale: nil,
setup_future_usage: nil,
subscriptions: nil
); end
end
class Konbini < Stripe::RequestParams
# An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number.
sig { returns(T.nilable(String)) }
def confirmation_number; end
sig { params(_confirmation_number: T.nilable(String)).returns(T.nilable(String)) }
def confirmation_number=(_confirmation_number); end
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
sig { returns(T.nilable(T.any(String, Integer))) }
def expires_after_days; end
sig {
params(_expires_after_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expires_after_days=(_expires_after_days); end
# The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.
sig { returns(T.nilable(T.any(String, Integer))) }
def expires_at; end
sig {
params(_expires_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expires_at=(_expires_at); end
# A product descriptor of up to 22 characters, which will appear to customers at the convenience store.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(confirmation_number: T.nilable(String), expires_after_days: T.nilable(T.any(String, Integer)), expires_at: T.nilable(T.any(String, Integer)), product_description: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(
confirmation_number: nil,
expires_after_days: nil,
expires_at: nil,
product_description: nil,
setup_future_usage: nil
); end
end
class KrCard < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Link < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
sig { params(_persistent_token: T.nilable(String)).returns(T.nilable(String)) }
def persistent_token=(_persistent_token); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), persistent_token: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, persistent_token: nil, setup_future_usage: nil); end
end
class MbWay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Mobilepay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Multibanco < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class NaverPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class NzBankAccount < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(setup_future_usage: nil, target_date: nil); end
end
class Oxxo < Stripe::RequestParams
# The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class P24 < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Confirm that the payer has accepted the P24 terms and conditions.
sig { returns(T.nilable(T::Boolean)) }
def tos_shown_and_accepted; end
sig {
params(_tos_shown_and_accepted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def tos_shown_and_accepted=(_tos_shown_and_accepted); end
sig {
params(setup_future_usage: T.nilable(String), tos_shown_and_accepted: T.nilable(T::Boolean)).void
}
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Paynow < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Paypal < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The tax for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The tax behavior for the line item.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(amount: Integer, behavior: String).void }
def initialize(amount: nil, behavior: nil); end
end
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Descriptive name of the line item.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Quantity of the line item. Must be a positive number.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Client facing stock keeping unit, article number or similar.
sig { returns(T.nilable(String)) }
def sku; end
sig { params(_sku: T.nilable(String)).returns(T.nilable(String)) }
def sku=(_sku); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
# The tax information for the line item.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypal::LineItem::Tax)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax=(_tax); end
# Price for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def unit_amount; end
sig { params(_unit_amount: Integer).returns(Integer) }
def unit_amount=(_unit_amount); end
sig {
params(category: T.nilable(String), description: T.nilable(String), name: String, quantity: Integer, sku: T.nilable(String), sold_by: T.nilable(String), tax: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypal::LineItem::Tax), unit_amount: Integer).void
}
def initialize(
category: nil,
description: nil,
name: nil,
quantity: nil,
sku: nil,
sold_by: nil,
tax: nil,
unit_amount: nil
); end
end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# The line items purchased by the customer.
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypal::LineItem])).returns(T.nilable(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items=(_line_items); end
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference_id; end
sig { params(_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def reference_id=(_reference_id); end
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
sig { returns(T.nilable(String)) }
def risk_correlation_id; end
sig { params(_risk_correlation_id: T.nilable(String)).returns(T.nilable(String)) }
def risk_correlation_id=(_risk_correlation_id); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(capture_method: T.nilable(String), line_items: T.nilable(T::Array[::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypal::LineItem]), preferred_locale: T.nilable(String), reference: T.nilable(String), reference_id: T.nilable(String), risk_correlation_id: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String)), subsellers: T.nilable(T::Array[String])).void
}
def initialize(
capture_method: nil,
line_items: nil,
preferred_locale: nil,
reference: nil,
reference_id: nil,
risk_correlation_id: nil,
setup_future_usage: nil,
subsellers: nil
); end
end
class Paypay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
sig { params(_payments_per_period: T.nilable(Integer)).returns(T.nilable(Integer)) }
def payments_per_period=(_payments_per_period); end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
sig { params(_purpose: T.nilable(String)).returns(T.nilable(String)) }
def purpose=(_purpose); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), payments_per_period: T.nilable(Integer), purpose: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil
); end
end
# Additional fields for Mandate creation. Only `purpose` field is configurable for PayTo PaymentIntent with `setup_future_usage=none`. Other fields are only applicable to PayTo PaymentIntent with `setup_future_usage=off_session`
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Payto::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Payto::MandateOptions), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(mandate_options: nil, setup_future_usage: nil); end
end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Type of amount. Defaults to `maximum`.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), amount_type: T.nilable(String), currency: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), reference: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
amount_type: nil,
currency: nil,
end_date: nil,
payment_schedule: nil,
reference: nil,
start_date: nil
); end
end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
sig { returns(T.nilable(Integer)) }
def expires_after_seconds; end
sig { params(_expires_after_seconds: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_seconds=(_expires_after_seconds); end
# The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# Additional fields for mandate creation. Only applicable when `setup_future_usage=off_session`.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(amount_includes_iof: T.nilable(String), expires_after_seconds: T.nilable(Integer), expires_at: T.nilable(Integer), mandate_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions), setup_future_usage: T.nilable(String)).void
}
def initialize(
amount_includes_iof: nil,
expires_after_seconds: nil,
expires_at: nil,
mandate_options: nil,
setup_future_usage: nil
); end
end
class Promptpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Qris < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Rechnung < Stripe::RequestParams; end
class RevolutPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class SamsungPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Satispay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Shopeepay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Sofort < Stripe::RequestParams
# Language shown to the payer on redirect.
sig { returns(T.nilable(T.any(String, String))) }
def preferred_language; end
sig {
params(_preferred_language: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(T.any(String, String)), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class StripeBalance < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Swish < Stripe::RequestParams
# A reference for this payment to be displayed in the Swish app.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(reference: T.nilable(String), setup_future_usage: T.nilable(String)).void }
def initialize(reference: nil, setup_future_usage: nil); end
end
class Twint < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
class ManualEntry < Stripe::RequestParams
# Settings for configuring manual entry of account details.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
sig { params(mode: String).void }
def initialize(mode: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# Customize manual entry behavior
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry; end
sig {
params(_manual_entry: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry=(_manual_entry); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(filters: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), manual_entry: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
}
def initialize(
filters: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
); end
end
class MandateOptions < Stripe::RequestParams
# The method used to collect offline mandate customer acceptance.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
sig { params(collection_method: T.nilable(String)).void }
def initialize(collection_method: nil); end
end
class Networks < Stripe::RequestParams
# Triggers validations to run across the selected networks
sig { returns(T.nilable(T::Array[String])) }
def requested; end
sig {
params(_requested: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested=(_requested); end
sig { params(requested: T.nilable(T::Array[String])).void }
def initialize(requested: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Additional fields for network related functions
sig {
returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks; end
sig {
params(_networks: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks=(_networks); end
# Preferred transaction settlement speed
sig { returns(T.nilable(T.any(String, String))) }
def preferred_settlement_speed; end
sig {
params(_preferred_settlement_speed: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred_settlement_speed=(_preferred_settlement_speed); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks), preferred_settlement_speed: T.nilable(T.any(String, String)), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
financial_connections: nil,
mandate_options: nil,
networks: nil,
preferred_settlement_speed: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class WechatPay < Stripe::RequestParams
# The app ID registered with WeChat Pay. Only required when client is ios or android.
sig { returns(T.nilable(String)) }
def app_id; end
sig { params(_app_id: T.nilable(String)).returns(T.nilable(String)) }
def app_id=(_app_id); end
# The client type that the end customer will pay from
sig { returns(T.nilable(String)) }
def client; end
sig { params(_client: T.nilable(String)).returns(T.nilable(String)) }
def client=(_client); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(app_id: T.nilable(String), client: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
end
class Zip < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
# If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AcssDebit)))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AcssDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AcssDebit)))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Affirm)))
}
def affirm; end
sig {
params(_affirm: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Affirm))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Affirm)))
}
def affirm=(_affirm); end
# If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AfterpayClearpay)))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AfterpayClearpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AfterpayClearpay)))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Alipay)))
}
def alipay; end
sig {
params(_alipay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Alipay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Alipay)))
}
def alipay=(_alipay); end
# If this is a `alma` PaymentMethod, this sub-hash contains details about the Alma payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Alma)))
}
def alma; end
sig {
params(_alma: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Alma))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Alma)))
}
def alma=(_alma); end
# If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AmazonPay)))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AmazonPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AmazonPay)))
}
def amazon_pay=(_amazon_pay); end
# If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AuBecsDebit)))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AuBecsDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AuBecsDebit)))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::BacsDebit)))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::BacsDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::BacsDebit)))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Bancontact)))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Bancontact))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Bancontact)))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this sub-hash contains details about the Billie payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Billie)))
}
def billie; end
sig {
params(_billie: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Billie))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Billie)))
}
def billie=(_billie); end
# If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Blik)))
}
def blik; end
sig {
params(_blik: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Blik))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Blik)))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Boleto)))
}
def boleto; end
sig {
params(_boleto: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Boleto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Boleto)))
}
def boleto=(_boleto); end
# Configuration for any card payments attempted on this PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card)))
}
def card; end
sig {
params(_card: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card)))
}
def card=(_card); end
# If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CardPresent)))
}
def card_present; end
sig {
params(_card_present: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CardPresent))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CardPresent)))
}
def card_present=(_card_present); end
# If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Cashapp)))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Cashapp))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Cashapp)))
}
def cashapp=(_cashapp); end
# If this is a `crypto` PaymentMethod, this sub-hash contains details about the Crypto payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Crypto)))
}
def crypto; end
sig {
params(_crypto: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Crypto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Crypto)))
}
def crypto=(_crypto); end
# If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CustomerBalance))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance=(_customer_balance); end
# If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Eps)))
}
def eps; end
sig {
params(_eps: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Eps))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Eps)))
}
def eps=(_eps); end
# If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Fpx)))
}
def fpx; end
sig {
params(_fpx: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Fpx))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Fpx)))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Giropay)))
}
def giropay; end
sig {
params(_giropay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Giropay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Giropay)))
}
def giropay=(_giropay); end
# If this is a `gopay` PaymentMethod, this sub-hash contains details about the Gopay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Gopay)))
}
def gopay; end
sig {
params(_gopay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Gopay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Gopay)))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Grabpay)))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Grabpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Grabpay)))
}
def grabpay=(_grabpay); end
# If this is a `id_bank_transfer` PaymentMethod, this sub-hash contains details about the Indonesia Bank Transfer payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::IdBankTransfer))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Ideal)))
}
def ideal; end
sig {
params(_ideal: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Ideal))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Ideal)))
}
def ideal=(_ideal); end
# If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::InteracPresent)))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::InteracPresent))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::InteracPresent)))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::KakaoPay)))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::KakaoPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::KakaoPay)))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna)))
}
def klarna; end
sig {
params(_klarna: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna)))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Konbini)))
}
def konbini; end
sig {
params(_konbini: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Konbini))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Konbini)))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this sub-hash contains details about the KR Card payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::KrCard)))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::KrCard))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::KrCard)))
}
def kr_card=(_kr_card); end
# If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Link)))
}
def link; end
sig {
params(_link: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Link))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Link)))
}
def link=(_link); end
# If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::MbWay)))
}
def mb_way; end
sig {
params(_mb_way: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::MbWay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::MbWay)))
}
def mb_way=(_mb_way); end
# If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Mobilepay)))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Mobilepay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Mobilepay)))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Multibanco)))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Multibanco))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Multibanco)))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this sub-hash contains details about the Naver Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::NaverPay)))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::NaverPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::NaverPay)))
}
def naver_pay=(_naver_pay); end
# If this is a `nz_bank_account` PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::NzBankAccount)))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::NzBankAccount))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::NzBankAccount)))
}
def nz_bank_account=(_nz_bank_account); end
# If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Oxxo)))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Oxxo))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Oxxo)))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::P24)))
}
def p24; end
sig {
params(_p24: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::P24))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::P24)))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this sub-hash contains details about the PayByBank payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::PayByBank)))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::PayByBank))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::PayByBank)))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this sub-hash contains details about the PAYCO payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Payco)))
}
def payco; end
sig {
params(_payco: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Payco))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Payco)))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paynow)))
}
def paynow; end
sig {
params(_paynow: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paynow))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paynow)))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypal)))
}
def paypal; end
sig {
params(_paypal: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypal))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypal)))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this sub-hash contains details about the PayPay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypay)))
}
def paypay; end
sig {
params(_paypay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypay)))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Payto)))
}
def payto; end
sig {
params(_payto: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Payto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Payto)))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Pix)))
}
def pix; end
sig {
params(_pix: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Pix))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Pix)))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Promptpay)))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Promptpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Promptpay)))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this sub-hash contains details about the QRIS payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Qris)))
}
def qris; end
sig {
params(_qris: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Qris))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Qris)))
}
def qris=(_qris); end
# If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Rechnung)))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Rechnung))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Rechnung)))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::RevolutPay)))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::RevolutPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::RevolutPay)))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SamsungPay)))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SamsungPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SamsungPay)))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Satispay)))
}
def satispay; end
sig {
params(_satispay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Satispay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Satispay)))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SepaDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit=(_sepa_debit); end
# If this is a `shopeepay` PaymentMethod, this sub-hash contains details about the ShopeePay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Shopeepay)))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Shopeepay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Shopeepay)))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Sofort)))
}
def sofort; end
sig {
params(_sofort: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Sofort))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Sofort)))
}
def sofort=(_sofort); end
# If this is a `stripe_balance` PaymentMethod, this sub-hash contains details about the Stripe Balance payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::StripeBalance)))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::StripeBalance))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::StripeBalance)))
}
def stripe_balance=(_stripe_balance); end
# If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Swish)))
}
def swish; end
sig {
params(_swish: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Swish))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Swish)))
}
def swish=(_swish); end
# If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Twint)))
}
def twint; end
sig {
params(_twint: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Twint))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Twint)))
}
def twint=(_twint); end
# If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
# If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::WechatPay)))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::WechatPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::WechatPay)))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Zip)))
}
def zip; end
sig {
params(_zip: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Zip))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Zip)))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AcssDebit)), affirm: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Affirm)), afterpay_clearpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AfterpayClearpay)), alipay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Alipay)), alma: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Alma)), amazon_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AmazonPay)), au_becs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AuBecsDebit)), bacs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::BacsDebit)), bancontact: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Bancontact)), billie: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Billie)), blik: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Blik)), boleto: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Boleto)), card: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card)), card_present: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CardPresent)), cashapp: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Cashapp)), crypto: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Crypto)), customer_balance: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CustomerBalance)), eps: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Eps)), fpx: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Fpx)), giropay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Giropay)), gopay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Gopay)), grabpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Grabpay)), id_bank_transfer: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::IdBankTransfer)), ideal: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Ideal)), interac_present: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::InteracPresent)), kakao_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::KakaoPay)), klarna: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna)), konbini: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Konbini)), kr_card: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::KrCard)), link: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Link)), mb_way: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::MbWay)), mobilepay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Mobilepay)), multibanco: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Multibanco)), naver_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::NaverPay)), nz_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::NzBankAccount)), oxxo: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Oxxo)), p24: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::P24)), pay_by_bank: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::PayByBank)), payco: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Payco)), paynow: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paynow)), paypal: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypal)), paypay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypay)), payto: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Payto)), pix: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Pix)), promptpay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Promptpay)), qris: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Qris)), rechnung: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Rechnung)), revolut_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::RevolutPay)), samsung_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SamsungPay)), satispay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Satispay)), sepa_debit: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SepaDebit)), shopeepay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Shopeepay)), sofort: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Sofort)), stripe_balance: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::StripeBalance)), swish: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Swish)), twint: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Twint)), us_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount)), wechat_pay: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::WechatPay)), zip: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Zip))).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
blik: nil,
boleto: nil,
card: nil,
card_present: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address.
sig { returns(::Stripe::PaymentIntent::ConfirmParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::PaymentIntent::ConfirmParams::Shipping::Address).returns(::Stripe::PaymentIntent::ConfirmParams::Shipping::Address)
}
def address=(_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
sig { params(_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def tracking_number=(_tracking_number); end
sig {
params(address: ::Stripe::PaymentIntent::ConfirmParams::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
}
def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
end
# Provides industry-specific information about the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::AmountDetails)))
}
def amount_details; end
sig {
params(_amount_details: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::AmountDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::AmountDetails)))
}
def amount_details=(_amount_details); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(T.any(String, Integer))) }
def application_fee_amount; end
sig {
params(_application_fee_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def application_fee_amount=(_application_fee_amount); end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# ID of the ConfirmationToken used to confirm this PaymentIntent.
#
# If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.
sig { returns(T.nilable(String)) }
def confirmation_token; end
sig { params(_confirmation_token: T.nilable(String)).returns(T.nilable(String)) }
def confirmation_token=(_confirmation_token); end
# Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication).
sig { returns(T.nilable(T::Boolean)) }
def error_on_requires_action; end
sig {
params(_error_on_requires_action: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def error_on_requires_action=(_error_on_requires_action); end
# The list of payment method types to exclude from use with this payment.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def excluded_payment_method_types; end
sig {
params(_excluded_payment_method_types: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def excluded_payment_method_types=(_excluded_payment_method_types); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.
sig { returns(T.nilable(String)) }
def fx_quote; end
sig { params(_fx_quote: T.nilable(String)).returns(T.nilable(String)) }
def fx_quote=(_fx_quote); end
# Automations to be run during the PaymentIntent lifecycle
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::Hooks)) }
def hooks; end
sig {
params(_hooks: T.nilable(::Stripe::PaymentIntent::ConfirmParams::Hooks)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::Hooks))
}
def hooks=(_hooks); end
# ID of the mandate that's used for this payment.
sig { returns(T.nilable(String)) }
def mandate; end
sig { params(_mandate: T.nilable(String)).returns(T.nilable(String)) }
def mandate=(_mandate); end
# Attribute for param field mandate_data
sig { returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::MandateData))) }
def mandate_data; end
sig {
params(_mandate_data: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::MandateData))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::MandateData)))
}
def mandate_data=(_mandate_data); end
# Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards).
sig { returns(T.nilable(T.any(T::Boolean, String))) }
def off_session; end
sig {
params(_off_session: T.nilable(T.any(T::Boolean, String))).returns(T.nilable(T.any(T::Boolean, String)))
}
def off_session=(_off_session); end
# Provides industry-specific information about the charge.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentDetails)))
}
def payment_details; end
sig {
params(_payment_details: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentDetails)))
}
def payment_details=(_payment_details); end
# ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent.
# If the payment method is attached to a Customer, it must match the [customer](https://stripe.com/docs/api#create_payment_intent-customer) that is set on this PaymentIntent.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
# in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)
# property on the PaymentIntent.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData)) }
def payment_method_data; end
sig {
params(_payment_method_data: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData))
}
def payment_method_data=(_payment_method_data); end
# Payment method-specific configuration for this PaymentIntent.
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions)) }
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (for example, a card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
# Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).
sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::RadarOptions)) }
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::RadarOptions)).returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::RadarOptions))
}
def radar_options=(_radar_options); end
# Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
sig { returns(T.nilable(String)) }
def receipt_email; end
sig { params(_receipt_email: T.nilable(String)).returns(T.nilable(String)) }
def receipt_email=(_receipt_email); end
# The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
# If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
# This parameter is only used for cards and other redirect-based payment methods.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Shipping information for this PaymentIntent.
sig { returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::Shipping))) }
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::Shipping))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::Shipping)))
}
def shipping=(_shipping); end
# Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
sig { returns(T.nilable(T::Boolean)) }
def use_stripe_sdk; end
sig { params(_use_stripe_sdk: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def use_stripe_sdk=(_use_stripe_sdk); end
sig {
params(amount_details: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::AmountDetails)), application_fee_amount: T.nilable(T.any(String, Integer)), capture_method: T.nilable(String), confirmation_token: T.nilable(String), error_on_requires_action: T.nilable(T::Boolean), excluded_payment_method_types: T.nilable(T.any(String, T::Array[String])), expand: T.nilable(T::Array[String]), fx_quote: T.nilable(String), hooks: T.nilable(::Stripe::PaymentIntent::ConfirmParams::Hooks), mandate: T.nilable(String), mandate_data: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::MandateData)), off_session: T.nilable(T.any(T::Boolean, String)), payment_details: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentDetails)), payment_method: T.nilable(String), payment_method_data: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), radar_options: T.nilable(::Stripe::PaymentIntent::ConfirmParams::RadarOptions), receipt_email: T.nilable(String), return_url: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String)), shipping: T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::Shipping)), use_stripe_sdk: T.nilable(T::Boolean)).void
}
def initialize(
amount_details: nil,
application_fee_amount: nil,
capture_method: nil,
confirmation_token: nil,
error_on_requires_action: nil,
excluded_payment_method_types: nil,
expand: nil,
fx_quote: nil,
hooks: nil,
mandate: nil,
mandate_data: nil,
off_session: nil,
payment_details: nil,
payment_method: nil,
payment_method_data: nil,
payment_method_options: nil,
payment_method_types: nil,
radar_options: nil,
receipt_email: nil,
return_url: nil,
setup_future_usage: nil,
shipping: nil,
use_stripe_sdk: nil
); end
end
class DecrementAuthorizationParams < Stripe::RequestParams
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
sig { returns(String) }
def calculation; end
sig { params(_calculation: String).returns(String) }
def calculation=(_calculation); end
sig { params(calculation: String).void }
def initialize(calculation: nil); end
end
# Tax arguments for automations
sig {
returns(T.nilable(::Stripe::PaymentIntent::DecrementAuthorizationParams::Hooks::Inputs::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntent::DecrementAuthorizationParams::Hooks::Inputs::Tax)).returns(T.nilable(::Stripe::PaymentIntent::DecrementAuthorizationParams::Hooks::Inputs::Tax))
}
def tax=(_tax); end
sig {
params(tax: T.nilable(::Stripe::PaymentIntent::DecrementAuthorizationParams::Hooks::Inputs::Tax)).void
}
def initialize(tax: nil); end
end
# Arguments passed in automations
sig {
returns(T.nilable(::Stripe::PaymentIntent::DecrementAuthorizationParams::Hooks::Inputs))
}
def inputs; end
sig {
params(_inputs: T.nilable(::Stripe::PaymentIntent::DecrementAuthorizationParams::Hooks::Inputs)).returns(T.nilable(::Stripe::PaymentIntent::DecrementAuthorizationParams::Hooks::Inputs))
}
def inputs=(_inputs); end
sig {
params(inputs: T.nilable(::Stripe::PaymentIntent::DecrementAuthorizationParams::Hooks::Inputs)).void
}
def initialize(inputs: nil); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
sig { params(amount: T.nilable(Integer)).void }
def initialize(amount: nil); end
end
# The updated total amount that you intend to collect from the cardholder. This amount must be smaller than the currently authorized amount and greater than the already captured amount.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Automations to be run during the PaymentIntent lifecycle
sig { returns(T.nilable(::Stripe::PaymentIntent::DecrementAuthorizationParams::Hooks)) }
def hooks; end
sig {
params(_hooks: T.nilable(::Stripe::PaymentIntent::DecrementAuthorizationParams::Hooks)).returns(T.nilable(::Stripe::PaymentIntent::DecrementAuthorizationParams::Hooks))
}
def hooks=(_hooks); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The parameters used to automatically create a transfer after the payment is captured.
# Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig {
returns(T.nilable(::Stripe::PaymentIntent::DecrementAuthorizationParams::TransferData))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::PaymentIntent::DecrementAuthorizationParams::TransferData)).returns(T.nilable(::Stripe::PaymentIntent::DecrementAuthorizationParams::TransferData))
}
def transfer_data=(_transfer_data); end
sig {
params(amount: Integer, application_fee_amount: T.nilable(Integer), description: T.nilable(String), expand: T.nilable(T::Array[String]), hooks: T.nilable(::Stripe::PaymentIntent::DecrementAuthorizationParams::Hooks), metadata: T.nilable(T::Hash[String, String]), transfer_data: T.nilable(::Stripe::PaymentIntent::DecrementAuthorizationParams::TransferData)).void
}
def initialize(
amount: nil,
application_fee_amount: nil,
description: nil,
expand: nil,
hooks: nil,
metadata: nil,
transfer_data: nil
); end
end
class IncrementAuthorizationParams < Stripe::RequestParams
class AmountDetails < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class Card < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class CardPresent < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class Klarna < Stripe::RequestParams
# URL to an image for the product. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def image_url; end
sig { params(_image_url: T.nilable(String)).returns(T.nilable(String)) }
def image_url=(_image_url); end
# URL to the product page. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def product_url; end
sig { params(_product_url: T.nilable(String)).returns(T.nilable(String)) }
def product_url=(_product_url); end
# Reference for the subscription this line item is for.
sig { returns(T.nilable(String)) }
def subscription_reference; end
sig { params(_subscription_reference: T.nilable(String)).returns(T.nilable(String)) }
def subscription_reference=(_subscription_reference); end
sig {
params(image_url: T.nilable(String), product_url: T.nilable(String), subscription_reference: T.nilable(String)).void
}
def initialize(image_url: nil, product_url: nil, subscription_reference: nil); end
end
class Paypal < Stripe::RequestParams
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
sig {
params(category: T.nilable(String), description: T.nilable(String), sold_by: T.nilable(String)).void
}
def initialize(category: nil, description: nil, sold_by: nil); end
end
# This sub-hash contains line item details that are specific to `card` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card=(_card); end
# This sub-hash contains line item details that are specific to `card_present` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present=(_card_present); end
# This sub-hash contains line item details that are specific to `klarna` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# This sub-hash contains line item details that are specific to `paypal` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
sig {
params(card: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent), klarna: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna), paypal: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).void
}
def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end
end
class Tax < Stripe::RequestParams
# The total tax on an item. Non-negative integer.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The amount an item was discounted for. Positive integer.
sig { returns(T.nilable(Integer)) }
def discount_amount; end
sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def discount_amount=(_discount_amount); end
# Payment method-specific information for line items.
sig {
returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# Unique identifier of the product. At most 12 characters long.
sig { returns(T.nilable(String)) }
def product_code; end
sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) }
def product_code=(_product_code); end
# Name of the product. At most 100 characters long.
sig { returns(String) }
def product_name; end
sig { params(_product_name: String).returns(String) }
def product_name=(_product_name); end
# Number of items of the product. Positive integer.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Contains information about the tax on the item.
sig {
returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::Tax)).returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::Tax))
}
def tax=(_tax); end
# Cost of the product. Non-negative integer.
sig { returns(Integer) }
def unit_cost; end
sig { params(_unit_cost: Integer).returns(Integer) }
def unit_cost=(_unit_cost); end
# A unit of measure for the line item, such as gallons, feet, meters, etc.
sig { returns(T.nilable(String)) }
def unit_of_measure; end
sig { params(_unit_of_measure: T.nilable(String)).returns(T.nilable(String)) }
def unit_of_measure=(_unit_of_measure); end
sig {
params(discount_amount: T.nilable(Integer), payment_method_options: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions), product_code: T.nilable(String), product_name: String, quantity: Integer, tax: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem::Tax), unit_cost: Integer, unit_of_measure: T.nilable(String)).void
}
def initialize(
discount_amount: nil,
payment_method_options: nil,
product_code: nil,
product_name: nil,
quantity: nil,
tax: nil,
unit_cost: nil,
unit_of_measure: nil
); end
end
class Shipping < Stripe::RequestParams
# Portion of the amount that is for shipping.
sig { returns(T.nilable(T.any(String, Integer))) }
def amount; end
sig {
params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def amount=(_amount); end
# The postal code that represents the shipping source.
sig { returns(T.nilable(String)) }
def from_postal_code; end
sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def from_postal_code=(_from_postal_code); end
# The postal code that represents the shipping destination.
sig { returns(T.nilable(String)) }
def to_postal_code; end
sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def to_postal_code=(_to_postal_code); end
sig {
params(amount: T.nilable(T.any(String, Integer)), from_postal_code: T.nilable(String), to_postal_code: T.nilable(String)).void
}
def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end
end
class Tax < Stripe::RequestParams
# Total portion of the amount that is for tax.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The total discount applied on the transaction.
sig { returns(T.nilable(T.any(String, Integer))) }
def discount_amount; end
sig {
params(_discount_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def discount_amount=(_discount_amount); end
# A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem])))
}
def line_items; end
sig {
params(_line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem])))
}
def line_items=(_line_items); end
# Contains information about the shipping portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::Shipping)))
}
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::Shipping))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::Shipping)))
}
def shipping=(_shipping); end
# Contains information about the tax portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::Tax)))
}
def tax; end
sig {
params(_tax: T.nilable(T.any(String, ::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::Tax))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::Tax)))
}
def tax=(_tax); end
sig {
params(discount_amount: T.nilable(T.any(String, Integer)), line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::LineItem])), shipping: T.nilable(T.any(String, ::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::Shipping)), tax: T.nilable(T.any(String, ::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails::Tax))).void
}
def initialize(discount_amount: nil, line_items: nil, shipping: nil, tax: nil); end
end
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
sig { returns(String) }
def calculation; end
sig { params(_calculation: String).returns(String) }
def calculation=(_calculation); end
sig { params(calculation: String).void }
def initialize(calculation: nil); end
end
# Tax arguments for automations
sig {
returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::Hooks::Inputs::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::Hooks::Inputs::Tax)).returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::Hooks::Inputs::Tax))
}
def tax=(_tax); end
sig {
params(tax: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::Hooks::Inputs::Tax)).void
}
def initialize(tax: nil); end
end
# Arguments passed in automations
sig {
returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::Hooks::Inputs))
}
def inputs; end
sig {
params(_inputs: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::Hooks::Inputs)).returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::Hooks::Inputs))
}
def inputs=(_inputs); end
sig {
params(inputs: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::Hooks::Inputs)).void
}
def initialize(inputs: nil); end
end
class PaymentDetails < Stripe::RequestParams
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
sig { returns(T.nilable(String)) }
def customer_reference; end
sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) }
def customer_reference=(_customer_reference); end
# A unique value assigned by the business to identify the transaction.
sig { returns(T.nilable(String)) }
def order_reference; end
sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) }
def order_reference=(_order_reference); end
sig {
params(customer_reference: T.nilable(String), order_reference: T.nilable(String)).void
}
def initialize(customer_reference: nil, order_reference: nil); end
end
class PaymentMethodOptions < Stripe::RequestParams
class Card < Stripe::RequestParams
# Request partial authorization on this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_partial_authorization; end
sig {
params(_request_partial_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_partial_authorization=(_request_partial_authorization); end
sig { params(request_partial_authorization: T.nilable(String)).void }
def initialize(request_partial_authorization: nil); end
end
# Configuration for any card payments attempted on this PaymentIntent.
sig {
returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::PaymentMethodOptions::Card))
}
def card=(_card); end
sig {
params(card: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::PaymentMethodOptions::Card)).void
}
def initialize(card: nil); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
sig { params(amount: T.nilable(Integer)).void }
def initialize(amount: nil); end
end
# The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Provides industry-specific information about the amount.
sig {
returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails))
}
def amount_details; end
sig {
params(_amount_details: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails)).returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails))
}
def amount_details=(_amount_details); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Automations to be run during the PaymentIntent lifecycle
sig { returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::Hooks)) }
def hooks; end
sig {
params(_hooks: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::Hooks)).returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::Hooks))
}
def hooks=(_hooks); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Provides industry-specific information about the charge.
sig {
returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::PaymentDetails))
}
def payment_details; end
sig {
params(_payment_details: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::PaymentDetails)).returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::PaymentDetails))
}
def payment_details=(_payment_details); end
# Payment method-specific configuration for this PaymentIntent.
sig {
returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# The parameters used to automatically create a transfer after the payment is captured.
# Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig {
returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::TransferData))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::TransferData)).returns(T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::TransferData))
}
def transfer_data=(_transfer_data); end
sig {
params(amount: Integer, amount_details: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::AmountDetails), application_fee_amount: T.nilable(Integer), description: T.nilable(String), expand: T.nilable(T::Array[String]), hooks: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::Hooks), metadata: T.nilable(T::Hash[String, String]), payment_details: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::PaymentDetails), payment_method_options: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::PaymentMethodOptions), statement_descriptor: T.nilable(String), transfer_data: T.nilable(::Stripe::PaymentIntent::IncrementAuthorizationParams::TransferData)).void
}
def initialize(
amount: nil,
amount_details: nil,
application_fee_amount: nil,
description: nil,
expand: nil,
hooks: nil,
metadata: nil,
payment_details: nil,
payment_method_options: nil,
statement_descriptor: nil,
transfer_data: nil
); end
end
class VerifyMicrodepositsParams < Stripe::RequestParams
# Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.
sig { returns(T.nilable(T::Array[Integer])) }
def amounts; end
sig { params(_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer])) }
def amounts=(_amounts); end
# A six-character code starting with SM present in the microdeposit sent to the bank account.
sig { returns(T.nilable(String)) }
def descriptor_code; end
sig { params(_descriptor_code: T.nilable(String)).returns(T.nilable(String)) }
def descriptor_code=(_descriptor_code); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(amounts: T.nilable(T::Array[Integer]), descriptor_code: T.nilable(String), expand: T.nilable(T::Array[String])).void
}
def initialize(amounts: nil, descriptor_code: nil, expand: nil); end
end
class TriggerActionParams < Stripe::RequestParams
class ScanQrCode < Stripe::RequestParams
# Whether the QR Code scan's payment should succeed or fail.
sig { returns(T.nilable(String)) }
def result; end
sig { params(_result: T.nilable(String)).returns(T.nilable(String)) }
def result=(_result); end
sig { params(result: T.nilable(String)).void }
def initialize(result: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# True to simulate success, false to simulate failure.
sig { returns(T.nilable(::Stripe::PaymentIntent::TriggerActionParams::ScanQrCode)) }
def scan_qr_code; end
sig {
params(_scan_qr_code: T.nilable(::Stripe::PaymentIntent::TriggerActionParams::ScanQrCode)).returns(T.nilable(::Stripe::PaymentIntent::TriggerActionParams::ScanQrCode))
}
def scan_qr_code=(_scan_qr_code); end
# The type of action to be simulated.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(expand: T.nilable(T::Array[String]), scan_qr_code: T.nilable(::Stripe::PaymentIntent::TriggerActionParams::ScanQrCode), type: String).void
}
def initialize(expand: nil, scan_qr_code: nil, type: nil); end
end
# Manually reconcile the remaining amount for a customer_balance PaymentIntent.
sig {
params(params: T.any(::Stripe::PaymentIntent::ApplyCustomerBalanceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def apply_customer_balance(params = {}, opts = {}); end
# Manually reconcile the remaining amount for a customer_balance PaymentIntent.
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntent::ApplyCustomerBalanceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def self.apply_customer_balance(intent, params = {}, opts = {}); end
# You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://docs.stripe.com/docs/payments/intents), processing.
#
# After it's canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.
#
# You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead.
sig {
params(params: T.any(::Stripe::PaymentIntent::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def cancel(params = {}, opts = {}); end
# You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://docs.stripe.com/docs/payments/intents), processing.
#
# After it's canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.
#
# You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead.
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntent::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def self.cancel(intent, params = {}, opts = {}); end
# Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.
#
# Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.
#
# Learn more about [separate authorization and capture](https://docs.stripe.com/docs/payments/capture-later).
sig {
params(params: T.any(::Stripe::PaymentIntent::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def capture(params = {}, opts = {}); end
# Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.
#
# Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.
#
# Learn more about [separate authorization and capture](https://docs.stripe.com/docs/payments/capture-later).
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntent::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def self.capture(intent, params = {}, opts = {}); end
# Confirm that your customer intends to pay with current or provided
# payment method. Upon confirmation, the PaymentIntent will attempt to initiate
# a payment.
#
# If the selected payment method requires additional authentication steps, the
# PaymentIntent will transition to the requires_action status and
# suggest additional actions via next_action. If payment fails,
# the PaymentIntent transitions to the requires_payment_method status or the
# canceled status if the confirmation limit is reached. If
# payment succeeds, the PaymentIntent will transition to the succeeded
# status (or requires_capture, if capture_method is set to manual).
#
# If the confirmation_method is automatic, payment may be attempted
# using our [client SDKs](https://docs.stripe.com/docs/stripe-js/reference#stripe-handle-card-payment)
# and the PaymentIntent's [client_secret](https://docs.stripe.com/api#payment_intent_object-client_secret).
# After next_actions are handled by the client, no additional
# confirmation is required to complete the payment.
#
# If the confirmation_method is manual, all payment attempts must be
# initiated using a secret key.
#
# If any actions are required for the payment, the PaymentIntent will
# return to the requires_confirmation state
# after those actions are completed. Your server needs to then
# explicitly re-confirm the PaymentIntent to initiate the next payment
# attempt.
#
# There is a variable upper limit on how many times a PaymentIntent can be confirmed.
# After this limit is reached, any further calls to this endpoint will
# transition the PaymentIntent to the canceled state.
sig {
params(params: T.any(::Stripe::PaymentIntent::ConfirmParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def confirm(params = {}, opts = {}); end
# Confirm that your customer intends to pay with current or provided
# payment method. Upon confirmation, the PaymentIntent will attempt to initiate
# a payment.
#
# If the selected payment method requires additional authentication steps, the
# PaymentIntent will transition to the requires_action status and
# suggest additional actions via next_action. If payment fails,
# the PaymentIntent transitions to the requires_payment_method status or the
# canceled status if the confirmation limit is reached. If
# payment succeeds, the PaymentIntent will transition to the succeeded
# status (or requires_capture, if capture_method is set to manual).
#
# If the confirmation_method is automatic, payment may be attempted
# using our [client SDKs](https://docs.stripe.com/docs/stripe-js/reference#stripe-handle-card-payment)
# and the PaymentIntent's [client_secret](https://docs.stripe.com/api#payment_intent_object-client_secret).
# After next_actions are handled by the client, no additional
# confirmation is required to complete the payment.
#
# If the confirmation_method is manual, all payment attempts must be
# initiated using a secret key.
#
# If any actions are required for the payment, the PaymentIntent will
# return to the requires_confirmation state
# after those actions are completed. Your server needs to then
# explicitly re-confirm the PaymentIntent to initiate the next payment
# attempt.
#
# There is a variable upper limit on how many times a PaymentIntent can be confirmed.
# After this limit is reached, any further calls to this endpoint will
# transition the PaymentIntent to the canceled state.
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntent::ConfirmParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def self.confirm(intent, params = {}, opts = {}); end
# Creates a PaymentIntent object.
#
# After the PaymentIntent is created, attach a payment method and [confirm](https://docs.stripe.com/docs/api/payment_intents/confirm)
# to continue the payment. Learn more about the available payment flows
# with the Payment Intents API.
#
# When you use confirm=true during creation, it's equivalent to creating
# and confirming the PaymentIntent in the same call. You can use any parameters
# available in the [confirm API](https://docs.stripe.com/docs/api/payment_intents/confirm) when you supply
# confirm=true.
sig {
params(params: T.any(::Stripe::PaymentIntent::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def self.create(params = {}, opts = {}); end
# Perform a decremental authorization on an eligible
# [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the
# PaymentIntent's status must be requires_capture and
# [decremental_authorization.status](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization)
# must be available.
#
# Decremental authorizations decrease the authorized amount on your customer's card
# to the new, lower amount provided. A single PaymentIntent can call this endpoint multiple times to further decrease the authorized amount.
#
# After decrement, the PaymentIntent object
# returns with the updated
# [amount](https://docs.stripe.com/docs/api/payment_intents/object#payment_intent_object-amount).
# The PaymentIntent will now be capturable up to the new authorized amount.
#
# Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines.
# After it's fully captured, a PaymentIntent can no longer be decremented.
sig {
params(params: T.any(::Stripe::PaymentIntent::DecrementAuthorizationParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def decrement_authorization(params = {}, opts = {}); end
# Perform a decremental authorization on an eligible
# [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the
# PaymentIntent's status must be requires_capture and
# [decremental_authorization.status](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization)
# must be available.
#
# Decremental authorizations decrease the authorized amount on your customer's card
# to the new, lower amount provided. A single PaymentIntent can call this endpoint multiple times to further decrease the authorized amount.
#
# After decrement, the PaymentIntent object
# returns with the updated
# [amount](https://docs.stripe.com/docs/api/payment_intents/object#payment_intent_object-amount).
# The PaymentIntent will now be capturable up to the new authorized amount.
#
# Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines.
# After it's fully captured, a PaymentIntent can no longer be decremented.
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntent::DecrementAuthorizationParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def self.decrement_authorization(intent, params = {}, opts = {}); end
# Perform an incremental authorization on an eligible
# [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the
# PaymentIntent's status must be requires_capture and
# [incremental_authorization_supported](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported)
# must be true.
#
# Incremental authorizations attempt to increase the authorized amount on
# your customer's card to the new, higher amount provided. Similar to the
# initial authorization, incremental authorizations can be declined. A
# single PaymentIntent can call this endpoint multiple times to further
# increase the authorized amount.
#
# If the incremental authorization succeeds, the PaymentIntent object
# returns with the updated
# [amount](https://docs.stripe.com/docs/api/payment_intents/object#payment_intent_object-amount).
# If the incremental authorization fails, a
# [card_declined](https://docs.stripe.com/docs/error-codes#card-declined) error returns, and no other
# fields on the PaymentIntent or Charge update. The PaymentIntent
# object remains capturable for the previously authorized amount.
#
# Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.
# After it's captured, a PaymentIntent can no longer be incremented.
#
# Learn more about [incremental authorizations](https://docs.stripe.com/docs/terminal/features/incremental-authorizations).
sig {
params(params: T.any(::Stripe::PaymentIntent::IncrementAuthorizationParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def increment_authorization(params = {}, opts = {}); end
# Perform an incremental authorization on an eligible
# [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the
# PaymentIntent's status must be requires_capture and
# [incremental_authorization_supported](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported)
# must be true.
#
# Incremental authorizations attempt to increase the authorized amount on
# your customer's card to the new, higher amount provided. Similar to the
# initial authorization, incremental authorizations can be declined. A
# single PaymentIntent can call this endpoint multiple times to further
# increase the authorized amount.
#
# If the incremental authorization succeeds, the PaymentIntent object
# returns with the updated
# [amount](https://docs.stripe.com/docs/api/payment_intents/object#payment_intent_object-amount).
# If the incremental authorization fails, a
# [card_declined](https://docs.stripe.com/docs/error-codes#card-declined) error returns, and no other
# fields on the PaymentIntent or Charge update. The PaymentIntent
# object remains capturable for the previously authorized amount.
#
# Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.
# After it's captured, a PaymentIntent can no longer be incremented.
#
# Learn more about [incremental authorizations](https://docs.stripe.com/docs/terminal/features/incremental-authorizations).
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntent::IncrementAuthorizationParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def self.increment_authorization(intent, params = {}, opts = {}); end
# Returns a list of PaymentIntents.
sig {
params(params: T.any(::Stripe::PaymentIntent::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
sig {
params(params: T.any(::Stripe::PaymentIntent::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
}
def self.search(params = {}, opts = {}); end
sig {
params(params: T.any(::Stripe::PaymentIntent::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, blk: T.untyped).returns(Stripe::SearchResultObject)
}
def self.search_auto_paging_each(params = {}, opts = {}, &blk); end
# Trigger an external action on a PaymentIntent.
sig {
params(params: T.any(::Stripe::PaymentIntent::TriggerActionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def trigger_action(params = {}, opts = {}); end
# Trigger an external action on a PaymentIntent.
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntent::TriggerActionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def self.trigger_action(intent, params = {}, opts = {}); end
# Updates properties on a PaymentIntent object without confirming.
#
# Depending on which properties you update, you might need to confirm the
# PaymentIntent again. For example, updating the payment_method
# always requires you to confirm the PaymentIntent again. If you prefer to
# update and confirm at the same time, we recommend updating properties through
# the [confirm API](https://docs.stripe.com/docs/api/payment_intents/confirm) instead.
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntent::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def self.update(intent, params = {}, opts = {}); end
# Verifies microdeposits on a PaymentIntent object.
sig {
params(params: T.any(::Stripe::PaymentIntent::VerifyMicrodepositsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def verify_microdeposits(params = {}, opts = {}); end
# Verifies microdeposits on a PaymentIntent object.
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntent::VerifyMicrodepositsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def self.verify_microdeposits(intent, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class PaymentIntentAmountDetailsLineItem < APIResource
class PaymentMethodOptions < Stripe::StripeObject
class Card < Stripe::StripeObject
# Attribute for field commodity_code
sig { returns(T.nilable(String)) }
def commodity_code; end
end
class CardPresent < Stripe::StripeObject
# Attribute for field commodity_code
sig { returns(T.nilable(String)) }
def commodity_code; end
end
class Klarna < Stripe::StripeObject
# Attribute for field image_url
sig { returns(T.nilable(String)) }
def image_url; end
# Attribute for field product_url
sig { returns(T.nilable(String)) }
def product_url; end
end
class Paypal < Stripe::StripeObject
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
# The Stripe account ID of the connected account that sells the item. This is only needed when using [Separate Charges and Transfers](https://docs.stripe.com/connect/separate-charges-and-transfers).
sig { returns(T.nilable(String)) }
def sold_by; end
end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# Attribute for field card_present
sig { returns(T.nilable(CardPresent)) }
def card_present; end
# Attribute for field klarna
sig { returns(T.nilable(Klarna)) }
def klarna; end
# Attribute for field paypal
sig { returns(T.nilable(Paypal)) }
def paypal; end
end
class Tax < Stripe::StripeObject
# Total portion of the amount that is for tax.
sig { returns(Integer) }
def total_tax_amount; end
end
# The amount an item was discounted for. Positive integer.
sig { returns(T.nilable(Integer)) }
def discount_amount; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Payment method-specific information for line items.
sig { returns(T.nilable(PaymentMethodOptions)) }
def payment_method_options; end
# Unique identifier of the product. At most 12 characters long.
sig { returns(T.nilable(String)) }
def product_code; end
# Name of the product. At most 100 characters long.
sig { returns(String) }
def product_name; end
# Number of items of the product. Positive integer.
sig { returns(Integer) }
def quantity; end
# Contains information about the tax on the item.
sig { returns(T.nilable(Tax)) }
def tax; end
# Cost of the product. Non-negative integer.
sig { returns(Integer) }
def unit_cost; end
# A unit of measure for the line item, such as gallons, feet, meters, etc.
sig { returns(T.nilable(String)) }
def unit_of_measure; end
end
end
# typed: 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/payment-links)
class PaymentLink < APIResource
class AfterCompletion < Stripe::StripeObject
class HostedConfirmation < Stripe::StripeObject
# The custom message that is displayed to the customer after the purchase is complete.
sig { returns(T.nilable(String)) }
def custom_message; end
end
class Redirect < Stripe::StripeObject
# The URL the customer will be redirected to after the purchase is complete.
sig { returns(String) }
def url; end
end
# Attribute for field hosted_confirmation
sig { returns(T.nilable(HostedConfirmation)) }
def hosted_confirmation; end
# Attribute for field redirect
sig { returns(T.nilable(Redirect)) }
def redirect; end
# The specified behavior after the purchase is complete.
sig { returns(String) }
def type; end
end
class AutomaticTax < Stripe::StripeObject
class Liability < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# If `true`, tax will be calculated automatically using the customer's location.
sig { returns(T::Boolean) }
def enabled; end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(Liability)) }
def liability; end
end
class ConsentCollection < Stripe::StripeObject
class PaymentMethodReuseAgreement < Stripe::StripeObject
# Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.
#
# When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
sig { returns(String) }
def position; end
end
# Settings related to the payment method reuse text shown in the Checkout UI.
sig { returns(T.nilable(PaymentMethodReuseAgreement)) }
def payment_method_reuse_agreement; end
# If set to `auto`, enables the collection of customer consent for promotional communications.
sig { returns(T.nilable(String)) }
def promotions; end
# If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service.
sig { returns(T.nilable(String)) }
def terms_of_service; end
end
class CustomField < Stripe::StripeObject
class Dropdown < Stripe::StripeObject
class Option < Stripe::StripeObject
# The label for the option, displayed to the customer. Up to 100 characters.
sig { returns(String) }
def label; end
# The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
sig { returns(String) }
def value; end
end
# The value that will pre-fill on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
# The options available for the customer to select. Up to 200 options allowed.
sig { returns(T::Array[Option]) }
def options; end
end
class Label < Stripe::StripeObject
# Custom text for the label, displayed to the customer. Up to 50 characters.
sig { returns(T.nilable(String)) }
def custom; end
# The type of the label.
sig { returns(String) }
def type; end
end
class Numeric < Stripe::StripeObject
# The value that will pre-fill the field on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
# The maximum character length constraint for the customer's input.
sig { returns(T.nilable(Integer)) }
def maximum_length; end
# The minimum character length requirement for the customer's input.
sig { returns(T.nilable(Integer)) }
def minimum_length; end
end
class Text < Stripe::StripeObject
# The value that will pre-fill the field on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
# The maximum character length constraint for the customer's input.
sig { returns(T.nilable(Integer)) }
def maximum_length; end
# The minimum character length requirement for the customer's input.
sig { returns(T.nilable(Integer)) }
def minimum_length; end
end
# Attribute for field dropdown
sig { returns(T.nilable(Dropdown)) }
def dropdown; end
# String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
sig { returns(String) }
def key; end
# Attribute for field label
sig { returns(Label) }
def label; end
# Attribute for field numeric
sig { returns(T.nilable(Numeric)) }
def numeric; end
# Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
sig { returns(T::Boolean) }
def optional; end
# Attribute for field text
sig { returns(T.nilable(Text)) }
def text; end
# The type of the field.
sig { returns(String) }
def type; end
end
class CustomText < Stripe::StripeObject
class AfterSubmit < Stripe::StripeObject
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
end
class ShippingAddress < Stripe::StripeObject
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
end
class Submit < Stripe::StripeObject
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
end
class TermsOfServiceAcceptance < Stripe::StripeObject
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
end
# Custom text that should be displayed after the payment confirmation button.
sig { returns(T.nilable(AfterSubmit)) }
def after_submit; end
# Custom text that should be displayed alongside shipping address collection.
sig { returns(T.nilable(ShippingAddress)) }
def shipping_address; end
# Custom text that should be displayed alongside the payment confirmation button.
sig { returns(T.nilable(Submit)) }
def submit; end
# Custom text that should be displayed in place of the default terms of service agreement text.
sig { returns(T.nilable(TermsOfServiceAcceptance)) }
def terms_of_service_acceptance; end
end
class InvoiceCreation < Stripe::StripeObject
class InvoiceData < Stripe::StripeObject
class CustomField < Stripe::StripeObject
# The name of the custom field.
sig { returns(String) }
def name; end
# The value of the custom field.
sig { returns(String) }
def value; end
end
class Issuer < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
class RenderingOptions < Stripe::StripeObject
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
sig { returns(T.nilable(String)) }
def amount_tax_display; end
# ID of the invoice rendering template to be used for the generated invoice.
sig { returns(T.nilable(String)) }
def template; end
end
# The account tax IDs associated with the invoice.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
def account_tax_ids; end
# A list of up to 4 custom fields to be displayed on the invoice.
sig { returns(T.nilable(T::Array[CustomField])) }
def custom_fields; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# Footer to be displayed on the invoice.
sig { returns(T.nilable(String)) }
def footer; end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig { returns(T.nilable(Issuer)) }
def issuer; end
# 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])) }
def metadata; end
# Options for invoice PDF rendering.
sig { returns(T.nilable(RenderingOptions)) }
def rendering_options; end
end
# Enable creating an invoice on successful payment.
sig { returns(T::Boolean) }
def enabled; end
# Configuration for the invoice. Default invoice values will be used if unspecified.
sig { returns(T.nilable(InvoiceData)) }
def invoice_data; end
end
class OptionalItem < Stripe::StripeObject
class AdjustableQuantity < Stripe::StripeObject
# Set to true if the quantity can be adjusted to any non-negative integer.
sig { returns(T::Boolean) }
def enabled; end
# The maximum quantity of this item the customer can purchase. By default this value is 99.
sig { returns(T.nilable(Integer)) }
def maximum; end
# The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.
sig { returns(T.nilable(Integer)) }
def minimum; end
end
# Attribute for field adjustable_quantity
sig { returns(T.nilable(AdjustableQuantity)) }
def adjustable_quantity; end
# Attribute for field price
sig { returns(String) }
def price; end
# Attribute for field quantity
sig { returns(Integer) }
def quantity; end
end
class PaymentIntentData < Stripe::StripeObject
# Indicates when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link.
sig { returns(T::Hash[String, String]) }
def metadata; end
# Indicates that you intend to make future payments with the payment method collected during checkout.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
# For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
# For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
# A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
sig { returns(T.nilable(String)) }
def transfer_group; end
end
class PhoneNumberCollection < Stripe::StripeObject
# If `true`, a phone number will be collected during checkout.
sig { returns(T::Boolean) }
def enabled; end
end
class Restrictions < Stripe::StripeObject
class CompletedSessions < Stripe::StripeObject
# The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met.
sig { returns(Integer) }
def count; end
# The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.
sig { returns(Integer) }
def limit; end
end
# Attribute for field completed_sessions
sig { returns(CompletedSessions) }
def completed_sessions; end
end
class ShippingAddressCollection < Stripe::StripeObject
# An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.
sig { returns(T::Array[String]) }
def allowed_countries; end
end
class ShippingOption < Stripe::StripeObject
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def shipping_amount; end
# The ID of the Shipping Rate to use for this shipping option.
sig { returns(T.any(String, Stripe::ShippingRate)) }
def shipping_rate; end
end
class SubscriptionData < Stripe::StripeObject
class InvoiceSettings < Stripe::StripeObject
class Issuer < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# Attribute for field issuer
sig { returns(Issuer) }
def issuer; end
end
class TrialSettings < Stripe::StripeObject
class EndBehavior < Stripe::StripeObject
# Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
sig { returns(String) }
def missing_payment_method; end
end
# Defines how a subscription behaves when a free trial ends.
sig { returns(EndBehavior) }
def end_behavior; end
end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
# Attribute for field invoice_settings
sig { returns(InvoiceSettings) }
def invoice_settings; end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link.
sig { returns(T::Hash[String, String]) }
def metadata; end
# Integer representing the number of trial period days before the customer is charged for the first time.
sig { returns(T.nilable(Integer)) }
def trial_period_days; end
# Settings related to subscription trials.
sig { returns(T.nilable(TrialSettings)) }
def trial_settings; end
end
class TaxIdCollection < Stripe::StripeObject
# Indicates whether tax ID collection is enabled for the session.
sig { returns(T::Boolean) }
def enabled; end
# Attribute for field required
sig { returns(String) }
def required; end
end
class TransferData < Stripe::StripeObject
# The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Integer)) }
def amount; end
# The connected account receiving the transfer.
sig { returns(T.any(String, Stripe::Account)) }
def destination; end
end
# Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.
sig { returns(T::Boolean) }
def active; end
# Attribute for field after_completion
sig { returns(AfterCompletion) }
def after_completion; end
# Whether user redeemable promotion codes are enabled.
sig { returns(T::Boolean) }
def allow_promotion_codes; end
# The ID of the Connect application that created the Payment Link.
sig { returns(T.nilable(T.any(String, Stripe::Application))) }
def application; end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
# This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
# Attribute for field automatic_tax
sig { returns(AutomaticTax) }
def automatic_tax; end
# Configuration for collecting the customer's billing address. Defaults to `auto`.
sig { returns(String) }
def billing_address_collection; end
# When set, provides configuration to gather active consent from customers.
sig { returns(T.nilable(ConsentCollection)) }
def consent_collection; end
# 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) }
def currency; end
# Collect additional information from your customer using custom fields. Up to 3 fields are supported.
sig { returns(T::Array[CustomField]) }
def custom_fields; end
# Attribute for field custom_text
sig { returns(CustomText) }
def custom_text; end
# Configuration for Customer creation during checkout.
sig { returns(String) }
def customer_creation; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The custom message to be displayed to a customer when a payment link is no longer active.
sig { returns(T.nilable(String)) }
def inactive_message; end
# Configuration for creating invoice for payment mode payment links.
sig { returns(T.nilable(InvoiceCreation)) }
def invoice_creation; end
# The line items representing what is being sold.
sig { returns(T.nilable(Stripe::ListObject)) }
def line_items; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def on_behalf_of; end
# The optional items presented to the customer at checkout.
sig { returns(T.nilable(T::Array[OptionalItem])) }
def optional_items; end
# Indicates the parameters to be passed to PaymentIntent creation during checkout.
sig { returns(T.nilable(PaymentIntentData)) }
def payment_intent_data; end
# Configuration for collecting a payment method during checkout. Defaults to `always`.
sig { returns(String) }
def payment_method_collection; end
# The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
# Attribute for field phone_number_collection
sig { returns(PhoneNumberCollection) }
def phone_number_collection; end
# Settings that restrict the usage of a payment link.
sig { returns(T.nilable(Restrictions)) }
def restrictions; end
# Configuration for collecting the customer's shipping address.
sig { returns(T.nilable(ShippingAddressCollection)) }
def shipping_address_collection; end
# The shipping rate options applied to the session.
sig { returns(T::Array[ShippingOption]) }
def shipping_options; end
# Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
sig { returns(String) }
def submit_type; end
# When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
sig { returns(T.nilable(SubscriptionData)) }
def subscription_data; end
# Attribute for field tax_id_collection
sig { returns(TaxIdCollection) }
def tax_id_collection; end
# The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
sig { returns(T.nilable(TransferData)) }
def transfer_data; end
# The public URL that can be shared with customers.
sig { returns(String) }
def url; end
class ListParams < Stripe::RequestParams
# Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links).
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(active: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
active: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class AfterCompletion < Stripe::RequestParams
class HostedConfirmation < Stripe::RequestParams
# A custom message to display to the customer after the purchase is complete.
sig { returns(T.nilable(String)) }
def custom_message; end
sig { params(_custom_message: T.nilable(String)).returns(T.nilable(String)) }
def custom_message=(_custom_message); end
sig { params(custom_message: T.nilable(String)).void }
def initialize(custom_message: nil); end
end
class Redirect < Stripe::RequestParams
# The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-id) included.
sig { returns(String) }
def url; end
sig { params(_url: String).returns(String) }
def url=(_url); end
sig { params(url: String).void }
def initialize(url: nil); end
end
# Configuration when `type=hosted_confirmation`.
sig {
returns(T.nilable(::Stripe::PaymentLink::CreateParams::AfterCompletion::HostedConfirmation))
}
def hosted_confirmation; end
sig {
params(_hosted_confirmation: T.nilable(::Stripe::PaymentLink::CreateParams::AfterCompletion::HostedConfirmation)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::AfterCompletion::HostedConfirmation))
}
def hosted_confirmation=(_hosted_confirmation); end
# Configuration when `type=redirect`.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::AfterCompletion::Redirect)) }
def redirect; end
sig {
params(_redirect: T.nilable(::Stripe::PaymentLink::CreateParams::AfterCompletion::Redirect)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::AfterCompletion::Redirect))
}
def redirect=(_redirect); end
# The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(hosted_confirmation: T.nilable(::Stripe::PaymentLink::CreateParams::AfterCompletion::HostedConfirmation), redirect: T.nilable(::Stripe::PaymentLink::CreateParams::AfterCompletion::Redirect), type: String).void
}
def initialize(hosted_confirmation: nil, redirect: nil, type: nil); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
#
# Enabling this parameter causes the payment link to collect any billing address information necessary for tax calculation.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::AutomaticTax::Liability)) }
def liability; end
sig {
params(_liability: T.nilable(::Stripe::PaymentLink::CreateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::PaymentLink::CreateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class ConsentCollection < Stripe::RequestParams
class PaymentMethodReuseAgreement < Stripe::RequestParams
# Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's
# defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
sig { returns(String) }
def position; end
sig { params(_position: String).returns(String) }
def position=(_position); end
sig { params(position: String).void }
def initialize(position: nil); end
end
# Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.
sig {
returns(T.nilable(::Stripe::PaymentLink::CreateParams::ConsentCollection::PaymentMethodReuseAgreement))
}
def payment_method_reuse_agreement; end
sig {
params(_payment_method_reuse_agreement: T.nilable(::Stripe::PaymentLink::CreateParams::ConsentCollection::PaymentMethodReuseAgreement)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::ConsentCollection::PaymentMethodReuseAgreement))
}
def payment_method_reuse_agreement=(_payment_method_reuse_agreement); end
# If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
# Session will determine whether to display an option to opt into promotional communication
# from the merchant depending on the customer's locale. Only available to US merchants.
sig { returns(T.nilable(String)) }
def promotions; end
sig { params(_promotions: T.nilable(String)).returns(T.nilable(String)) }
def promotions=(_promotions); end
# If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
# There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
sig { returns(T.nilable(String)) }
def terms_of_service; end
sig { params(_terms_of_service: T.nilable(String)).returns(T.nilable(String)) }
def terms_of_service=(_terms_of_service); end
sig {
params(payment_method_reuse_agreement: T.nilable(::Stripe::PaymentLink::CreateParams::ConsentCollection::PaymentMethodReuseAgreement), promotions: T.nilable(String), terms_of_service: T.nilable(String)).void
}
def initialize(
payment_method_reuse_agreement: nil,
promotions: nil,
terms_of_service: nil
); end
end
class CustomField < Stripe::RequestParams
class Dropdown < Stripe::RequestParams
class Option < Stripe::RequestParams
# The label for the option, displayed to the customer. Up to 100 characters.
sig { returns(String) }
def label; end
sig { params(_label: String).returns(String) }
def label=(_label); end
# The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(label: String, value: String).void }
def initialize(label: nil, value: nil); end
end
# The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The options available for the customer to select. Up to 200 options allowed.
sig {
returns(T::Array[::Stripe::PaymentLink::CreateParams::CustomField::Dropdown::Option])
}
def options; end
sig {
params(_options: T::Array[::Stripe::PaymentLink::CreateParams::CustomField::Dropdown::Option]).returns(T::Array[::Stripe::PaymentLink::CreateParams::CustomField::Dropdown::Option])
}
def options=(_options); end
sig {
params(default_value: T.nilable(String), options: T::Array[::Stripe::PaymentLink::CreateParams::CustomField::Dropdown::Option]).void
}
def initialize(default_value: nil, options: nil); end
end
class Label < Stripe::RequestParams
# Custom text for the label, displayed to the customer. Up to 50 characters.
sig { returns(String) }
def custom; end
sig { params(_custom: String).returns(String) }
def custom=(_custom); end
# The type of the label.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(custom: String, type: String).void }
def initialize(custom: nil, type: nil); end
end
class Numeric < Stripe::RequestParams
# The value that will pre-fill the field on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The maximum character length constraint for the customer's input.
sig { returns(T.nilable(Integer)) }
def maximum_length; end
sig { params(_maximum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_length=(_maximum_length); end
# The minimum character length requirement for the customer's input.
sig { returns(T.nilable(Integer)) }
def minimum_length; end
sig { params(_minimum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_length=(_minimum_length); end
sig {
params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
}
def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
end
class Text < Stripe::RequestParams
# The value that will pre-fill the field on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The maximum character length constraint for the customer's input.
sig { returns(T.nilable(Integer)) }
def maximum_length; end
sig { params(_maximum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_length=(_maximum_length); end
# The minimum character length requirement for the customer's input.
sig { returns(T.nilable(Integer)) }
def minimum_length; end
sig { params(_minimum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_length=(_minimum_length); end
sig {
params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
}
def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
end
# Configuration for `type=dropdown` fields.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::CustomField::Dropdown)) }
def dropdown; end
sig {
params(_dropdown: T.nilable(::Stripe::PaymentLink::CreateParams::CustomField::Dropdown)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::CustomField::Dropdown))
}
def dropdown=(_dropdown); end
# String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
sig { returns(String) }
def key; end
sig { params(_key: String).returns(String) }
def key=(_key); end
# The label for the field, displayed to the customer.
sig { returns(::Stripe::PaymentLink::CreateParams::CustomField::Label) }
def label; end
sig {
params(_label: ::Stripe::PaymentLink::CreateParams::CustomField::Label).returns(::Stripe::PaymentLink::CreateParams::CustomField::Label)
}
def label=(_label); end
# Configuration for `type=numeric` fields.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::CustomField::Numeric)) }
def numeric; end
sig {
params(_numeric: T.nilable(::Stripe::PaymentLink::CreateParams::CustomField::Numeric)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::CustomField::Numeric))
}
def numeric=(_numeric); end
# Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def optional; end
sig { params(_optional: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def optional=(_optional); end
# Configuration for `type=text` fields.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::CustomField::Text)) }
def text; end
sig {
params(_text: T.nilable(::Stripe::PaymentLink::CreateParams::CustomField::Text)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::CustomField::Text))
}
def text=(_text); end
# The type of the field.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(dropdown: T.nilable(::Stripe::PaymentLink::CreateParams::CustomField::Dropdown), key: String, label: ::Stripe::PaymentLink::CreateParams::CustomField::Label, numeric: T.nilable(::Stripe::PaymentLink::CreateParams::CustomField::Numeric), optional: T.nilable(T::Boolean), text: T.nilable(::Stripe::PaymentLink::CreateParams::CustomField::Text), type: String).void
}
def initialize(
dropdown: nil,
key: nil,
label: nil,
numeric: nil,
optional: nil,
text: nil,
type: nil
); end
end
class CustomText < Stripe::RequestParams
class AfterSubmit < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class ShippingAddress < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class Submit < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class TermsOfServiceAcceptance < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
# Custom text that should be displayed after the payment confirmation button.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::CustomText::AfterSubmit)))
}
def after_submit; end
sig {
params(_after_submit: T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::CustomText::AfterSubmit))).returns(T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::CustomText::AfterSubmit)))
}
def after_submit=(_after_submit); end
# Custom text that should be displayed alongside shipping address collection.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::CustomText::ShippingAddress)))
}
def shipping_address; end
sig {
params(_shipping_address: T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::CustomText::ShippingAddress))).returns(T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::CustomText::ShippingAddress)))
}
def shipping_address=(_shipping_address); end
# Custom text that should be displayed alongside the payment confirmation button.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::CustomText::Submit)))
}
def submit; end
sig {
params(_submit: T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::CustomText::Submit))).returns(T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::CustomText::Submit)))
}
def submit=(_submit); end
# Custom text that should be displayed in place of the default terms of service agreement text.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::CustomText::TermsOfServiceAcceptance)))
}
def terms_of_service_acceptance; end
sig {
params(_terms_of_service_acceptance: T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::CustomText::TermsOfServiceAcceptance))).returns(T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::CustomText::TermsOfServiceAcceptance)))
}
def terms_of_service_acceptance=(_terms_of_service_acceptance); end
sig {
params(after_submit: T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::CustomText::AfterSubmit)), shipping_address: T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::CustomText::ShippingAddress)), submit: T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::CustomText::Submit)), terms_of_service_acceptance: T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::CustomText::TermsOfServiceAcceptance))).void
}
def initialize(
after_submit: nil,
shipping_address: nil,
submit: nil,
terms_of_service_acceptance: nil
); end
end
class InvoiceCreation < Stripe::RequestParams
class InvoiceData < Stripe::RequestParams
class CustomField < Stripe::RequestParams
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The value of the custom field. This may be up to 140 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
class RenderingOptions < Stripe::RequestParams
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(T.any(String, String))) }
def amount_tax_display; end
sig {
params(_amount_tax_display: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def amount_tax_display=(_amount_tax_display); end
# ID of the invoice rendering template to use for this invoice.
sig { returns(T.nilable(String)) }
def template; end
sig { params(_template: T.nilable(String)).returns(T.nilable(String)) }
def template=(_template); end
sig {
params(amount_tax_display: T.nilable(T.any(String, String)), template: T.nilable(String)).void
}
def initialize(amount_tax_display: nil, template: nil); end
end
# The account tax IDs associated with the invoice.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# Default custom fields to be displayed on invoices for this customer.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentLink::CreateParams::InvoiceCreation::InvoiceData::CustomField])))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T.any(String, T::Array[::Stripe::PaymentLink::CreateParams::InvoiceCreation::InvoiceData::CustomField]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentLink::CreateParams::InvoiceCreation::InvoiceData::CustomField])))
}
def custom_fields=(_custom_fields); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Default footer to be displayed on invoices for this customer.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::PaymentLink::CreateParams::InvoiceCreation::InvoiceData::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::PaymentLink::CreateParams::InvoiceCreation::InvoiceData::Issuer)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::InvoiceCreation::InvoiceData::Issuer))
}
def issuer=(_issuer); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Default options for invoice PDF rendering for this customer.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)))
}
def rendering_options; end
sig {
params(_rendering_options: T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))).returns(T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)))
}
def rendering_options=(_rendering_options); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), custom_fields: T.nilable(T.any(String, T::Array[::Stripe::PaymentLink::CreateParams::InvoiceCreation::InvoiceData::CustomField])), description: T.nilable(String), footer: T.nilable(String), issuer: T.nilable(::Stripe::PaymentLink::CreateParams::InvoiceCreation::InvoiceData::Issuer), metadata: T.nilable(T.any(String, T::Hash[String, String])), rendering_options: T.nilable(T.any(String, ::Stripe::PaymentLink::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))).void
}
def initialize(
account_tax_ids: nil,
custom_fields: nil,
description: nil,
footer: nil,
issuer: nil,
metadata: nil,
rendering_options: nil
); end
end
# Whether the feature is enabled
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Invoice PDF configuration.
sig {
returns(T.nilable(::Stripe::PaymentLink::CreateParams::InvoiceCreation::InvoiceData))
}
def invoice_data; end
sig {
params(_invoice_data: T.nilable(::Stripe::PaymentLink::CreateParams::InvoiceCreation::InvoiceData)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::InvoiceCreation::InvoiceData))
}
def invoice_data=(_invoice_data); end
sig {
params(enabled: T::Boolean, invoice_data: T.nilable(::Stripe::PaymentLink::CreateParams::InvoiceCreation::InvoiceData)).void
}
def initialize(enabled: nil, invoice_data: nil); end
end
class LineItem < Stripe::RequestParams
class AdjustableQuantity < Stripe::RequestParams
# Set to true if the quantity can be adjusted to any non-negative Integer.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil); end
end
class PriceData < Stripe::RequestParams
class ProductData < Stripe::RequestParams
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T::Array[String])) }
def images; end
sig {
params(_images: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def images=(_images); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
sig {
params(description: T.nilable(String), images: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: String, tax_code: T.nilable(String), unit_label: T.nilable(String)).void
}
def initialize(
description: nil,
images: nil,
metadata: nil,
name: nil,
tax_code: nil,
unit_label: nil
); end
end
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
sig {
returns(T.nilable(::Stripe::PaymentLink::CreateParams::LineItem::PriceData::ProductData))
}
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::PaymentLink::CreateParams::LineItem::PriceData::ProductData)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::LineItem::PriceData::ProductData))
}
def product_data=(_product_data); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(T.nilable(::Stripe::PaymentLink::CreateParams::LineItem::PriceData::Recurring))
}
def recurring; end
sig {
params(_recurring: T.nilable(::Stripe::PaymentLink::CreateParams::LineItem::PriceData::Recurring)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::LineItem::PriceData::Recurring))
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: T.nilable(String), product_data: T.nilable(::Stripe::PaymentLink::CreateParams::LineItem::PriceData::ProductData), recurring: T.nilable(::Stripe::PaymentLink::CreateParams::LineItem::PriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
product_data: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
sig {
returns(T.nilable(::Stripe::PaymentLink::CreateParams::LineItem::AdjustableQuantity))
}
def adjustable_quantity; end
sig {
params(_adjustable_quantity: T.nilable(::Stripe::PaymentLink::CreateParams::LineItem::AdjustableQuantity)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::LineItem::AdjustableQuantity))
}
def adjustable_quantity=(_adjustable_quantity); end
# The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::LineItem::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::PaymentLink::CreateParams::LineItem::PriceData)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::LineItem::PriceData))
}
def price_data=(_price_data); end
# The quantity of the line item being purchased.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
sig {
params(adjustable_quantity: T.nilable(::Stripe::PaymentLink::CreateParams::LineItem::AdjustableQuantity), price: T.nilable(String), price_data: T.nilable(::Stripe::PaymentLink::CreateParams::LineItem::PriceData), quantity: Integer).void
}
def initialize(adjustable_quantity: nil, price: nil, price_data: nil, quantity: nil); end
end
class OptionalItem < Stripe::RequestParams
class AdjustableQuantity < Stripe::RequestParams
# Set to true if the quantity can be adjusted to any non-negative integer.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum quantity of this item the customer can purchase. By default this value is 99.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil); end
end
# When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.
sig {
returns(T.nilable(::Stripe::PaymentLink::CreateParams::OptionalItem::AdjustableQuantity))
}
def adjustable_quantity; end
sig {
params(_adjustable_quantity: T.nilable(::Stripe::PaymentLink::CreateParams::OptionalItem::AdjustableQuantity)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::OptionalItem::AdjustableQuantity))
}
def adjustable_quantity=(_adjustable_quantity); end
# The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# The initial quantity of the line item created when a customer chooses to add this optional item to their order.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
sig {
params(adjustable_quantity: T.nilable(::Stripe::PaymentLink::CreateParams::OptionalItem::AdjustableQuantity), price: String, quantity: Integer).void
}
def initialize(adjustable_quantity: nil, price: nil, quantity: nil); end
end
class PaymentIntentData < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session.
#
# When setting this to `on_session`, Checkout will show a notice to the customer that their payment details will be saved.
#
# When setting this to `off_session`, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.
#
# If a Customer has been provided or Checkout creates a new Customer,Checkout will attach the payment method to the Customer.
#
# If Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.
#
# When processing card payments, Checkout also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(capture_method: T.nilable(String), description: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), setup_future_usage: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_group: T.nilable(String)).void
}
def initialize(
capture_method: nil,
description: nil,
metadata: nil,
setup_future_usage: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_group: nil
); end
end
class PhoneNumberCollection < Stripe::RequestParams
# Set to `true` to enable phone number collection.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class Restrictions < Stripe::RequestParams
class CompletedSessions < Stripe::RequestParams
# The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.
sig { returns(Integer) }
def limit; end
sig { params(_limit: Integer).returns(Integer) }
def limit=(_limit); end
sig { params(limit: Integer).void }
def initialize(limit: nil); end
end
# Configuration for the `completed_sessions` restriction type.
sig { returns(::Stripe::PaymentLink::CreateParams::Restrictions::CompletedSessions) }
def completed_sessions; end
sig {
params(_completed_sessions: ::Stripe::PaymentLink::CreateParams::Restrictions::CompletedSessions).returns(::Stripe::PaymentLink::CreateParams::Restrictions::CompletedSessions)
}
def completed_sessions=(_completed_sessions); end
sig {
params(completed_sessions: ::Stripe::PaymentLink::CreateParams::Restrictions::CompletedSessions).void
}
def initialize(completed_sessions: nil); end
end
class ShippingAddressCollection < Stripe::RequestParams
# An array of two-letter ISO country codes representing which countries Checkout should provide as options for
# shipping locations.
sig { returns(T::Array[String]) }
def allowed_countries; end
sig { params(_allowed_countries: T::Array[String]).returns(T::Array[String]) }
def allowed_countries=(_allowed_countries); end
sig { params(allowed_countries: T::Array[String]).void }
def initialize(allowed_countries: nil); end
end
class ShippingOption < Stripe::RequestParams
# The ID of the Shipping Rate to use for this shipping option.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
sig { params(shipping_rate: T.nilable(String)).void }
def initialize(shipping_rate: nil); end
end
class SubscriptionData < Stripe::RequestParams
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::PaymentLink::CreateParams::SubscriptionData::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::PaymentLink::CreateParams::SubscriptionData::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::SubscriptionData::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(issuer: T.nilable(::Stripe::PaymentLink::CreateParams::SubscriptionData::InvoiceSettings::Issuer)).void
}
def initialize(issuer: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
sig { returns(String) }
def missing_payment_method; end
sig { params(_missing_payment_method: String).returns(String) }
def missing_payment_method=(_missing_payment_method); end
sig { params(missing_payment_method: String).void }
def initialize(missing_payment_method: nil); end
end
# Defines how the subscription should behave when the user's free trial ends.
sig {
returns(::Stripe::PaymentLink::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
}
def end_behavior; end
sig {
params(_end_behavior: ::Stripe::PaymentLink::CreateParams::SubscriptionData::TrialSettings::EndBehavior).returns(::Stripe::PaymentLink::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: ::Stripe::PaymentLink::CreateParams::SubscriptionData::TrialSettings::EndBehavior).void
}
def initialize(end_behavior: nil); end
end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::PaymentLink::CreateParams::SubscriptionData::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::PaymentLink::CreateParams::SubscriptionData::InvoiceSettings)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::SubscriptionData::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
sig { returns(T.nilable(Integer)) }
def trial_period_days; end
sig { params(_trial_period_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_period_days=(_trial_period_days); end
# Settings related to subscription trials.
sig {
returns(T.nilable(::Stripe::PaymentLink::CreateParams::SubscriptionData::TrialSettings))
}
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::PaymentLink::CreateParams::SubscriptionData::TrialSettings)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::SubscriptionData::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(description: T.nilable(String), invoice_settings: T.nilable(::Stripe::PaymentLink::CreateParams::SubscriptionData::InvoiceSettings), metadata: T.nilable(T::Hash[String, String]), trial_period_days: T.nilable(Integer), trial_settings: T.nilable(::Stripe::PaymentLink::CreateParams::SubscriptionData::TrialSettings)).void
}
def initialize(
description: nil,
invoice_settings: nil,
metadata: nil,
trial_period_days: nil,
trial_settings: nil
); end
end
class TaxIdCollection < Stripe::RequestParams
# Enable tax ID collection during checkout. Defaults to `false`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Describes whether a tax ID is required during checkout. Defaults to `never`.
sig { returns(T.nilable(String)) }
def required; end
sig { params(_required: T.nilable(String)).returns(T.nilable(String)) }
def required=(_required); end
sig { params(enabled: T::Boolean, required: T.nilable(String)).void }
def initialize(enabled: nil, required: nil); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# If specified, successful charges will be attributed to the destination
# account for tax reporting, and the funds from charges will be transferred
# to the destination account. The ID of the resulting transfer will be
# returned on the successful charge's `transfer` field.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# Behavior after the purchase is complete.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::AfterCompletion)) }
def after_completion; end
sig {
params(_after_completion: T.nilable(::Stripe::PaymentLink::CreateParams::AfterCompletion)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::AfterCompletion))
}
def after_completion=(_after_completion); end
# Enables user redeemable promotion codes.
sig { returns(T.nilable(T::Boolean)) }
def allow_promotion_codes; end
sig { params(_allow_promotion_codes: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def allow_promotion_codes=(_allow_promotion_codes); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Can only be applied when there are no line items with recurring prices.
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
sig { params(_application_fee_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def application_fee_percent=(_application_fee_percent); end
# Configuration for automatic tax collection.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::PaymentLink::CreateParams::AutomaticTax)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Configuration for collecting the customer's billing address. Defaults to `auto`.
sig { returns(T.nilable(String)) }
def billing_address_collection; end
sig { params(_billing_address_collection: T.nilable(String)).returns(T.nilable(String)) }
def billing_address_collection=(_billing_address_collection); end
# Configure fields to gather active consent from customers.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::ConsentCollection)) }
def consent_collection; end
sig {
params(_consent_collection: T.nilable(::Stripe::PaymentLink::CreateParams::ConsentCollection)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::ConsentCollection))
}
def consent_collection=(_consent_collection); end
# 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) and supported by each line item's price.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Collect additional information from your customer using custom fields. Up to 3 fields are supported.
sig { returns(T.nilable(T::Array[::Stripe::PaymentLink::CreateParams::CustomField])) }
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T::Array[::Stripe::PaymentLink::CreateParams::CustomField])).returns(T.nilable(T::Array[::Stripe::PaymentLink::CreateParams::CustomField]))
}
def custom_fields=(_custom_fields); end
# Display additional text for your customers using custom text.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::CustomText)) }
def custom_text; end
sig {
params(_custom_text: T.nilable(::Stripe::PaymentLink::CreateParams::CustomText)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::CustomText))
}
def custom_text=(_custom_text); end
# Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).
sig { returns(T.nilable(String)) }
def customer_creation; end
sig { params(_customer_creation: T.nilable(String)).returns(T.nilable(String)) }
def customer_creation=(_customer_creation); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The custom message to be displayed to a customer when a payment link is no longer active.
sig { returns(T.nilable(String)) }
def inactive_message; end
sig { params(_inactive_message: T.nilable(String)).returns(T.nilable(String)) }
def inactive_message=(_inactive_message); end
# Generate a post-purchase Invoice for one-time payments.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::InvoiceCreation)) }
def invoice_creation; end
sig {
params(_invoice_creation: T.nilable(::Stripe::PaymentLink::CreateParams::InvoiceCreation)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::InvoiceCreation))
}
def invoice_creation=(_invoice_creation); end
# The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
sig { returns(T::Array[::Stripe::PaymentLink::CreateParams::LineItem]) }
def line_items; end
sig {
params(_line_items: T::Array[::Stripe::PaymentLink::CreateParams::LineItem]).returns(T::Array[::Stripe::PaymentLink::CreateParams::LineItem])
}
def line_items=(_line_items); end
# 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The account on behalf of which to charge.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
# There is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items.
# There is a maximum of 20 combined line items and optional items.
sig { returns(T.nilable(T::Array[::Stripe::PaymentLink::CreateParams::OptionalItem])) }
def optional_items; end
sig {
params(_optional_items: T.nilable(T::Array[::Stripe::PaymentLink::CreateParams::OptionalItem])).returns(T.nilable(T::Array[::Stripe::PaymentLink::CreateParams::OptionalItem]))
}
def optional_items=(_optional_items); end
# A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::PaymentIntentData)) }
def payment_intent_data; end
sig {
params(_payment_intent_data: T.nilable(::Stripe::PaymentLink::CreateParams::PaymentIntentData)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::PaymentIntentData))
}
def payment_intent_data=(_payment_intent_data); end
# Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.
#
# Can only be set in `subscription` mode. Defaults to `always`.
#
# If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
sig { returns(T.nilable(String)) }
def payment_method_collection; end
sig { params(_payment_method_collection: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_collection=(_payment_method_collection); end
# The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
# Controls phone number collection settings during checkout.
#
# We recommend that you review your privacy policy and check with your legal contacts.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::PhoneNumberCollection)) }
def phone_number_collection; end
sig {
params(_phone_number_collection: T.nilable(::Stripe::PaymentLink::CreateParams::PhoneNumberCollection)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::PhoneNumberCollection))
}
def phone_number_collection=(_phone_number_collection); end
# Settings that restrict the usage of a payment link.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::Restrictions)) }
def restrictions; end
sig {
params(_restrictions: T.nilable(::Stripe::PaymentLink::CreateParams::Restrictions)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::Restrictions))
}
def restrictions=(_restrictions); end
# Configuration for collecting the customer's shipping address.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::ShippingAddressCollection)) }
def shipping_address_collection; end
sig {
params(_shipping_address_collection: T.nilable(::Stripe::PaymentLink::CreateParams::ShippingAddressCollection)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::ShippingAddressCollection))
}
def shipping_address_collection=(_shipping_address_collection); end
# The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
sig { returns(T.nilable(T::Array[::Stripe::PaymentLink::CreateParams::ShippingOption])) }
def shipping_options; end
sig {
params(_shipping_options: T.nilable(T::Array[::Stripe::PaymentLink::CreateParams::ShippingOption])).returns(T.nilable(T::Array[::Stripe::PaymentLink::CreateParams::ShippingOption]))
}
def shipping_options=(_shipping_options); end
# Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).
sig { returns(T.nilable(String)) }
def submit_type; end
sig { params(_submit_type: T.nilable(String)).returns(T.nilable(String)) }
def submit_type=(_submit_type); end
# When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::SubscriptionData)) }
def subscription_data; end
sig {
params(_subscription_data: T.nilable(::Stripe::PaymentLink::CreateParams::SubscriptionData)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::SubscriptionData))
}
def subscription_data=(_subscription_data); end
# Controls tax ID collection during checkout.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::TaxIdCollection)) }
def tax_id_collection; end
sig {
params(_tax_id_collection: T.nilable(::Stripe::PaymentLink::CreateParams::TaxIdCollection)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::TaxIdCollection))
}
def tax_id_collection=(_tax_id_collection); end
# The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
sig { returns(T.nilable(::Stripe::PaymentLink::CreateParams::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::PaymentLink::CreateParams::TransferData)).returns(T.nilable(::Stripe::PaymentLink::CreateParams::TransferData))
}
def transfer_data=(_transfer_data); end
sig {
params(after_completion: T.nilable(::Stripe::PaymentLink::CreateParams::AfterCompletion), allow_promotion_codes: T.nilable(T::Boolean), application_fee_amount: T.nilable(Integer), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::PaymentLink::CreateParams::AutomaticTax), billing_address_collection: T.nilable(String), consent_collection: T.nilable(::Stripe::PaymentLink::CreateParams::ConsentCollection), currency: T.nilable(String), custom_fields: T.nilable(T::Array[::Stripe::PaymentLink::CreateParams::CustomField]), custom_text: T.nilable(::Stripe::PaymentLink::CreateParams::CustomText), customer_creation: T.nilable(String), expand: T.nilable(T::Array[String]), inactive_message: T.nilable(String), invoice_creation: T.nilable(::Stripe::PaymentLink::CreateParams::InvoiceCreation), line_items: T::Array[::Stripe::PaymentLink::CreateParams::LineItem], metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), optional_items: T.nilable(T::Array[::Stripe::PaymentLink::CreateParams::OptionalItem]), payment_intent_data: T.nilable(::Stripe::PaymentLink::CreateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_types: T.nilable(T::Array[String]), phone_number_collection: T.nilable(::Stripe::PaymentLink::CreateParams::PhoneNumberCollection), restrictions: T.nilable(::Stripe::PaymentLink::CreateParams::Restrictions), shipping_address_collection: T.nilable(::Stripe::PaymentLink::CreateParams::ShippingAddressCollection), shipping_options: T.nilable(T::Array[::Stripe::PaymentLink::CreateParams::ShippingOption]), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::PaymentLink::CreateParams::SubscriptionData), tax_id_collection: T.nilable(::Stripe::PaymentLink::CreateParams::TaxIdCollection), transfer_data: T.nilable(::Stripe::PaymentLink::CreateParams::TransferData)).void
}
def initialize(
after_completion: nil,
allow_promotion_codes: nil,
application_fee_amount: nil,
application_fee_percent: nil,
automatic_tax: nil,
billing_address_collection: nil,
consent_collection: nil,
currency: nil,
custom_fields: nil,
custom_text: nil,
customer_creation: nil,
expand: nil,
inactive_message: nil,
invoice_creation: nil,
line_items: nil,
metadata: nil,
on_behalf_of: nil,
optional_items: nil,
payment_intent_data: nil,
payment_method_collection: nil,
payment_method_types: nil,
phone_number_collection: nil,
restrictions: nil,
shipping_address_collection: nil,
shipping_options: nil,
submit_type: nil,
subscription_data: nil,
tax_id_collection: nil,
transfer_data: nil
); end
end
class UpdateParams < Stripe::RequestParams
class AfterCompletion < Stripe::RequestParams
class HostedConfirmation < Stripe::RequestParams
# A custom message to display to the customer after the purchase is complete.
sig { returns(T.nilable(String)) }
def custom_message; end
sig { params(_custom_message: T.nilable(String)).returns(T.nilable(String)) }
def custom_message=(_custom_message); end
sig { params(custom_message: T.nilable(String)).void }
def initialize(custom_message: nil); end
end
class Redirect < Stripe::RequestParams
# The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-id) included.
sig { returns(String) }
def url; end
sig { params(_url: String).returns(String) }
def url=(_url); end
sig { params(url: String).void }
def initialize(url: nil); end
end
# Configuration when `type=hosted_confirmation`.
sig {
returns(T.nilable(::Stripe::PaymentLink::UpdateParams::AfterCompletion::HostedConfirmation))
}
def hosted_confirmation; end
sig {
params(_hosted_confirmation: T.nilable(::Stripe::PaymentLink::UpdateParams::AfterCompletion::HostedConfirmation)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::AfterCompletion::HostedConfirmation))
}
def hosted_confirmation=(_hosted_confirmation); end
# Configuration when `type=redirect`.
sig { returns(T.nilable(::Stripe::PaymentLink::UpdateParams::AfterCompletion::Redirect)) }
def redirect; end
sig {
params(_redirect: T.nilable(::Stripe::PaymentLink::UpdateParams::AfterCompletion::Redirect)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::AfterCompletion::Redirect))
}
def redirect=(_redirect); end
# The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(hosted_confirmation: T.nilable(::Stripe::PaymentLink::UpdateParams::AfterCompletion::HostedConfirmation), redirect: T.nilable(::Stripe::PaymentLink::UpdateParams::AfterCompletion::Redirect), type: String).void
}
def initialize(hosted_confirmation: nil, redirect: nil, type: nil); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
#
# Enabling this parameter causes the payment link to collect any billing address information necessary for tax calculation.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(::Stripe::PaymentLink::UpdateParams::AutomaticTax::Liability)) }
def liability; end
sig {
params(_liability: T.nilable(::Stripe::PaymentLink::UpdateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::PaymentLink::UpdateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class CustomField < Stripe::RequestParams
class Dropdown < Stripe::RequestParams
class Option < Stripe::RequestParams
# The label for the option, displayed to the customer. Up to 100 characters.
sig { returns(String) }
def label; end
sig { params(_label: String).returns(String) }
def label=(_label); end
# The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(label: String, value: String).void }
def initialize(label: nil, value: nil); end
end
# The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The options available for the customer to select. Up to 200 options allowed.
sig {
returns(T::Array[::Stripe::PaymentLink::UpdateParams::CustomField::Dropdown::Option])
}
def options; end
sig {
params(_options: T::Array[::Stripe::PaymentLink::UpdateParams::CustomField::Dropdown::Option]).returns(T::Array[::Stripe::PaymentLink::UpdateParams::CustomField::Dropdown::Option])
}
def options=(_options); end
sig {
params(default_value: T.nilable(String), options: T::Array[::Stripe::PaymentLink::UpdateParams::CustomField::Dropdown::Option]).void
}
def initialize(default_value: nil, options: nil); end
end
class Label < Stripe::RequestParams
# Custom text for the label, displayed to the customer. Up to 50 characters.
sig { returns(String) }
def custom; end
sig { params(_custom: String).returns(String) }
def custom=(_custom); end
# The type of the label.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(custom: String, type: String).void }
def initialize(custom: nil, type: nil); end
end
class Numeric < Stripe::RequestParams
# The value that will pre-fill the field on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The maximum character length constraint for the customer's input.
sig { returns(T.nilable(Integer)) }
def maximum_length; end
sig { params(_maximum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_length=(_maximum_length); end
# The minimum character length requirement for the customer's input.
sig { returns(T.nilable(Integer)) }
def minimum_length; end
sig { params(_minimum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_length=(_minimum_length); end
sig {
params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
}
def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
end
class Text < Stripe::RequestParams
# The value that will pre-fill the field on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The maximum character length constraint for the customer's input.
sig { returns(T.nilable(Integer)) }
def maximum_length; end
sig { params(_maximum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_length=(_maximum_length); end
# The minimum character length requirement for the customer's input.
sig { returns(T.nilable(Integer)) }
def minimum_length; end
sig { params(_minimum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_length=(_minimum_length); end
sig {
params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
}
def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
end
# Configuration for `type=dropdown` fields.
sig { returns(T.nilable(::Stripe::PaymentLink::UpdateParams::CustomField::Dropdown)) }
def dropdown; end
sig {
params(_dropdown: T.nilable(::Stripe::PaymentLink::UpdateParams::CustomField::Dropdown)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::CustomField::Dropdown))
}
def dropdown=(_dropdown); end
# String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
sig { returns(String) }
def key; end
sig { params(_key: String).returns(String) }
def key=(_key); end
# The label for the field, displayed to the customer.
sig { returns(::Stripe::PaymentLink::UpdateParams::CustomField::Label) }
def label; end
sig {
params(_label: ::Stripe::PaymentLink::UpdateParams::CustomField::Label).returns(::Stripe::PaymentLink::UpdateParams::CustomField::Label)
}
def label=(_label); end
# Configuration for `type=numeric` fields.
sig { returns(T.nilable(::Stripe::PaymentLink::UpdateParams::CustomField::Numeric)) }
def numeric; end
sig {
params(_numeric: T.nilable(::Stripe::PaymentLink::UpdateParams::CustomField::Numeric)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::CustomField::Numeric))
}
def numeric=(_numeric); end
# Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def optional; end
sig { params(_optional: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def optional=(_optional); end
# Configuration for `type=text` fields.
sig { returns(T.nilable(::Stripe::PaymentLink::UpdateParams::CustomField::Text)) }
def text; end
sig {
params(_text: T.nilable(::Stripe::PaymentLink::UpdateParams::CustomField::Text)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::CustomField::Text))
}
def text=(_text); end
# The type of the field.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(dropdown: T.nilable(::Stripe::PaymentLink::UpdateParams::CustomField::Dropdown), key: String, label: ::Stripe::PaymentLink::UpdateParams::CustomField::Label, numeric: T.nilable(::Stripe::PaymentLink::UpdateParams::CustomField::Numeric), optional: T.nilable(T::Boolean), text: T.nilable(::Stripe::PaymentLink::UpdateParams::CustomField::Text), type: String).void
}
def initialize(
dropdown: nil,
key: nil,
label: nil,
numeric: nil,
optional: nil,
text: nil,
type: nil
); end
end
class CustomText < Stripe::RequestParams
class AfterSubmit < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class ShippingAddress < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class Submit < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class TermsOfServiceAcceptance < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
# Custom text that should be displayed after the payment confirmation button.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::CustomText::AfterSubmit)))
}
def after_submit; end
sig {
params(_after_submit: T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::CustomText::AfterSubmit))).returns(T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::CustomText::AfterSubmit)))
}
def after_submit=(_after_submit); end
# Custom text that should be displayed alongside shipping address collection.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::CustomText::ShippingAddress)))
}
def shipping_address; end
sig {
params(_shipping_address: T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::CustomText::ShippingAddress))).returns(T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::CustomText::ShippingAddress)))
}
def shipping_address=(_shipping_address); end
# Custom text that should be displayed alongside the payment confirmation button.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::CustomText::Submit)))
}
def submit; end
sig {
params(_submit: T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::CustomText::Submit))).returns(T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::CustomText::Submit)))
}
def submit=(_submit); end
# Custom text that should be displayed in place of the default terms of service agreement text.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::CustomText::TermsOfServiceAcceptance)))
}
def terms_of_service_acceptance; end
sig {
params(_terms_of_service_acceptance: T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::CustomText::TermsOfServiceAcceptance))).returns(T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::CustomText::TermsOfServiceAcceptance)))
}
def terms_of_service_acceptance=(_terms_of_service_acceptance); end
sig {
params(after_submit: T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::CustomText::AfterSubmit)), shipping_address: T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::CustomText::ShippingAddress)), submit: T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::CustomText::Submit)), terms_of_service_acceptance: T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::CustomText::TermsOfServiceAcceptance))).void
}
def initialize(
after_submit: nil,
shipping_address: nil,
submit: nil,
terms_of_service_acceptance: nil
); end
end
class InvoiceCreation < Stripe::RequestParams
class InvoiceData < Stripe::RequestParams
class CustomField < Stripe::RequestParams
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The value of the custom field. This may be up to 140 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
class RenderingOptions < Stripe::RequestParams
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(T.any(String, String))) }
def amount_tax_display; end
sig {
params(_amount_tax_display: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def amount_tax_display=(_amount_tax_display); end
# ID of the invoice rendering template to use for this invoice.
sig { returns(T.nilable(String)) }
def template; end
sig { params(_template: T.nilable(String)).returns(T.nilable(String)) }
def template=(_template); end
sig {
params(amount_tax_display: T.nilable(T.any(String, String)), template: T.nilable(String)).void
}
def initialize(amount_tax_display: nil, template: nil); end
end
# The account tax IDs associated with the invoice.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# Default custom fields to be displayed on invoices for this customer.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentLink::UpdateParams::InvoiceCreation::InvoiceData::CustomField])))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T.any(String, T::Array[::Stripe::PaymentLink::UpdateParams::InvoiceCreation::InvoiceData::CustomField]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentLink::UpdateParams::InvoiceCreation::InvoiceData::CustomField])))
}
def custom_fields=(_custom_fields); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Default footer to be displayed on invoices for this customer.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::PaymentLink::UpdateParams::InvoiceCreation::InvoiceData::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::PaymentLink::UpdateParams::InvoiceCreation::InvoiceData::Issuer)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::InvoiceCreation::InvoiceData::Issuer))
}
def issuer=(_issuer); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Default options for invoice PDF rendering for this customer.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::InvoiceCreation::InvoiceData::RenderingOptions)))
}
def rendering_options; end
sig {
params(_rendering_options: T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::InvoiceCreation::InvoiceData::RenderingOptions))).returns(T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::InvoiceCreation::InvoiceData::RenderingOptions)))
}
def rendering_options=(_rendering_options); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), custom_fields: T.nilable(T.any(String, T::Array[::Stripe::PaymentLink::UpdateParams::InvoiceCreation::InvoiceData::CustomField])), description: T.nilable(String), footer: T.nilable(String), issuer: T.nilable(::Stripe::PaymentLink::UpdateParams::InvoiceCreation::InvoiceData::Issuer), metadata: T.nilable(T.any(String, T::Hash[String, String])), rendering_options: T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::InvoiceCreation::InvoiceData::RenderingOptions))).void
}
def initialize(
account_tax_ids: nil,
custom_fields: nil,
description: nil,
footer: nil,
issuer: nil,
metadata: nil,
rendering_options: nil
); end
end
# Whether the feature is enabled
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Invoice PDF configuration.
sig {
returns(T.nilable(::Stripe::PaymentLink::UpdateParams::InvoiceCreation::InvoiceData))
}
def invoice_data; end
sig {
params(_invoice_data: T.nilable(::Stripe::PaymentLink::UpdateParams::InvoiceCreation::InvoiceData)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::InvoiceCreation::InvoiceData))
}
def invoice_data=(_invoice_data); end
sig {
params(enabled: T::Boolean, invoice_data: T.nilable(::Stripe::PaymentLink::UpdateParams::InvoiceCreation::InvoiceData)).void
}
def initialize(enabled: nil, invoice_data: nil); end
end
class LineItem < Stripe::RequestParams
class AdjustableQuantity < Stripe::RequestParams
# Set to true if the quantity can be adjusted to any non-negative Integer.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil); end
end
# When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
sig {
returns(T.nilable(::Stripe::PaymentLink::UpdateParams::LineItem::AdjustableQuantity))
}
def adjustable_quantity; end
sig {
params(_adjustable_quantity: T.nilable(::Stripe::PaymentLink::UpdateParams::LineItem::AdjustableQuantity)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::LineItem::AdjustableQuantity))
}
def adjustable_quantity=(_adjustable_quantity); end
# The ID of an existing line item on the payment link.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
# The quantity of the line item being purchased.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
sig {
params(adjustable_quantity: T.nilable(::Stripe::PaymentLink::UpdateParams::LineItem::AdjustableQuantity), id: String, quantity: T.nilable(Integer)).void
}
def initialize(adjustable_quantity: nil, id: nil, quantity: nil); end
end
class PaymentIntentData < Stripe::RequestParams
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(description: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_group: T.nilable(String)).void
}
def initialize(
description: nil,
metadata: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_group: nil
); end
end
class PhoneNumberCollection < Stripe::RequestParams
# Set to `true` to enable phone number collection.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class Restrictions < Stripe::RequestParams
class CompletedSessions < Stripe::RequestParams
# The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.
sig { returns(Integer) }
def limit; end
sig { params(_limit: Integer).returns(Integer) }
def limit=(_limit); end
sig { params(limit: Integer).void }
def initialize(limit: nil); end
end
# Configuration for the `completed_sessions` restriction type.
sig { returns(::Stripe::PaymentLink::UpdateParams::Restrictions::CompletedSessions) }
def completed_sessions; end
sig {
params(_completed_sessions: ::Stripe::PaymentLink::UpdateParams::Restrictions::CompletedSessions).returns(::Stripe::PaymentLink::UpdateParams::Restrictions::CompletedSessions)
}
def completed_sessions=(_completed_sessions); end
sig {
params(completed_sessions: ::Stripe::PaymentLink::UpdateParams::Restrictions::CompletedSessions).void
}
def initialize(completed_sessions: nil); end
end
class ShippingAddressCollection < Stripe::RequestParams
# An array of two-letter ISO country codes representing which countries Checkout should provide as options for
# shipping locations.
sig { returns(T::Array[String]) }
def allowed_countries; end
sig { params(_allowed_countries: T::Array[String]).returns(T::Array[String]) }
def allowed_countries=(_allowed_countries); end
sig { params(allowed_countries: T::Array[String]).void }
def initialize(allowed_countries: nil); end
end
class SubscriptionData < Stripe::RequestParams
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::PaymentLink::UpdateParams::SubscriptionData::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::PaymentLink::UpdateParams::SubscriptionData::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::SubscriptionData::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(issuer: T.nilable(::Stripe::PaymentLink::UpdateParams::SubscriptionData::InvoiceSettings::Issuer)).void
}
def initialize(issuer: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
sig { returns(String) }
def missing_payment_method; end
sig { params(_missing_payment_method: String).returns(String) }
def missing_payment_method=(_missing_payment_method); end
sig { params(missing_payment_method: String).void }
def initialize(missing_payment_method: nil); end
end
# Defines how the subscription should behave when the user's free trial ends.
sig {
returns(::Stripe::PaymentLink::UpdateParams::SubscriptionData::TrialSettings::EndBehavior)
}
def end_behavior; end
sig {
params(_end_behavior: ::Stripe::PaymentLink::UpdateParams::SubscriptionData::TrialSettings::EndBehavior).returns(::Stripe::PaymentLink::UpdateParams::SubscriptionData::TrialSettings::EndBehavior)
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: ::Stripe::PaymentLink::UpdateParams::SubscriptionData::TrialSettings::EndBehavior).void
}
def initialize(end_behavior: nil); end
end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::PaymentLink::UpdateParams::SubscriptionData::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::PaymentLink::UpdateParams::SubscriptionData::InvoiceSettings)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::SubscriptionData::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
sig { returns(T.nilable(T.any(String, Integer))) }
def trial_period_days; end
sig {
params(_trial_period_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def trial_period_days=(_trial_period_days); end
# Settings related to subscription trials.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::SubscriptionData::TrialSettings)))
}
def trial_settings; end
sig {
params(_trial_settings: T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::SubscriptionData::TrialSettings))).returns(T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::SubscriptionData::TrialSettings)))
}
def trial_settings=(_trial_settings); end
sig {
params(invoice_settings: T.nilable(::Stripe::PaymentLink::UpdateParams::SubscriptionData::InvoiceSettings), metadata: T.nilable(T.any(String, T::Hash[String, String])), trial_period_days: T.nilable(T.any(String, Integer)), trial_settings: T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::SubscriptionData::TrialSettings))).void
}
def initialize(
invoice_settings: nil,
metadata: nil,
trial_period_days: nil,
trial_settings: nil
); end
end
class TaxIdCollection < Stripe::RequestParams
# Enable tax ID collection during checkout. Defaults to `false`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Describes whether a tax ID is required during checkout. Defaults to `never`.
sig { returns(T.nilable(String)) }
def required; end
sig { params(_required: T.nilable(String)).returns(T.nilable(String)) }
def required=(_required); end
sig { params(enabled: T::Boolean, required: T.nilable(String)).void }
def initialize(enabled: nil, required: nil); end
end
# Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Behavior after the purchase is complete.
sig { returns(T.nilable(::Stripe::PaymentLink::UpdateParams::AfterCompletion)) }
def after_completion; end
sig {
params(_after_completion: T.nilable(::Stripe::PaymentLink::UpdateParams::AfterCompletion)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::AfterCompletion))
}
def after_completion=(_after_completion); end
# Enables user redeemable promotion codes.
sig { returns(T.nilable(T::Boolean)) }
def allow_promotion_codes; end
sig { params(_allow_promotion_codes: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def allow_promotion_codes=(_allow_promotion_codes); end
# Configuration for automatic tax collection.
sig { returns(T.nilable(::Stripe::PaymentLink::UpdateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::PaymentLink::UpdateParams::AutomaticTax)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Configuration for collecting the customer's billing address. Defaults to `auto`.
sig { returns(T.nilable(String)) }
def billing_address_collection; end
sig { params(_billing_address_collection: T.nilable(String)).returns(T.nilable(String)) }
def billing_address_collection=(_billing_address_collection); end
# Collect additional information from your customer using custom fields. Up to 3 fields are supported.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentLink::UpdateParams::CustomField])))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T.any(String, T::Array[::Stripe::PaymentLink::UpdateParams::CustomField]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentLink::UpdateParams::CustomField])))
}
def custom_fields=(_custom_fields); end
# Display additional text for your customers using custom text.
sig { returns(T.nilable(::Stripe::PaymentLink::UpdateParams::CustomText)) }
def custom_text; end
sig {
params(_custom_text: T.nilable(::Stripe::PaymentLink::UpdateParams::CustomText)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::CustomText))
}
def custom_text=(_custom_text); end
# Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).
sig { returns(T.nilable(String)) }
def customer_creation; end
sig { params(_customer_creation: T.nilable(String)).returns(T.nilable(String)) }
def customer_creation=(_customer_creation); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The custom message to be displayed to a customer when a payment link is no longer active.
sig { returns(T.nilable(String)) }
def inactive_message; end
sig { params(_inactive_message: T.nilable(String)).returns(T.nilable(String)) }
def inactive_message=(_inactive_message); end
# Generate a post-purchase Invoice for one-time payments.
sig { returns(T.nilable(::Stripe::PaymentLink::UpdateParams::InvoiceCreation)) }
def invoice_creation; end
sig {
params(_invoice_creation: T.nilable(::Stripe::PaymentLink::UpdateParams::InvoiceCreation)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::InvoiceCreation))
}
def invoice_creation=(_invoice_creation); end
# The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
sig { returns(T.nilable(T::Array[::Stripe::PaymentLink::UpdateParams::LineItem])) }
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::PaymentLink::UpdateParams::LineItem])).returns(T.nilable(T::Array[::Stripe::PaymentLink::UpdateParams::LineItem]))
}
def line_items=(_line_items); end
# 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
sig { returns(T.nilable(::Stripe::PaymentLink::UpdateParams::PaymentIntentData)) }
def payment_intent_data; end
sig {
params(_payment_intent_data: T.nilable(::Stripe::PaymentLink::UpdateParams::PaymentIntentData)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::PaymentIntentData))
}
def payment_intent_data=(_payment_intent_data); end
# Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.
#
# Can only be set in `subscription` mode. Defaults to `always`.
#
# If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
sig { returns(T.nilable(String)) }
def payment_method_collection; end
sig { params(_payment_method_collection: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_collection=(_payment_method_collection); end
# The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def payment_method_types=(_payment_method_types); end
# Controls phone number collection settings during checkout.
#
# We recommend that you review your privacy policy and check with your legal contacts.
sig { returns(T.nilable(::Stripe::PaymentLink::UpdateParams::PhoneNumberCollection)) }
def phone_number_collection; end
sig {
params(_phone_number_collection: T.nilable(::Stripe::PaymentLink::UpdateParams::PhoneNumberCollection)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::PhoneNumberCollection))
}
def phone_number_collection=(_phone_number_collection); end
# Settings that restrict the usage of a payment link.
sig { returns(T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::Restrictions))) }
def restrictions; end
sig {
params(_restrictions: T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::Restrictions))).returns(T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::Restrictions)))
}
def restrictions=(_restrictions); end
# Configuration for collecting the customer's shipping address.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::ShippingAddressCollection)))
}
def shipping_address_collection; end
sig {
params(_shipping_address_collection: T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::ShippingAddressCollection))).returns(T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::ShippingAddressCollection)))
}
def shipping_address_collection=(_shipping_address_collection); end
# Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).
sig { returns(T.nilable(String)) }
def submit_type; end
sig { params(_submit_type: T.nilable(String)).returns(T.nilable(String)) }
def submit_type=(_submit_type); end
# When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
sig { returns(T.nilable(::Stripe::PaymentLink::UpdateParams::SubscriptionData)) }
def subscription_data; end
sig {
params(_subscription_data: T.nilable(::Stripe::PaymentLink::UpdateParams::SubscriptionData)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::SubscriptionData))
}
def subscription_data=(_subscription_data); end
# Controls tax ID collection during checkout.
sig { returns(T.nilable(::Stripe::PaymentLink::UpdateParams::TaxIdCollection)) }
def tax_id_collection; end
sig {
params(_tax_id_collection: T.nilable(::Stripe::PaymentLink::UpdateParams::TaxIdCollection)).returns(T.nilable(::Stripe::PaymentLink::UpdateParams::TaxIdCollection))
}
def tax_id_collection=(_tax_id_collection); end
sig {
params(active: T.nilable(T::Boolean), after_completion: T.nilable(::Stripe::PaymentLink::UpdateParams::AfterCompletion), allow_promotion_codes: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::PaymentLink::UpdateParams::AutomaticTax), billing_address_collection: T.nilable(String), custom_fields: T.nilable(T.any(String, T::Array[::Stripe::PaymentLink::UpdateParams::CustomField])), custom_text: T.nilable(::Stripe::PaymentLink::UpdateParams::CustomText), customer_creation: T.nilable(String), expand: T.nilable(T::Array[String]), inactive_message: T.nilable(String), invoice_creation: T.nilable(::Stripe::PaymentLink::UpdateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::PaymentLink::UpdateParams::LineItem]), metadata: T.nilable(T::Hash[String, String]), payment_intent_data: T.nilable(::Stripe::PaymentLink::UpdateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_types: T.nilable(T.any(String, T::Array[String])), phone_number_collection: T.nilable(::Stripe::PaymentLink::UpdateParams::PhoneNumberCollection), restrictions: T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::Restrictions)), shipping_address_collection: T.nilable(T.any(String, ::Stripe::PaymentLink::UpdateParams::ShippingAddressCollection)), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::PaymentLink::UpdateParams::SubscriptionData), tax_id_collection: T.nilable(::Stripe::PaymentLink::UpdateParams::TaxIdCollection)).void
}
def initialize(
active: nil,
after_completion: nil,
allow_promotion_codes: nil,
automatic_tax: nil,
billing_address_collection: nil,
custom_fields: nil,
custom_text: nil,
customer_creation: nil,
expand: nil,
inactive_message: nil,
invoice_creation: nil,
line_items: nil,
metadata: nil,
payment_intent_data: nil,
payment_method_collection: nil,
payment_method_types: nil,
phone_number_collection: nil,
restrictions: nil,
shipping_address_collection: nil,
submit_type: nil,
subscription_data: nil,
tax_id_collection: nil
); end
end
class ListLineItemsParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Creates a payment link.
sig {
params(params: T.any(::Stripe::PaymentLink::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentLink)
}
def self.create(params = {}, opts = {}); end
# Returns a list of your payment links.
sig {
params(params: T.any(::Stripe::PaymentLink::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
sig {
params(params: T.any(::Stripe::PaymentLink::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list_line_items(params = {}, opts = {}); end
# When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
sig {
params(payment_link: String, params: T.any(::Stripe::PaymentLink::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list_line_items(payment_link, params = {}, opts = {}); end
# Updates a payment link.
sig {
params(payment_link: String, params: T.any(::Stripe::PaymentLink::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentLink)
}
def self.update(payment_link, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.
#
# There are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://stripe.com/docs/connect/charges):
#
# **Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.
#
# **Child** configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter.
#
# Child configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account's associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API.
#
# Related guides:
# - [Payment Method Configurations API](https://stripe.com/docs/connect/payment-method-configurations)
# - [Multiple configurations on dynamic payment methods](https://stripe.com/docs/payments/multiple-payment-method-configs)
# - [Multiple configurations for your Connect accounts](https://stripe.com/docs/connect/multiple-payment-method-configurations)
class PaymentMethodConfiguration < APIResource
class AcssDebit < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Affirm < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class AfterpayClearpay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Alipay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Alma < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class AmazonPay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class ApplePay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class AuBecsDebit < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class BacsDebit < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Bancontact < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Billie < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Blik < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Boleto < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Card < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class CartesBancaires < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Cashapp < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class CustomerBalance < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Eps < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Fpx < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class FrMealVoucherConecs < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Giropay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class GooglePay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Gopay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Grabpay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class IdBankTransfer < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Ideal < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Jcb < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class KakaoPay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Klarna < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Konbini < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class KrCard < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Link < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Mobilepay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Multibanco < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class NaverPay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class NzBankAccount < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Oxxo < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class P24 < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class PayByBank < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Payco < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Paynow < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Paypal < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Paypay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Payto < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Pix < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Promptpay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Qris < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class RevolutPay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class SamsungPay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Satispay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class SepaDebit < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Shopeepay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Sofort < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Swish < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Twint < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class UsBankAccount < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class WechatPay < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
class Zip < Stripe::StripeObject
class DisplayPreference < Stripe::StripeObject
# For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
sig { returns(T.nilable(T::Boolean)) }
def overridable; end
# The account's display preference.
sig { returns(String) }
def preference; end
# The effective display preference value.
sig { returns(String) }
def value; end
end
# Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
sig { returns(T::Boolean) }
def available; end
# Attribute for field display_preference
sig { returns(DisplayPreference) }
def display_preference; end
end
# Attribute for field acss_debit
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# Whether the configuration can be used for new payments.
sig { returns(T::Boolean) }
def active; end
# Attribute for field affirm
sig { returns(T.nilable(Affirm)) }
def affirm; end
# Attribute for field afterpay_clearpay
sig { returns(T.nilable(AfterpayClearpay)) }
def afterpay_clearpay; end
# Attribute for field alipay
sig { returns(T.nilable(Alipay)) }
def alipay; end
# Attribute for field alma
sig { returns(T.nilable(Alma)) }
def alma; end
# Attribute for field amazon_pay
sig { returns(T.nilable(AmazonPay)) }
def amazon_pay; end
# Attribute for field apple_pay
sig { returns(T.nilable(ApplePay)) }
def apple_pay; end
# For child configs, the Connect application associated with the configuration.
sig { returns(T.nilable(String)) }
def application; end
# Attribute for field au_becs_debit
sig { returns(T.nilable(AuBecsDebit)) }
def au_becs_debit; end
# Attribute for field bacs_debit
sig { returns(T.nilable(BacsDebit)) }
def bacs_debit; end
# Attribute for field bancontact
sig { returns(T.nilable(Bancontact)) }
def bancontact; end
# Attribute for field billie
sig { returns(T.nilable(Billie)) }
def billie; end
# Attribute for field blik
sig { returns(T.nilable(Blik)) }
def blik; end
# Attribute for field boleto
sig { returns(T.nilable(Boleto)) }
def boleto; end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# Attribute for field cartes_bancaires
sig { returns(T.nilable(CartesBancaires)) }
def cartes_bancaires; end
# Attribute for field cashapp
sig { returns(T.nilable(Cashapp)) }
def cashapp; end
# Attribute for field customer_balance
sig { returns(T.nilable(CustomerBalance)) }
def customer_balance; end
# Attribute for field eps
sig { returns(T.nilable(Eps)) }
def eps; end
# Attribute for field fpx
sig { returns(T.nilable(Fpx)) }
def fpx; end
# Attribute for field fr_meal_voucher_conecs
sig { returns(T.nilable(FrMealVoucherConecs)) }
def fr_meal_voucher_conecs; end
# Attribute for field giropay
sig { returns(T.nilable(Giropay)) }
def giropay; end
# Attribute for field google_pay
sig { returns(T.nilable(GooglePay)) }
def google_pay; end
# Attribute for field gopay
sig { returns(T.nilable(Gopay)) }
def gopay; end
# Attribute for field grabpay
sig { returns(T.nilable(Grabpay)) }
def grabpay; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Attribute for field id_bank_transfer
sig { returns(T.nilable(IdBankTransfer)) }
def id_bank_transfer; end
# Attribute for field ideal
sig { returns(T.nilable(Ideal)) }
def ideal; end
# The default configuration is used whenever a payment method configuration is not specified.
sig { returns(T::Boolean) }
def is_default; end
# Attribute for field jcb
sig { returns(T.nilable(Jcb)) }
def jcb; end
# Attribute for field kakao_pay
sig { returns(T.nilable(KakaoPay)) }
def kakao_pay; end
# Attribute for field klarna
sig { returns(T.nilable(Klarna)) }
def klarna; end
# Attribute for field konbini
sig { returns(T.nilable(Konbini)) }
def konbini; end
# Attribute for field kr_card
sig { returns(T.nilable(KrCard)) }
def kr_card; end
# Attribute for field link
sig { returns(T.nilable(Link)) }
def link; end
# 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) }
def livemode; end
# Attribute for field mobilepay
sig { returns(T.nilable(Mobilepay)) }
def mobilepay; end
# Attribute for field multibanco
sig { returns(T.nilable(Multibanco)) }
def multibanco; end
# The configuration's name.
sig { returns(String) }
def name; end
# Attribute for field naver_pay
sig { returns(T.nilable(NaverPay)) }
def naver_pay; end
# Attribute for field nz_bank_account
sig { returns(T.nilable(NzBankAccount)) }
def nz_bank_account; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Attribute for field oxxo
sig { returns(T.nilable(Oxxo)) }
def oxxo; end
# Attribute for field p24
sig { returns(T.nilable(P24)) }
def p24; end
# For child configs, the configuration's parent configuration.
sig { returns(T.nilable(String)) }
def parent; end
# Attribute for field pay_by_bank
sig { returns(T.nilable(PayByBank)) }
def pay_by_bank; end
# Attribute for field payco
sig { returns(T.nilable(Payco)) }
def payco; end
# Attribute for field paynow
sig { returns(T.nilable(Paynow)) }
def paynow; end
# Attribute for field paypal
sig { returns(T.nilable(Paypal)) }
def paypal; end
# Attribute for field paypay
sig { returns(T.nilable(Paypay)) }
def paypay; end
# Attribute for field payto
sig { returns(T.nilable(Payto)) }
def payto; end
# Attribute for field pix
sig { returns(T.nilable(Pix)) }
def pix; end
# Attribute for field promptpay
sig { returns(T.nilable(Promptpay)) }
def promptpay; end
# Attribute for field qris
sig { returns(T.nilable(Qris)) }
def qris; end
# Attribute for field revolut_pay
sig { returns(T.nilable(RevolutPay)) }
def revolut_pay; end
# Attribute for field samsung_pay
sig { returns(T.nilable(SamsungPay)) }
def samsung_pay; end
# Attribute for field satispay
sig { returns(T.nilable(Satispay)) }
def satispay; end
# Attribute for field sepa_debit
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# Attribute for field shopeepay
sig { returns(T.nilable(Shopeepay)) }
def shopeepay; end
# Attribute for field sofort
sig { returns(T.nilable(Sofort)) }
def sofort; end
# Attribute for field swish
sig { returns(T.nilable(Swish)) }
def swish; end
# Attribute for field twint
sig { returns(T.nilable(Twint)) }
def twint; end
# Attribute for field us_bank_account
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
# Attribute for field wechat_pay
sig { returns(T.nilable(WechatPay)) }
def wechat_pay; end
# Attribute for field zip
sig { returns(T.nilable(Zip)) }
def zip; end
class ListParams < Stripe::RequestParams
# The Connect application to filter by.
sig { returns(T.nilable(String)) }
def application; end
sig { params(_application: T.nilable(String)).returns(T.nilable(String)) }
def application=(_application); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(application: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
application: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AcssDebit::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AcssDebit::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AcssDebit::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AcssDebit::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Affirm < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Affirm::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Affirm::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Affirm::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Affirm::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class AfterpayClearpay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AfterpayClearpay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AfterpayClearpay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AfterpayClearpay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AfterpayClearpay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Alipay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alipay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alipay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alipay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alipay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Alma < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alma::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alma::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alma::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alma::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class AmazonPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AmazonPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AmazonPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AmazonPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AmazonPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class ApplePay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class ApplePayLater < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePayLater::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePayLater::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePayLater::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePayLater::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class AuBecsDebit < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AuBecsDebit::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AuBecsDebit::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AuBecsDebit::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AuBecsDebit::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class BacsDebit < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::BacsDebit::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::BacsDebit::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::BacsDebit::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::BacsDebit::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Bancontact < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Bancontact::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Bancontact::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Bancontact::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Bancontact::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Billie < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Billie::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Billie::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Billie::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Billie::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Blik < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Blik::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Blik::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Blik::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Blik::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Boleto < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Boleto::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Boleto::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Boleto::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Boleto::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Card < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Card::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Card::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Card::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Card::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class CartesBancaires < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CartesBancaires::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CartesBancaires::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CartesBancaires::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CartesBancaires::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Cashapp < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Cashapp::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Cashapp::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Cashapp::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Cashapp::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class CustomerBalance < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CustomerBalance::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CustomerBalance::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CustomerBalance::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CustomerBalance::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Eps < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Eps::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Eps::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Eps::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Eps::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Fpx < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Fpx::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Fpx::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Fpx::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Fpx::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class FrMealVoucherConecs < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::FrMealVoucherConecs::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::FrMealVoucherConecs::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::FrMealVoucherConecs::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::FrMealVoucherConecs::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Giropay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Giropay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Giropay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Giropay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Giropay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class GooglePay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::GooglePay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::GooglePay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::GooglePay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::GooglePay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Gopay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Gopay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Gopay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Gopay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Gopay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Grabpay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Grabpay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Grabpay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Grabpay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Grabpay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class IdBankTransfer < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::IdBankTransfer::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::IdBankTransfer::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::IdBankTransfer::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::IdBankTransfer::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Ideal < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Ideal::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Ideal::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Ideal::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Ideal::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Jcb < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Jcb::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Jcb::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Jcb::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Jcb::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class KakaoPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KakaoPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KakaoPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KakaoPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KakaoPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Klarna < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Klarna::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Klarna::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Klarna::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Klarna::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Konbini < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Konbini::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Konbini::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Konbini::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Konbini::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class KrCard < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KrCard::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KrCard::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KrCard::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KrCard::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Link < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Link::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Link::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Link::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Link::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Mobilepay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Mobilepay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Mobilepay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Mobilepay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Mobilepay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Multibanco < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Multibanco::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Multibanco::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Multibanco::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Multibanco::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class NaverPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NaverPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NaverPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NaverPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NaverPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class NzBankAccount < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NzBankAccount::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NzBankAccount::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NzBankAccount::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NzBankAccount::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Oxxo < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Oxxo::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Oxxo::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Oxxo::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Oxxo::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class P24 < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::P24::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::P24::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::P24::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::P24::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class PayByBank < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::PayByBank::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::PayByBank::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::PayByBank::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::PayByBank::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Payco < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payco::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payco::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payco::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payco::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Paynow < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paynow::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paynow::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paynow::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paynow::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Paypal < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypal::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypal::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypal::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypal::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Paypay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Payto < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payto::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payto::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payto::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payto::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Pix < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Pix::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Pix::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Pix::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Pix::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Promptpay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Promptpay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Promptpay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Promptpay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Promptpay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Qris < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Qris::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Qris::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Qris::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Qris::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class RevolutPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::RevolutPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::RevolutPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::RevolutPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::RevolutPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class SamsungPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SamsungPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SamsungPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SamsungPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SamsungPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Satispay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Satispay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Satispay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Satispay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Satispay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class SepaDebit < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SepaDebit::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SepaDebit::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SepaDebit::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SepaDebit::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Shopeepay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Shopeepay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Shopeepay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Shopeepay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Shopeepay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Sofort < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Sofort::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Sofort::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Sofort::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Sofort::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Swish < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Swish::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Swish::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Swish::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Swish::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Twint < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Twint::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Twint::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Twint::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Twint::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class UsBankAccount < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::UsBankAccount::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::UsBankAccount::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::UsBankAccount::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::UsBankAccount::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class WechatPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::WechatPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::WechatPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::WechatPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::WechatPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Zip < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Zip::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Zip::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Zip::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Zip::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
# Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AcssDebit)) }
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AcssDebit)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AcssDebit))
}
def acss_debit=(_acss_debit); end
# [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Affirm)) }
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Affirm)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Affirm))
}
def affirm=(_affirm); end
# Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AfterpayClearpay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alipay)) }
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alipay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alipay))
}
def alipay=(_alipay); end
# Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alma)) }
def alma; end
sig {
params(_alma: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alma)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alma))
}
def alma=(_alma); end
# Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AmazonPay)) }
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AmazonPay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePay)) }
def apple_pay; end
sig {
params(_apple_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePay))
}
def apple_pay=(_apple_pay); end
# Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePayLater)) }
def apple_pay_later; end
sig {
params(_apple_pay_later: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePayLater)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePayLater))
}
def apple_pay_later=(_apple_pay_later); end
# Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AuBecsDebit)) }
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AuBecsDebit)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::BacsDebit)) }
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::BacsDebit)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Bancontact)) }
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Bancontact)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Bancontact))
}
def bancontact=(_bancontact); end
# Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Billie)) }
def billie; end
sig {
params(_billie: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Billie)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Billie))
}
def billie=(_billie); end
# BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Blik)) }
def blik; end
sig {
params(_blik: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Blik)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Blik))
}
def blik=(_blik); end
# Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Boleto)) }
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Boleto)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Boleto))
}
def boleto=(_boleto); end
# Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Card)) }
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Card)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Card))
}
def card=(_card); end
# Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CartesBancaires))
}
def cartes_bancaires; end
sig {
params(_cartes_bancaires: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CartesBancaires)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CartesBancaires))
}
def cartes_bancaires=(_cartes_bancaires); end
# Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Cashapp)) }
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Cashapp)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Cashapp))
}
def cashapp=(_cashapp); end
# Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CustomerBalance)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Eps)) }
def eps; end
sig {
params(_eps: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Eps)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Eps))
}
def eps=(_eps); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Fpx)) }
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Fpx)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Fpx))
}
def fpx=(_fpx); end
# Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://stripe.com/docs/payments/benefits/fr-meal-vouchers) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::FrMealVoucherConecs))
}
def fr_meal_voucher_conecs; end
sig {
params(_fr_meal_voucher_conecs: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::FrMealVoucherConecs)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::FrMealVoucherConecs))
}
def fr_meal_voucher_conecs=(_fr_meal_voucher_conecs); end
# giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Giropay)) }
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Giropay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Giropay))
}
def giropay=(_giropay); end
# Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::GooglePay)) }
def google_pay; end
sig {
params(_google_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::GooglePay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::GooglePay))
}
def google_pay=(_google_pay); end
# GoPay is a [single use](https://stripe.com/docs/payments/payment-methods#usage) digital wallet payment method popular in Indonesia. When paying with GoPay, customers authenticate and approve payments using the Gojek app. Desktop checkout is performed by scanning a QR code. When checking out on mobile, customers are redirected to the Gojek app to confirm payment.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Gopay)) }
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Gopay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Gopay))
}
def gopay=(_gopay); end
# GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Grabpay)) }
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Grabpay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Grabpay))
}
def grabpay=(_grabpay); end
# Stripe users in Indonesia can receive bank transfers from customers in Indonesia. Bank transfers are a popular B2C and B2B payment method in Indonesia.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::IdBankTransfer)) }
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::IdBankTransfer)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Ideal)) }
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Ideal)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Ideal))
}
def ideal=(_ideal); end
# JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Jcb)) }
def jcb; end
sig {
params(_jcb: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Jcb)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Jcb))
}
def jcb=(_jcb); end
# Kakao Pay is a popular local wallet available in South Korea.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KakaoPay)) }
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KakaoPay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Klarna)) }
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Klarna)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Klarna))
}
def klarna=(_klarna); end
# Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Konbini)) }
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Konbini)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Konbini))
}
def konbini=(_konbini); end
# Korean cards let users pay using locally issued cards from South Korea.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KrCard)) }
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KrCard)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KrCard))
}
def kr_card=(_kr_card); end
# [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Link)) }
def link; end
sig {
params(_link: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Link)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Link))
}
def link=(_link); end
# MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Mobilepay)) }
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Mobilepay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Mobilepay))
}
def mobilepay=(_mobilepay); end
# Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Multibanco)) }
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Multibanco)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Multibanco))
}
def multibanco=(_multibanco); end
# Configuration name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Naver Pay is a popular local wallet available in South Korea.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NaverPay)) }
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NaverPay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NaverPay))
}
def naver_pay=(_naver_pay); end
# Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NzBankAccount)) }
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NzBankAccount)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Oxxo)) }
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Oxxo)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Oxxo))
}
def oxxo=(_oxxo); end
# Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::P24)) }
def p24; end
sig {
params(_p24: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::P24)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::P24))
}
def p24=(_p24); end
# Configuration's parent configuration. Specify to create a child configuration.
sig { returns(T.nilable(String)) }
def parent; end
sig { params(_parent: T.nilable(String)).returns(T.nilable(String)) }
def parent=(_parent); end
# Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::PayByBank)) }
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::PayByBank)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payco)) }
def payco; end
sig {
params(_payco: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payco)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payco))
}
def payco=(_payco); end
# PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paynow)) }
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paynow)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paynow))
}
def paynow=(_paynow); end
# PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypal)) }
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypal)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypal))
}
def paypal=(_paypal); end
# Customers can pay with PayPay online or using the PayPay app.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypay)) }
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypay))
}
def paypay=(_paypay); end
# PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payto)) }
def payto; end
sig {
params(_payto: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payto)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payto))
}
def payto=(_payto); end
# Pix is a payment method popular in Brazil. When paying with Pix, customers authenticate and approve payments by scanning a QR code in their preferred banking app. Check this [page](https://docs.stripe.com/payments/pix) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Pix)) }
def pix; end
sig {
params(_pix: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Pix)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Pix))
}
def pix=(_pix); end
# PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Promptpay)) }
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Promptpay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Promptpay))
}
def promptpay=(_promptpay); end
# QRIS is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Indonesia. When paying with QRIS, customers authenticate and approve payments by scanning a QR code in their preferred digital wallet app.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Qris)) }
def qris; end
sig {
params(_qris: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Qris)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Qris))
}
def qris=(_qris); end
# Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::RevolutPay)) }
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::RevolutPay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SamsungPay)) }
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SamsungPay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Satispay)) }
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Satispay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Satispay))
}
def satispay=(_satispay); end
# The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SepaDebit)) }
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SepaDebit)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# ShopeePay is a [single use](https://stripe.com/docs/payments/payment-methods#usage) digital wallet payment method popular in Indonesia. When paying with GoPay, customers authenticate and approve payments using the Shopee app. Desktop checkout is performed by scanning a QR code. When checking out on mobile, customers are redirected to the Shopee app to confirm payment.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Shopeepay)) }
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Shopeepay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Shopeepay))
}
def shopeepay=(_shopeepay); end
# Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Sofort)) }
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Sofort)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Sofort))
}
def sofort=(_sofort); end
# Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Swish)) }
def swish; end
sig {
params(_swish: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Swish)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Swish))
}
def swish=(_swish); end
# Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Twint)) }
def twint; end
sig {
params(_twint: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Twint)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Twint))
}
def twint=(_twint); end
# Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-direct-debit) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::UsBankAccount)) }
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::UsBankAccount)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::WechatPay)) }
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::WechatPay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Zip)) }
def zip; end
sig {
params(_zip: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Zip)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AcssDebit), affirm: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alipay), alma: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alma), amazon_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AmazonPay), apple_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePay), apple_pay_later: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePayLater), au_becs_debit: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::BacsDebit), bancontact: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Bancontact), billie: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Billie), blik: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Blik), boleto: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Boleto), card: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Card), cartes_bancaires: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CartesBancaires), cashapp: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Cashapp), customer_balance: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CustomerBalance), eps: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Eps), expand: T.nilable(T::Array[String]), fpx: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Fpx), fr_meal_voucher_conecs: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::FrMealVoucherConecs), giropay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Giropay), google_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::GooglePay), gopay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Gopay), grabpay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Grabpay), id_bank_transfer: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::IdBankTransfer), ideal: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Ideal), jcb: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Jcb), kakao_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KakaoPay), klarna: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Klarna), konbini: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Konbini), kr_card: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KrCard), link: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Link), mobilepay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Mobilepay), multibanco: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Multibanco), name: T.nilable(String), naver_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NaverPay), nz_bank_account: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Oxxo), p24: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::P24), parent: T.nilable(String), pay_by_bank: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::PayByBank), payco: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payco), paynow: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paynow), paypal: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypal), paypay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypay), payto: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payto), pix: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Pix), promptpay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Promptpay), qris: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Qris), revolut_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::RevolutPay), samsung_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SamsungPay), satispay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Satispay), sepa_debit: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SepaDebit), shopeepay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Shopeepay), sofort: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Sofort), swish: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Swish), twint: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Twint), us_bank_account: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::WechatPay), zip: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
alma: nil,
amazon_pay: nil,
apple_pay: nil,
apple_pay_later: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
blik: nil,
boleto: nil,
card: nil,
cartes_bancaires: nil,
cashapp: nil,
customer_balance: nil,
eps: nil,
expand: nil,
fpx: nil,
fr_meal_voucher_conecs: nil,
giropay: nil,
google_pay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
jcb: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mobilepay: nil,
multibanco: nil,
name: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
parent: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
swish: nil,
twint: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class UpdateParams < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AcssDebit::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AcssDebit::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AcssDebit::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AcssDebit::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Affirm < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Affirm::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Affirm::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Affirm::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Affirm::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class AfterpayClearpay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AfterpayClearpay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AfterpayClearpay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AfterpayClearpay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AfterpayClearpay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Alipay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alipay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alipay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alipay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alipay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Alma < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alma::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alma::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alma::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alma::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class AmazonPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AmazonPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AmazonPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AmazonPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AmazonPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class ApplePay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class ApplePayLater < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePayLater::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePayLater::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePayLater::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePayLater::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class AuBecsDebit < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AuBecsDebit::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AuBecsDebit::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AuBecsDebit::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AuBecsDebit::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class BacsDebit < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::BacsDebit::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::BacsDebit::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::BacsDebit::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::BacsDebit::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Bancontact < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Bancontact::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Bancontact::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Bancontact::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Bancontact::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Billie < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Billie::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Billie::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Billie::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Billie::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Blik < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Blik::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Blik::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Blik::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Blik::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Boleto < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Boleto::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Boleto::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Boleto::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Boleto::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Card < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Card::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Card::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Card::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Card::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class CartesBancaires < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CartesBancaires::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CartesBancaires::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CartesBancaires::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CartesBancaires::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Cashapp < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Cashapp::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Cashapp::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Cashapp::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Cashapp::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class CustomerBalance < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CustomerBalance::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CustomerBalance::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CustomerBalance::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CustomerBalance::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Eps < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Eps::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Eps::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Eps::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Eps::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Fpx < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Fpx::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Fpx::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Fpx::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Fpx::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class FrMealVoucherConecs < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::FrMealVoucherConecs::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::FrMealVoucherConecs::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::FrMealVoucherConecs::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::FrMealVoucherConecs::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Giropay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Giropay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Giropay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Giropay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Giropay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class GooglePay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::GooglePay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::GooglePay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::GooglePay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::GooglePay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Gopay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Gopay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Gopay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Gopay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Gopay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Grabpay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Grabpay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Grabpay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Grabpay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Grabpay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class IdBankTransfer < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::IdBankTransfer::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::IdBankTransfer::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::IdBankTransfer::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::IdBankTransfer::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Ideal < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Ideal::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Ideal::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Ideal::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Ideal::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Jcb < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Jcb::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Jcb::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Jcb::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Jcb::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class KakaoPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KakaoPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KakaoPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KakaoPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KakaoPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Klarna < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Klarna::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Klarna::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Klarna::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Klarna::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Konbini < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Konbini::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Konbini::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Konbini::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Konbini::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class KrCard < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KrCard::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KrCard::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KrCard::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KrCard::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Link < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Link::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Link::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Link::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Link::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Mobilepay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Mobilepay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Mobilepay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Mobilepay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Mobilepay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Multibanco < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Multibanco::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Multibanco::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Multibanco::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Multibanco::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class NaverPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NaverPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NaverPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NaverPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NaverPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class NzBankAccount < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NzBankAccount::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NzBankAccount::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NzBankAccount::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NzBankAccount::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Oxxo < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Oxxo::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Oxxo::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Oxxo::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Oxxo::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class P24 < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::P24::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::P24::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::P24::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::P24::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class PayByBank < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::PayByBank::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::PayByBank::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::PayByBank::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::PayByBank::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Payco < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payco::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payco::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payco::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payco::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Paynow < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paynow::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paynow::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paynow::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paynow::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Paypal < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypal::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypal::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypal::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypal::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Paypay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Payto < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payto::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payto::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payto::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payto::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Pix < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Pix::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Pix::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Pix::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Pix::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Promptpay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Promptpay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Promptpay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Promptpay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Promptpay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Qris < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Qris::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Qris::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Qris::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Qris::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class RevolutPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::RevolutPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::RevolutPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::RevolutPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::RevolutPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class SamsungPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SamsungPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SamsungPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SamsungPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SamsungPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Satispay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Satispay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Satispay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Satispay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Satispay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class SepaDebit < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SepaDebit::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SepaDebit::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SepaDebit::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SepaDebit::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Shopeepay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Shopeepay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Shopeepay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Shopeepay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Shopeepay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Sofort < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Sofort::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Sofort::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Sofort::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Sofort::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Swish < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Swish::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Swish::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Swish::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Swish::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Twint < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Twint::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Twint::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Twint::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Twint::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class UsBankAccount < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::UsBankAccount::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::UsBankAccount::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::UsBankAccount::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::UsBankAccount::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class WechatPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::WechatPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::WechatPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::WechatPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::WechatPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Zip < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Zip::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Zip::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Zip::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Zip::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
# Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AcssDebit)) }
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AcssDebit)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AcssDebit))
}
def acss_debit=(_acss_debit); end
# Whether the configuration can be used for new payments.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Affirm)) }
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Affirm)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Affirm))
}
def affirm=(_affirm); end
# Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AfterpayClearpay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alipay)) }
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alipay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alipay))
}
def alipay=(_alipay); end
# Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alma)) }
def alma; end
sig {
params(_alma: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alma)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alma))
}
def alma=(_alma); end
# Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AmazonPay)) }
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AmazonPay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePay)) }
def apple_pay; end
sig {
params(_apple_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePay))
}
def apple_pay=(_apple_pay); end
# Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePayLater)) }
def apple_pay_later; end
sig {
params(_apple_pay_later: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePayLater)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePayLater))
}
def apple_pay_later=(_apple_pay_later); end
# Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AuBecsDebit)) }
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AuBecsDebit)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::BacsDebit)) }
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::BacsDebit)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Bancontact)) }
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Bancontact)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Bancontact))
}
def bancontact=(_bancontact); end
# Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Billie)) }
def billie; end
sig {
params(_billie: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Billie)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Billie))
}
def billie=(_billie); end
# BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Blik)) }
def blik; end
sig {
params(_blik: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Blik)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Blik))
}
def blik=(_blik); end
# Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Boleto)) }
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Boleto)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Boleto))
}
def boleto=(_boleto); end
# Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Card)) }
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Card)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Card))
}
def card=(_card); end
# Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CartesBancaires))
}
def cartes_bancaires; end
sig {
params(_cartes_bancaires: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CartesBancaires)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CartesBancaires))
}
def cartes_bancaires=(_cartes_bancaires); end
# Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Cashapp)) }
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Cashapp)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Cashapp))
}
def cashapp=(_cashapp); end
# Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CustomerBalance)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Eps)) }
def eps; end
sig {
params(_eps: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Eps)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Eps))
}
def eps=(_eps); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Fpx)) }
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Fpx)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Fpx))
}
def fpx=(_fpx); end
# Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://stripe.com/docs/payments/benefits/fr-meal-vouchers) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::FrMealVoucherConecs))
}
def fr_meal_voucher_conecs; end
sig {
params(_fr_meal_voucher_conecs: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::FrMealVoucherConecs)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::FrMealVoucherConecs))
}
def fr_meal_voucher_conecs=(_fr_meal_voucher_conecs); end
# giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Giropay)) }
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Giropay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Giropay))
}
def giropay=(_giropay); end
# Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::GooglePay)) }
def google_pay; end
sig {
params(_google_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::GooglePay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::GooglePay))
}
def google_pay=(_google_pay); end
# GoPay is a [single use](https://stripe.com/docs/payments/payment-methods#usage) digital wallet payment method popular in Indonesia. When paying with GoPay, customers authenticate and approve payments using the Gojek app. Desktop checkout is performed by scanning a QR code. When checking out on mobile, customers are redirected to the Gojek app to confirm payment.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Gopay)) }
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Gopay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Gopay))
}
def gopay=(_gopay); end
# GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Grabpay)) }
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Grabpay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Grabpay))
}
def grabpay=(_grabpay); end
# Stripe users in Indonesia can receive bank transfers from customers in Indonesia. Bank transfers are a popular B2C and B2B payment method in Indonesia.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::IdBankTransfer)) }
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::IdBankTransfer)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Ideal)) }
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Ideal)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Ideal))
}
def ideal=(_ideal); end
# JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Jcb)) }
def jcb; end
sig {
params(_jcb: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Jcb)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Jcb))
}
def jcb=(_jcb); end
# Kakao Pay is a popular local wallet available in South Korea.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KakaoPay)) }
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KakaoPay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Klarna)) }
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Klarna)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Klarna))
}
def klarna=(_klarna); end
# Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Konbini)) }
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Konbini)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Konbini))
}
def konbini=(_konbini); end
# Korean cards let users pay using locally issued cards from South Korea.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KrCard)) }
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KrCard)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KrCard))
}
def kr_card=(_kr_card); end
# [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Link)) }
def link; end
sig {
params(_link: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Link)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Link))
}
def link=(_link); end
# MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Mobilepay)) }
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Mobilepay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Mobilepay))
}
def mobilepay=(_mobilepay); end
# Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Multibanco)) }
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Multibanco)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Multibanco))
}
def multibanco=(_multibanco); end
# Configuration name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Naver Pay is a popular local wallet available in South Korea.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NaverPay)) }
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NaverPay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NaverPay))
}
def naver_pay=(_naver_pay); end
# Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NzBankAccount)) }
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NzBankAccount)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Oxxo)) }
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Oxxo)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Oxxo))
}
def oxxo=(_oxxo); end
# Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::P24)) }
def p24; end
sig {
params(_p24: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::P24)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::P24))
}
def p24=(_p24); end
# Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::PayByBank)) }
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::PayByBank)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payco)) }
def payco; end
sig {
params(_payco: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payco)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payco))
}
def payco=(_payco); end
# PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paynow)) }
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paynow)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paynow))
}
def paynow=(_paynow); end
# PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypal)) }
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypal)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypal))
}
def paypal=(_paypal); end
# Customers can pay with PayPay online or using the PayPay app.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypay)) }
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypay))
}
def paypay=(_paypay); end
# PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payto)) }
def payto; end
sig {
params(_payto: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payto)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payto))
}
def payto=(_payto); end
# Pix is a payment method popular in Brazil. When paying with Pix, customers authenticate and approve payments by scanning a QR code in their preferred banking app. Check this [page](https://docs.stripe.com/payments/pix) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Pix)) }
def pix; end
sig {
params(_pix: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Pix)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Pix))
}
def pix=(_pix); end
# PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Promptpay)) }
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Promptpay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Promptpay))
}
def promptpay=(_promptpay); end
# QRIS is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Indonesia. When paying with QRIS, customers authenticate and approve payments by scanning a QR code in their preferred digital wallet app.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Qris)) }
def qris; end
sig {
params(_qris: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Qris)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Qris))
}
def qris=(_qris); end
# Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::RevolutPay)) }
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::RevolutPay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SamsungPay)) }
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SamsungPay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Satispay)) }
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Satispay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Satispay))
}
def satispay=(_satispay); end
# The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SepaDebit)) }
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SepaDebit)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# ShopeePay is a [single use](https://stripe.com/docs/payments/payment-methods#usage) digital wallet payment method popular in Indonesia. When paying with GoPay, customers authenticate and approve payments using the Shopee app. Desktop checkout is performed by scanning a QR code. When checking out on mobile, customers are redirected to the Shopee app to confirm payment.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Shopeepay)) }
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Shopeepay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Shopeepay))
}
def shopeepay=(_shopeepay); end
# Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Sofort)) }
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Sofort)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Sofort))
}
def sofort=(_sofort); end
# Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Swish)) }
def swish; end
sig {
params(_swish: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Swish)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Swish))
}
def swish=(_swish); end
# Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Twint)) }
def twint; end
sig {
params(_twint: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Twint)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Twint))
}
def twint=(_twint); end
# Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-direct-debit) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::UsBankAccount)) }
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::UsBankAccount)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::WechatPay)) }
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::WechatPay)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability.
sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Zip)) }
def zip; end
sig {
params(_zip: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Zip)).returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AcssDebit), active: T.nilable(T::Boolean), affirm: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alipay), alma: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alma), amazon_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AmazonPay), apple_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePay), apple_pay_later: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePayLater), au_becs_debit: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::BacsDebit), bancontact: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Bancontact), billie: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Billie), blik: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Blik), boleto: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Boleto), card: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Card), cartes_bancaires: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CartesBancaires), cashapp: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Cashapp), customer_balance: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CustomerBalance), eps: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Eps), expand: T.nilable(T::Array[String]), fpx: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Fpx), fr_meal_voucher_conecs: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::FrMealVoucherConecs), giropay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Giropay), google_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::GooglePay), gopay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Gopay), grabpay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Grabpay), id_bank_transfer: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::IdBankTransfer), ideal: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Ideal), jcb: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Jcb), kakao_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KakaoPay), klarna: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Klarna), konbini: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Konbini), kr_card: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KrCard), link: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Link), mobilepay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Mobilepay), multibanco: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Multibanco), name: T.nilable(String), naver_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NaverPay), nz_bank_account: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Oxxo), p24: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::P24), pay_by_bank: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::PayByBank), payco: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payco), paynow: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paynow), paypal: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypal), paypay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypay), payto: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payto), pix: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Pix), promptpay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Promptpay), qris: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Qris), revolut_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::RevolutPay), samsung_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SamsungPay), satispay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Satispay), sepa_debit: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SepaDebit), shopeepay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Shopeepay), sofort: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Sofort), swish: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Swish), twint: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Twint), us_bank_account: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::WechatPay), zip: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Zip)).void
}
def initialize(
acss_debit: nil,
active: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
alma: nil,
amazon_pay: nil,
apple_pay: nil,
apple_pay_later: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
blik: nil,
boleto: nil,
card: nil,
cartes_bancaires: nil,
cashapp: nil,
customer_balance: nil,
eps: nil,
expand: nil,
fpx: nil,
fr_meal_voucher_conecs: nil,
giropay: nil,
google_pay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
jcb: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mobilepay: nil,
multibanco: nil,
name: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
swish: nil,
twint: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
# Creates a payment method configuration
sig {
params(params: T.any(::Stripe::PaymentMethodConfiguration::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethodConfiguration)
}
def self.create(params = {}, opts = {}); end
# List payment method configurations
sig {
params(params: T.any(::Stripe::PaymentMethodConfiguration::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Update payment method configuration
sig {
params(configuration: String, params: T.any(::Stripe::PaymentMethodConfiguration::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethodConfiguration)
}
def self.update(configuration, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# A payment method domain represents a web domain that you have registered with Stripe.
# Stripe Elements use registered payment method domains to control where certain payment methods are shown.
#
# Related guide: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
class PaymentMethodDomain < APIResource
class AmazonPay < Stripe::StripeObject
class StatusDetails < Stripe::StripeObject
# The error message associated with the status of the payment method on the domain.
sig { returns(String) }
def error_message; end
end
# The status of the payment method on the domain.
sig { returns(String) }
def status; end
# Contains additional details about the status of a payment method for a specific payment method domain.
sig { returns(T.nilable(StatusDetails)) }
def status_details; end
end
class ApplePay < Stripe::StripeObject
class StatusDetails < Stripe::StripeObject
# The error message associated with the status of the payment method on the domain.
sig { returns(String) }
def error_message; end
end
# The status of the payment method on the domain.
sig { returns(String) }
def status; end
# Contains additional details about the status of a payment method for a specific payment method domain.
sig { returns(T.nilable(StatusDetails)) }
def status_details; end
end
class GooglePay < Stripe::StripeObject
class StatusDetails < Stripe::StripeObject
# The error message associated with the status of the payment method on the domain.
sig { returns(String) }
def error_message; end
end
# The status of the payment method on the domain.
sig { returns(String) }
def status; end
# Contains additional details about the status of a payment method for a specific payment method domain.
sig { returns(T.nilable(StatusDetails)) }
def status_details; end
end
class Klarna < Stripe::StripeObject
class StatusDetails < Stripe::StripeObject
# The error message associated with the status of the payment method on the domain.
sig { returns(String) }
def error_message; end
end
# The status of the payment method on the domain.
sig { returns(String) }
def status; end
# Contains additional details about the status of a payment method for a specific payment method domain.
sig { returns(T.nilable(StatusDetails)) }
def status_details; end
end
class Link < Stripe::StripeObject
class StatusDetails < Stripe::StripeObject
# The error message associated with the status of the payment method on the domain.
sig { returns(String) }
def error_message; end
end
# The status of the payment method on the domain.
sig { returns(String) }
def status; end
# Contains additional details about the status of a payment method for a specific payment method domain.
sig { returns(T.nilable(StatusDetails)) }
def status_details; end
end
class Paypal < Stripe::StripeObject
class StatusDetails < Stripe::StripeObject
# The error message associated with the status of the payment method on the domain.
sig { returns(String) }
def error_message; end
end
# The status of the payment method on the domain.
sig { returns(String) }
def status; end
# Contains additional details about the status of a payment method for a specific payment method domain.
sig { returns(T.nilable(StatusDetails)) }
def status_details; end
end
# Indicates the status of a specific payment method on a payment method domain.
sig { returns(AmazonPay) }
def amazon_pay; end
# Indicates the status of a specific payment method on a payment method domain.
sig { returns(ApplePay) }
def apple_pay; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The domain name that this payment method domain object represents.
sig { returns(String) }
def domain_name; end
# Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.
sig { returns(T::Boolean) }
def enabled; end
# Indicates the status of a specific payment method on a payment method domain.
sig { returns(GooglePay) }
def google_pay; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Indicates the status of a specific payment method on a payment method domain.
sig { returns(Klarna) }
def klarna; end
# Indicates the status of a specific payment method on a payment method domain.
sig { returns(Link) }
def link; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Indicates the status of a specific payment method on a payment method domain.
sig { returns(Paypal) }
def paypal; end
class ListParams < Stripe::RequestParams
# The domain name that this payment method domain object represents.
sig { returns(T.nilable(String)) }
def domain_name; end
sig { params(_domain_name: T.nilable(String)).returns(T.nilable(String)) }
def domain_name=(_domain_name); end
# Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements or Embedded Checkout
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(domain_name: T.nilable(String), enabled: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
domain_name: nil,
enabled: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# The domain name that this payment method domain object represents.
sig { returns(String) }
def domain_name; end
sig { params(_domain_name: String).returns(String) }
def domain_name=(_domain_name); end
# Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(domain_name: String, enabled: T.nilable(T::Boolean), expand: T.nilable(T::Array[String])).void
}
def initialize(domain_name: nil, enabled: nil, expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(enabled: T.nilable(T::Boolean), expand: T.nilable(T::Array[String])).void }
def initialize(enabled: nil, expand: nil); end
end
class ValidateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Creates a payment method domain.
sig {
params(params: T.any(::Stripe::PaymentMethodDomain::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethodDomain)
}
def self.create(params = {}, opts = {}); end
# Lists the details of existing payment method domains.
sig {
params(params: T.any(::Stripe::PaymentMethodDomain::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates an existing payment method domain.
sig {
params(payment_method_domain: String, params: T.any(::Stripe::PaymentMethodDomain::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethodDomain)
}
def self.update(payment_method_domain, params = {}, opts = {}); end
# 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 registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
#
# Related guides: [Payment method domains](https://docs.stripe.com/docs/payments/payment-methods/pmd-registration).
sig {
params(params: T.any(::Stripe::PaymentMethodDomain::ValidateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethodDomain)
}
def validate(params = {}, opts = {}); end
# 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 registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
#
# Related guides: [Payment method domains](https://docs.stripe.com/docs/payments/payment-methods/pmd-registration).
sig {
params(payment_method_domain: String, params: T.any(::Stripe::PaymentMethodDomain::ValidateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethodDomain)
}
def self.validate(payment_method_domain, params = {}, opts = {}); end
end
end
# typed: 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
class AcssDebit < Stripe::StripeObject
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Institution number of the bank account.
sig { returns(T.nilable(String)) }
def institution_number; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# Transit number of the bank account.
sig { returns(T.nilable(String)) }
def transit_number; end
end
class Affirm < Stripe::StripeObject; end
class AfterpayClearpay < Stripe::StripeObject; end
class Alipay < Stripe::StripeObject; end
class Alma < Stripe::StripeObject; end
class AmazonPay < Stripe::StripeObject; end
class AuBecsDebit < Stripe::StripeObject
# Six-digit number identifying bank and branch associated with this bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
end
class BacsDebit < Stripe::StripeObject
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
end
class Bancontact < Stripe::StripeObject; end
class Billie < Stripe::StripeObject; end
class BillingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Billing address.
sig { returns(T.nilable(Address)) }
def address; end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
end
class Blik < Stripe::StripeObject; end
class Boleto < Stripe::StripeObject
# Uniquely identifies the customer tax id (CNPJ or CPF)
sig { returns(String) }
def tax_id; end
end
class Card < Stripe::StripeObject
class Checks < Stripe::StripeObject
# If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
sig { returns(T.nilable(String)) }
def address_line1_check; end
# If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
sig { returns(T.nilable(String)) }
def address_postal_code_check; end
# If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
sig { returns(T.nilable(String)) }
def cvc_check; end
end
class GeneratedFrom < Stripe::StripeObject
class PaymentMethodDetails < Stripe::StripeObject
class CardPresent < Stripe::StripeObject
class Offline < Stripe::StripeObject
# Time at which the payment was collected while offline
sig { returns(T.nilable(Integer)) }
def stored_at; end
# The method used to process this payment method offline. Only deferred is allowed.
sig { returns(T.nilable(String)) }
def type; end
end
class Receipt < Stripe::StripeObject
# The type of account being debited or credited
sig { returns(T.nilable(String)) }
def account_type; end
# The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.
sig { returns(T.nilable(String)) }
def application_cryptogram; end
# The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip.
sig { returns(T.nilable(String)) }
def application_preferred_name; end
# Identifier for this transaction.
sig { returns(T.nilable(String)) }
def authorization_code; end
# EMV tag 8A. A code returned by the card issuer.
sig { returns(T.nilable(String)) }
def authorization_response_code; end
# Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.
sig { returns(T.nilable(String)) }
def cardholder_verification_method; end
# Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.
sig { returns(T.nilable(String)) }
def dedicated_file_name; end
# A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.
sig { returns(T.nilable(String)) }
def terminal_verification_results; end
# An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.
sig { returns(T.nilable(String)) }
def transaction_status_information; end
end
class Wallet < Stripe::StripeObject
# The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.
sig { returns(String) }
def type; end
end
# The authorized amount
sig { returns(T.nilable(Integer)) }
def amount_authorized; end
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(T.nilable(String)) }
def brand; end
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.
sig { returns(T.nilable(String)) }
def brand_product; end
# When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.
sig { returns(T.nilable(Integer)) }
def capture_before; end
# The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
sig { returns(T.nilable(String)) }
def cardholder_name; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# Authorization response cryptogram.
sig { returns(T.nilable(String)) }
def emv_auth_data; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
sig { returns(T.nilable(String)) }
def generated_card; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
sig { returns(T::Boolean) }
def incremental_authorization_supported; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
# Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
sig { returns(T.nilable(String)) }
def network; end
# This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
sig { returns(T.nilable(String)) }
def network_transaction_id; end
# Details about payments collected offline.
sig { returns(T.nilable(Offline)) }
def offline; end
# Defines whether the authorized amount can be over-captured or not
sig { returns(T::Boolean) }
def overcapture_supported; end
# The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
# How card details were read in this transaction.
sig { returns(T.nilable(String)) }
def read_method; end
# A collection of fields required to be displayed on receipts. Only required for EMV transactions.
sig { returns(T.nilable(Receipt)) }
def receipt; end
# Attribute for field wallet
sig { returns(T.nilable(Wallet)) }
def wallet; end
end
# Attribute for field card_present
sig { returns(T.nilable(CardPresent)) }
def card_present; end
# The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`.
sig { returns(String) }
def type; end
end
# The charge that created this object.
sig { returns(T.nilable(String)) }
def charge; end
# Transaction-specific details of the payment method used in the payment.
sig { returns(T.nilable(PaymentMethodDetails)) }
def payment_method_details; end
# The ID of the SetupAttempt that generated this PaymentMethod, if any.
sig { returns(T.nilable(T.any(String, Stripe::SetupAttempt))) }
def setup_attempt; end
end
class Networks < Stripe::StripeObject
# All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).
sig { returns(T::Array[String]) }
def available; end
# The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.
sig { returns(T.nilable(String)) }
def preferred; end
end
class ThreeDSecureUsage < Stripe::StripeObject
# Whether 3D Secure is supported on this card.
sig { returns(T::Boolean) }
def supported; end
end
class Wallet < Stripe::StripeObject
class AmexExpressCheckout < Stripe::StripeObject; end
class ApplePay < Stripe::StripeObject; end
class GooglePay < Stripe::StripeObject; end
class Link < Stripe::StripeObject; end
class Masterpass < Stripe::StripeObject
class BillingAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class ShippingAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(BillingAddress)) }
def billing_address; end
# Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def email; end
# Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def name; end
# Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(ShippingAddress)) }
def shipping_address; end
end
class SamsungPay < Stripe::StripeObject; end
class VisaCheckout < Stripe::StripeObject
class BillingAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class ShippingAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(BillingAddress)) }
def billing_address; end
# Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def email; end
# Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def name; end
# Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(ShippingAddress)) }
def shipping_address; end
end
# Attribute for field amex_express_checkout
sig { returns(T.nilable(AmexExpressCheckout)) }
def amex_express_checkout; end
# Attribute for field apple_pay
sig { returns(T.nilable(ApplePay)) }
def apple_pay; end
# (For tokenized numbers only.) The last four digits of the device account number.
sig { returns(T.nilable(String)) }
def dynamic_last4; end
# Attribute for field google_pay
sig { returns(T.nilable(GooglePay)) }
def google_pay; end
# Attribute for field link
sig { returns(T.nilable(Link)) }
def link; end
# Attribute for field masterpass
sig { returns(T.nilable(Masterpass)) }
def masterpass; end
# Attribute for field samsung_pay
sig { returns(T.nilable(SamsungPay)) }
def samsung_pay; end
# The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.
sig { returns(String) }
def type; end
# Attribute for field visa_checkout
sig { returns(T.nilable(VisaCheckout)) }
def visa_checkout; end
end
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(String) }
def brand; end
# Checks on Card address and CVC if provided.
sig { returns(T.nilable(Checks)) }
def checks; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future.
sig { returns(T.nilable(String)) }
def display_brand; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(String) }
def funding; end
# Details of the original PaymentMethod that created this object.
sig { returns(T.nilable(GeneratedFrom)) }
def generated_from; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(String) }
def last4; end
# Contains information about card networks that can be used to process the payment.
sig { returns(T.nilable(Networks)) }
def networks; end
# Status of a card based on the card issuer.
sig { returns(T.nilable(String)) }
def regulated_status; end
# Contains details on how this Card may be used for 3D Secure authentication.
sig { returns(T.nilable(ThreeDSecureUsage)) }
def three_d_secure_usage; end
# If this Card is part of a card wallet, this contains the details of the card wallet.
sig { returns(T.nilable(Wallet)) }
def wallet; end
end
class CardPresent < Stripe::StripeObject
class Networks < Stripe::StripeObject
# All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).
sig { returns(T::Array[String]) }
def available; end
# The preferred network for the card.
sig { returns(T.nilable(String)) }
def preferred; end
end
class Offline < Stripe::StripeObject
# Time at which the payment was collected while offline
sig { returns(T.nilable(Integer)) }
def stored_at; end
# The method used to process this payment method offline. Only deferred is allowed.
sig { returns(T.nilable(String)) }
def type; end
end
class Wallet < Stripe::StripeObject
# The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.
sig { returns(String) }
def type; end
end
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(T.nilable(String)) }
def brand; end
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.
sig { returns(T.nilable(String)) }
def brand_product; end
# The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
sig { returns(T.nilable(String)) }
def cardholder_name; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
# Contains information about card networks that can be used to process the payment.
sig { returns(T.nilable(Networks)) }
def networks; end
# Details about payment methods collected offline.
sig { returns(T.nilable(Offline)) }
def offline; end
# The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
# How card details were read in this transaction.
sig { returns(T.nilable(String)) }
def read_method; end
# Attribute for field wallet
sig { returns(T.nilable(Wallet)) }
def wallet; end
end
class Cashapp < Stripe::StripeObject
# A unique and immutable identifier assigned by Cash App to every buyer.
sig { returns(T.nilable(String)) }
def buyer_id; end
# A public identifier for buyers using Cash App.
sig { returns(T.nilable(String)) }
def cashtag; end
end
class Crypto < Stripe::StripeObject; end
class CustomerBalance < Stripe::StripeObject; end
class Eps < Stripe::StripeObject
# The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.
sig { returns(T.nilable(String)) }
def bank; end
end
class Fpx < Stripe::StripeObject
# Account holder type, if provided. Can be one of `individual` or `company`.
sig { returns(T.nilable(String)) }
def account_holder_type; end
# The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
sig { returns(String) }
def bank; end
end
class Giropay < Stripe::StripeObject; end
class Gopay < Stripe::StripeObject; end
class Grabpay < Stripe::StripeObject; end
class IdBankTransfer < Stripe::StripeObject
# Attribute for field bank
sig { returns(T.nilable(String)) }
def bank; end
# Attribute for field bank_code
sig { returns(T.nilable(String)) }
def bank_code; end
# Attribute for field bank_name
sig { returns(T.nilable(String)) }
def bank_name; end
# Attribute for field display_name
sig { returns(T.nilable(String)) }
def display_name; end
end
class Ideal < Stripe::StripeObject
# The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
sig { returns(T.nilable(String)) }
def bank; end
# The Bank Identifier Code of the customer's bank, if the bank was provided.
sig { returns(T.nilable(String)) }
def bic; end
end
class InteracPresent < Stripe::StripeObject
class Networks < Stripe::StripeObject
# All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).
sig { returns(T::Array[String]) }
def available; end
# The preferred network for the card.
sig { returns(T.nilable(String)) }
def preferred; end
end
# Card brand. Can be `interac`, `mastercard` or `visa`.
sig { returns(T.nilable(String)) }
def brand; end
# The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
sig { returns(T.nilable(String)) }
def cardholder_name; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
# Contains information about card networks that can be used to process the payment.
sig { returns(T.nilable(Networks)) }
def networks; end
# The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
# How card details were read in this transaction.
sig { returns(T.nilable(String)) }
def read_method; end
end
class KakaoPay < Stripe::StripeObject; end
class Klarna < Stripe::StripeObject
class Dob < Stripe::StripeObject
# The day of birth, between 1 and 31.
sig { returns(T.nilable(Integer)) }
def day; end
# The month of birth, between 1 and 12.
sig { returns(T.nilable(Integer)) }
def month; end
# The four-digit year of birth.
sig { returns(T.nilable(Integer)) }
def year; end
end
# The customer's date of birth, if provided.
sig { returns(T.nilable(Dob)) }
def dob; end
end
class Konbini < Stripe::StripeObject; end
class KrCard < Stripe::StripeObject
# The local credit or debit card brand.
sig { returns(T.nilable(String)) }
def brand; end
# The last four digits of the card. This may not be present for American Express cards.
sig { returns(T.nilable(String)) }
def last4; end
end
class Link < Stripe::StripeObject
# Account owner's email address.
sig { returns(T.nilable(String)) }
def email; end
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
end
class MbWay < Stripe::StripeObject; end
class Mobilepay < Stripe::StripeObject; end
class Multibanco < Stripe::StripeObject; end
class NaverPay < Stripe::StripeObject
# Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.
sig { returns(T.nilable(String)) }
def buyer_id; end
# Whether to fund this transaction with Naver Pay points or a card.
sig { returns(String) }
def funding; end
end
class NzBankAccount < Stripe::StripeObject
# The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
# The name of the bank.
sig { returns(String) }
def bank_name; end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
# Last four digits of the bank account number.
sig { returns(String) }
def last4; end
# The suffix of the bank account number.
sig { returns(T.nilable(String)) }
def suffix; end
end
class Oxxo < Stripe::StripeObject; end
class P24 < Stripe::StripeObject
# The customer's bank, if provided.
sig { returns(T.nilable(String)) }
def bank; end
end
class PayByBank < Stripe::StripeObject; end
class Payco < Stripe::StripeObject; end
class Paynow < Stripe::StripeObject; end
class Paypal < Stripe::StripeObject
# Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def country; end
# Uniquely identifies this particular PayPal account. You can use this attribute to check whether two PayPal accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Owner's email. Values are provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def payer_email; end
# PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
sig { returns(T.nilable(String)) }
def payer_id; end
# Owner's verified email. Values are verified or provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_email; end
end
class Paypay < Stripe::StripeObject; end
class Payto < Stripe::StripeObject
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
end
class Pix < Stripe::StripeObject; end
class Promptpay < Stripe::StripeObject; end
class Qris < Stripe::StripeObject; end
class RadarOptions < Stripe::StripeObject
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
end
class Rechnung < Stripe::StripeObject
class Dob < Stripe::StripeObject
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
end
# Attribute for field dob
sig { returns(T.nilable(Dob)) }
def dob; end
end
class RevolutPay < Stripe::StripeObject; end
class SamsungPay < Stripe::StripeObject; end
class Satispay < Stripe::StripeObject; end
class SepaDebit < Stripe::StripeObject
class GeneratedFrom < Stripe::StripeObject
# The ID of the Charge that generated this PaymentMethod, if any.
sig { returns(T.nilable(T.any(String, Stripe::Charge))) }
def charge; end
# The ID of the SetupAttempt that generated this PaymentMethod, if any.
sig { returns(T.nilable(T.any(String, Stripe::SetupAttempt))) }
def setup_attempt; end
end
# Bank code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_code; end
# Branch code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def branch_code; end
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(T.nilable(String)) }
def country; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Information about the object that generated this PaymentMethod.
sig { returns(T.nilable(GeneratedFrom)) }
def generated_from; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def last4; end
end
class Shopeepay < Stripe::StripeObject; end
class Sofort < Stripe::StripeObject
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(T.nilable(String)) }
def country; end
end
class StripeBalance < Stripe::StripeObject
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(String) }
def source_type; end
end
class Swish < Stripe::StripeObject; end
class Twint < Stripe::StripeObject; end
class UsBankAccount < Stripe::StripeObject
class Networks < Stripe::StripeObject
# The preferred network.
sig { returns(T.nilable(String)) }
def preferred; end
# All supported networks.
sig { returns(T::Array[String]) }
def supported; end
end
class StatusDetails < Stripe::StripeObject
class Blocked < Stripe::StripeObject
# The ACH network code that resulted in this block.
sig { returns(T.nilable(String)) }
def network_code; end
# The reason why this PaymentMethod's fingerprint has been blocked
sig { returns(T.nilable(String)) }
def reason; end
end
# Attribute for field blocked
sig { returns(T.nilable(Blocked)) }
def blocked; end
end
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
# The name of the bank.
sig { returns(T.nilable(String)) }
def bank_name; end
# The ID of the Financial Connections Account used to create the payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# Contains information about US bank account networks that can be used.
sig { returns(T.nilable(Networks)) }
def networks; end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
# Contains information about the future reusability of this PaymentMethod.
sig { returns(T.nilable(StatusDetails)) }
def status_details; end
end
class WechatPay < Stripe::StripeObject; end
class Zip < Stripe::StripeObject; end
# Attribute for field acss_debit
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# Attribute for field affirm
sig { returns(T.nilable(Affirm)) }
def affirm; end
# Attribute for field afterpay_clearpay
sig { returns(T.nilable(AfterpayClearpay)) }
def afterpay_clearpay; end
# Attribute for field alipay
sig { returns(T.nilable(Alipay)) }
def alipay; end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
# Attribute for field alma
sig { returns(T.nilable(Alma)) }
def alma; end
# Attribute for field amazon_pay
sig { returns(T.nilable(AmazonPay)) }
def amazon_pay; end
# Attribute for field au_becs_debit
sig { returns(T.nilable(AuBecsDebit)) }
def au_becs_debit; end
# Attribute for field bacs_debit
sig { returns(T.nilable(BacsDebit)) }
def bacs_debit; end
# Attribute for field bancontact
sig { returns(T.nilable(Bancontact)) }
def bancontact; end
# Attribute for field billie
sig { returns(T.nilable(Billie)) }
def billie; end
# Attribute for field billing_details
sig { returns(BillingDetails) }
def billing_details; end
# Attribute for field blik
sig { returns(T.nilable(Blik)) }
def blik; end
# Attribute for field boleto
sig { returns(T.nilable(Boleto)) }
def boleto; end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# Attribute for field card_present
sig { returns(T.nilable(CardPresent)) }
def card_present; end
# Attribute for field cashapp
sig { returns(T.nilable(Cashapp)) }
def cashapp; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Attribute for field crypto
sig { returns(T.nilable(Crypto)) }
def crypto; end
# The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# Attribute for field customer_account
sig { returns(T.nilable(String)) }
def customer_account; end
# Attribute for field customer_balance
sig { returns(T.nilable(CustomerBalance)) }
def customer_balance; end
# Attribute for field eps
sig { returns(T.nilable(Eps)) }
def eps; end
# Attribute for field fpx
sig { returns(T.nilable(Fpx)) }
def fpx; end
# Attribute for field giropay
sig { returns(T.nilable(Giropay)) }
def giropay; end
# Attribute for field gopay
sig { returns(T.nilable(Gopay)) }
def gopay; end
# Attribute for field grabpay
sig { returns(T.nilable(Grabpay)) }
def grabpay; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Attribute for field id_bank_transfer
sig { returns(T.nilable(IdBankTransfer)) }
def id_bank_transfer; end
# Attribute for field ideal
sig { returns(T.nilable(Ideal)) }
def ideal; end
# Attribute for field interac_present
sig { returns(T.nilable(InteracPresent)) }
def interac_present; end
# Attribute for field kakao_pay
sig { returns(T.nilable(KakaoPay)) }
def kakao_pay; end
# Attribute for field klarna
sig { returns(T.nilable(Klarna)) }
def klarna; end
# Attribute for field konbini
sig { returns(T.nilable(Konbini)) }
def konbini; end
# Attribute for field kr_card
sig { returns(T.nilable(KrCard)) }
def kr_card; end
# The Mandate object of the most recently created Mandate associated with this payment method
sig { returns(T.nilable(Stripe::Mandate)) }
def latest_active_mandate; end
# Attribute for field link
sig { returns(T.nilable(Link)) }
def link; end
# 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) }
def livemode; end
# Attribute for field mb_way
sig { returns(T.nilable(MbWay)) }
def mb_way; end
# 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])) }
def metadata; end
# Attribute for field mobilepay
sig { returns(T.nilable(Mobilepay)) }
def mobilepay; end
# Attribute for field multibanco
sig { returns(T.nilable(Multibanco)) }
def multibanco; end
# Attribute for field naver_pay
sig { returns(T.nilable(NaverPay)) }
def naver_pay; end
# Attribute for field nz_bank_account
sig { returns(T.nilable(NzBankAccount)) }
def nz_bank_account; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Attribute for field oxxo
sig { returns(T.nilable(Oxxo)) }
def oxxo; end
# Attribute for field p24
sig { returns(T.nilable(P24)) }
def p24; end
# Attribute for field pay_by_bank
sig { returns(T.nilable(PayByBank)) }
def pay_by_bank; end
# Attribute for field payco
sig { returns(T.nilable(Payco)) }
def payco; end
# Attribute for field paynow
sig { returns(T.nilable(Paynow)) }
def paynow; end
# Attribute for field paypal
sig { returns(T.nilable(Paypal)) }
def paypal; end
# Attribute for field paypay
sig { returns(T.nilable(Paypay)) }
def paypay; end
# Attribute for field payto
sig { returns(T.nilable(Payto)) }
def payto; end
# Attribute for field pix
sig { returns(T.nilable(Pix)) }
def pix; end
# Attribute for field promptpay
sig { returns(T.nilable(Promptpay)) }
def promptpay; end
# Attribute for field qris
sig { returns(T.nilable(Qris)) }
def qris; end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig { returns(T.nilable(RadarOptions)) }
def radar_options; end
# Attribute for field rechnung
sig { returns(T.nilable(Rechnung)) }
def rechnung; end
# Attribute for field revolut_pay
sig { returns(T.nilable(RevolutPay)) }
def revolut_pay; end
# Attribute for field samsung_pay
sig { returns(T.nilable(SamsungPay)) }
def samsung_pay; end
# Attribute for field satispay
sig { returns(T.nilable(Satispay)) }
def satispay; end
# Attribute for field sepa_debit
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# Attribute for field shopeepay
sig { returns(T.nilable(Shopeepay)) }
def shopeepay; end
# Attribute for field sofort
sig { returns(T.nilable(Sofort)) }
def sofort; end
# Attribute for field stripe_balance
sig { returns(T.nilable(StripeBalance)) }
def stripe_balance; end
# Attribute for field swish
sig { returns(T.nilable(Swish)) }
def swish; end
# Attribute for field twint
sig { returns(T.nilable(Twint)) }
def twint; end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
# Attribute for field us_bank_account
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
# Attribute for field wechat_pay
sig { returns(T.nilable(WechatPay)) }
def wechat_pay; end
# Attribute for field zip
sig { returns(T.nilable(Zip)) }
def zip; end
class ListParams < Stripe::RequestParams
# The ID of the customer whose PaymentMethods will be retrieved.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
customer: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
type: nil
); end
end
class CreateParams < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Institution number of the customer's bank.
sig { returns(String) }
def institution_number; end
sig { params(_institution_number: String).returns(String) }
def institution_number=(_institution_number); end
# Transit number of the customer's bank.
sig { returns(String) }
def transit_number; end
sig { params(_transit_number: String).returns(String) }
def transit_number=(_transit_number); end
sig {
params(account_number: String, institution_number: String, transit_number: String).void
}
def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(String) }
def bsb_number; end
sig { params(_bsb_number: String).returns(String) }
def bsb_number=(_bsb_number); end
sig { params(account_number: String, bsb_number: String).void }
def initialize(account_number: nil, bsb_number: nil); end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
sig { params(_sort_code: T.nilable(String)).returns(T.nilable(String)) }
def sort_code=(_sort_code); end
sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
def initialize(account_number: nil, sort_code: nil); end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentMethod::CreateParams::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::PaymentMethod::CreateParams::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::PaymentMethod::CreateParams::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::PaymentMethod::CreateParams::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
sig { params(_tax_id: String).returns(String) }
def tax_id=(_tax_id); end
sig { params(tax_id: String).void }
def initialize(tax_id: nil); end
end
class Card < Stripe::RequestParams
class Networks < Stripe::RequestParams
# The customer's preferred card network for co-branded cards. Supports `cartes_bancaires`, `mastercard`, or `visa`. Selection of a network that does not apply to the card will be stored as `invalid_preference` on the card.
sig { returns(T.nilable(String)) }
def preferred; end
sig { params(_preferred: T.nilable(String)).returns(T.nilable(String)) }
def preferred=(_preferred); end
sig { params(preferred: T.nilable(String)).void }
def initialize(preferred: nil); end
end
# The card's CVC. It is highly recommended to always include this value.
sig { returns(T.nilable(String)) }
def cvc; end
sig { params(_cvc: T.nilable(String)).returns(T.nilable(String)) }
def cvc=(_cvc); end
# Two-digit number representing the card's expiration month.
sig { returns(T.nilable(Integer)) }
def exp_month; end
sig { params(_exp_month: T.nilable(Integer)).returns(T.nilable(Integer)) }
def exp_month=(_exp_month); end
# Four-digit number representing the card's expiration year.
sig { returns(T.nilable(Integer)) }
def exp_year; end
sig { params(_exp_year: T.nilable(Integer)).returns(T.nilable(Integer)) }
def exp_year=(_exp_year); end
# Contains information about card networks used to process the payment.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Card::Networks)) }
def networks; end
sig {
params(_networks: T.nilable(::Stripe::PaymentMethod::CreateParams::Card::Networks)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Card::Networks))
}
def networks=(_networks); end
# The card number, as a string without any separators.
sig { returns(T.nilable(String)) }
def number; end
sig { params(_number: T.nilable(String)).returns(T.nilable(String)) }
def number=(_number); end
# For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format card: {token: "tok_visa"}.
sig { returns(T.nilable(String)) }
def token; end
sig { params(_token: T.nilable(String)).returns(T.nilable(String)) }
def token=(_token); end
sig {
params(cvc: T.nilable(String), exp_month: T.nilable(Integer), exp_year: T.nilable(Integer), networks: T.nilable(::Stripe::PaymentMethod::CreateParams::Card::Networks), number: T.nilable(String), token: T.nilable(String)).void
}
def initialize(
cvc: nil,
exp_month: nil,
exp_year: nil,
networks: nil,
number: nil,
token: nil
); end
end
class Cashapp < Stripe::RequestParams; end
class Crypto < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The customer's bank.
sig { returns(String) }
def bank; end
sig { params(_bank: String).returns(String) }
def bank=(_bank); end
sig { params(account_holder_type: T.nilable(String), bank: String).void }
def initialize(account_holder_type: nil, bank: nil); end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Klarna::Dob)) }
def dob; end
sig {
params(_dob: T.nilable(::Stripe::PaymentMethod::CreateParams::Klarna::Dob)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Klarna::Dob))
}
def dob=(_dob); end
sig { params(dob: T.nilable(::Stripe::PaymentMethod::CreateParams::Klarna::Dob)).void }
def initialize(dob: nil); end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
sig { returns(T.nilable(String)) }
def funding; end
sig { params(_funding: T.nilable(String)).returns(T.nilable(String)) }
def funding=(_funding); end
sig { params(funding: T.nilable(String)).void }
def initialize(funding: nil); end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
sig { params(_bank_code: String).returns(String) }
def bank_code=(_bank_code); end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
sig { params(_branch_code: String).returns(String) }
def branch_code=(_branch_code); end
# Attribute for param field reference
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# The suffix of the bank account number.
sig { returns(String) }
def suffix; end
sig { params(_suffix: String).returns(String) }
def suffix=(_suffix); end
sig {
params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
); end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Paypay < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig { returns(::Stripe::PaymentMethod::CreateParams::Rechnung::Dob) }
def dob; end
sig {
params(_dob: ::Stripe::PaymentMethod::CreateParams::Rechnung::Dob).returns(::Stripe::PaymentMethod::CreateParams::Rechnung::Dob)
}
def dob=(_dob); end
sig { params(dob: ::Stripe::PaymentMethod::CreateParams::Rechnung::Dob).void }
def initialize(dob: nil); end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
sig { returns(String) }
def iban; end
sig { params(_iban: String).returns(String) }
def iban=(_iban); end
sig { params(iban: String).void }
def initialize(iban: nil); end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
sig { params(account: T.nilable(String), source_type: T.nilable(String)).void }
def initialize(account: nil, source_type: nil); end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig { params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String)) }
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::AcssDebit)) }
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::PaymentMethod::CreateParams::AcssDebit)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Affirm)) }
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::PaymentMethod::CreateParams::Affirm)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Affirm))
}
def affirm=(_affirm); end
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::AfterpayClearpay)) }
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::PaymentMethod::CreateParams::AfterpayClearpay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Alipay)) }
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::PaymentMethod::CreateParams::Alipay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Alipay))
}
def alipay=(_alipay); end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Alma)) }
def alma; end
sig {
params(_alma: T.nilable(::Stripe::PaymentMethod::CreateParams::Alma)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Alma))
}
def alma=(_alma); end
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::AmazonPay)) }
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::PaymentMethod::CreateParams::AmazonPay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::AuBecsDebit)) }
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::PaymentMethod::CreateParams::AuBecsDebit)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::BacsDebit)) }
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::PaymentMethod::CreateParams::BacsDebit)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Bancontact)) }
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::PaymentMethod::CreateParams::Bancontact)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Bancontact))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Billie)) }
def billie; end
sig {
params(_billie: T.nilable(::Stripe::PaymentMethod::CreateParams::Billie)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Billie))
}
def billie=(_billie); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::BillingDetails)) }
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::PaymentMethod::CreateParams::BillingDetails)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Blik)) }
def blik; end
sig {
params(_blik: T.nilable(::Stripe::PaymentMethod::CreateParams::Blik)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Blik))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Boleto)) }
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::PaymentMethod::CreateParams::Boleto)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Boleto))
}
def boleto=(_boleto); end
# If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Card)) }
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentMethod::CreateParams::Card)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Card))
}
def card=(_card); end
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Cashapp)) }
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::PaymentMethod::CreateParams::Cashapp)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Cashapp))
}
def cashapp=(_cashapp); end
# If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Crypto)) }
def crypto; end
sig {
params(_crypto: T.nilable(::Stripe::PaymentMethod::CreateParams::Crypto)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Crypto))
}
def crypto=(_crypto); end
# The `Customer` to whom the original PaymentMethod is attached.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::CustomerBalance)) }
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::PaymentMethod::CreateParams::CustomerBalance)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Eps)) }
def eps; end
sig {
params(_eps: T.nilable(::Stripe::PaymentMethod::CreateParams::Eps)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Eps))
}
def eps=(_eps); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Fpx)) }
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::PaymentMethod::CreateParams::Fpx)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Fpx))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Giropay)) }
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::PaymentMethod::CreateParams::Giropay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Giropay))
}
def giropay=(_giropay); end
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Gopay)) }
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::PaymentMethod::CreateParams::Gopay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Gopay))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Grabpay)) }
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::PaymentMethod::CreateParams::Grabpay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Grabpay))
}
def grabpay=(_grabpay); end
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::IdBankTransfer)) }
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::PaymentMethod::CreateParams::IdBankTransfer)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Ideal)) }
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::PaymentMethod::CreateParams::Ideal)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Ideal))
}
def ideal=(_ideal); end
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::InteracPresent)) }
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::PaymentMethod::CreateParams::InteracPresent)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::InteracPresent))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::KakaoPay)) }
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::PaymentMethod::CreateParams::KakaoPay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Klarna)) }
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentMethod::CreateParams::Klarna)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Klarna))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Konbini)) }
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::PaymentMethod::CreateParams::Konbini)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Konbini))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::KrCard)) }
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::PaymentMethod::CreateParams::KrCard)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::KrCard))
}
def kr_card=(_kr_card); end
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Link)) }
def link; end
sig {
params(_link: T.nilable(::Stripe::PaymentMethod::CreateParams::Link)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Link))
}
def link=(_link); end
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::MbWay)) }
def mb_way; end
sig {
params(_mb_way: T.nilable(::Stripe::PaymentMethod::CreateParams::MbWay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::MbWay))
}
def mb_way=(_mb_way); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Mobilepay)) }
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::PaymentMethod::CreateParams::Mobilepay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Mobilepay))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Multibanco)) }
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::PaymentMethod::CreateParams::Multibanco)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Multibanco))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::NaverPay)) }
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::PaymentMethod::CreateParams::NaverPay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::NaverPay))
}
def naver_pay=(_naver_pay); end
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::NzBankAccount)) }
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::PaymentMethod::CreateParams::NzBankAccount)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Oxxo)) }
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::PaymentMethod::CreateParams::Oxxo)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Oxxo))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::P24)) }
def p24; end
sig {
params(_p24: T.nilable(::Stripe::PaymentMethod::CreateParams::P24)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::P24))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::PayByBank)) }
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::PaymentMethod::CreateParams::PayByBank)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Payco)) }
def payco; end
sig {
params(_payco: T.nilable(::Stripe::PaymentMethod::CreateParams::Payco)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Payco))
}
def payco=(_payco); end
# The PaymentMethod to share.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Paynow)) }
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::PaymentMethod::CreateParams::Paynow)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Paynow))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Paypal)) }
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentMethod::CreateParams::Paypal)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Paypal))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Paypay)) }
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::PaymentMethod::CreateParams::Paypay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Paypay))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Payto)) }
def payto; end
sig {
params(_payto: T.nilable(::Stripe::PaymentMethod::CreateParams::Payto)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Payto))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Pix)) }
def pix; end
sig {
params(_pix: T.nilable(::Stripe::PaymentMethod::CreateParams::Pix)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Pix))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Promptpay)) }
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::PaymentMethod::CreateParams::Promptpay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Promptpay))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Qris)) }
def qris; end
sig {
params(_qris: T.nilable(::Stripe::PaymentMethod::CreateParams::Qris)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Qris))
}
def qris=(_qris); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::RadarOptions)) }
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::PaymentMethod::CreateParams::RadarOptions)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::RadarOptions))
}
def radar_options=(_radar_options); end
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Rechnung)) }
def rechnung; end
sig {
params(_rechnung: T.nilable(::Stripe::PaymentMethod::CreateParams::Rechnung)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Rechnung))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::RevolutPay)) }
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::PaymentMethod::CreateParams::RevolutPay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::SamsungPay)) }
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::PaymentMethod::CreateParams::SamsungPay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Satispay)) }
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::PaymentMethod::CreateParams::Satispay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Satispay))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::SepaDebit)) }
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::PaymentMethod::CreateParams::SepaDebit)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Shopeepay)) }
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::PaymentMethod::CreateParams::Shopeepay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Shopeepay))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Sofort)) }
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::PaymentMethod::CreateParams::Sofort)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Sofort))
}
def sofort=(_sofort); end
# This hash contains details about the Stripe balance payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::StripeBalance)) }
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::PaymentMethod::CreateParams::StripeBalance)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Swish)) }
def swish; end
sig {
params(_swish: T.nilable(::Stripe::PaymentMethod::CreateParams::Swish)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Swish))
}
def swish=(_swish); end
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Twint)) }
def twint; end
sig {
params(_twint: T.nilable(::Stripe::PaymentMethod::CreateParams::Twint)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Twint))
}
def twint=(_twint); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::UsBankAccount)) }
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::PaymentMethod::CreateParams::UsBankAccount)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::WechatPay)) }
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::PaymentMethod::CreateParams::WechatPay)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Zip)) }
def zip; end
sig {
params(_zip: T.nilable(::Stripe::PaymentMethod::CreateParams::Zip)).returns(T.nilable(::Stripe::PaymentMethod::CreateParams::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::PaymentMethod::CreateParams::AcssDebit), affirm: T.nilable(::Stripe::PaymentMethod::CreateParams::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentMethod::CreateParams::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentMethod::CreateParams::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::PaymentMethod::CreateParams::Alma), amazon_pay: T.nilable(::Stripe::PaymentMethod::CreateParams::AmazonPay), au_becs_debit: T.nilable(::Stripe::PaymentMethod::CreateParams::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentMethod::CreateParams::BacsDebit), bancontact: T.nilable(::Stripe::PaymentMethod::CreateParams::Bancontact), billie: T.nilable(::Stripe::PaymentMethod::CreateParams::Billie), billing_details: T.nilable(::Stripe::PaymentMethod::CreateParams::BillingDetails), blik: T.nilable(::Stripe::PaymentMethod::CreateParams::Blik), boleto: T.nilable(::Stripe::PaymentMethod::CreateParams::Boleto), card: T.nilable(::Stripe::PaymentMethod::CreateParams::Card), cashapp: T.nilable(::Stripe::PaymentMethod::CreateParams::Cashapp), crypto: T.nilable(::Stripe::PaymentMethod::CreateParams::Crypto), customer: T.nilable(String), customer_balance: T.nilable(::Stripe::PaymentMethod::CreateParams::CustomerBalance), eps: T.nilable(::Stripe::PaymentMethod::CreateParams::Eps), expand: T.nilable(T::Array[String]), fpx: T.nilable(::Stripe::PaymentMethod::CreateParams::Fpx), giropay: T.nilable(::Stripe::PaymentMethod::CreateParams::Giropay), gopay: T.nilable(::Stripe::PaymentMethod::CreateParams::Gopay), grabpay: T.nilable(::Stripe::PaymentMethod::CreateParams::Grabpay), id_bank_transfer: T.nilable(::Stripe::PaymentMethod::CreateParams::IdBankTransfer), ideal: T.nilable(::Stripe::PaymentMethod::CreateParams::Ideal), interac_present: T.nilable(::Stripe::PaymentMethod::CreateParams::InteracPresent), kakao_pay: T.nilable(::Stripe::PaymentMethod::CreateParams::KakaoPay), klarna: T.nilable(::Stripe::PaymentMethod::CreateParams::Klarna), konbini: T.nilable(::Stripe::PaymentMethod::CreateParams::Konbini), kr_card: T.nilable(::Stripe::PaymentMethod::CreateParams::KrCard), link: T.nilable(::Stripe::PaymentMethod::CreateParams::Link), mb_way: T.nilable(::Stripe::PaymentMethod::CreateParams::MbWay), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::PaymentMethod::CreateParams::Mobilepay), multibanco: T.nilable(::Stripe::PaymentMethod::CreateParams::Multibanco), naver_pay: T.nilable(::Stripe::PaymentMethod::CreateParams::NaverPay), nz_bank_account: T.nilable(::Stripe::PaymentMethod::CreateParams::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentMethod::CreateParams::Oxxo), p24: T.nilable(::Stripe::PaymentMethod::CreateParams::P24), pay_by_bank: T.nilable(::Stripe::PaymentMethod::CreateParams::PayByBank), payco: T.nilable(::Stripe::PaymentMethod::CreateParams::Payco), payment_method: T.nilable(String), paynow: T.nilable(::Stripe::PaymentMethod::CreateParams::Paynow), paypal: T.nilable(::Stripe::PaymentMethod::CreateParams::Paypal), paypay: T.nilable(::Stripe::PaymentMethod::CreateParams::Paypay), payto: T.nilable(::Stripe::PaymentMethod::CreateParams::Payto), pix: T.nilable(::Stripe::PaymentMethod::CreateParams::Pix), promptpay: T.nilable(::Stripe::PaymentMethod::CreateParams::Promptpay), qris: T.nilable(::Stripe::PaymentMethod::CreateParams::Qris), radar_options: T.nilable(::Stripe::PaymentMethod::CreateParams::RadarOptions), rechnung: T.nilable(::Stripe::PaymentMethod::CreateParams::Rechnung), revolut_pay: T.nilable(::Stripe::PaymentMethod::CreateParams::RevolutPay), samsung_pay: T.nilable(::Stripe::PaymentMethod::CreateParams::SamsungPay), satispay: T.nilable(::Stripe::PaymentMethod::CreateParams::Satispay), sepa_debit: T.nilable(::Stripe::PaymentMethod::CreateParams::SepaDebit), shopeepay: T.nilable(::Stripe::PaymentMethod::CreateParams::Shopeepay), sofort: T.nilable(::Stripe::PaymentMethod::CreateParams::Sofort), stripe_balance: T.nilable(::Stripe::PaymentMethod::CreateParams::StripeBalance), swish: T.nilable(::Stripe::PaymentMethod::CreateParams::Swish), twint: T.nilable(::Stripe::PaymentMethod::CreateParams::Twint), type: T.nilable(String), us_bank_account: T.nilable(::Stripe::PaymentMethod::CreateParams::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentMethod::CreateParams::WechatPay), zip: T.nilable(::Stripe::PaymentMethod::CreateParams::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
card: nil,
cashapp: nil,
crypto: nil,
customer: nil,
customer_balance: nil,
eps: nil,
expand: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
payment_method: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class UpdateParams < Stripe::RequestParams
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentMethod::UpdateParams::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::PaymentMethod::UpdateParams::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::PaymentMethod::UpdateParams::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::PaymentMethod::UpdateParams::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Card < Stripe::RequestParams
class Networks < Stripe::RequestParams
# The customer's preferred card network for co-branded cards. Supports `cartes_bancaires`, `mastercard`, or `visa`. Selection of a network that does not apply to the card will be stored as `invalid_preference` on the card.
sig { returns(T.nilable(T.any(String, String))) }
def preferred; end
sig {
params(_preferred: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred=(_preferred); end
sig { params(preferred: T.nilable(T.any(String, String))).void }
def initialize(preferred: nil); end
end
# Two-digit number representing the card's expiration month.
sig { returns(T.nilable(Integer)) }
def exp_month; end
sig { params(_exp_month: T.nilable(Integer)).returns(T.nilable(Integer)) }
def exp_month=(_exp_month); end
# Four-digit number representing the card's expiration year.
sig { returns(T.nilable(Integer)) }
def exp_year; end
sig { params(_exp_year: T.nilable(Integer)).returns(T.nilable(Integer)) }
def exp_year=(_exp_year); end
# Contains information about card networks used to process the payment.
sig { returns(T.nilable(::Stripe::PaymentMethod::UpdateParams::Card::Networks)) }
def networks; end
sig {
params(_networks: T.nilable(::Stripe::PaymentMethod::UpdateParams::Card::Networks)).returns(T.nilable(::Stripe::PaymentMethod::UpdateParams::Card::Networks))
}
def networks=(_networks); end
sig {
params(exp_month: T.nilable(Integer), exp_year: T.nilable(Integer), networks: T.nilable(::Stripe::PaymentMethod::UpdateParams::Card::Networks)).void
}
def initialize(exp_month: nil, exp_year: nil, networks: nil); end
end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class UsBankAccount < Stripe::RequestParams
# Bank account holder type.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Bank account type.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
sig { params(account_holder_type: T.nilable(String), account_type: T.nilable(String)).void }
def initialize(account_holder_type: nil, account_type: nil); end
end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig { returns(T.nilable(::Stripe::PaymentMethod::UpdateParams::BillingDetails)) }
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::PaymentMethod::UpdateParams::BillingDetails)).returns(T.nilable(::Stripe::PaymentMethod::UpdateParams::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `card` PaymentMethod, this hash contains the user's card details.
sig { returns(T.nilable(::Stripe::PaymentMethod::UpdateParams::Card)) }
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentMethod::UpdateParams::Card)).returns(T.nilable(::Stripe::PaymentMethod::UpdateParams::Card))
}
def card=(_card); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::UpdateParams::Payto)) }
def payto; end
sig {
params(_payto: T.nilable(::Stripe::PaymentMethod::UpdateParams::Payto)).returns(T.nilable(::Stripe::PaymentMethod::UpdateParams::Payto))
}
def payto=(_payto); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig { returns(T.nilable(::Stripe::PaymentMethod::UpdateParams::UsBankAccount)) }
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::PaymentMethod::UpdateParams::UsBankAccount)).returns(T.nilable(::Stripe::PaymentMethod::UpdateParams::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
sig {
params(allow_redisplay: T.nilable(String), billing_details: T.nilable(::Stripe::PaymentMethod::UpdateParams::BillingDetails), card: T.nilable(::Stripe::PaymentMethod::UpdateParams::Card), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), payto: T.nilable(::Stripe::PaymentMethod::UpdateParams::Payto), us_bank_account: T.nilable(::Stripe::PaymentMethod::UpdateParams::UsBankAccount)).void
}
def initialize(
allow_redisplay: nil,
billing_details: nil,
card: nil,
expand: nil,
metadata: nil,
payto: nil,
us_bank_account: nil
); end
end
class AttachParams < Stripe::RequestParams
# The ID of the customer to which to attach the PaymentMethod.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The ID of the account to which to attach the PaymentMethod.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(customer: T.nilable(String), customer_account: T.nilable(String), expand: T.nilable(T::Array[String])).void
}
def initialize(customer: nil, customer_account: nil, expand: nil); end
end
class DetachParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Attaches a PaymentMethod object to a Customer.
#
# To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://docs.stripe.com/docs/api/setup_intents)
# or a PaymentIntent with [setup_future_usage](https://docs.stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage).
# These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach
# endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for
# future use, which makes later declines and payment friction more likely.
# See [Optimizing cards for future payments](https://docs.stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up
# future payments.
#
# To use this PaymentMethod as the default for invoice or subscription payments,
# set [invoice_settings.default_payment_method](https://docs.stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method),
# on the Customer to the PaymentMethod's ID.
sig {
params(params: T.any(::Stripe::PaymentMethod::AttachParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
}
def attach(params = {}, opts = {}); end
# Attaches a PaymentMethod object to a Customer.
#
# To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://docs.stripe.com/docs/api/setup_intents)
# or a PaymentIntent with [setup_future_usage](https://docs.stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage).
# These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach
# endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for
# future use, which makes later declines and payment friction more likely.
# See [Optimizing cards for future payments](https://docs.stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up
# future payments.
#
# To use this PaymentMethod as the default for invoice or subscription payments,
# set [invoice_settings.default_payment_method](https://docs.stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method),
# on the Customer to the PaymentMethod's ID.
sig {
params(payment_method: String, params: T.any(::Stripe::PaymentMethod::AttachParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
}
def self.attach(payment_method, params = {}, opts = {}); end
# Creates a PaymentMethod object. Read the [Stripe.js reference](https://docs.stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js.
#
# Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the SetupIntent](https://docs.stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment.
sig {
params(params: T.any(::Stripe::PaymentMethod::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
}
def self.create(params = {}, opts = {}); end
# Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.
sig {
params(params: T.any(::Stripe::PaymentMethod::DetachParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
}
def detach(params = {}, opts = {}); end
# Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.
sig {
params(payment_method: String, params: T.any(::Stripe::PaymentMethod::DetachParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
}
def self.detach(payment_method, params = {}, opts = {}); end
# Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer_list) API instead.
sig {
params(params: T.any(::Stripe::PaymentMethod::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.
sig {
params(payment_method: String, params: T.any(::Stripe::PaymentMethod::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
}
def self.update(payment_method, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# A Payment Record is a resource that allows you to represent payments that occur on- or off-Stripe.
# For example, you can create a Payment Record to model a payment made on a different payment processor,
# in order to mark an Invoice as paid and a Subscription as active. Payment Records consist of one or
# more Payment Attempt Records, which represent individual attempts made on a payment network.
class PaymentRecord < APIResource
class Amount < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
sig { returns(Integer) }
def value; end
end
class AmountAuthorized < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
sig { returns(Integer) }
def value; end
end
class AmountCanceled < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
sig { returns(Integer) }
def value; end
end
class AmountFailed < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
sig { returns(Integer) }
def value; end
end
class AmountGuaranteed < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
sig { returns(Integer) }
def value; end
end
class AmountRefunded < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
sig { returns(Integer) }
def value; end
end
class AmountRequested < Stripe::StripeObject
# 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) }
def currency; end
# A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
sig { returns(Integer) }
def value; end
end
class CustomerDetails < Stripe::StripeObject
# ID of the Stripe Customer associated with this payment.
sig { returns(T.nilable(String)) }
def customer; end
# The customer's email address.
sig { returns(T.nilable(String)) }
def email; end
# The customer's name.
sig { returns(T.nilable(String)) }
def name; end
# The customer's phone number.
sig { returns(T.nilable(String)) }
def phone; end
end
class PaymentMethodDetails < Stripe::StripeObject
class AchCreditTransfer < Stripe::StripeObject
# Account number to transfer funds to.
sig { returns(T.nilable(String)) }
def account_number; end
# Name of the bank associated with the routing number.
sig { returns(T.nilable(String)) }
def bank_name; end
# Routing transit number for the bank account to transfer funds to.
sig { returns(T.nilable(String)) }
def routing_number; end
# SWIFT code of the bank associated with the routing number.
sig { returns(T.nilable(String)) }
def swift_code; end
end
class AchDebit < Stripe::StripeObject
# Type of entity that holds the account. This can be either `individual` or `company`.
sig { returns(T.nilable(String)) }
def account_holder_type; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(T.nilable(String)) }
def country; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# Routing transit number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
end
class AcssDebit < Stripe::StripeObject
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Institution number of the bank account
sig { returns(T.nilable(String)) }
def institution_number; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(String)) }
def mandate; end
# Transit number of the bank account.
sig { returns(T.nilable(String)) }
def transit_number; end
end
class Affirm < Stripe::StripeObject
# ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
sig { returns(T.nilable(String)) }
def location; end
# ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
sig { returns(T.nilable(String)) }
def reader; end
# The Affirm transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class AfterpayClearpay < Stripe::StripeObject
# The Afterpay order ID associated with this payment intent.
sig { returns(T.nilable(String)) }
def order_id; end
# Order identifier shown to the merchant in Afterpay’s online portal.
sig { returns(T.nilable(String)) }
def reference; end
end
class Alipay < Stripe::StripeObject
# Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
sig { returns(T.nilable(String)) }
def buyer_id; end
# Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Transaction ID of this particular Alipay transaction.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Alma < Stripe::StripeObject
class Installments < Stripe::StripeObject
# The number of installments.
sig { returns(Integer) }
def count; end
end
# Attribute for field installments
sig { returns(T.nilable(Installments)) }
def installments; end
# The Alma transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class AmazonPay < Stripe::StripeObject
class Funding < Stripe::StripeObject
class Card < Stripe::StripeObject
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(T.nilable(String)) }
def brand; end
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def brand_product; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# Two-digit number representing the card's expiration month.
sig { returns(T.nilable(Integer)) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(T.nilable(Integer)) }
def exp_year; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# funding type of the underlying payment method.
sig { returns(T.nilable(String)) }
def type; end
end
# Attribute for field funding
sig { returns(T.nilable(Funding)) }
def funding; end
# The Amazon Pay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class AuBecsDebit < Stripe::StripeObject
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(String)) }
def mandate; end
end
class BacsDebit < Stripe::StripeObject
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(String)) }
def mandate; end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
end
class Bancontact < Stripe::StripeObject
# Bank code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_code; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Bank Identifier Code of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bic; end
# The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def generated_sepa_debit; end
# The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def generated_sepa_debit_mandate; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def iban_last4; end
# Preferred language of the Bancontact authorization page that the customer is redirected to.
# Can be one of `en`, `de`, `fr`, or `nl`
sig { returns(T.nilable(String)) }
def preferred_language; end
# Owner's verified full name. Values are verified or provided by Bancontact directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class Billie < Stripe::StripeObject
# The Billie transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class BillingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# A representation of a physical address.
sig { returns(Address) }
def address; end
# The billing email associated with the method of payment.
sig { returns(T.nilable(String)) }
def email; end
# The billing name associated with the method of payment.
sig { returns(T.nilable(String)) }
def name; end
# The billing phone number associated with the method of payment.
sig { returns(T.nilable(String)) }
def phone; end
end
class Blik < Stripe::StripeObject
# A unique and immutable identifier assigned by BLIK to every buyer.
sig { returns(T.nilable(String)) }
def buyer_id; end
end
class Boleto < Stripe::StripeObject
# The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
end
class Card < Stripe::StripeObject
class Checks < Stripe::StripeObject
# Attribute for field address_line1_check
sig { returns(T.nilable(String)) }
def address_line1_check; end
# Attribute for field address_postal_code_check
sig { returns(T.nilable(String)) }
def address_postal_code_check; end
# Attribute for field cvc_check
sig { returns(T.nilable(String)) }
def cvc_check; end
end
class NetworkToken < Stripe::StripeObject
# Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction.
sig { returns(T::Boolean) }
def used; end
end
class ThreeDSecure < Stripe::StripeObject
# Attribute for field authentication_flow
sig { returns(T.nilable(String)) }
def authentication_flow; end
# Attribute for field result
sig { returns(T.nilable(String)) }
def result; end
# Attribute for field result_reason
sig { returns(T.nilable(String)) }
def result_reason; end
# Attribute for field version
sig { returns(T.nilable(String)) }
def version; end
end
class Wallet < Stripe::StripeObject
class ApplePay < Stripe::StripeObject
# Type of the apple_pay transaction, one of `apple_pay` or `apple_pay_later`.
sig { returns(String) }
def type; end
end
class GooglePay < Stripe::StripeObject; end
# Attribute for field apple_pay
sig { returns(T.nilable(ApplePay)) }
def apple_pay; end
# (For tokenized numbers only.) The last four digits of the device account number.
sig { returns(T.nilable(String)) }
def dynamic_last4; end
# Attribute for field google_pay
sig { returns(T.nilable(GooglePay)) }
def google_pay; end
# The type of the card wallet, one of `apple_pay` or `google_pay`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.
sig { returns(String) }
def type; end
end
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(String) }
def brand; end
# When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.
sig { returns(T.nilable(Integer)) }
def capture_before; end
# Check results by Card networks on Card address and CVC at time of payment.
sig { returns(T.nilable(Checks)) }
def checks; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(String) }
def funding; end
# The last four digits of the card.
sig { returns(String) }
def last4; end
# True if this payment was marked as MOTO and out of scope for SCA.
sig { returns(T.nilable(T::Boolean)) }
def moto; end
# Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
sig { returns(T.nilable(String)) }
def network; end
# If this card has network token credentials, this contains the details of the network token credentials.
sig { returns(T.nilable(NetworkToken)) }
def network_token; end
# This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
sig { returns(T.nilable(String)) }
def network_transaction_id; end
# Populated if this transaction used 3D Secure authentication.
sig { returns(T.nilable(ThreeDSecure)) }
def three_d_secure; end
# If this Card is part of a card wallet, this contains the details of the card wallet.
sig { returns(T.nilable(Wallet)) }
def wallet; end
end
class CardPresent < Stripe::StripeObject
class Offline < Stripe::StripeObject
# Time at which the payment was collected while offline
sig { returns(T.nilable(Integer)) }
def stored_at; end
# The method used to process this payment method offline. Only deferred is allowed.
sig { returns(T.nilable(String)) }
def type; end
end
class Receipt < Stripe::StripeObject
# The type of account being debited or credited
sig { returns(T.nilable(String)) }
def account_type; end
# The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.
sig { returns(T.nilable(String)) }
def application_cryptogram; end
# The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip.
sig { returns(T.nilable(String)) }
def application_preferred_name; end
# Identifier for this transaction.
sig { returns(T.nilable(String)) }
def authorization_code; end
# EMV tag 8A. A code returned by the card issuer.
sig { returns(T.nilable(String)) }
def authorization_response_code; end
# Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.
sig { returns(T.nilable(String)) }
def cardholder_verification_method; end
# Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.
sig { returns(T.nilable(String)) }
def dedicated_file_name; end
# A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.
sig { returns(T.nilable(String)) }
def terminal_verification_results; end
# An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.
sig { returns(T.nilable(String)) }
def transaction_status_information; end
end
class Wallet < Stripe::StripeObject
# The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.
sig { returns(String) }
def type; end
end
# The authorized amount
sig { returns(T.nilable(Integer)) }
def amount_authorized; end
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(T.nilable(String)) }
def brand; end
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.
sig { returns(T.nilable(String)) }
def brand_product; end
# When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.
sig { returns(T.nilable(Integer)) }
def capture_before; end
# The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
sig { returns(T.nilable(String)) }
def cardholder_name; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# Authorization response cryptogram.
sig { returns(T.nilable(String)) }
def emv_auth_data; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
sig { returns(T.nilable(String)) }
def generated_card; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
sig { returns(T::Boolean) }
def incremental_authorization_supported; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
# Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
sig { returns(T.nilable(String)) }
def network; end
# This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
sig { returns(T.nilable(String)) }
def network_transaction_id; end
# Details about payments collected offline.
sig { returns(T.nilable(Offline)) }
def offline; end
# Defines whether the authorized amount can be over-captured or not
sig { returns(T::Boolean) }
def overcapture_supported; end
# The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
# How card details were read in this transaction.
sig { returns(T.nilable(String)) }
def read_method; end
# A collection of fields required to be displayed on receipts. Only required for EMV transactions.
sig { returns(T.nilable(Receipt)) }
def receipt; end
# Attribute for field wallet
sig { returns(T.nilable(Wallet)) }
def wallet; end
end
class Cashapp < Stripe::StripeObject
# A unique and immutable identifier assigned by Cash App to every buyer.
sig { returns(T.nilable(String)) }
def buyer_id; end
# A public identifier for buyers using Cash App.
sig { returns(T.nilable(String)) }
def cashtag; end
# A unique and immutable identifier of payments assigned by Cash App
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Crypto < Stripe::StripeObject
# The wallet address of the customer.
sig { returns(T.nilable(String)) }
def buyer_address; end
# The blockchain network that the transaction was sent on.
sig { returns(T.nilable(String)) }
def network; end
# The token currency that the transaction was sent with.
sig { returns(T.nilable(String)) }
def token_currency; end
# The blockchain transaction hash of the crypto payment.
sig { returns(T.nilable(String)) }
def transaction_hash; end
end
class Custom < Stripe::StripeObject
# Display name for the custom (user-defined) payment method type used to make this payment.
sig { returns(String) }
def display_name; end
# The custom payment method type associated with this payment.
sig { returns(T.nilable(String)) }
def type; end
end
class CustomerBalance < Stripe::StripeObject; end
class Eps < Stripe::StripeObject
# The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.
sig { returns(T.nilable(String)) }
def bank; end
# Owner's verified full name. Values are verified or provided by EPS directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
# EPS rarely provides this information so the attribute is usually empty.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class Fpx < Stripe::StripeObject
# Account holder type, if provided. Can be one of `individual` or `company`.
sig { returns(T.nilable(String)) }
def account_holder_type; end
# The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
sig { returns(String) }
def bank; end
# Unique transaction id generated by FPX for every request from the merchant
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Giropay < Stripe::StripeObject
# Bank code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_code; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Bank Identifier Code of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bic; end
# Owner's verified full name. Values are verified or provided by Giropay directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
# Giropay rarely provides this information so the attribute is usually empty.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class Gopay < Stripe::StripeObject; end
class Grabpay < Stripe::StripeObject
# Unique transaction id generated by GrabPay
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class IdBankTransfer < Stripe::StripeObject
# Account number of the bank account to transfer funds to.
sig { returns(String) }
def account_number; end
# Bank where the account is located.
sig { returns(String) }
def bank; end
# Local bank code of the bank.
sig { returns(T.nilable(String)) }
def bank_code; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
sig { returns(T.nilable(String)) }
def display_name; end
end
class Ideal < Stripe::StripeObject
# The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
sig { returns(T.nilable(String)) }
def bank; end
# The Bank Identifier Code of the customer's bank.
sig { returns(T.nilable(String)) }
def bic; end
# The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def generated_sepa_debit; end
# The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def generated_sepa_debit_mandate; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def iban_last4; end
# Owner's verified full name. Values are verified or provided by iDEAL directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class InteracPresent < Stripe::StripeObject
class Receipt < Stripe::StripeObject
# The type of account being debited or credited
sig { returns(T.nilable(String)) }
def account_type; end
# The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.
sig { returns(T.nilable(String)) }
def application_cryptogram; end
# The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip.
sig { returns(T.nilable(String)) }
def application_preferred_name; end
# Identifier for this transaction.
sig { returns(T.nilable(String)) }
def authorization_code; end
# EMV tag 8A. A code returned by the card issuer.
sig { returns(T.nilable(String)) }
def authorization_response_code; end
# Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.
sig { returns(T.nilable(String)) }
def cardholder_verification_method; end
# Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.
sig { returns(T.nilable(String)) }
def dedicated_file_name; end
# A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.
sig { returns(T.nilable(String)) }
def terminal_verification_results; end
# An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.
sig { returns(T.nilable(String)) }
def transaction_status_information; end
end
# Card brand. Can be `interac`, `mastercard` or `visa`.
sig { returns(T.nilable(String)) }
def brand; end
# The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
sig { returns(T.nilable(String)) }
def cardholder_name; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# Authorization response cryptogram.
sig { returns(T.nilable(String)) }
def emv_auth_data; end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
sig { returns(T.nilable(String)) }
def generated_card; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
# Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
sig { returns(T.nilable(String)) }
def network; end
# This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
sig { returns(T.nilable(String)) }
def network_transaction_id; end
# The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
# How card details were read in this transaction.
sig { returns(T.nilable(String)) }
def read_method; end
# A collection of fields required to be displayed on receipts. Only required for EMV transactions.
sig { returns(T.nilable(Receipt)) }
def receipt; end
end
class KakaoPay < Stripe::StripeObject
# A unique identifier for the buyer as determined by the local payment processor.
sig { returns(T.nilable(String)) }
def buyer_id; end
# The Kakao Pay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Klarna < Stripe::StripeObject
class PayerDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# The payer address country
sig { returns(T.nilable(String)) }
def country; end
end
# The payer's address
sig { returns(T.nilable(Address)) }
def address; end
end
# The payer details for this transaction.
sig { returns(T.nilable(PayerDetails)) }
def payer_details; end
# The Klarna payment method used for this transaction.
# Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`
sig { returns(T.nilable(String)) }
def payment_method_category; end
# Preferred language of the Klarna authorization page that the customer is redirected to.
# Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`
sig { returns(T.nilable(String)) }
def preferred_locale; end
end
class Konbini < Stripe::StripeObject
class Store < Stripe::StripeObject
# The name of the convenience store chain where the payment was completed.
sig { returns(T.nilable(String)) }
def chain; end
end
# If the payment succeeded, this contains the details of the convenience store where the payment was completed.
sig { returns(T.nilable(Store)) }
def store; end
end
class KrCard < Stripe::StripeObject
# The local credit or debit card brand.
sig { returns(T.nilable(String)) }
def brand; end
# A unique identifier for the buyer as determined by the local payment processor.
sig { returns(T.nilable(String)) }
def buyer_id; end
# The last four digits of the card. This may not be present for American Express cards.
sig { returns(T.nilable(String)) }
def last4; end
# The Korean Card transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Link < Stripe::StripeObject
# Two-letter ISO code representing the funding source country beneath the Link payment.
# You could use this attribute to get a sense of international fees.
sig { returns(T.nilable(String)) }
def country; end
end
class MbWay < Stripe::StripeObject; end
class Mobilepay < Stripe::StripeObject
class Card < Stripe::StripeObject
# Brand of the card used in the transaction
sig { returns(T.nilable(String)) }
def brand; end
# Two-letter ISO code representing the country of the card
sig { returns(T.nilable(String)) }
def country; end
# Two digit number representing the card's expiration month
sig { returns(T.nilable(Integer)) }
def exp_month; end
# Two digit number representing the card's expiration year
sig { returns(T.nilable(Integer)) }
def exp_year; end
# The last 4 digits of the card
sig { returns(T.nilable(String)) }
def last4; end
end
# Internal card details
sig { returns(T.nilable(Card)) }
def card; end
end
class Multibanco < Stripe::StripeObject
# Entity number associated with this Multibanco payment.
sig { returns(T.nilable(String)) }
def entity; end
# Reference number associated with this Multibanco payment.
sig { returns(T.nilable(String)) }
def reference; end
end
class NaverPay < Stripe::StripeObject
# A unique identifier for the buyer as determined by the local payment processor.
sig { returns(T.nilable(String)) }
def buyer_id; end
# The Naver Pay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class NzBankAccount < Stripe::StripeObject
# The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
# The name of the bank.
sig { returns(String) }
def bank_name; end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
# Last four digits of the bank account number.
sig { returns(String) }
def last4; end
# The suffix of the bank account number.
sig { returns(T.nilable(String)) }
def suffix; end
end
class Oxxo < Stripe::StripeObject
# OXXO reference number
sig { returns(T.nilable(String)) }
def number; end
end
class P24 < Stripe::StripeObject
# The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`.
sig { returns(T.nilable(String)) }
def bank; end
# Unique reference for this Przelewy24 payment.
sig { returns(T.nilable(String)) }
def reference; end
# Owner's verified full name. Values are verified or provided by Przelewy24 directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
# Przelewy24 rarely provides this information so the attribute is usually empty.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class PayByBank < Stripe::StripeObject; end
class Payco < Stripe::StripeObject
# A unique identifier for the buyer as determined by the local payment processor.
sig { returns(T.nilable(String)) }
def buyer_id; end
# The Payco transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Paynow < Stripe::StripeObject
# ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
sig { returns(T.nilable(String)) }
def location; end
# ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
sig { returns(T.nilable(String)) }
def reader; end
# Reference number associated with this PayNow payment
sig { returns(T.nilable(String)) }
def reference; end
end
class Paypal < Stripe::StripeObject
class SellerProtection < Stripe::StripeObject
# An array of conditions that are covered for the transaction, if applicable.
sig { returns(T.nilable(T::Array[String])) }
def dispute_categories; end
# Indicates whether the transaction is eligible for PayPal's seller protection.
sig { returns(String) }
def status; end
end
class Shipping < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class VerifiedAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def country; end
# Owner's email. Values are provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def payer_email; end
# PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
sig { returns(T.nilable(String)) }
def payer_id; end
# Owner's full name. Values provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def payer_name; end
# The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.
sig { returns(T.nilable(SellerProtection)) }
def seller_protection; end
# The shipping address for the customer, as supplied by the merchant at the point of payment
# execution. This shipping address will not be updated if the merchant updates the shipping
# address on the PaymentIntent after the PaymentIntent was successfully confirmed.
sig { returns(T.nilable(Shipping)) }
def shipping; end
# A unique ID generated by PayPal for this transaction.
sig { returns(T.nilable(String)) }
def transaction_id; end
# The shipping address for the customer, as supplied by the merchant at the point of payment
# execution. This shipping address will not be updated if the merchant updates the shipping
# address on the PaymentIntent after the PaymentIntent was successfully confirmed.
sig { returns(T.nilable(VerifiedAddress)) }
def verified_address; end
# Owner's verified email. Values are verified or provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_email; end
# Owner's verified full name. Values are verified or provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class Paypay < Stripe::StripeObject; end
class Payto < Stripe::StripeObject
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(String)) }
def mandate; end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
end
class Pix < Stripe::StripeObject
# Unique transaction id generated by BCB
sig { returns(T.nilable(String)) }
def bank_transaction_id; end
# ID of the multi use Mandate generated by the PaymentIntent
sig { returns(T.nilable(String)) }
def mandate; end
end
class Promptpay < Stripe::StripeObject
# Bill reference generated by PromptPay
sig { returns(T.nilable(String)) }
def reference; end
end
class Qris < Stripe::StripeObject; end
class Rechnung < Stripe::StripeObject; end
class RevolutPay < Stripe::StripeObject
class Funding < Stripe::StripeObject
class Card < Stripe::StripeObject
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(T.nilable(String)) }
def brand; end
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def brand_product; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# Two-digit number representing the card's expiration month.
sig { returns(T.nilable(Integer)) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(T.nilable(Integer)) }
def exp_year; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# funding type of the underlying payment method.
sig { returns(T.nilable(String)) }
def type; end
end
# Attribute for field funding
sig { returns(T.nilable(Funding)) }
def funding; end
# The Revolut Pay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class SamsungPay < Stripe::StripeObject
# A unique identifier for the buyer as determined by the local payment processor.
sig { returns(T.nilable(String)) }
def buyer_id; end
# The Samsung Pay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Satispay < Stripe::StripeObject
# The Satispay transaction ID associated with this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class SepaCreditTransfer < Stripe::StripeObject
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Bank Identifier Code of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bic; end
# IBAN of the bank account to transfer funds to.
sig { returns(T.nilable(String)) }
def iban; end
end
class SepaDebit < Stripe::StripeObject
# Bank code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_code; end
# Branch code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def branch_code; end
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(T.nilable(String)) }
def country; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def last4; end
# Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve).
sig { returns(T.nilable(String)) }
def mandate; end
end
class Shopeepay < Stripe::StripeObject; end
class Sofort < Stripe::StripeObject
# Bank code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_code; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Bank Identifier Code of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bic; end
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(T.nilable(String)) }
def country; end
# The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def generated_sepa_debit; end
# The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def generated_sepa_debit_mandate; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def iban_last4; end
# Preferred language of the SOFORT authorization page that the customer is redirected to.
# Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`
sig { returns(T.nilable(String)) }
def preferred_language; end
# Owner's verified full name. Values are verified or provided by SOFORT directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class StripeAccount < Stripe::StripeObject; end
class StripeBalance < Stripe::StripeObject
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(String) }
def source_type; end
end
class Swish < Stripe::StripeObject
# Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer
sig { returns(T.nilable(String)) }
def fingerprint; end
# Payer bank reference number for the payment
sig { returns(T.nilable(String)) }
def payment_reference; end
# The last four digits of the Swish account phone number
sig { returns(T.nilable(String)) }
def verified_phone_last4; end
end
class Twint < Stripe::StripeObject; end
class UsBankAccount < Stripe::StripeObject
# Attribute for field account_holder_type
sig { returns(T.nilable(String)) }
def account_holder_type; end
# Attribute for field account_type
sig { returns(T.nilable(String)) }
def account_type; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def mandate; end
# Reference number to locate ACH payments with customer’s bank.
sig { returns(T.nilable(String)) }
def payment_reference; end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
end
class Wechat < Stripe::StripeObject; end
class WechatPay < Stripe::StripeObject
# Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
sig { returns(T.nilable(String)) }
def location; end
# ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
sig { returns(T.nilable(String)) }
def reader; end
# Transaction ID of this particular WeChat Pay transaction.
sig { returns(T.nilable(String)) }
def transaction_id; end
end
class Zip < Stripe::StripeObject; end
# Attribute for field ach_credit_transfer
sig { returns(T.nilable(AchCreditTransfer)) }
def ach_credit_transfer; end
# Attribute for field ach_debit
sig { returns(T.nilable(AchDebit)) }
def ach_debit; end
# Attribute for field acss_debit
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# Attribute for field affirm
sig { returns(T.nilable(Affirm)) }
def affirm; end
# Attribute for field afterpay_clearpay
sig { returns(T.nilable(AfterpayClearpay)) }
def afterpay_clearpay; end
# Attribute for field alipay
sig { returns(T.nilable(Alipay)) }
def alipay; end
# Attribute for field alma
sig { returns(T.nilable(Alma)) }
def alma; end
# Attribute for field amazon_pay
sig { returns(T.nilable(AmazonPay)) }
def amazon_pay; end
# Attribute for field au_becs_debit
sig { returns(T.nilable(AuBecsDebit)) }
def au_becs_debit; end
# Attribute for field bacs_debit
sig { returns(T.nilable(BacsDebit)) }
def bacs_debit; end
# Attribute for field bancontact
sig { returns(T.nilable(Bancontact)) }
def bancontact; end
# Attribute for field billie
sig { returns(T.nilable(Billie)) }
def billie; end
# The billing details associated with the method of payment.
sig { returns(T.nilable(BillingDetails)) }
def billing_details; end
# Attribute for field blik
sig { returns(T.nilable(Blik)) }
def blik; end
# Attribute for field boleto
sig { returns(T.nilable(Boleto)) }
def boleto; end
# Details of the card used for this payment attempt.
sig { returns(T.nilable(Card)) }
def card; end
# Attribute for field card_present
sig { returns(T.nilable(CardPresent)) }
def card_present; end
# Attribute for field cashapp
sig { returns(T.nilable(Cashapp)) }
def cashapp; end
# Attribute for field crypto
sig { returns(T.nilable(Crypto)) }
def crypto; end
# Custom Payment Methods represent Payment Method types not modeled directly in
# the Stripe API. This resource consists of details about the custom payment method
# used for this payment attempt.
sig { returns(T.nilable(Custom)) }
def custom; end
# Attribute for field customer_balance
sig { returns(T.nilable(CustomerBalance)) }
def customer_balance; end
# Attribute for field eps
sig { returns(T.nilable(Eps)) }
def eps; end
# Attribute for field fpx
sig { returns(T.nilable(Fpx)) }
def fpx; end
# Attribute for field giropay
sig { returns(T.nilable(Giropay)) }
def giropay; end
# Attribute for field gopay
sig { returns(T.nilable(Gopay)) }
def gopay; end
# Attribute for field grabpay
sig { returns(T.nilable(Grabpay)) }
def grabpay; end
# Attribute for field id_bank_transfer
sig { returns(T.nilable(IdBankTransfer)) }
def id_bank_transfer; end
# Attribute for field ideal
sig { returns(T.nilable(Ideal)) }
def ideal; end
# Attribute for field interac_present
sig { returns(T.nilable(InteracPresent)) }
def interac_present; end
# Attribute for field kakao_pay
sig { returns(T.nilable(KakaoPay)) }
def kakao_pay; end
# Attribute for field klarna
sig { returns(T.nilable(Klarna)) }
def klarna; end
# Attribute for field konbini
sig { returns(T.nilable(Konbini)) }
def konbini; end
# Attribute for field kr_card
sig { returns(T.nilable(KrCard)) }
def kr_card; end
# Attribute for field link
sig { returns(T.nilable(Link)) }
def link; end
# Attribute for field mb_way
sig { returns(T.nilable(MbWay)) }
def mb_way; end
# Attribute for field mobilepay
sig { returns(T.nilable(Mobilepay)) }
def mobilepay; end
# Attribute for field multibanco
sig { returns(T.nilable(Multibanco)) }
def multibanco; end
# Attribute for field naver_pay
sig { returns(T.nilable(NaverPay)) }
def naver_pay; end
# Attribute for field nz_bank_account
sig { returns(T.nilable(NzBankAccount)) }
def nz_bank_account; end
# Attribute for field oxxo
sig { returns(T.nilable(Oxxo)) }
def oxxo; end
# Attribute for field p24
sig { returns(T.nilable(P24)) }
def p24; end
# Attribute for field pay_by_bank
sig { returns(T.nilable(PayByBank)) }
def pay_by_bank; end
# Attribute for field payco
sig { returns(T.nilable(Payco)) }
def payco; end
# ID of the Stripe PaymentMethod used to make this payment.
sig { returns(T.nilable(String)) }
def payment_method; end
# Attribute for field paynow
sig { returns(T.nilable(Paynow)) }
def paynow; end
# Attribute for field paypal
sig { returns(T.nilable(Paypal)) }
def paypal; end
# Attribute for field paypay
sig { returns(T.nilable(Paypay)) }
def paypay; end
# Attribute for field payto
sig { returns(T.nilable(Payto)) }
def payto; end
# Attribute for field pix
sig { returns(T.nilable(Pix)) }
def pix; end
# Attribute for field promptpay
sig { returns(T.nilable(Promptpay)) }
def promptpay; end
# Attribute for field qris
sig { returns(T.nilable(Qris)) }
def qris; end
# Attribute for field rechnung
sig { returns(T.nilable(Rechnung)) }
def rechnung; end
# Attribute for field revolut_pay
sig { returns(T.nilable(RevolutPay)) }
def revolut_pay; end
# Attribute for field samsung_pay
sig { returns(T.nilable(SamsungPay)) }
def samsung_pay; end
# Attribute for field satispay
sig { returns(T.nilable(Satispay)) }
def satispay; end
# Attribute for field sepa_credit_transfer
sig { returns(T.nilable(SepaCreditTransfer)) }
def sepa_credit_transfer; end
# Attribute for field sepa_debit
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# Attribute for field shopeepay
sig { returns(T.nilable(Shopeepay)) }
def shopeepay; end
# Attribute for field sofort
sig { returns(T.nilable(Sofort)) }
def sofort; end
# Attribute for field stripe_account
sig { returns(T.nilable(StripeAccount)) }
def stripe_account; end
# Attribute for field stripe_balance
sig { returns(T.nilable(StripeBalance)) }
def stripe_balance; end
# Attribute for field swish
sig { returns(T.nilable(Swish)) }
def swish; end
# Attribute for field twint
sig { returns(T.nilable(Twint)) }
def twint; end
# The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type) for the full list of possible types.
# An additional hash is included on `payment_method_details` with a name matching this value.
# It contains information specific to the payment method.
sig { returns(String) }
def type; end
# Details of the US Bank Account used for this payment attempt.
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
# Attribute for field wechat
sig { returns(T.nilable(Wechat)) }
def wechat; end
# Attribute for field wechat_pay
sig { returns(T.nilable(WechatPay)) }
def wechat_pay; end
# Attribute for field zip
sig { returns(T.nilable(Zip)) }
def zip; end
end
class ProcessorDetails < Stripe::StripeObject
class Custom < Stripe::StripeObject
# An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
sig { returns(String) }
def payment_reference; end
end
# Custom processors represent payment processors not modeled directly in
# the Stripe API. This resource consists of details about the custom processor
# used for this payment attempt.
sig { returns(T.nilable(Custom)) }
def custom; end
# The processor used for this payment attempt.
sig { returns(String) }
def type; end
end
class ShippingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# A representation of a physical address.
sig { returns(Address) }
def address; end
# The shipping recipient's name.
sig { returns(T.nilable(String)) }
def name; end
# The shipping recipient's phone number.
sig { returns(T.nilable(String)) }
def phone; end
end
# A representation of an amount of money, consisting of an amount and a currency.
sig { returns(Amount) }
def amount; end
# A representation of an amount of money, consisting of an amount and a currency.
sig { returns(AmountAuthorized) }
def amount_authorized; end
# A representation of an amount of money, consisting of an amount and a currency.
sig { returns(AmountCanceled) }
def amount_canceled; end
# A representation of an amount of money, consisting of an amount and a currency.
sig { returns(AmountFailed) }
def amount_failed; end
# A representation of an amount of money, consisting of an amount and a currency.
sig { returns(AmountGuaranteed) }
def amount_guaranteed; end
# A representation of an amount of money, consisting of an amount and a currency.
sig { returns(AmountRefunded) }
def amount_refunded; end
# A representation of an amount of money, consisting of an amount and a currency.
sig { returns(AmountRequested) }
def amount_requested; end
# ID of the Connect application that created the PaymentRecord.
sig { returns(T.nilable(String)) }
def application; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Customer information for this payment.
sig { returns(T.nilable(CustomerDetails)) }
def customer_details; end
# Indicates whether the customer was present in your checkout flow during this payment.
sig { returns(T.nilable(String)) }
def customer_presence; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# ID of the latest Payment Attempt Record attached to this Payment Record.
sig { returns(T.nilable(String)) }
def latest_payment_attempt_record; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Information about the Payment Method debited for this payment.
sig { returns(T.nilable(PaymentMethodDetails)) }
def payment_method_details; end
# Processor information associated with this payment.
sig { returns(ProcessorDetails) }
def processor_details; end
# Shipping information for this payment.
sig { returns(T.nilable(ShippingDetails)) }
def shipping_details; end
class ReportPaymentAttemptParams < Stripe::RequestParams
class Failed < Stripe::RequestParams
# When the reported payment failed. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def failed_at; end
sig { params(_failed_at: Integer).returns(Integer) }
def failed_at=(_failed_at); end
sig { params(failed_at: Integer).void }
def initialize(failed_at: nil); end
end
class Guaranteed < Stripe::RequestParams
# When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def guaranteed_at; end
sig { params(_guaranteed_at: Integer).returns(Integer) }
def guaranteed_at=(_guaranteed_at); end
sig { params(guaranteed_at: Integer).void }
def initialize(guaranteed_at: nil); end
end
class PaymentMethodDetails < Stripe::RequestParams
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The billing address associated with the method of payment.
sig {
returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::PaymentMethodDetails::BillingDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::PaymentMethodDetails::BillingDetails::Address)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::PaymentMethodDetails::BillingDetails::Address))
}
def address=(_address); end
# The billing email associated with the method of payment.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The billing name associated with the method of payment.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The billing phone number associated with the method of payment.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::PaymentMethodDetails::BillingDetails::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil); end
end
class Custom < Stripe::RequestParams
# Display name for the custom (user-defined) payment method type used to make this payment.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# The custom payment method type associated with this payment.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig { params(display_name: T.nilable(String), type: T.nilable(String)).void }
def initialize(display_name: nil, type: nil); end
end
# The billing details associated with the method of payment.
sig {
returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::PaymentMethodDetails::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::PaymentMethodDetails::BillingDetails)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::PaymentMethodDetails::BillingDetails))
}
def billing_details=(_billing_details); end
# Information about the custom (user-defined) payment method used to make this payment.
sig {
returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::PaymentMethodDetails::Custom))
}
def custom; end
sig {
params(_custom: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::PaymentMethodDetails::Custom)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::PaymentMethodDetails::Custom))
}
def custom=(_custom); end
# ID of the Stripe Payment Method used to make this payment.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(billing_details: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::PaymentMethodDetails::BillingDetails), custom: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::PaymentMethodDetails::Custom), payment_method: T.nilable(String), type: T.nilable(String)).void
}
def initialize(billing_details: nil, custom: nil, payment_method: nil, type: nil); end
end
class ShippingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The physical shipping address.
sig {
returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::ShippingDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::ShippingDetails::Address)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::ShippingDetails::Address))
}
def address=(_address); end
# The shipping recipient's name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The shipping recipient's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::ShippingDetails::Address), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Information about the payment attempt failure.
sig { returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::Failed)) }
def failed; end
sig {
params(_failed: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::Failed)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::Failed))
}
def failed=(_failed); end
# Information about the payment attempt guarantee.
sig { returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::Guaranteed)) }
def guaranteed; end
sig {
params(_guaranteed: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::Guaranteed)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::Guaranteed))
}
def guaranteed=(_guaranteed); end
# When the reported payment was initiated. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def initiated_at; end
sig { params(_initiated_at: Integer).returns(Integer) }
def initiated_at=(_initiated_at); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The outcome of the reported payment.
sig { returns(T.nilable(String)) }
def outcome; end
sig { params(_outcome: T.nilable(String)).returns(T.nilable(String)) }
def outcome=(_outcome); end
# Information about the Payment Method debited for this payment.
sig {
returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::PaymentMethodDetails))
}
def payment_method_details; end
sig {
params(_payment_method_details: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::PaymentMethodDetails)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::PaymentMethodDetails))
}
def payment_method_details=(_payment_method_details); end
# Shipping information for this payment.
sig {
returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::ShippingDetails))
}
def shipping_details; end
sig {
params(_shipping_details: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::ShippingDetails)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::ShippingDetails))
}
def shipping_details=(_shipping_details); end
sig {
params(description: T.nilable(String), expand: T.nilable(T::Array[String]), failed: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::Failed), guaranteed: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::Guaranteed), initiated_at: Integer, metadata: T.nilable(T.any(String, T::Hash[String, String])), outcome: T.nilable(String), payment_method_details: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::PaymentMethodDetails), shipping_details: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptParams::ShippingDetails)).void
}
def initialize(
description: nil,
expand: nil,
failed: nil,
guaranteed: nil,
initiated_at: nil,
metadata: nil,
outcome: nil,
payment_method_details: nil,
shipping_details: nil
); end
end
class ReportPaymentAttemptCanceledParams < Stripe::RequestParams
# When the reported payment was canceled. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def canceled_at; end
sig { params(_canceled_at: Integer).returns(Integer) }
def canceled_at=(_canceled_at); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Attribute for param field metadata
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(canceled_at: Integer, expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(canceled_at: nil, expand: nil, metadata: nil); end
end
class ReportPaymentAttemptFailedParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# When the reported payment failed. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def failed_at; end
sig { params(_failed_at: Integer).returns(Integer) }
def failed_at=(_failed_at); end
# Attribute for param field metadata
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), failed_at: Integer, metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, failed_at: nil, metadata: nil); end
end
class ReportPaymentAttemptGuaranteedParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def guaranteed_at; end
sig { params(_guaranteed_at: Integer).returns(Integer) }
def guaranteed_at=(_guaranteed_at); end
# Attribute for param field metadata
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), guaranteed_at: Integer, metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, guaranteed_at: nil, metadata: nil); end
end
class ReportPaymentAttemptInformationalParams < Stripe::RequestParams
class CustomerDetails < Stripe::RequestParams
# The customer who made the payment.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The customer's phone number.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The customer's name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The customer's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(customer: T.nilable(String), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(customer: nil, email: nil, name: nil, phone: nil); end
end
class ShippingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The physical shipping address.
sig {
returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptInformationalParams::ShippingDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptInformationalParams::ShippingDetails::Address)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptInformationalParams::ShippingDetails::Address))
}
def address=(_address); end
# The shipping recipient's name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The shipping recipient's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptInformationalParams::ShippingDetails::Address), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
# Customer information for this payment.
sig {
returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptInformationalParams::CustomerDetails))
}
def customer_details; end
sig {
params(_customer_details: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptInformationalParams::CustomerDetails)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptInformationalParams::CustomerDetails))
}
def customer_details=(_customer_details); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Shipping information for this payment.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentRecord::ReportPaymentAttemptInformationalParams::ShippingDetails)))
}
def shipping_details; end
sig {
params(_shipping_details: T.nilable(T.any(String, ::Stripe::PaymentRecord::ReportPaymentAttemptInformationalParams::ShippingDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentRecord::ReportPaymentAttemptInformationalParams::ShippingDetails)))
}
def shipping_details=(_shipping_details); end
sig {
params(customer_details: T.nilable(::Stripe::PaymentRecord::ReportPaymentAttemptInformationalParams::CustomerDetails), description: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), shipping_details: T.nilable(T.any(String, ::Stripe::PaymentRecord::ReportPaymentAttemptInformationalParams::ShippingDetails))).void
}
def initialize(
customer_details: nil,
description: nil,
expand: nil,
metadata: nil,
shipping_details: nil
); end
end
class ReportPaymentParams < Stripe::RequestParams
class AmountRequested < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(currency: String, value: Integer).void }
def initialize(currency: nil, value: nil); end
end
class CustomerDetails < Stripe::RequestParams
# The customer who made the payment.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The customer's phone number.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The customer's name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The customer's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(customer: T.nilable(String), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(customer: nil, email: nil, name: nil, phone: nil); end
end
class Failed < Stripe::RequestParams
# When the reported payment failed. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def failed_at; end
sig { params(_failed_at: Integer).returns(Integer) }
def failed_at=(_failed_at); end
sig { params(failed_at: Integer).void }
def initialize(failed_at: nil); end
end
class Guaranteed < Stripe::RequestParams
# When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def guaranteed_at; end
sig { params(_guaranteed_at: Integer).returns(Integer) }
def guaranteed_at=(_guaranteed_at); end
sig { params(guaranteed_at: Integer).void }
def initialize(guaranteed_at: nil); end
end
class PaymentMethodDetails < Stripe::RequestParams
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The billing address associated with the method of payment.
sig {
returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::PaymentMethodDetails::BillingDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::PaymentMethodDetails::BillingDetails::Address)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::PaymentMethodDetails::BillingDetails::Address))
}
def address=(_address); end
# The billing email associated with the method of payment.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The billing name associated with the method of payment.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The billing phone number associated with the method of payment.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::PaymentMethodDetails::BillingDetails::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil); end
end
class Custom < Stripe::RequestParams
# Display name for the custom (user-defined) payment method type used to make this payment.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# The custom payment method type associated with this payment.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig { params(display_name: T.nilable(String), type: T.nilable(String)).void }
def initialize(display_name: nil, type: nil); end
end
# The billing details associated with the method of payment.
sig {
returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::PaymentMethodDetails::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::PaymentMethodDetails::BillingDetails)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::PaymentMethodDetails::BillingDetails))
}
def billing_details=(_billing_details); end
# Information about the custom (user-defined) payment method used to make this payment.
sig {
returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::PaymentMethodDetails::Custom))
}
def custom; end
sig {
params(_custom: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::PaymentMethodDetails::Custom)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::PaymentMethodDetails::Custom))
}
def custom=(_custom); end
# ID of the Stripe Payment Method used to make this payment.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(billing_details: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::PaymentMethodDetails::BillingDetails), custom: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::PaymentMethodDetails::Custom), payment_method: T.nilable(String), type: T.nilable(String)).void
}
def initialize(billing_details: nil, custom: nil, payment_method: nil, type: nil); end
end
class ProcessorDetails < Stripe::RequestParams
class Custom < Stripe::RequestParams
# An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
sig { returns(String) }
def payment_reference; end
sig { params(_payment_reference: String).returns(String) }
def payment_reference=(_payment_reference); end
sig { params(payment_reference: String).void }
def initialize(payment_reference: nil); end
end
# Information about the custom processor used to make this payment.
sig {
returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::ProcessorDetails::Custom))
}
def custom; end
sig {
params(_custom: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::ProcessorDetails::Custom)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::ProcessorDetails::Custom))
}
def custom=(_custom); end
# The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(custom: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::ProcessorDetails::Custom), type: String).void
}
def initialize(custom: nil, type: nil); end
end
class ShippingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The physical shipping address.
sig {
returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::ShippingDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::ShippingDetails::Address)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::ShippingDetails::Address))
}
def address=(_address); end
# The shipping recipient's name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The shipping recipient's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::ShippingDetails::Address), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
# The amount you initially requested for this payment.
sig { returns(::Stripe::PaymentRecord::ReportPaymentParams::AmountRequested) }
def amount_requested; end
sig {
params(_amount_requested: ::Stripe::PaymentRecord::ReportPaymentParams::AmountRequested).returns(::Stripe::PaymentRecord::ReportPaymentParams::AmountRequested)
}
def amount_requested=(_amount_requested); end
# Customer information for this payment.
sig { returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::CustomerDetails)) }
def customer_details; end
sig {
params(_customer_details: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::CustomerDetails)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::CustomerDetails))
}
def customer_details=(_customer_details); end
# Indicates whether the customer was present in your checkout flow during this payment.
sig { returns(T.nilable(String)) }
def customer_presence; end
sig { params(_customer_presence: T.nilable(String)).returns(T.nilable(String)) }
def customer_presence=(_customer_presence); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Information about the payment attempt failure.
sig { returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::Failed)) }
def failed; end
sig {
params(_failed: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::Failed)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::Failed))
}
def failed=(_failed); end
# Information about the payment attempt guarantee.
sig { returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::Guaranteed)) }
def guaranteed; end
sig {
params(_guaranteed: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::Guaranteed)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::Guaranteed))
}
def guaranteed=(_guaranteed); end
# When the reported payment was initiated. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def initiated_at; end
sig { params(_initiated_at: Integer).returns(Integer) }
def initiated_at=(_initiated_at); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The outcome of the reported payment.
sig { returns(T.nilable(String)) }
def outcome; end
sig { params(_outcome: T.nilable(String)).returns(T.nilable(String)) }
def outcome=(_outcome); end
# Information about the Payment Method debited for this payment.
sig { returns(::Stripe::PaymentRecord::ReportPaymentParams::PaymentMethodDetails) }
def payment_method_details; end
sig {
params(_payment_method_details: ::Stripe::PaymentRecord::ReportPaymentParams::PaymentMethodDetails).returns(::Stripe::PaymentRecord::ReportPaymentParams::PaymentMethodDetails)
}
def payment_method_details=(_payment_method_details); end
# Processor information for this payment.
sig { returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::ProcessorDetails)) }
def processor_details; end
sig {
params(_processor_details: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::ProcessorDetails)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::ProcessorDetails))
}
def processor_details=(_processor_details); end
# Shipping information for this payment.
sig { returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::ShippingDetails)) }
def shipping_details; end
sig {
params(_shipping_details: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::ShippingDetails)).returns(T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::ShippingDetails))
}
def shipping_details=(_shipping_details); end
sig {
params(amount_requested: ::Stripe::PaymentRecord::ReportPaymentParams::AmountRequested, customer_details: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::CustomerDetails), customer_presence: T.nilable(String), description: T.nilable(String), expand: T.nilable(T::Array[String]), failed: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::Failed), guaranteed: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::Guaranteed), initiated_at: Integer, metadata: T.nilable(T.any(String, T::Hash[String, String])), outcome: T.nilable(String), payment_method_details: ::Stripe::PaymentRecord::ReportPaymentParams::PaymentMethodDetails, processor_details: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::ProcessorDetails), shipping_details: T.nilable(::Stripe::PaymentRecord::ReportPaymentParams::ShippingDetails)).void
}
def initialize(
amount_requested: nil,
customer_details: nil,
customer_presence: nil,
description: nil,
expand: nil,
failed: nil,
guaranteed: nil,
initiated_at: nil,
metadata: nil,
outcome: nil,
payment_method_details: nil,
processor_details: nil,
shipping_details: nil
); end
end
# Report a new Payment Record. You may report a Payment Record as it is
# initialized and later report updates through the other report_* methods, or report Payment
# Records in a terminal state directly, through this method.
sig {
params(params: T.any(::Stripe::PaymentRecord::ReportPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def self.report_payment(params = {}, opts = {}); end
# Report a new payment attempt on the specified Payment Record. A new payment
# attempt can only be specified if all other payment attempts are canceled or failed.
sig {
params(params: T.any(::Stripe::PaymentRecord::ReportPaymentAttemptParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def report_payment_attempt(params = {}, opts = {}); end
# Report a new payment attempt on the specified Payment Record. A new payment
# attempt can only be specified if all other payment attempts are canceled or failed.
sig {
params(id: String, params: T.any(::Stripe::PaymentRecord::ReportPaymentAttemptParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def self.report_payment_attempt(id, params = {}, opts = {}); end
# Report that the most recent payment attempt on the specified Payment Record
# was canceled.
sig {
params(params: T.any(::Stripe::PaymentRecord::ReportPaymentAttemptCanceledParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def report_payment_attempt_canceled(params = {}, opts = {}); end
# Report that the most recent payment attempt on the specified Payment Record
# was canceled.
sig {
params(id: String, params: T.any(::Stripe::PaymentRecord::ReportPaymentAttemptCanceledParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def self.report_payment_attempt_canceled(id, params = {}, opts = {}); end
# Report that the most recent payment attempt on the specified Payment Record
# failed or errored.
sig {
params(params: T.any(::Stripe::PaymentRecord::ReportPaymentAttemptFailedParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def report_payment_attempt_failed(params = {}, opts = {}); end
# Report that the most recent payment attempt on the specified Payment Record
# failed or errored.
sig {
params(id: String, params: T.any(::Stripe::PaymentRecord::ReportPaymentAttemptFailedParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def self.report_payment_attempt_failed(id, params = {}, opts = {}); end
# Report that the most recent payment attempt on the specified Payment Record
# was guaranteed.
sig {
params(params: T.any(::Stripe::PaymentRecord::ReportPaymentAttemptGuaranteedParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def report_payment_attempt_guaranteed(params = {}, opts = {}); end
# Report that the most recent payment attempt on the specified Payment Record
# was guaranteed.
sig {
params(id: String, params: T.any(::Stripe::PaymentRecord::ReportPaymentAttemptGuaranteedParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def self.report_payment_attempt_guaranteed(id, params = {}, opts = {}); end
# Report informational updates on the specified Payment Record.
sig {
params(params: T.any(::Stripe::PaymentRecord::ReportPaymentAttemptInformationalParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def report_payment_attempt_informational(params = {}, opts = {}); end
# Report informational updates on the specified Payment Record.
sig {
params(id: String, params: T.any(::Stripe::PaymentRecord::ReportPaymentAttemptInformationalParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def self.report_payment_attempt_informational(id, params = {}, opts = {}); end
end
end
# typed: 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://docs.stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
# and list all payouts. Payouts are made on [varying
# schedules](https://docs.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
class TraceId < Stripe::StripeObject
# Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`.
sig { returns(String) }
def status; end
# The trace ID value if `trace_id.status` is `supported`, otherwise `nil`.
sig { returns(T.nilable(String)) }
def value; end
end
# The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.
sig { returns(Integer) }
def amount; end
# The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.
sig { returns(T.nilable(T.any(String, Stripe::ApplicationFee))) }
def application_fee; end
# The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
# Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.
sig { returns(Integer) }
def arrival_date; end
# Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts).
sig { returns(T::Boolean) }
def automatic; end
# ID of the balance transaction that describes the impact of this payout on your account balance.
sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
def balance_transaction; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# ID of the bank account or card the payout is sent to.
sig { returns(T.nilable(T.any(String, T.any(Stripe::BankAccount, Stripe::Card)))) }
def destination; end
# If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.
sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
def failure_balance_transaction; end
# Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures).
sig { returns(T.nilable(String)) }
def failure_code; end
# Message that provides the reason for a payout failure, if available.
sig { returns(T.nilable(String)) }
def failure_message; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).
sig { returns(String) }
def method; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# If the payout reverses another, this is the ID of the original payout.
sig { returns(T.nilable(T.any(String, Stripe::Payout))) }
def original_payout; end
# ID of the v2 FinancialAccount the funds are sent to.
sig { returns(T.nilable(String)) }
def payout_method; end
# If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.
sig { returns(String) }
def reconciliation_status; end
# If the payout reverses, this is the ID of the payout that reverses this payout.
sig { returns(T.nilable(T.any(String, Stripe::Payout))) }
def reversed_by; end
# The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`.
sig { returns(String) }
def source_type; end
# Extra information about a payout that displays on the user's bank statement.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
# Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`.
sig { returns(String) }
def status; end
# A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar.
sig { returns(T.nilable(TraceId)) }
def trace_id; end
# Can be `bank_account` or `card`.
sig { returns(String) }
def type; end
class ListParams < Stripe::RequestParams
class ArrivalDate < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return payouts that are expected to arrive during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Payout::ListParams::ArrivalDate, Integer))) }
def arrival_date; end
sig {
params(_arrival_date: T.nilable(T.any(::Stripe::Payout::ListParams::ArrivalDate, Integer))).returns(T.nilable(T.any(::Stripe::Payout::ListParams::ArrivalDate, Integer)))
}
def arrival_date=(_arrival_date); end
# Only return payouts that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Payout::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Payout::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Payout::ListParams::Created, Integer)))
}
def created=(_created); end
# The ID of an external account - only return payouts sent to this external account.
sig { returns(T.nilable(String)) }
def destination; end
sig { params(_destination: T.nilable(String)).returns(T.nilable(String)) }
def destination=(_destination); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(arrival_date: T.nilable(T.any(::Stripe::Payout::ListParams::ArrivalDate, Integer)), created: T.nilable(T.any(::Stripe::Payout::ListParams::Created, Integer)), destination: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
arrival_date: nil,
created: nil,
destination: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
# A positive integer in cents representing how much to payout.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency.
sig { returns(T.nilable(String)) }
def destination; end
sig { params(_destination: T.nilable(String)).returns(T.nilable(String)) }
def destination=(_destination); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The method used to send this payout, which is `standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).
sig { returns(T.nilable(String)) }
def method; end
sig { params(_method: T.nilable(String)).returns(T.nilable(String)) }
def method=(_method); end
# The ID of a v2 FinancialAccount to send funds to.
sig { returns(T.nilable(String)) }
def payout_method; end
sig { params(_payout_method: T.nilable(String)).returns(T.nilable(String)) }
def payout_method=(_payout_method); end
# The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`.
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
# A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
sig {
params(amount: Integer, currency: String, description: T.nilable(String), destination: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), method: T.nilable(String), payout_method: T.nilable(String), source_type: T.nilable(String), statement_descriptor: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
destination: nil,
expand: nil,
metadata: nil,
method: nil,
payout_method: nil,
source_type: nil,
statement_descriptor: nil
); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, metadata: nil); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ReverseParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(expand: nil, metadata: nil); end
end
# You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can't cancel automatic Stripe payouts.
sig {
params(params: T.any(::Stripe::Payout::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Payout)
}
def cancel(params = {}, opts = {}); end
# You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can't cancel automatic Stripe payouts.
sig {
params(payout: String, params: T.any(::Stripe::Payout::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Payout)
}
def self.cancel(payout, params = {}, opts = {}); end
# To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://docs.stripe.com/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error.
#
# If your API key is in test mode, money won't actually be sent, though every other action occurs as if you're in live mode.
#
# If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://docs.stripe.com/api#balance_object) details available and pending amounts by source type.
sig {
params(params: T.any(::Stripe::Payout::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Payout)
}
def self.create(params = {}, opts = {}); end
# Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.
sig {
params(params: T.any(::Stripe::Payout::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.
#
# By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.
sig {
params(params: T.any(::Stripe::Payout::ReverseParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Payout)
}
def reverse(params = {}, opts = {}); end
# Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.
#
# By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.
sig {
params(payout: String, params: T.any(::Stripe::Payout::ReverseParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Payout)
}
def self.reverse(payout, params = {}, opts = {}); end
# Updates the specified payout by setting the values of the parameters you pass. We don't change parameters that you don't provide. This request only accepts the metadata as arguments.
sig {
params(payout: String, params: T.any(::Stripe::Payout::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Payout)
}
def self.update(payout, params = {}, opts = {}); end
end
end
# typed: 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
class Tier < Stripe::StripeObject
# Price for the entire tier.
sig { returns(T.nilable(Integer)) }
def flat_amount; end
# Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def flat_amount_decimal; end
# Per unit price for units relevant to the tier.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
# Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
# Up to and including to this quantity will be contained in the tier.
sig { returns(T.nilable(Integer)) }
def up_to; end
end
class TransformUsage < Stripe::StripeObject
# Divide usage by this number.
sig { returns(Integer) }
def divide_by; end
# After division, either round the result `up` or `down`.
sig { returns(String) }
def round; end
end
# Whether the plan can be used for new purchases.
sig { returns(T::Boolean) }
def active; end
# The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.
sig { returns(T.nilable(Integer)) }
def amount; end
# The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.
sig { returns(T.nilable(String)) }
def amount_decimal; end
# Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
sig { returns(String) }
def billing_scheme; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
# The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
sig { returns(Integer) }
def interval_count; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# The meter tracking the usage of a metered price
sig { returns(T.nilable(String)) }
def meter; end
# A brief description of the plan, hidden from customers.
sig { returns(T.nilable(String)) }
def nickname; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The product whose pricing this plan determines.
sig { returns(T.nilable(T.any(String, Stripe::Product))) }
def product; end
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
sig { returns(T.nilable(T::Array[Tier])) }
def tiers; end
# Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.
sig { returns(T.nilable(String)) }
def tiers_mode; end
# Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
sig { returns(T.nilable(TransformUsage)) }
def transform_usage; end
# Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
sig { returns(T.nilable(Integer)) }
def trial_period_days; end
# Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
sig { returns(String) }
def usage_type; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams; end
class UpdateParams < Stripe::RequestParams
# Whether the plan is currently available for new subscriptions.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# A brief description of the plan, hidden from customers.
sig { returns(T.nilable(String)) }
def nickname; end
sig { params(_nickname: T.nilable(String)).returns(T.nilable(String)) }
def nickname=(_nickname); end
# The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
sig { returns(T.nilable(Integer)) }
def trial_period_days; end
sig { params(_trial_period_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_period_days=(_trial_period_days); end
sig {
params(active: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), nickname: T.nilable(String), product: T.nilable(String), trial_period_days: T.nilable(Integer)).void
}
def initialize(
active: nil,
expand: nil,
metadata: nil,
nickname: nil,
product: nil,
trial_period_days: nil
); end
end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans).
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
sig { returns(T.nilable(T.any(::Stripe::Plan::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Plan::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Plan::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return plans for the given product.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::Plan::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), product: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
active: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
product: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Product < Stripe::RequestParams
# Whether the product is currently available for purchase. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
#
# This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
sig {
params(active: T.nilable(T::Boolean), id: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), name: String, statement_descriptor: T.nilable(String), tax_code: T.nilable(String), unit_label: T.nilable(String)).void
}
def initialize(
active: nil,
id: nil,
metadata: nil,
name: nil,
statement_descriptor: nil,
tax_code: nil,
unit_label: nil
); end
end
class Tier < Stripe::RequestParams
# The flat billing amount for an entire tier, regardless of the number of units in the tier.
sig { returns(T.nilable(Integer)) }
def flat_amount; end
sig { params(_flat_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def flat_amount=(_flat_amount); end
# Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def flat_amount_decimal; end
sig { params(_flat_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def flat_amount_decimal=(_flat_amount_decimal); end
# The per unit billing amount for each individual unit for which this tier applies.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
# Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
sig { returns(T.any(String, Integer)) }
def up_to; end
sig { params(_up_to: T.any(String, Integer)).returns(T.any(String, Integer)) }
def up_to=(_up_to); end
sig {
params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
}
def initialize(
flat_amount: nil,
flat_amount_decimal: nil,
unit_amount: nil,
unit_amount_decimal: nil,
up_to: nil
); end
end
class TransformUsage < Stripe::RequestParams
# Divide usage by this number.
sig { returns(Integer) }
def divide_by; end
sig { params(_divide_by: Integer).returns(Integer) }
def divide_by=(_divide_by); end
# After division, either round the result `up` or `down`.
sig { returns(String) }
def round; end
sig { params(_round: String).returns(String) }
def round=(_round); end
sig { params(divide_by: Integer, round: String).void }
def initialize(divide_by: nil, round: nil); end
end
# Whether the plan is currently available for new subscriptions. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def amount_decimal; end
sig { params(_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def amount_decimal=(_amount_decimal); end
# Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
sig { returns(T.nilable(String)) }
def billing_scheme; end
sig { params(_billing_scheme: T.nilable(String)).returns(T.nilable(String)) }
def billing_scheme=(_billing_scheme); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The meter tracking the usage of a metered price
sig { returns(T.nilable(String)) }
def meter; end
sig { params(_meter: T.nilable(String)).returns(T.nilable(String)) }
def meter=(_meter); end
# A brief description of the plan, hidden from customers.
sig { returns(T.nilable(String)) }
def nickname; end
sig { params(_nickname: T.nilable(String)).returns(T.nilable(String)) }
def nickname=(_nickname); end
# Attribute for param field product
sig { returns(T.nilable(T.any(::Stripe::Plan::CreateParams::Product, String))) }
def product; end
sig {
params(_product: T.nilable(T.any(::Stripe::Plan::CreateParams::Product, String))).returns(T.nilable(T.any(::Stripe::Plan::CreateParams::Product, String)))
}
def product=(_product); end
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
sig { returns(T.nilable(T::Array[::Stripe::Plan::CreateParams::Tier])) }
def tiers; end
sig {
params(_tiers: T.nilable(T::Array[::Stripe::Plan::CreateParams::Tier])).returns(T.nilable(T::Array[::Stripe::Plan::CreateParams::Tier]))
}
def tiers=(_tiers); end
# Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.
sig { returns(T.nilable(String)) }
def tiers_mode; end
sig { params(_tiers_mode: T.nilable(String)).returns(T.nilable(String)) }
def tiers_mode=(_tiers_mode); end
# Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.
sig { returns(T.nilable(::Stripe::Plan::CreateParams::TransformUsage)) }
def transform_usage; end
sig {
params(_transform_usage: T.nilable(::Stripe::Plan::CreateParams::TransformUsage)).returns(T.nilable(::Stripe::Plan::CreateParams::TransformUsage))
}
def transform_usage=(_transform_usage); end
# Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
sig { returns(T.nilable(Integer)) }
def trial_period_days; end
sig { params(_trial_period_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_period_days=(_trial_period_days); end
# Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
sig { returns(T.nilable(String)) }
def usage_type; end
sig { params(_usage_type: T.nilable(String)).returns(T.nilable(String)) }
def usage_type=(_usage_type); end
sig {
params(active: T.nilable(T::Boolean), amount: T.nilable(Integer), amount_decimal: T.nilable(String), billing_scheme: T.nilable(String), currency: String, expand: T.nilable(T::Array[String]), id: T.nilable(String), interval: String, interval_count: T.nilable(Integer), metadata: T.nilable(T.any(String, T::Hash[String, String])), meter: T.nilable(String), nickname: T.nilable(String), product: T.nilable(T.any(::Stripe::Plan::CreateParams::Product, String)), tiers: T.nilable(T::Array[::Stripe::Plan::CreateParams::Tier]), tiers_mode: T.nilable(String), transform_usage: T.nilable(::Stripe::Plan::CreateParams::TransformUsage), trial_period_days: T.nilable(Integer), usage_type: T.nilable(String)).void
}
def initialize(
active: nil,
amount: nil,
amount_decimal: nil,
billing_scheme: nil,
currency: nil,
expand: nil,
id: nil,
interval: nil,
interval_count: nil,
metadata: nil,
meter: nil,
nickname: nil,
product: nil,
tiers: nil,
tiers_mode: nil,
transform_usage: nil,
trial_period_days: nil,
usage_type: nil
); end
end
# You can now model subscriptions more flexibly using the [Prices API](https://docs.stripe.com/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
sig {
params(params: T.any(::Stripe::Plan::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan)
}
def self.create(params = {}, opts = {}); end
# Deleting plans means new subscribers can't be added. Existing subscribers aren't affected.
sig {
params(plan: String, params: T.any(::Stripe::Plan::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan)
}
def self.delete(plan, params = {}, opts = {}); end
# Deleting plans means new subscribers can't be added. Existing subscribers aren't affected.
sig {
params(params: T.any(::Stripe::Plan::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan)
}
def delete(params = {}, opts = {}); end
# Returns a list of your plans.
sig {
params(params: T.any(::Stripe::Plan::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan's ID, amount, currency, or billing cycle.
sig {
params(plan: String, params: T.any(::Stripe::Plan::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan)
}
def self.update(plan, params = {}, opts = {}); end
end
end
# typed: 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
class CurrencyOptions < Stripe::StripeObject
class CustomUnitAmount < Stripe::StripeObject
# The maximum unit amount the customer can specify for this item.
sig { returns(T.nilable(Integer)) }
def maximum; end
# The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
sig { returns(T.nilable(Integer)) }
def minimum; end
# The starting unit amount which can be updated by the customer.
sig { returns(T.nilable(Integer)) }
def preset; end
end
class Tier < Stripe::StripeObject
# Price for the entire tier.
sig { returns(T.nilable(Integer)) }
def flat_amount; end
# Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def flat_amount_decimal; end
# Per unit price for units relevant to the tier.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
# Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
# Up to and including to this quantity will be contained in the tier.
sig { returns(T.nilable(Integer)) }
def up_to; end
end
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
sig { returns(T.nilable(CustomUnitAmount)) }
def custom_unit_amount; end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
sig { returns(T.nilable(T::Array[Tier])) }
def tiers; end
# The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
# The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
end
class CustomUnitAmount < Stripe::StripeObject
# The maximum unit amount the customer can specify for this item.
sig { returns(T.nilable(Integer)) }
def maximum; end
# The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
sig { returns(T.nilable(Integer)) }
def minimum; end
# The starting unit amount which can be updated by the customer.
sig { returns(T.nilable(Integer)) }
def preset; end
end
class MigrateTo < Stripe::StripeObject
# The behavior controlling at what point in the subscription lifecycle to migrate the price
sig { returns(String) }
def behavior; end
# The unix timestamp after at which subscriptions will start to migrate to the new price.
sig { returns(Integer) }
def effective_after; end
# The id of the price being migrated to
sig { returns(String) }
def price; end
end
class Recurring < Stripe::StripeObject
# The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
# The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
sig { returns(Integer) }
def interval_count; end
# The meter tracking the usage of a metered price
sig { returns(T.nilable(String)) }
def meter; end
# Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
sig { returns(T.nilable(Integer)) }
def trial_period_days; end
# Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
sig { returns(String) }
def usage_type; end
end
class Tier < Stripe::StripeObject
# Price for the entire tier.
sig { returns(T.nilable(Integer)) }
def flat_amount; end
# Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def flat_amount_decimal; end
# Per unit price for units relevant to the tier.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
# Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
# Up to and including to this quantity will be contained in the tier.
sig { returns(T.nilable(Integer)) }
def up_to; end
end
class TransformQuantity < Stripe::StripeObject
# Divide usage by this number.
sig { returns(Integer) }
def divide_by; end
# After division, either round the result `up` or `down`.
sig { returns(String) }
def round; end
end
# Whether the price can be used for new purchases.
sig { returns(T::Boolean) }
def active; end
# Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
sig { returns(String) }
def billing_scheme; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig { returns(T.nilable(T::Hash[String, CurrencyOptions])) }
def currency_options; end
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
sig { returns(T.nilable(CustomUnitAmount)) }
def custom_unit_amount; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
sig { returns(T.nilable(String)) }
def lookup_key; end
# 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::Hash[String, String]) }
def metadata; end
# Subscriptions using this price will be migrated to use the new referenced price.
sig { returns(T.nilable(MigrateTo)) }
def migrate_to; end
# A brief description of the price, hidden from customers.
sig { returns(T.nilable(String)) }
def nickname; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The ID of the product this price is associated with.
sig { returns(T.any(String, Stripe::Product)) }
def product; end
# The recurring components of a price such as `interval` and `usage_type`.
sig { returns(T.nilable(Recurring)) }
def recurring; end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
sig { returns(T.nilable(T::Array[Tier])) }
def tiers; end
# Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.
sig { returns(T.nilable(String)) }
def tiers_mode; end
# Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
sig { returns(T.nilable(TransformQuantity)) }
def transform_quantity; end
# One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
sig { returns(String) }
def type; end
# The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
# The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class Recurring < Stripe::RequestParams
# Filter by billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# Filter by the price's meter.
sig { returns(T.nilable(String)) }
def meter; end
sig { params(_meter: T.nilable(String)).returns(T.nilable(String)) }
def meter=(_meter); end
# Filter by the usage type for this price. Can be either `metered` or `licensed`.
sig { returns(T.nilable(String)) }
def usage_type; end
sig { params(_usage_type: T.nilable(String)).returns(T.nilable(String)) }
def usage_type=(_usage_type); end
sig {
params(interval: T.nilable(String), meter: T.nilable(String), usage_type: T.nilable(String)).void
}
def initialize(interval: nil, meter: nil, usage_type: nil); end
end
# Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
sig { returns(T.nilable(T.any(::Stripe::Price::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Price::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Price::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return prices for the given currency.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.
sig { returns(T.nilable(T::Array[String])) }
def lookup_keys; end
sig { params(_lookup_keys: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def lookup_keys=(_lookup_keys); end
# Only return prices for the given product.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Only return prices with these recurring fields.
sig { returns(T.nilable(::Stripe::Price::ListParams::Recurring)) }
def recurring; end
sig {
params(_recurring: T.nilable(::Stripe::Price::ListParams::Recurring)).returns(T.nilable(::Stripe::Price::ListParams::Recurring))
}
def recurring=(_recurring); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return prices of type `recurring` or `one_time`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::Price::ListParams::Created, Integer)), currency: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), lookup_keys: T.nilable(T::Array[String]), product: T.nilable(String), recurring: T.nilable(::Stripe::Price::ListParams::Recurring), starting_after: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
active: nil,
created: nil,
currency: nil,
ending_before: nil,
expand: nil,
limit: nil,
lookup_keys: nil,
product: nil,
recurring: nil,
starting_after: nil,
type: nil
); end
end
class CreateParams < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
class CustomUnitAmount < Stripe::RequestParams
# Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum unit amount the customer can specify for this item.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
# The starting unit amount which can be updated by the customer.
sig { returns(T.nilable(Integer)) }
def preset; end
sig { params(_preset: T.nilable(Integer)).returns(T.nilable(Integer)) }
def preset=(_preset); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
end
class Tier < Stripe::RequestParams
# The flat billing amount for an entire tier, regardless of the number of units in the tier.
sig { returns(T.nilable(Integer)) }
def flat_amount; end
sig { params(_flat_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def flat_amount=(_flat_amount); end
# Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def flat_amount_decimal; end
sig { params(_flat_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def flat_amount_decimal=(_flat_amount_decimal); end
# The per unit billing amount for each individual unit for which this tier applies.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
# Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
sig { returns(T.any(String, Integer)) }
def up_to; end
sig { params(_up_to: T.any(String, Integer)).returns(T.any(String, Integer)) }
def up_to=(_up_to); end
sig {
params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
}
def initialize(
flat_amount: nil,
flat_amount_decimal: nil,
unit_amount: nil,
unit_amount_decimal: nil,
up_to: nil
); end
end
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
sig { returns(T.nilable(::Stripe::Price::CreateParams::CurrencyOptions::CustomUnitAmount)) }
def custom_unit_amount; end
sig {
params(_custom_unit_amount: T.nilable(::Stripe::Price::CreateParams::CurrencyOptions::CustomUnitAmount)).returns(T.nilable(::Stripe::Price::CreateParams::CurrencyOptions::CustomUnitAmount))
}
def custom_unit_amount=(_custom_unit_amount); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
sig { returns(T.nilable(T::Array[::Stripe::Price::CreateParams::CurrencyOptions::Tier])) }
def tiers; end
sig {
params(_tiers: T.nilable(T::Array[::Stripe::Price::CreateParams::CurrencyOptions::Tier])).returns(T.nilable(T::Array[::Stripe::Price::CreateParams::CurrencyOptions::Tier]))
}
def tiers=(_tiers); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(custom_unit_amount: T.nilable(::Stripe::Price::CreateParams::CurrencyOptions::CustomUnitAmount), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::Price::CreateParams::CurrencyOptions::Tier]), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
custom_unit_amount: nil,
tax_behavior: nil,
tiers: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class CustomUnitAmount < Stripe::RequestParams
# Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum unit amount the customer can specify for this item.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
# The starting unit amount which can be updated by the customer.
sig { returns(T.nilable(Integer)) }
def preset; end
sig { params(_preset: T.nilable(Integer)).returns(T.nilable(Integer)) }
def preset=(_preset); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
end
class ProductData < Stripe::RequestParams
# Whether the product is currently available for purchase. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
#
# This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
sig {
params(active: T.nilable(T::Boolean), id: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), name: String, statement_descriptor: T.nilable(String), tax_code: T.nilable(String), unit_label: T.nilable(String)).void
}
def initialize(
active: nil,
id: nil,
metadata: nil,
name: nil,
statement_descriptor: nil,
tax_code: nil,
unit_label: nil
); end
end
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# The meter tracking the usage of a metered price
sig { returns(T.nilable(String)) }
def meter; end
sig { params(_meter: T.nilable(String)).returns(T.nilable(String)) }
def meter=(_meter); end
# Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
sig { returns(T.nilable(Integer)) }
def trial_period_days; end
sig { params(_trial_period_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_period_days=(_trial_period_days); end
# Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
sig { returns(T.nilable(String)) }
def usage_type; end
sig { params(_usage_type: T.nilable(String)).returns(T.nilable(String)) }
def usage_type=(_usage_type); end
sig {
params(interval: String, interval_count: T.nilable(Integer), meter: T.nilable(String), trial_period_days: T.nilable(Integer), usage_type: T.nilable(String)).void
}
def initialize(
interval: nil,
interval_count: nil,
meter: nil,
trial_period_days: nil,
usage_type: nil
); end
end
class Tier < Stripe::RequestParams
# The flat billing amount for an entire tier, regardless of the number of units in the tier.
sig { returns(T.nilable(Integer)) }
def flat_amount; end
sig { params(_flat_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def flat_amount=(_flat_amount); end
# Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def flat_amount_decimal; end
sig { params(_flat_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def flat_amount_decimal=(_flat_amount_decimal); end
# The per unit billing amount for each individual unit for which this tier applies.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
# Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
sig { returns(T.any(String, Integer)) }
def up_to; end
sig { params(_up_to: T.any(String, Integer)).returns(T.any(String, Integer)) }
def up_to=(_up_to); end
sig {
params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
}
def initialize(
flat_amount: nil,
flat_amount_decimal: nil,
unit_amount: nil,
unit_amount_decimal: nil,
up_to: nil
); end
end
class TransformQuantity < Stripe::RequestParams
# Divide usage by this number.
sig { returns(Integer) }
def divide_by; end
sig { params(_divide_by: Integer).returns(Integer) }
def divide_by=(_divide_by); end
# After division, either round the result `up` or `down`.
sig { returns(String) }
def round; end
sig { params(_round: String).returns(String) }
def round=(_round); end
sig { params(divide_by: Integer, round: String).void }
def initialize(divide_by: nil, round: nil); end
end
# Whether the price can be used for new purchases. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
sig { returns(T.nilable(String)) }
def billing_scheme; end
sig { params(_billing_scheme: T.nilable(String)).returns(T.nilable(String)) }
def billing_scheme=(_billing_scheme); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig { returns(T.nilable(T::Hash[String, ::Stripe::Price::CreateParams::CurrencyOptions])) }
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::Price::CreateParams::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::Price::CreateParams::CurrencyOptions]))
}
def currency_options=(_currency_options); end
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
sig { returns(T.nilable(::Stripe::Price::CreateParams::CustomUnitAmount)) }
def custom_unit_amount; end
sig {
params(_custom_unit_amount: T.nilable(::Stripe::Price::CreateParams::CustomUnitAmount)).returns(T.nilable(::Stripe::Price::CreateParams::CustomUnitAmount))
}
def custom_unit_amount=(_custom_unit_amount); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
sig { returns(T.nilable(String)) }
def lookup_key; end
sig { params(_lookup_key: T.nilable(String)).returns(T.nilable(String)) }
def lookup_key=(_lookup_key); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# A brief description of the price, hidden from customers.
sig { returns(T.nilable(String)) }
def nickname; end
sig { params(_nickname: T.nilable(String)).returns(T.nilable(String)) }
def nickname=(_nickname); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# These fields can be used to create a new product that this price will belong to.
sig { returns(T.nilable(::Stripe::Price::CreateParams::ProductData)) }
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::Price::CreateParams::ProductData)).returns(T.nilable(::Stripe::Price::CreateParams::ProductData))
}
def product_data=(_product_data); end
# The recurring components of a price such as `interval` and `usage_type`.
sig { returns(T.nilable(::Stripe::Price::CreateParams::Recurring)) }
def recurring; end
sig {
params(_recurring: T.nilable(::Stripe::Price::CreateParams::Recurring)).returns(T.nilable(::Stripe::Price::CreateParams::Recurring))
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
sig { returns(T.nilable(T::Array[::Stripe::Price::CreateParams::Tier])) }
def tiers; end
sig {
params(_tiers: T.nilable(T::Array[::Stripe::Price::CreateParams::Tier])).returns(T.nilable(T::Array[::Stripe::Price::CreateParams::Tier]))
}
def tiers=(_tiers); end
# Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.
sig { returns(T.nilable(String)) }
def tiers_mode; end
sig { params(_tiers_mode: T.nilable(String)).returns(T.nilable(String)) }
def tiers_mode=(_tiers_mode); end
# If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
sig { returns(T.nilable(T::Boolean)) }
def transfer_lookup_key; end
sig { params(_transfer_lookup_key: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def transfer_lookup_key=(_transfer_lookup_key); end
# Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.
sig { returns(T.nilable(::Stripe::Price::CreateParams::TransformQuantity)) }
def transform_quantity; end
sig {
params(_transform_quantity: T.nilable(::Stripe::Price::CreateParams::TransformQuantity)).returns(T.nilable(::Stripe::Price::CreateParams::TransformQuantity))
}
def transform_quantity=(_transform_quantity); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(active: T.nilable(T::Boolean), billing_scheme: T.nilable(String), currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::Price::CreateParams::CurrencyOptions]), custom_unit_amount: T.nilable(::Stripe::Price::CreateParams::CustomUnitAmount), expand: T.nilable(T::Array[String]), lookup_key: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), nickname: T.nilable(String), product: T.nilable(String), product_data: T.nilable(::Stripe::Price::CreateParams::ProductData), recurring: T.nilable(::Stripe::Price::CreateParams::Recurring), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::Price::CreateParams::Tier]), tiers_mode: T.nilable(String), transfer_lookup_key: T.nilable(T::Boolean), transform_quantity: T.nilable(::Stripe::Price::CreateParams::TransformQuantity), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
active: nil,
billing_scheme: nil,
currency: nil,
currency_options: nil,
custom_unit_amount: nil,
expand: nil,
lookup_key: nil,
metadata: nil,
nickname: nil,
product: nil,
product_data: nil,
recurring: nil,
tax_behavior: nil,
tiers: nil,
tiers_mode: nil,
transfer_lookup_key: nil,
transform_quantity: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class UpdateParams < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
class CustomUnitAmount < Stripe::RequestParams
# Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum unit amount the customer can specify for this item.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
# The starting unit amount which can be updated by the customer.
sig { returns(T.nilable(Integer)) }
def preset; end
sig { params(_preset: T.nilable(Integer)).returns(T.nilable(Integer)) }
def preset=(_preset); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
end
class Tier < Stripe::RequestParams
# The flat billing amount for an entire tier, regardless of the number of units in the tier.
sig { returns(T.nilable(Integer)) }
def flat_amount; end
sig { params(_flat_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def flat_amount=(_flat_amount); end
# Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def flat_amount_decimal; end
sig { params(_flat_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def flat_amount_decimal=(_flat_amount_decimal); end
# The per unit billing amount for each individual unit for which this tier applies.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
# Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
sig { returns(T.any(String, Integer)) }
def up_to; end
sig { params(_up_to: T.any(String, Integer)).returns(T.any(String, Integer)) }
def up_to=(_up_to); end
sig {
params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
}
def initialize(
flat_amount: nil,
flat_amount_decimal: nil,
unit_amount: nil,
unit_amount_decimal: nil,
up_to: nil
); end
end
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
sig { returns(T.nilable(::Stripe::Price::UpdateParams::CurrencyOptions::CustomUnitAmount)) }
def custom_unit_amount; end
sig {
params(_custom_unit_amount: T.nilable(::Stripe::Price::UpdateParams::CurrencyOptions::CustomUnitAmount)).returns(T.nilable(::Stripe::Price::UpdateParams::CurrencyOptions::CustomUnitAmount))
}
def custom_unit_amount=(_custom_unit_amount); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
sig { returns(T.nilable(T::Array[::Stripe::Price::UpdateParams::CurrencyOptions::Tier])) }
def tiers; end
sig {
params(_tiers: T.nilable(T::Array[::Stripe::Price::UpdateParams::CurrencyOptions::Tier])).returns(T.nilable(T::Array[::Stripe::Price::UpdateParams::CurrencyOptions::Tier]))
}
def tiers=(_tiers); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(custom_unit_amount: T.nilable(::Stripe::Price::UpdateParams::CurrencyOptions::CustomUnitAmount), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::Price::UpdateParams::CurrencyOptions::Tier]), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
custom_unit_amount: nil,
tax_behavior: nil,
tiers: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class MigrateTo < Stripe::RequestParams
# The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
# The time after which subscriptions should start using the new price.
sig { returns(T.nilable(Integer)) }
def effective_after; end
sig { params(_effective_after: T.nilable(Integer)).returns(T.nilable(Integer)) }
def effective_after=(_effective_after); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
sig { params(behavior: String, effective_after: T.nilable(Integer), price: String).void }
def initialize(behavior: nil, effective_after: nil, price: nil); end
end
# Whether the price can be used for new purchases. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T.any(String, T::Hash[String, ::Stripe::Price::UpdateParams::CurrencyOptions])))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T.any(String, T::Hash[String, ::Stripe::Price::UpdateParams::CurrencyOptions]))).returns(T.nilable(T.any(String, T::Hash[String, ::Stripe::Price::UpdateParams::CurrencyOptions])))
}
def currency_options=(_currency_options); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
sig { returns(T.nilable(String)) }
def lookup_key; end
sig { params(_lookup_key: T.nilable(String)).returns(T.nilable(String)) }
def lookup_key=(_lookup_key); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# If specified, subscriptions using this price will be updated to use the new referenced price.
sig { returns(T.nilable(T.any(String, ::Stripe::Price::UpdateParams::MigrateTo))) }
def migrate_to; end
sig {
params(_migrate_to: T.nilable(T.any(String, ::Stripe::Price::UpdateParams::MigrateTo))).returns(T.nilable(T.any(String, ::Stripe::Price::UpdateParams::MigrateTo)))
}
def migrate_to=(_migrate_to); end
# A brief description of the price, hidden from customers.
sig { returns(T.nilable(String)) }
def nickname; end
sig { params(_nickname: T.nilable(String)).returns(T.nilable(String)) }
def nickname=(_nickname); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
sig { returns(T.nilable(T::Boolean)) }
def transfer_lookup_key; end
sig { params(_transfer_lookup_key: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def transfer_lookup_key=(_transfer_lookup_key); end
sig {
params(active: T.nilable(T::Boolean), currency_options: T.nilable(T.any(String, T::Hash[String, ::Stripe::Price::UpdateParams::CurrencyOptions])), expand: T.nilable(T::Array[String]), lookup_key: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), migrate_to: T.nilable(T.any(String, ::Stripe::Price::UpdateParams::MigrateTo)), nickname: T.nilable(String), tax_behavior: T.nilable(String), transfer_lookup_key: T.nilable(T::Boolean)).void
}
def initialize(
active: nil,
currency_options: nil,
expand: nil,
lookup_key: nil,
metadata: nil,
migrate_to: nil,
nickname: nil,
tax_behavior: nil,
transfer_lookup_key: nil
); end
end
class SearchParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
sig { returns(T.nilable(String)) }
def page; end
sig { params(_page: T.nilable(String)).returns(T.nilable(String)) }
def page=(_page); end
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for prices](https://stripe.com/docs/search#query-fields-for-prices).
sig { returns(String) }
def query; end
sig { params(_query: String).returns(String) }
def query=(_query); end
sig {
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
}
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
end
# Creates a new [Price for an existing Product](https://docs.stripe.com/api/prices). The Price can be recurring or one-time.
sig {
params(params: T.any(::Stripe::Price::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Price)
}
def self.create(params = {}, opts = {}); end
# Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
sig {
params(params: T.any(::Stripe::Price::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
sig {
params(params: T.any(::Stripe::Price::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
}
def self.search(params = {}, opts = {}); end
sig {
params(params: T.any(::Stripe::Price::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, blk: T.untyped).returns(Stripe::SearchResultObject)
}
def self.search_auto_paging_each(params = {}, opts = {}, &blk); end
# Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
sig {
params(price: String, params: T.any(::Stripe::Price::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Price)
}
def self.update(price, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
module Privacy
# The Redaction Job object redacts Stripe objects. You can use it
# to coordinate the removal of personal information from selected
# objects, making them permanently inaccessible in the Stripe Dashboard
# and API.
class RedactionJob < APIResource
class Objects < Stripe::StripeObject
# Charge object identifiers usually starting with `ch_`
sig { returns(T.nilable(T::Array[String])) }
def charges; end
# CheckoutSession object identifiers starting with `cs_`
sig { returns(T.nilable(T::Array[String])) }
def checkout_sessions; end
# Customer object identifiers starting with `cus_`
sig { returns(T.nilable(T::Array[String])) }
def customers; end
# Identity VerificationSessions object identifiers starting with `vs_`
sig { returns(T.nilable(T::Array[String])) }
def identity_verification_sessions; end
# Invoice object identifiers starting with `in_`
sig { returns(T.nilable(T::Array[String])) }
def invoices; end
# Issuing Cardholder object identifiers starting with `ich_`
sig { returns(T.nilable(T::Array[String])) }
def issuing_cardholders; end
# PaymentIntent object identifiers starting with `pi_`
sig { returns(T.nilable(T::Array[String])) }
def payment_intents; end
# Fraud ValueListItem object identifiers starting with `rsli_`
sig { returns(T.nilable(T::Array[String])) }
def radar_value_list_items; end
# SetupIntent object identifiers starting with `seti_`
sig { returns(T.nilable(T::Array[String])) }
def setup_intents; end
end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The objects to redact in this job.
sig { returns(T.nilable(Objects)) }
def objects; end
# The status of the job.
sig { returns(String) }
def status; end
# Validation behavior determines how a job validates objects for redaction eligibility. Default is `error`.
sig { returns(T.nilable(String)) }
def validation_behavior; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Attribute for param field status
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class Objects < Stripe::RequestParams
# Attribute for param field charges
sig { returns(T.nilable(T::Array[String])) }
def charges; end
sig { params(_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def charges=(_charges); end
# Attribute for param field checkout_sessions
sig { returns(T.nilable(T::Array[String])) }
def checkout_sessions; end
sig {
params(_checkout_sessions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def checkout_sessions=(_checkout_sessions); end
# Attribute for param field customers
sig { returns(T.nilable(T::Array[String])) }
def customers; end
sig {
params(_customers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def customers=(_customers); end
# Attribute for param field identity_verification_sessions
sig { returns(T.nilable(T::Array[String])) }
def identity_verification_sessions; end
sig {
params(_identity_verification_sessions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def identity_verification_sessions=(_identity_verification_sessions); end
# Attribute for param field invoices
sig { returns(T.nilable(T::Array[String])) }
def invoices; end
sig {
params(_invoices: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def invoices=(_invoices); end
# Attribute for param field issuing_cardholders
sig { returns(T.nilable(T::Array[String])) }
def issuing_cardholders; end
sig {
params(_issuing_cardholders: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def issuing_cardholders=(_issuing_cardholders); end
# Attribute for param field issuing_cards
sig { returns(T.nilable(T::Array[String])) }
def issuing_cards; end
sig {
params(_issuing_cards: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def issuing_cards=(_issuing_cards); end
# Attribute for param field payment_intents
sig { returns(T.nilable(T::Array[String])) }
def payment_intents; end
sig {
params(_payment_intents: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_intents=(_payment_intents); end
# Attribute for param field radar_value_list_items
sig { returns(T.nilable(T::Array[String])) }
def radar_value_list_items; end
sig {
params(_radar_value_list_items: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def radar_value_list_items=(_radar_value_list_items); end
# Attribute for param field setup_intents
sig { returns(T.nilable(T::Array[String])) }
def setup_intents; end
sig {
params(_setup_intents: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def setup_intents=(_setup_intents); end
sig {
params(charges: T.nilable(T::Array[String]), checkout_sessions: T.nilable(T::Array[String]), customers: T.nilable(T::Array[String]), identity_verification_sessions: T.nilable(T::Array[String]), invoices: T.nilable(T::Array[String]), issuing_cardholders: T.nilable(T::Array[String]), issuing_cards: T.nilable(T::Array[String]), payment_intents: T.nilable(T::Array[String]), radar_value_list_items: T.nilable(T::Array[String]), setup_intents: T.nilable(T::Array[String])).void
}
def initialize(
charges: nil,
checkout_sessions: nil,
customers: nil,
identity_verification_sessions: nil,
invoices: nil,
issuing_cardholders: nil,
issuing_cards: nil,
payment_intents: nil,
radar_value_list_items: nil,
setup_intents: nil
); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The objects to redact. These root objects and their related ones will be validated for redaction.
sig { returns(::Stripe::Privacy::RedactionJob::CreateParams::Objects) }
def objects; end
sig {
params(_objects: ::Stripe::Privacy::RedactionJob::CreateParams::Objects).returns(::Stripe::Privacy::RedactionJob::CreateParams::Objects)
}
def objects=(_objects); end
# Determines the validation behavior of the job. Default is `error`.
sig { returns(T.nilable(String)) }
def validation_behavior; end
sig { params(_validation_behavior: T.nilable(String)).returns(T.nilable(String)) }
def validation_behavior=(_validation_behavior); end
sig {
params(expand: T.nilable(T::Array[String]), objects: ::Stripe::Privacy::RedactionJob::CreateParams::Objects, validation_behavior: T.nilable(String)).void
}
def initialize(expand: nil, objects: nil, validation_behavior: nil); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Determines the validation behavior of the job. Default is `error`.
sig { returns(T.nilable(String)) }
def validation_behavior; end
sig { params(_validation_behavior: T.nilable(String)).returns(T.nilable(String)) }
def validation_behavior=(_validation_behavior); end
sig {
params(expand: T.nilable(T::Array[String]), validation_behavior: T.nilable(String)).void
}
def initialize(expand: nil, validation_behavior: nil); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class RunParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ValidateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# You can cancel a redaction job when it's in one of these statuses: ready, failed.
#
# Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.
sig {
params(params: T.any(::Stripe::Privacy::RedactionJob::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Privacy::RedactionJob)
}
def cancel(params = {}, opts = {}); end
# You can cancel a redaction job when it's in one of these statuses: ready, failed.
#
# Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.
sig {
params(job: String, params: T.any(::Stripe::Privacy::RedactionJob::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Privacy::RedactionJob)
}
def self.cancel(job, params = {}, opts = {}); end
# Creates a redaction job. When a job is created, it will start to validate.
sig {
params(params: T.any(::Stripe::Privacy::RedactionJob::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Privacy::RedactionJob)
}
def self.create(params = {}, opts = {}); end
# Returns a list of redaction jobs.
sig {
params(params: T.any(::Stripe::Privacy::RedactionJob::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Run a redaction job in a ready status.
#
# When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.
#
# The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job's validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.
sig {
params(params: T.any(::Stripe::Privacy::RedactionJob::RunParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Privacy::RedactionJob)
}
def run(params = {}, opts = {}); end
# Run a redaction job in a ready status.
#
# When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.
#
# The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job's validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.
sig {
params(job: String, params: T.any(::Stripe::Privacy::RedactionJob::RunParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Privacy::RedactionJob)
}
def self.run(job, params = {}, opts = {}); end
# Updates the properties of a redaction job without running or canceling the job.
#
# If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.
sig {
params(job: String, params: T.any(::Stripe::Privacy::RedactionJob::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Privacy::RedactionJob)
}
def self.update(job, params = {}, opts = {}); end
# Validate a redaction job when it is in a failed status.
#
# When a job is created, it automatically begins to validate on the configured objects' eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job's validation_behavior is changed.
#
# The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.
sig {
params(params: T.any(::Stripe::Privacy::RedactionJob::ValidateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Privacy::RedactionJob)
}
def validate(params = {}, opts = {}); end
# Validate a redaction job when it is in a failed status.
#
# When a job is created, it automatically begins to validate on the configured objects' eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job's validation_behavior is changed.
#
# The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.
sig {
params(job: String, params: T.any(::Stripe::Privacy::RedactionJob::ValidateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Privacy::RedactionJob)
}
def self.validate(job, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Privacy
# The Redaction Job validation error object contains information about
# errors that affect the ability to redact a specific object in a
# redaction job.
class RedactionJobValidationError < APIResource
class ErroringObject < Stripe::StripeObject
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Erroring object type
sig { returns(String) }
def object_type; end
end
# A code indicating the reason for the error.
sig { returns(String) }
def code; end
# If the error is related to a specific object, this field includes the object's identifier and object type.
sig { returns(T.nilable(ErroringObject)) }
def erroring_object; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# A human-readable message providing more details about the error.
sig { returns(String) }
def message; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
end
end
end
# typed: 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/payment-links),
# [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
class MarketingFeature < Stripe::StripeObject
# The marketing feature name. Up to 80 characters long.
sig { returns(T.nilable(String)) }
def name; end
end
class PackageDimensions < Stripe::StripeObject
# Height, in inches.
sig { returns(Float) }
def height; end
# Length, in inches.
sig { returns(Float) }
def length; end
# Weight, in ounces.
sig { returns(Float) }
def weight; end
# Width, in inches.
sig { returns(Float) }
def width; end
end
# Whether the product is currently available for purchase.
sig { returns(T::Boolean) }
def active; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.
sig { returns(T.nilable(T.any(String, Stripe::Price))) }
def default_price; end
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T::Array[String]) }
def images; end
# 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) }
def livemode; end
# A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
sig { returns(T::Array[MarketingFeature]) }
def marketing_features; end
# 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::Hash[String, String]) }
def metadata; end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The dimensions of this product for shipping purposes.
sig { returns(T.nilable(PackageDimensions)) }
def package_dimensions; end
# Whether this product is shipped (i.e., physical goods).
sig { returns(T.nilable(T::Boolean)) }
def shippable; end
# Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(T.any(String, Stripe::TaxCode))) }
def tax_code; end
# The type of the product. The product is either of type `good`, which is eligible for use with Orders and SKUs, or `service`, which is eligible for use with Subscriptions and Plans.
sig { returns(String) }
def type; end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
# Time at which the object was last updated. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def updated; end
# A URL of a publicly-accessible webpage for this product.
sig { returns(T.nilable(String)) }
def url; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams; end
class UpdateParams < Stripe::RequestParams
class MarketingFeature < Stripe::RequestParams
# The marketing feature name. Up to 80 characters long.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class PackageDimensions < Stripe::RequestParams
# Height, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def height; end
sig { params(_height: Float).returns(Float) }
def height=(_height); end
# Length, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def length; end
sig { params(_length: Float).returns(Float) }
def length=(_length); end
# Weight, in ounces. Maximum precision is 2 decimal places.
sig { returns(Float) }
def weight; end
sig { params(_weight: Float).returns(Float) }
def weight=(_weight); end
# Width, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def width; end
sig { params(_width: Float).returns(Float) }
def width=(_width); end
sig { params(height: Float, length: Float, weight: Float, width: Float).void }
def initialize(height: nil, length: nil, weight: nil, width: nil); end
end
# Whether the product is available for purchase.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.
sig { returns(T.nilable(String)) }
def default_price; end
sig { params(_default_price: T.nilable(String)).returns(T.nilable(String)) }
def default_price=(_default_price); end
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def images; end
sig {
params(_images: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def images=(_images); end
# A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Product::UpdateParams::MarketingFeature])))
}
def marketing_features; end
sig {
params(_marketing_features: T.nilable(T.any(String, T::Array[::Stripe::Product::UpdateParams::MarketingFeature]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Product::UpdateParams::MarketingFeature])))
}
def marketing_features=(_marketing_features); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The dimensions of this product for shipping purposes.
sig { returns(T.nilable(T.any(String, ::Stripe::Product::UpdateParams::PackageDimensions))) }
def package_dimensions; end
sig {
params(_package_dimensions: T.nilable(T.any(String, ::Stripe::Product::UpdateParams::PackageDimensions))).returns(T.nilable(T.any(String, ::Stripe::Product::UpdateParams::PackageDimensions)))
}
def package_dimensions=(_package_dimensions); end
# Whether this product is shipped (i.e., physical goods).
sig { returns(T.nilable(T::Boolean)) }
def shippable; end
sig { params(_shippable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def shippable=(_shippable); end
# An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
#
# This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
# It must contain at least one letter. May only be set if `type=service`. Only used for subscription payments.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
# A URL of a publicly-accessible webpage for this product.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(active: T.nilable(T::Boolean), default_price: T.nilable(String), description: T.nilable(String), expand: T.nilable(T::Array[String]), images: T.nilable(T.any(String, T::Array[String])), marketing_features: T.nilable(T.any(String, T::Array[::Stripe::Product::UpdateParams::MarketingFeature])), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String), package_dimensions: T.nilable(T.any(String, ::Stripe::Product::UpdateParams::PackageDimensions)), shippable: T.nilable(T::Boolean), statement_descriptor: T.nilable(String), tax_code: T.nilable(String), unit_label: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
active: nil,
default_price: nil,
description: nil,
expand: nil,
images: nil,
marketing_features: nil,
metadata: nil,
name: nil,
package_dimensions: nil,
shippable: nil,
statement_descriptor: nil,
tax_code: nil,
unit_label: nil,
url: nil
); end
end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return products that are active or inactive (e.g., pass `false` to list all inactive products).
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Only return products that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Product::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Product::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Product::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before).
sig { returns(T.nilable(T::Array[String])) }
def ids; end
sig { params(_ids: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def ids=(_ids); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return products that can be shipped (i.e., physical, not digital products).
sig { returns(T.nilable(T::Boolean)) }
def shippable; end
sig { params(_shippable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def shippable=(_shippable); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return products of this type.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# Only return products with the given url.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::Product::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), ids: T.nilable(T::Array[String]), limit: T.nilable(Integer), shippable: T.nilable(T::Boolean), starting_after: T.nilable(String), type: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
active: nil,
created: nil,
ending_before: nil,
expand: nil,
ids: nil,
limit: nil,
shippable: nil,
starting_after: nil,
type: nil,
url: nil
); end
end
class CreateParams < Stripe::RequestParams
class DefaultPriceData < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
class CustomUnitAmount < Stripe::RequestParams
# Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum unit amount the customer can specify for this item.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
# The starting unit amount which can be updated by the customer.
sig { returns(T.nilable(Integer)) }
def preset; end
sig { params(_preset: T.nilable(Integer)).returns(T.nilable(Integer)) }
def preset=(_preset); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
end
class Tier < Stripe::RequestParams
# The flat billing amount for an entire tier, regardless of the number of units in the tier.
sig { returns(T.nilable(Integer)) }
def flat_amount; end
sig { params(_flat_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def flat_amount=(_flat_amount); end
# Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def flat_amount_decimal; end
sig { params(_flat_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def flat_amount_decimal=(_flat_amount_decimal); end
# The per unit billing amount for each individual unit for which this tier applies.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
# Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
sig { returns(T.any(String, Integer)) }
def up_to; end
sig { params(_up_to: T.any(String, Integer)).returns(T.any(String, Integer)) }
def up_to=(_up_to); end
sig {
params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
}
def initialize(
flat_amount: nil,
flat_amount_decimal: nil,
unit_amount: nil,
unit_amount_decimal: nil,
up_to: nil
); end
end
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
sig {
returns(T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions::CustomUnitAmount))
}
def custom_unit_amount; end
sig {
params(_custom_unit_amount: T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions::CustomUnitAmount)).returns(T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions::CustomUnitAmount))
}
def custom_unit_amount=(_custom_unit_amount); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
sig {
returns(T.nilable(T::Array[::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions::Tier]))
}
def tiers; end
sig {
params(_tiers: T.nilable(T::Array[::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions::Tier])).returns(T.nilable(T::Array[::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions::Tier]))
}
def tiers=(_tiers); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(custom_unit_amount: T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions::CustomUnitAmount), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions::Tier]), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
custom_unit_amount: nil,
tax_behavior: nil,
tiers: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class CustomUnitAmount < Stripe::RequestParams
# Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum unit amount the customer can specify for this item.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
# The starting unit amount which can be updated by the customer.
sig { returns(T.nilable(Integer)) }
def preset; end
sig { params(_preset: T.nilable(Integer)).returns(T.nilable(Integer)) }
def preset=(_preset); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
end
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions]))
}
def currency_options=(_currency_options); end
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
sig {
returns(T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::CustomUnitAmount))
}
def custom_unit_amount; end
sig {
params(_custom_unit_amount: T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::CustomUnitAmount)).returns(T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::CustomUnitAmount))
}
def custom_unit_amount=(_custom_unit_amount); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The recurring components of a price such as `interval` and `interval_count`.
sig { returns(T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::Recurring)) }
def recurring; end
sig {
params(_recurring: T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::Recurring)).returns(T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::Recurring))
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions]), custom_unit_amount: T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::CustomUnitAmount), metadata: T.nilable(T::Hash[String, String]), recurring: T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
currency_options: nil,
custom_unit_amount: nil,
metadata: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class MarketingFeature < Stripe::RequestParams
# The marketing feature name. Up to 80 characters long.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class PackageDimensions < Stripe::RequestParams
# Height, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def height; end
sig { params(_height: Float).returns(Float) }
def height=(_height); end
# Length, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def length; end
sig { params(_length: Float).returns(Float) }
def length=(_length); end
# Weight, in ounces. Maximum precision is 2 decimal places.
sig { returns(Float) }
def weight; end
sig { params(_weight: Float).returns(Float) }
def weight=(_weight); end
# Width, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def width; end
sig { params(_width: Float).returns(Float) }
def width=(_width); end
sig { params(height: Float, length: Float, weight: Float, width: Float).void }
def initialize(height: nil, length: nil, weight: nil, width: nil); end
end
# Whether the product is currently available for purchase. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product.
sig { returns(T.nilable(::Stripe::Product::CreateParams::DefaultPriceData)) }
def default_price_data; end
sig {
params(_default_price_data: T.nilable(::Stripe::Product::CreateParams::DefaultPriceData)).returns(T.nilable(::Stripe::Product::CreateParams::DefaultPriceData))
}
def default_price_data=(_default_price_data); end
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T::Array[String])) }
def images; end
sig { params(_images: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def images=(_images); end
# A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
sig { returns(T.nilable(T::Array[::Stripe::Product::CreateParams::MarketingFeature])) }
def marketing_features; end
sig {
params(_marketing_features: T.nilable(T::Array[::Stripe::Product::CreateParams::MarketingFeature])).returns(T.nilable(T::Array[::Stripe::Product::CreateParams::MarketingFeature]))
}
def marketing_features=(_marketing_features); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The dimensions of this product for shipping purposes.
sig { returns(T.nilable(::Stripe::Product::CreateParams::PackageDimensions)) }
def package_dimensions; end
sig {
params(_package_dimensions: T.nilable(::Stripe::Product::CreateParams::PackageDimensions)).returns(T.nilable(::Stripe::Product::CreateParams::PackageDimensions))
}
def package_dimensions=(_package_dimensions); end
# Whether this product is shipped (i.e., physical goods).
sig { returns(T.nilable(T::Boolean)) }
def shippable; end
sig { params(_shippable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def shippable=(_shippable); end
# An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
#
# This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
# It must contain at least one letter. Only used for subscription payments.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The type of the product. Defaults to `service` if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to `good` to use this product with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for compatibility reasons.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
# A URL of a publicly-accessible webpage for this product.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(active: T.nilable(T::Boolean), default_price_data: T.nilable(::Stripe::Product::CreateParams::DefaultPriceData), description: T.nilable(String), expand: T.nilable(T::Array[String]), id: T.nilable(String), images: T.nilable(T::Array[String]), marketing_features: T.nilable(T::Array[::Stripe::Product::CreateParams::MarketingFeature]), metadata: T.nilable(T::Hash[String, String]), name: String, package_dimensions: T.nilable(::Stripe::Product::CreateParams::PackageDimensions), shippable: T.nilable(T::Boolean), statement_descriptor: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String), unit_label: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
active: nil,
default_price_data: nil,
description: nil,
expand: nil,
id: nil,
images: nil,
marketing_features: nil,
metadata: nil,
name: nil,
package_dimensions: nil,
shippable: nil,
statement_descriptor: nil,
tax_code: nil,
type: nil,
unit_label: nil,
url: nil
); end
end
class SearchParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
sig { returns(T.nilable(String)) }
def page; end
sig { params(_page: T.nilable(String)).returns(T.nilable(String)) }
def page=(_page); end
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for products](https://stripe.com/docs/search#query-fields-for-products).
sig { returns(String) }
def query; end
sig { params(_query: String).returns(String) }
def query=(_query); end
sig {
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
}
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
end
# Creates a new product object.
sig {
params(params: T.any(::Stripe::Product::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Product)
}
def self.create(params = {}, opts = {}); end
# Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.
sig {
params(id: String, params: T.any(::Stripe::Product::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Product)
}
def self.delete(id, params = {}, opts = {}); end
# Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.
sig {
params(params: T.any(::Stripe::Product::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Product)
}
def delete(params = {}, opts = {}); end
# Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
sig {
params(params: T.any(::Stripe::Product::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
sig {
params(params: T.any(::Stripe::Product::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
}
def self.search(params = {}, opts = {}); end
sig {
params(params: T.any(::Stripe::Product::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, blk: T.untyped).returns(Stripe::SearchResultObject)
}
def self.search_auto_paging_each(params = {}, opts = {}, &blk); end
# Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(id: String, params: T.any(::Stripe::Product::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Product)
}
def self.update(id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# A product_feature represents an attachment between a feature and a product.
# When a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer.
class ProductFeature < APIResource
# A feature represents a monetizable ability or functionality in your system.
# Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
sig { returns(Stripe::Entitlements::Feature) }
def entitlement_feature; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
end
end
# typed: true
module Stripe
# A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons).
# You can create multiple codes for a single coupon.
#
# If you enable promotion codes in your [customer portal configuration](https://stripe.com/docs/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal.
# Customers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal.
class PromotionCode < APIResource
class Restrictions < Stripe::StripeObject
class CurrencyOptions < Stripe::StripeObject
# Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
sig { returns(Integer) }
def minimum_amount; end
end
# Promotion code restrictions defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig { returns(T.nilable(T::Hash[String, CurrencyOptions])) }
def currency_options; end
# A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
sig { returns(T::Boolean) }
def first_time_transaction; end
# Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
# Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount
sig { returns(T.nilable(String)) }
def minimum_amount_currency; end
end
# Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
sig { returns(T::Boolean) }
def active; end
# The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).
sig { returns(String) }
def code; end
# 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) }
def coupon; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The customer that this promotion code can be used by.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# The account that this promotion code can be used by.
sig { returns(T.nilable(String)) }
def customer_account; end
# Date at which the promotion code can no longer be redeemed.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# Maximum number of times this promotion code can be redeemed.
sig { returns(T.nilable(Integer)) }
def max_redemptions; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Attribute for field restrictions
sig { returns(Restrictions) }
def restrictions; end
# Number of times this promotion code has been used.
sig { returns(Integer) }
def times_redeemed; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Filter promotion codes by whether they are active.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Only return promotion codes that have this case-insensitive code.
sig { returns(T.nilable(String)) }
def code; end
sig { params(_code: T.nilable(String)).returns(T.nilable(String)) }
def code=(_code); end
# Only return promotion codes for this coupon.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
sig { returns(T.nilable(T.any(::Stripe::PromotionCode::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::PromotionCode::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::PromotionCode::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return promotion codes that are restricted to this customer.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Only return promotion codes that are restricted to this account.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(active: T.nilable(T::Boolean), code: T.nilable(String), coupon: T.nilable(String), created: T.nilable(T.any(::Stripe::PromotionCode::ListParams::Created, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
active: nil,
code: nil,
coupon: nil,
created: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Restrictions < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
sig { params(minimum_amount: T.nilable(Integer)).void }
def initialize(minimum_amount: nil); end
end
# Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::PromotionCode::CreateParams::Restrictions::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::PromotionCode::CreateParams::Restrictions::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::PromotionCode::CreateParams::Restrictions::CurrencyOptions]))
}
def currency_options=(_currency_options); end
# A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
sig { returns(T.nilable(T::Boolean)) }
def first_time_transaction; end
sig {
params(_first_time_transaction: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def first_time_transaction=(_first_time_transaction); end
# Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount
sig { returns(T.nilable(String)) }
def minimum_amount_currency; end
sig { params(_minimum_amount_currency: T.nilable(String)).returns(T.nilable(String)) }
def minimum_amount_currency=(_minimum_amount_currency); end
sig {
params(currency_options: T.nilable(T::Hash[String, ::Stripe::PromotionCode::CreateParams::Restrictions::CurrencyOptions]), first_time_transaction: T.nilable(T::Boolean), minimum_amount: T.nilable(Integer), minimum_amount_currency: T.nilable(String)).void
}
def initialize(
currency_options: nil,
first_time_transaction: nil,
minimum_amount: nil,
minimum_amount_currency: nil
); end
end
# Whether the promotion code is currently active.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).
#
# If left blank, we will generate one automatically.
sig { returns(T.nilable(String)) }
def code; end
sig { params(_code: T.nilable(String)).returns(T.nilable(String)) }
def code=(_code); end
# The coupon for this promotion code.
sig { returns(String) }
def coupon; end
sig { params(_coupon: String).returns(String) }
def coupon=(_coupon); end
# The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The account that this promotion code can be used by. If not set, the promotion code can be used by all accounts.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`.
sig { returns(T.nilable(Integer)) }
def max_redemptions; end
sig { params(_max_redemptions: T.nilable(Integer)).returns(T.nilable(Integer)) }
def max_redemptions=(_max_redemptions); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Settings that restrict the redemption of the promotion code.
sig { returns(T.nilable(::Stripe::PromotionCode::CreateParams::Restrictions)) }
def restrictions; end
sig {
params(_restrictions: T.nilable(::Stripe::PromotionCode::CreateParams::Restrictions)).returns(T.nilable(::Stripe::PromotionCode::CreateParams::Restrictions))
}
def restrictions=(_restrictions); end
sig {
params(active: T.nilable(T::Boolean), code: T.nilable(String), coupon: String, customer: T.nilable(String), customer_account: T.nilable(String), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), max_redemptions: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), restrictions: T.nilable(::Stripe::PromotionCode::CreateParams::Restrictions)).void
}
def initialize(
active: nil,
code: nil,
coupon: nil,
customer: nil,
customer_account: nil,
expand: nil,
expires_at: nil,
max_redemptions: nil,
metadata: nil,
restrictions: nil
); end
end
class UpdateParams < Stripe::RequestParams
class Restrictions < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
sig { params(minimum_amount: T.nilable(Integer)).void }
def initialize(minimum_amount: nil); end
end
# Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::PromotionCode::UpdateParams::Restrictions::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::PromotionCode::UpdateParams::Restrictions::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::PromotionCode::UpdateParams::Restrictions::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(currency_options: T.nilable(T::Hash[String, ::Stripe::PromotionCode::UpdateParams::Restrictions::CurrencyOptions])).void
}
def initialize(currency_options: nil); end
end
# Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Settings that restrict the redemption of the promotion code.
sig { returns(T.nilable(::Stripe::PromotionCode::UpdateParams::Restrictions)) }
def restrictions; end
sig {
params(_restrictions: T.nilable(::Stripe::PromotionCode::UpdateParams::Restrictions)).returns(T.nilable(::Stripe::PromotionCode::UpdateParams::Restrictions))
}
def restrictions=(_restrictions); end
sig {
params(active: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), restrictions: T.nilable(::Stripe::PromotionCode::UpdateParams::Restrictions)).void
}
def initialize(active: nil, expand: nil, metadata: nil, restrictions: nil); end
end
# A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
sig {
params(params: T.any(::Stripe::PromotionCode::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PromotionCode)
}
def self.create(params = {}, opts = {}); end
# Returns a list of your promotion codes.
sig {
params(params: T.any(::Stripe::PromotionCode::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.
sig {
params(promotion_code: String, params: T.any(::Stripe::PromotionCode::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PromotionCode)
}
def self.update(promotion_code, params = {}, opts = {}); end
end
end
# typed: 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
class AutomaticTax < Stripe::StripeObject
class Liability < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# Automatically calculate taxes
sig { returns(T::Boolean) }
def enabled; end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(Liability)) }
def liability; end
# The tax provider powering automatic tax.
sig { returns(T.nilable(String)) }
def provider; end
# The status of the most recent automated tax calculation for this quote.
sig { returns(T.nilable(String)) }
def status; end
end
class Computed < Stripe::StripeObject
class LastReestimationDetails < Stripe::StripeObject
class Failed < Stripe::StripeObject
# The failure `code` is more granular than the `reason` provided and may correspond to a Stripe error code. For automation errors, this field is one of: `reverse_api_failure`, `reverse_api_deadline_exceeeded`, or `reverse_api_response_validation_error`, which are Stripe error codes and map to the error `message` field.
sig { returns(T.nilable(String)) }
def failure_code; end
# Information derived from the `failure_code` or a freeform message that explains the error as a human-readable English string. For example, "margin ID is not a valid ID".
sig { returns(T.nilable(String)) }
def message; end
# The reason the reestimation failed.
sig { returns(String) }
def reason; end
end
# When `status` is `failed`, provides details about the quote reestimation failure.
sig { returns(T.nilable(Failed)) }
def failed; end
# Latest status of the reestimation.
sig { returns(String) }
def status; end
end
class Recurring < Stripe::StripeObject
class TotalDetails < Stripe::StripeObject
class Breakdown < Stripe::StripeObject
class Discount < Stripe::StripeObject
# The amount discounted.
sig { returns(Integer) }
def amount; end
# 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)
sig { returns(Stripe::Discount) }
def discount; end
end
class Tax < Stripe::StripeObject
# Amount of tax applied for this rate.
sig { returns(Integer) }
def amount; end
# Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
#
# Related guide: [Tax rates](/billing/taxes/tax-rates)
sig { returns(Stripe::TaxRate) }
def rate; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(T.nilable(String)) }
def taxability_reason; end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(T.nilable(Integer)) }
def taxable_amount; end
end
# The aggregated discounts.
sig { returns(T::Array[Discount]) }
def discounts; end
# The aggregated tax amounts by rate.
sig { returns(T::Array[Tax]) }
def taxes; end
end
# This is the sum of all the discounts.
sig { returns(Integer) }
def amount_discount; end
# This is the sum of all the shipping amounts.
sig { returns(T.nilable(Integer)) }
def amount_shipping; end
# This is the sum of all the tax amounts.
sig { returns(Integer) }
def amount_tax; end
# Attribute for field breakdown
sig { returns(T.nilable(Breakdown)) }
def breakdown; end
end
# Total before any discounts or taxes are applied.
sig { returns(Integer) }
def amount_subtotal; end
# Total after discounts and taxes are applied.
sig { returns(Integer) }
def amount_total; end
# The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
# The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
sig { returns(Integer) }
def interval_count; end
# Attribute for field total_details
sig { returns(TotalDetails) }
def total_details; end
end
class Upfront < Stripe::StripeObject
class TotalDetails < Stripe::StripeObject
class Breakdown < Stripe::StripeObject
class Discount < Stripe::StripeObject
# The amount discounted.
sig { returns(Integer) }
def amount; end
# 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)
sig { returns(Stripe::Discount) }
def discount; end
end
class Tax < Stripe::StripeObject
# Amount of tax applied for this rate.
sig { returns(Integer) }
def amount; end
# Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
#
# Related guide: [Tax rates](/billing/taxes/tax-rates)
sig { returns(Stripe::TaxRate) }
def rate; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(T.nilable(String)) }
def taxability_reason; end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(T.nilable(Integer)) }
def taxable_amount; end
end
# The aggregated discounts.
sig { returns(T::Array[Discount]) }
def discounts; end
# The aggregated tax amounts by rate.
sig { returns(T::Array[Tax]) }
def taxes; end
end
# This is the sum of all the discounts.
sig { returns(Integer) }
def amount_discount; end
# This is the sum of all the shipping amounts.
sig { returns(T.nilable(Integer)) }
def amount_shipping; end
# This is the sum of all the tax amounts.
sig { returns(Integer) }
def amount_tax; end
# Attribute for field breakdown
sig { returns(T.nilable(Breakdown)) }
def breakdown; end
end
# Total before any discounts or taxes are applied.
sig { returns(Integer) }
def amount_subtotal; end
# Total after discounts and taxes are applied.
sig { returns(Integer) }
def amount_total; end
# The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice.
sig { returns(T.nilable(Stripe::ListObject)) }
def line_items; end
# Attribute for field total_details
sig { returns(TotalDetails) }
def total_details; end
end
# Details of the most recent reestimate of the quote's preview schedules and upcoming invoices, including the status of Stripe's calculation.
sig { returns(T.nilable(LastReestimationDetails)) }
def last_reestimation_details; end
# The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices.
sig { returns(T.nilable(Recurring)) }
def recurring; end
# The time at which the quote's estimated schedules and upcoming invoices were generated.
sig { returns(T.nilable(Integer)) }
def updated_at; end
# Attribute for field upfront
sig { returns(Upfront) }
def upfront; end
end
class FromQuote < Stripe::StripeObject
# Whether this quote is a revision of a different quote.
sig { returns(T::Boolean) }
def is_revision; end
# The quote that was cloned.
sig { returns(T.any(String, Stripe::Quote)) }
def quote; end
end
class InvoiceSettings < Stripe::StripeObject
class Issuer < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
# Attribute for field issuer
sig { returns(Issuer) }
def issuer; end
end
class StatusDetails < Stripe::StripeObject
class Canceled < Stripe::StripeObject
# The reason this quote was marked as canceled.
sig { returns(T.nilable(String)) }
def reason; end
# Time at which the quote was marked as canceled. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def transitioned_at; end
end
class Stale < Stripe::StripeObject
class LastReason < Stripe::StripeObject
class LinesInvalid < Stripe::StripeObject
# The timestamp at which the lines were marked as invalid.
sig { returns(Integer) }
def invalid_at; end
# The list of lines that became invalid at the given timestamp.
sig { returns(T::Array[String]) }
def lines; end
end
class SubscriptionChanged < Stripe::StripeObject
# The subscription's state before the quote was marked as stale.
sig { returns(T.nilable(Stripe::Subscription)) }
def previous_subscription; end
end
class SubscriptionScheduleChanged < Stripe::StripeObject
# The subscription schedule's state before the quote was marked as stale.
sig { returns(T.nilable(Stripe::SubscriptionSchedule)) }
def previous_subscription_schedule; end
end
# The ID of the line that is invalid if the stale reason type is `line_invalid`.
sig { returns(T.nilable(String)) }
def line_invalid; end
# The IDs of the lines that are invalid if the stale reason type is `lines_invalid`.
sig { returns(T.nilable(T::Array[LinesInvalid])) }
def lines_invalid; end
# The user supplied mark stale reason.
sig { returns(T.nilable(String)) }
def marked_stale; end
# The ID of the subscription that was canceled.
sig { returns(T.nilable(String)) }
def subscription_canceled; end
# Attribute for field subscription_changed
sig { returns(T.nilable(SubscriptionChanged)) }
def subscription_changed; end
# The ID of the subscription that was expired.
sig { returns(T.nilable(String)) }
def subscription_expired; end
# The ID of the subscription schedule that was canceled.
sig { returns(T.nilable(String)) }
def subscription_schedule_canceled; end
# Attribute for field subscription_schedule_changed
sig { returns(T.nilable(SubscriptionScheduleChanged)) }
def subscription_schedule_changed; end
# The ID of the subscription schedule that was released.
sig { returns(T.nilable(String)) }
def subscription_schedule_released; end
# The reason the quote was marked as stale.
sig { returns(T.nilable(String)) }
def type; end
end
# Time at which the quote expires. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# The most recent reason this quote was marked as stale.
sig { returns(T.nilable(LastReason)) }
def last_reason; end
# Time at which the stale reason was updated. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def last_updated_at; end
# Time at which the quote was marked as stale. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def transitioned_at; end
end
# Attribute for field canceled
sig { returns(T.nilable(Canceled)) }
def canceled; end
# Attribute for field stale
sig { returns(T.nilable(Stale)) }
def stale; end
end
class StatusTransitions < Stripe::StripeObject
# The time that the quote was accepted. Measured in seconds since Unix epoch.
sig { returns(T.nilable(Integer)) }
def accepted_at; end
# The time that the quote was canceled. Measured in seconds since Unix epoch.
sig { returns(T.nilable(Integer)) }
def canceled_at; end
# The time that the quote was finalized. Measured in seconds since Unix epoch.
sig { returns(T.nilable(Integer)) }
def finalized_at; end
end
class SubscriptionData < Stripe::StripeObject
class BillOnAcceptance < Stripe::StripeObject
class BillFrom < Stripe::StripeObject
class LineStartsAt < Stripe::StripeObject
# Unique identifier for the object.
sig { returns(String) }
def id; end
end
# The materialized time.
sig { returns(T.nilable(Integer)) }
def computed; end
# The timestamp the given line starts at.
sig { returns(T.nilable(LineStartsAt)) }
def line_starts_at; end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# The type of method to specify the `bill_from` time.
sig { returns(String) }
def type; end
end
class BillUntil < Stripe::StripeObject
class Duration < Stripe::StripeObject
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
end
class LineEndsAt < Stripe::StripeObject
# Unique identifier for the object.
sig { returns(String) }
def id; end
end
# The materialized time.
sig { returns(T.nilable(Integer)) }
def computed; end
# Time span for the quote line starting from the `starts_at` date.
sig { returns(T.nilable(Duration)) }
def duration; end
# The timestamp the given line ends at.
sig { returns(T.nilable(LineEndsAt)) }
def line_ends_at; end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# The type of method to specify the `bill_until` time.
sig { returns(String) }
def type; end
end
# The start of the period to bill from when the Quote is accepted.
sig { returns(T.nilable(BillFrom)) }
def bill_from; end
# The end of the period to bill until when the Quote is accepted.
sig { returns(T.nilable(BillUntil)) }
def bill_until; end
end
class BillingMode < Stripe::StripeObject
class Flexible < Stripe::StripeObject
# When true, proration line items will show accurate discount amounts and use gross amounts, making them consistent with non-proration line items.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
end
# Attribute for field flexible
sig { returns(T.nilable(Flexible)) }
def flexible; end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig { returns(String) }
def type; end
end
class Prebilling < Stripe::StripeObject
# Attribute for field iterations
sig { returns(Integer) }
def iterations; end
end
# Describes the period to bill for upon accepting the quote.
sig { returns(T.nilable(BillOnAcceptance)) }
def bill_on_acceptance; end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
# Whether the subscription will always start a new billing period when the quote is accepted.
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
# The billing mode of the quote.
sig { returns(BillingMode) }
def billing_mode; end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
# When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def effective_date; end
# Behavior of the subscription schedule and underlying subscription when it ends.
sig { returns(T.nilable(String)) }
def end_behavior; end
# The id of the subscription that will be updated when the quote is accepted.
sig { returns(T.nilable(T.any(String, Stripe::Subscription))) }
def from_subscription; end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
# If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
sig { returns(T.nilable(Prebilling)) }
def prebilling; end
# Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the quote is accepted.
sig { returns(T.nilable(String)) }
def proration_behavior; end
# Integer representing the number of trial period days before the customer is charged for the first time.
sig { returns(T.nilable(Integer)) }
def trial_period_days; end
end
class SubscriptionDataOverride < Stripe::StripeObject
class AppliesTo < Stripe::StripeObject
# A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
sig { returns(T.nilable(String)) }
def new_reference; end
# The ID of the schedule the line applies to.
sig { returns(T.nilable(String)) }
def subscription_schedule; end
# Describes whether the quote line is affecting a new schedule or an existing schedule.
sig { returns(String) }
def type; end
end
class BillOnAcceptance < Stripe::StripeObject
class BillFrom < Stripe::StripeObject
class LineStartsAt < Stripe::StripeObject
# Unique identifier for the object.
sig { returns(String) }
def id; end
end
# The materialized time.
sig { returns(T.nilable(Integer)) }
def computed; end
# The timestamp the given line starts at.
sig { returns(T.nilable(LineStartsAt)) }
def line_starts_at; end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# The type of method to specify the `bill_from` time.
sig { returns(String) }
def type; end
end
class BillUntil < Stripe::StripeObject
class Duration < Stripe::StripeObject
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
end
class LineEndsAt < Stripe::StripeObject
# Unique identifier for the object.
sig { returns(String) }
def id; end
end
# The materialized time.
sig { returns(T.nilable(Integer)) }
def computed; end
# Time span for the quote line starting from the `starts_at` date.
sig { returns(T.nilable(Duration)) }
def duration; end
# The timestamp the given line ends at.
sig { returns(T.nilable(LineEndsAt)) }
def line_ends_at; end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# The type of method to specify the `bill_until` time.
sig { returns(String) }
def type; end
end
# The start of the period to bill from when the Quote is accepted.
sig { returns(T.nilable(BillFrom)) }
def bill_from; end
# The end of the period to bill until when the Quote is accepted.
sig { returns(T.nilable(BillUntil)) }
def bill_until; end
end
# Attribute for field applies_to
sig { returns(AppliesTo) }
def applies_to; end
# Describes the period to bill for upon accepting the quote.
sig { returns(T.nilable(BillOnAcceptance)) }
def bill_on_acceptance; end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
# The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
sig { returns(T.nilable(String)) }
def customer; end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
# Behavior of the subscription schedule and underlying subscription when it ends.
sig { returns(T.nilable(String)) }
def end_behavior; end
# Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the quote is accepted.
sig { returns(T.nilable(String)) }
def proration_behavior; end
end
class SubscriptionSchedule < Stripe::StripeObject
class AppliesTo < Stripe::StripeObject
# A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
sig { returns(T.nilable(String)) }
def new_reference; end
# The ID of the schedule the line applies to.
sig { returns(T.nilable(String)) }
def subscription_schedule; end
# Describes whether the quote line is affecting a new schedule or an existing schedule.
sig { returns(String) }
def type; end
end
# Attribute for field applies_to
sig { returns(AppliesTo) }
def applies_to; end
# The subscription schedule that was created or updated from this quote.
sig { returns(String) }
def subscription_schedule; end
end
class TotalDetails < Stripe::StripeObject
class Breakdown < Stripe::StripeObject
class Discount < Stripe::StripeObject
# The amount discounted.
sig { returns(Integer) }
def amount; end
# 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)
sig { returns(Stripe::Discount) }
def discount; end
end
class Tax < Stripe::StripeObject
# Amount of tax applied for this rate.
sig { returns(Integer) }
def amount; end
# Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
#
# Related guide: [Tax rates](/billing/taxes/tax-rates)
sig { returns(Stripe::TaxRate) }
def rate; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(T.nilable(String)) }
def taxability_reason; end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(T.nilable(Integer)) }
def taxable_amount; end
end
# The aggregated discounts.
sig { returns(T::Array[Discount]) }
def discounts; end
# The aggregated tax amounts by rate.
sig { returns(T::Array[Tax]) }
def taxes; end
end
# This is the sum of all the discounts.
sig { returns(Integer) }
def amount_discount; end
# This is the sum of all the shipping amounts.
sig { returns(T.nilable(Integer)) }
def amount_shipping; end
# This is the sum of all the tax amounts.
sig { returns(Integer) }
def amount_tax; end
# Attribute for field breakdown
sig { returns(T.nilable(Breakdown)) }
def breakdown; end
end
class TransferData < Stripe::StripeObject
# The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Integer)) }
def amount; end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
# The account where funds from the payment will be transferred to upon payment success.
sig { returns(T.any(String, Stripe::Account)) }
def destination; end
end
# Allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
sig { returns(T.nilable(T::Boolean)) }
def allow_backdated_lines; end
# Total before any discounts or taxes are applied.
sig { returns(Integer) }
def amount_subtotal; end
# Total after discounts and taxes are applied.
sig { returns(Integer) }
def amount_total; end
# ID of the Connect Application that created the quote.
sig { returns(T.nilable(T.any(String, Stripe::Application))) }
def application; end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote.
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote.
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
# Attribute for field automatic_tax
sig { returns(AutomaticTax) }
def automatic_tax; end
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or 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`.
sig { returns(String) }
def collection_method; end
# Attribute for field computed
sig { returns(Computed) }
def computed; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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(T.nilable(String)) }
def currency; end
# The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# The account which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.
sig { returns(T.nilable(String)) }
def customer_account; end
# The tax rates applied to this quote.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxRate)])) }
def default_tax_rates; end
# A description that will be displayed on the quote PDF.
sig { returns(T.nilable(String)) }
def description; end
# The discounts applied to this quote.
sig { returns(T::Array[T.any(String, Stripe::Discount)]) }
def discounts; end
# The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def expires_at; end
# A footer that will be displayed on the quote PDF.
sig { returns(T.nilable(String)) }
def footer; end
# Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details.
sig { returns(T.nilable(FromQuote)) }
def from_quote; end
# A header that will be displayed on the quote PDF.
sig { returns(T.nilable(String)) }
def header; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The invoice that was created from this quote.
sig { returns(T.nilable(T.any(String, Stripe::Invoice))) }
def invoice; end
# Attribute for field invoice_settings
sig { returns(InvoiceSettings) }
def invoice_settings; end
# A list of items the customer is being quoted for.
sig { returns(T.nilable(Stripe::ListObject)) }
def line_items; end
# A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
sig { returns(T.nilable(T::Array[String])) }
def lines; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize).
sig { returns(T.nilable(String)) }
def number; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def on_behalf_of; end
# The status of the quote.
sig { returns(String) }
def status; end
# Details on when and why a quote has been marked as stale or canceled.
sig { returns(T.nilable(StatusDetails)) }
def status_details; end
# Attribute for field status_transitions
sig { returns(StatusTransitions) }
def status_transitions; end
# The subscription that was created or updated from this quote.
sig { returns(T.nilable(T.any(String, Stripe::Subscription))) }
def subscription; end
# Attribute for field subscription_data
sig { returns(SubscriptionData) }
def subscription_data; end
# List representing overrides for `subscription_data` configurations for specific subscription schedules.
sig { returns(T.nilable(T::Array[SubscriptionDataOverride])) }
def subscription_data_overrides; end
# The subscription schedule that was created or updated from this quote.
sig { returns(T.nilable(T.any(String, Stripe::SubscriptionSchedule))) }
def subscription_schedule; end
# The subscription schedules that were created or updated from this quote.
sig { returns(T.nilable(T::Array[SubscriptionSchedule])) }
def subscription_schedules; end
# ID of the test clock this quote belongs to.
sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
def test_clock; end
# Attribute for field total_details
sig { returns(TotalDetails) }
def total_details; end
# The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.
sig { returns(T.nilable(TransferData)) }
def transfer_data; end
class ListParams < Stripe::RequestParams
# The ID of the customer whose quotes will be retrieved.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The ID of the account whose quotes will be retrieved.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The subscription which the quote updates.
sig { returns(T.nilable(String)) }
def from_subscription; end
sig { params(_from_subscription: T.nilable(String)).returns(T.nilable(String)) }
def from_subscription=(_from_subscription); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# The status of the quote.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set.
sig { returns(T.nilable(String)) }
def test_clock; end
sig { params(_test_clock: T.nilable(String)).returns(T.nilable(String)) }
def test_clock=(_test_clock); end
sig {
params(customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), from_subscription: T.nilable(String), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String), test_clock: T.nilable(String)).void
}
def initialize(
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
from_subscription: nil,
limit: nil,
starting_after: nil,
status: nil,
test_clock: nil
); end
end
class CreateParams < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::AutomaticTax::Liability)) }
def liability; end
sig {
params(_liability: T.nilable(::Stripe::Quote::CreateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::Quote::CreateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::Quote::CreateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Discount::DiscountEnd::Duration)) }
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Quote::CreateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Quote::CreateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Quote::CreateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Quote::CreateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Quote::CreateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Quote::CreateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class FromQuote < Stripe::RequestParams
# Whether this quote is a revision of the previous quote.
sig { returns(T.nilable(T::Boolean)) }
def is_revision; end
sig { params(_is_revision: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def is_revision=(_is_revision); end
# The `id` of the quote that will be cloned.
sig { returns(String) }
def quote; end
sig { params(_quote: String).returns(String) }
def quote=(_quote); end
sig { params(is_revision: T.nilable(T::Boolean), quote: String).void }
def initialize(is_revision: nil, quote: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::InvoiceSettings::Issuer)) }
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::Quote::CreateParams::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::Quote::CreateParams::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::Quote::CreateParams::InvoiceSettings::Issuer)).void
}
def initialize(days_until_due: nil, issuer: nil); end
end
class Line < Stripe::RequestParams
class Action < Stripe::RequestParams
class AddDiscount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
# The coupon code to redeem.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# An ID of an existing discount for a coupon that was already redeemed.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddDiscount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddDiscount::DiscountEnd)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddDiscount::DiscountEnd))
}
def discount_end=(_discount_end); end
# The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
# The promotion code to redeem.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddDiscount::DiscountEnd), index: T.nilable(Integer), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
index: nil,
promotion_code: nil
); end
end
class AddItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); end
end
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
sig {
returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action::AddItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action::AddItem::Discount])).returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action::AddItem::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# Quantity for this item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
# Options that configure the trial on the subscription item.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddItem::Trial)) }
def trial; end
sig {
params(_trial: T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddItem::Trial)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddItem::Trial))
}
def trial=(_trial); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action::AddItem::Discount]), metadata: T.nilable(T::Hash[String, String]), price: String, quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String]), trial: T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddItem::Trial)).void
}
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
class RemoveDiscount < Stripe::RequestParams
# The coupon code to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# The ID of a discount to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# The ID of a promotion code to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
class RemoveItem < Stripe::RequestParams
# ID of a price to remove.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
sig { params(price: String).void }
def initialize(price: nil); end
end
class SetDiscount < Stripe::RequestParams
# The coupon code to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# An ID of an existing discount to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# An ID of an existing promotion code to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
class SetItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Quote::CreateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Quote::CreateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::SetItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Quote::CreateParams::Line::Action::SetItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::SetItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Quote::CreateParams::Line::Action::SetItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); end
end
# If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.
sig {
returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action::SetItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action::SetItem::Discount])).returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action::SetItem::Discount]))
}
def discounts=(_discounts); end
# If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
# If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::SetItem::Trial)) }
def trial; end
sig {
params(_trial: T.nilable(::Stripe::Quote::CreateParams::Line::Action::SetItem::Trial)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::SetItem::Trial))
}
def trial=(_trial); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action::SetItem::Discount]), metadata: T.nilable(T::Hash[String, String]), price: String, quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String]), trial: T.nilable(::Stripe::Quote::CreateParams::Line::Action::SetItem::Trial)).void
}
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
# Details for the `add_discount` type.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddDiscount)) }
def add_discount; end
sig {
params(_add_discount: T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddDiscount)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddDiscount))
}
def add_discount=(_add_discount); end
# Details for the `add_item` type.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddItem)) }
def add_item; end
sig {
params(_add_item: T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddItem)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddItem))
}
def add_item=(_add_item); end
# Details for the `add_metadata` type: specify a hash of key-value pairs.
sig { returns(T.nilable(T::Hash[String, String])) }
def add_metadata; end
sig {
params(_add_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def add_metadata=(_add_metadata); end
# Details for the `remove_discount` type.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::RemoveDiscount)) }
def remove_discount; end
sig {
params(_remove_discount: T.nilable(::Stripe::Quote::CreateParams::Line::Action::RemoveDiscount)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::RemoveDiscount))
}
def remove_discount=(_remove_discount); end
# Details for the `remove_item` type.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::RemoveItem)) }
def remove_item; end
sig {
params(_remove_item: T.nilable(::Stripe::Quote::CreateParams::Line::Action::RemoveItem)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::Action::RemoveItem))
}
def remove_item=(_remove_item); end
# Details for the `remove_metadata` type: specify an array of metadata keys.
sig { returns(T.nilable(T::Array[String])) }
def remove_metadata; end
sig {
params(_remove_metadata: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def remove_metadata=(_remove_metadata); end
# Details for the `set_discounts` type.
sig {
returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action::SetDiscount]))
}
def set_discounts; end
sig {
params(_set_discounts: T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action::SetDiscount])).returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action::SetDiscount]))
}
def set_discounts=(_set_discounts); end
# Details for the `set_items` type.
sig { returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action::SetItem])) }
def set_items; end
sig {
params(_set_items: T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action::SetItem])).returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action::SetItem]))
}
def set_items=(_set_items); end
# Details for the `set_metadata` type: specify an array of key-value pairs.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def set_metadata; end
sig {
params(_set_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def set_metadata=(_set_metadata); end
# The type of action the quote line performs.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(add_discount: T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddDiscount), add_item: T.nilable(::Stripe::Quote::CreateParams::Line::Action::AddItem), add_metadata: T.nilable(T::Hash[String, String]), remove_discount: T.nilable(::Stripe::Quote::CreateParams::Line::Action::RemoveDiscount), remove_item: T.nilable(::Stripe::Quote::CreateParams::Line::Action::RemoveItem), remove_metadata: T.nilable(T::Array[String]), set_discounts: T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action::SetDiscount]), set_items: T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action::SetItem]), set_metadata: T.nilable(T.any(String, T::Hash[String, String])), type: String).void
}
def initialize(
add_discount: nil,
add_item: nil,
add_metadata: nil,
remove_discount: nil,
remove_item: nil,
remove_metadata: nil,
set_discounts: nil,
set_items: nil,
set_metadata: nil,
type: nil
); end
end
class AppliesTo < Stripe::RequestParams
# A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
sig { returns(T.nilable(String)) }
def new_reference; end
sig { params(_new_reference: T.nilable(String)).returns(T.nilable(String)) }
def new_reference=(_new_reference); end
# The ID of the schedule the line applies to.
sig { returns(T.nilable(String)) }
def subscription_schedule; end
sig { params(_subscription_schedule: T.nilable(String)).returns(T.nilable(String)) }
def subscription_schedule=(_subscription_schedule); end
# Describes whether the quote line is affecting a new schedule or an existing schedule.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(new_reference: T.nilable(String), subscription_schedule: T.nilable(String), type: String).void
}
def initialize(new_reference: nil, subscription_schedule: nil, type: nil); end
end
class CancelSubscriptionSchedule < Stripe::RequestParams
# Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
sig { returns(String) }
def cancel_at; end
sig { params(_cancel_at: String).returns(String) }
def cancel_at=(_cancel_at); end
# If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def invoice_now; end
sig { params(_invoice_now: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def invoice_now=(_invoice_now); end
# If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def prorate; end
sig { params(_prorate: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def prorate=(_prorate); end
sig {
params(cancel_at: String, invoice_now: T.nilable(T::Boolean), prorate: T.nilable(T::Boolean)).void
}
def initialize(cancel_at: nil, invoice_now: nil, prorate: nil); end
end
class EndsAt < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
sig { returns(String) }
def discount; end
sig { params(_discount: String).returns(String) }
def discount=(_discount); end
sig { params(discount: String).void }
def initialize(discount: nil); end
end
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Use the `end` time of a given discount.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::EndsAt::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Quote::CreateParams::Line::EndsAt::DiscountEnd)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::EndsAt::DiscountEnd))
}
def discount_end=(_discount_end); end
# Time span for the quote line starting from the `starts_at` date.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::EndsAt::Duration)) }
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Quote::CreateParams::Line::EndsAt::Duration)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::EndsAt::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select a way to pass in `ends_at`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(discount_end: T.nilable(::Stripe::Quote::CreateParams::Line::EndsAt::DiscountEnd), duration: T.nilable(::Stripe::Quote::CreateParams::Line::EndsAt::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(discount_end: nil, duration: nil, timestamp: nil, type: nil); end
end
class SetPauseCollection < Stripe::RequestParams
class Set < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(behavior: String).void }
def initialize(behavior: nil); end
end
# Details of the pause_collection behavior to apply to the amendment.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::SetPauseCollection::Set)) }
def set; end
sig {
params(_set: T.nilable(::Stripe::Quote::CreateParams::Line::SetPauseCollection::Set)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::SetPauseCollection::Set))
}
def set=(_set); end
# Determines the type of the pause_collection amendment.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(set: T.nilable(::Stripe::Quote::CreateParams::Line::SetPauseCollection::Set), type: String).void
}
def initialize(set: nil, type: nil); end
end
class StartsAt < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
sig { returns(String) }
def discount; end
sig { params(_discount: String).returns(String) }
def discount=(_discount); end
sig { params(discount: String).void }
def initialize(discount: nil); end
end
class LineEndsAt < Stripe::RequestParams
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(index: T.nilable(Integer)).void }
def initialize(index: nil); end
end
# Use the `end` time of a given discount.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::StartsAt::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Quote::CreateParams::Line::StartsAt::DiscountEnd)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::StartsAt::DiscountEnd))
}
def discount_end=(_discount_end); end
# The timestamp the given line ends at.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::StartsAt::LineEndsAt)) }
def line_ends_at; end
sig {
params(_line_ends_at: T.nilable(::Stripe::Quote::CreateParams::Line::StartsAt::LineEndsAt)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::StartsAt::LineEndsAt))
}
def line_ends_at=(_line_ends_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select a way to pass in `starts_at`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(discount_end: T.nilable(::Stripe::Quote::CreateParams::Line::StartsAt::DiscountEnd), line_ends_at: T.nilable(::Stripe::Quote::CreateParams::Line::StartsAt::LineEndsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(discount_end: nil, line_ends_at: nil, timestamp: nil, type: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
sig { params(_prorate_up_front: T.nilable(String)).returns(T.nilable(String)) }
def prorate_up_front=(_prorate_up_front); end
sig { params(prorate_up_front: T.nilable(String)).void }
def initialize(prorate_up_front: nil); end
end
# Defines how the subscription should behave when a trial ends.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::Line::TrialSettings::EndBehavior))
}
def end_behavior; end
sig {
params(_end_behavior: T.nilable(::Stripe::Quote::CreateParams::Line::TrialSettings::EndBehavior)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::TrialSettings::EndBehavior))
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: T.nilable(::Stripe::Quote::CreateParams::Line::TrialSettings::EndBehavior)).void
}
def initialize(end_behavior: nil); end
end
# An array of operations the quote line performs.
sig { returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action])) }
def actions; end
sig {
params(_actions: T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action])).returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action]))
}
def actions=(_actions); end
# Details to identify the subscription schedule the quote line applies to.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::AppliesTo)) }
def applies_to; end
sig {
params(_applies_to: T.nilable(::Stripe::Quote::CreateParams::Line::AppliesTo)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::AppliesTo))
}
def applies_to=(_applies_to); end
# For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::CancelSubscriptionSchedule)) }
def cancel_subscription_schedule; end
sig {
params(_cancel_subscription_schedule: T.nilable(::Stripe::Quote::CreateParams::Line::CancelSubscriptionSchedule)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::CancelSubscriptionSchedule))
}
def cancel_subscription_schedule=(_cancel_subscription_schedule); end
# Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::EndsAt)) }
def ends_at; end
sig {
params(_ends_at: T.nilable(::Stripe::Quote::CreateParams::Line::EndsAt)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::EndsAt))
}
def ends_at=(_ends_at); end
# Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::SetPauseCollection)) }
def set_pause_collection; end
sig {
params(_set_pause_collection: T.nilable(::Stripe::Quote::CreateParams::Line::SetPauseCollection)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::SetPauseCollection))
}
def set_pause_collection=(_set_pause_collection); end
# Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
sig { returns(T.nilable(String)) }
def set_schedule_end; end
sig { params(_set_schedule_end: T.nilable(String)).returns(T.nilable(String)) }
def set_schedule_end=(_set_schedule_end); end
# Details to identify the earliest timestamp where the proposed change should take effect.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::StartsAt)) }
def starts_at; end
sig {
params(_starts_at: T.nilable(::Stripe::Quote::CreateParams::Line::StartsAt)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::StartsAt))
}
def starts_at=(_starts_at); end
# Settings related to subscription trials.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::Line::TrialSettings)) }
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::Quote::CreateParams::Line::TrialSettings)).returns(T.nilable(::Stripe::Quote::CreateParams::Line::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(actions: T.nilable(T::Array[::Stripe::Quote::CreateParams::Line::Action]), applies_to: T.nilable(::Stripe::Quote::CreateParams::Line::AppliesTo), billing_cycle_anchor: T.nilable(String), cancel_subscription_schedule: T.nilable(::Stripe::Quote::CreateParams::Line::CancelSubscriptionSchedule), ends_at: T.nilable(::Stripe::Quote::CreateParams::Line::EndsAt), proration_behavior: T.nilable(String), set_pause_collection: T.nilable(::Stripe::Quote::CreateParams::Line::SetPauseCollection), set_schedule_end: T.nilable(String), starts_at: T.nilable(::Stripe::Quote::CreateParams::Line::StartsAt), trial_settings: T.nilable(::Stripe::Quote::CreateParams::Line::TrialSettings)).void
}
def initialize(
actions: nil,
applies_to: nil,
billing_cycle_anchor: nil,
cancel_subscription_schedule: nil,
ends_at: nil,
proration_behavior: nil,
set_pause_collection: nil,
set_schedule_end: nil,
starts_at: nil,
trial_settings: nil
); end
end
class LineItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::LineItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Quote::CreateParams::LineItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Quote::CreateParams::LineItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Quote::CreateParams::LineItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::LineItem::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Quote::CreateParams::LineItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Quote::CreateParams::LineItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Quote::CreateParams::LineItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::LineItem::PriceData::Recurring)) }
def recurring; end
sig {
params(_recurring: T.nilable(::Stripe::Quote::CreateParams::LineItem::PriceData::Recurring)).returns(T.nilable(::Stripe::Quote::CreateParams::LineItem::PriceData::Recurring))
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: T.nilable(::Stripe::Quote::CreateParams::LineItem::PriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# The discounts applied to this line item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Quote::CreateParams::LineItem::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Quote::CreateParams::LineItem::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Quote::CreateParams::LineItem::Discount])))
}
def discounts=(_discounts); end
# The ID of the price object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::LineItem::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Quote::CreateParams::LineItem::PriceData)).returns(T.nilable(::Stripe::Quote::CreateParams::LineItem::PriceData))
}
def price_data=(_price_data); end
# The quantity of the line item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(discounts: T.nilable(T.any(String, T::Array[::Stripe::Quote::CreateParams::LineItem::Discount])), price: T.nilable(String), price_data: T.nilable(::Stripe::Quote::CreateParams::LineItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
discounts: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class SubscriptionData < Stripe::RequestParams
class BillOnAcceptance < Stripe::RequestParams
class BillFrom < Stripe::RequestParams
class LineStartsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Details of a Quote line to start the bill period from.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt))
}
def line_starts_at; end
sig {
params(_line_starts_at: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt)).returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt))
}
def line_starts_at=(_line_starts_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of method to specify the `bill_from` time.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(line_starts_at: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(line_starts_at: nil, timestamp: nil, type: nil); end
end
class BillUntil < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
class LineEndsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Details of the duration over which to bill.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration)).returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration))
}
def duration=(_duration); end
# Details of a Quote line item from which to bill until.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt))
}
def line_ends_at; end
sig {
params(_line_ends_at: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt)).returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt))
}
def line_ends_at=(_line_ends_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of method to specify the `bill_until` time.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration), line_ends_at: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, line_ends_at: nil, timestamp: nil, type: nil); end
end
# The start of the period to bill from when the Quote is accepted.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom))
}
def bill_from; end
sig {
params(_bill_from: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom)).returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom))
}
def bill_from=(_bill_from); end
# The end of the period to bill until when the Quote is accepted.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil))
}
def bill_until; end
sig {
params(_bill_until: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil)).returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil))
}
def bill_until=(_bill_until); end
sig {
params(bill_from: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom), bill_until: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil)).void
}
def initialize(bill_from: nil, bill_until: nil); end
end
class BillingMode < Stripe::RequestParams
class Flexible < Stripe::RequestParams
# Set to `true` to display gross amounts, net amounts, and discount amounts consistently between prorations and non-proration items on invoices, line items, and invoice items. Once set to `true`, you can't change it back to `false`.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
sig {
params(_consistent_proration_discount_amounts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consistent_proration_discount_amounts=(_consistent_proration_discount_amounts); end
sig { params(consistent_proration_discount_amounts: T.nilable(T::Boolean)).void }
def initialize(consistent_proration_discount_amounts: nil); end
end
# Configure behavior for flexible billing mode.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillingMode::Flexible))
}
def flexible; end
sig {
params(_flexible: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillingMode::Flexible)).returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillingMode::Flexible))
}
def flexible=(_flexible); end
# Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(flexible: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillingMode::Flexible), type: String).void
}
def initialize(flexible: nil, type: nil); end
end
class Prebilling < Stripe::RequestParams
# This is used to determine the number of billing cycles to prebill.
sig { returns(Integer) }
def iterations; end
sig { params(_iterations: Integer).returns(Integer) }
def iterations=(_iterations); end
sig { params(iterations: Integer).void }
def initialize(iterations: nil); end
end
# Describes the period to bill for upon accepting the quote.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance))
}
def bill_on_acceptance; end
sig {
params(_bill_on_acceptance: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance)).returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance))
}
def bill_on_acceptance=(_bill_on_acceptance); end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
sig { params(_billing_behavior: T.nilable(String)).returns(T.nilable(String)) }
def billing_behavior=(_billing_behavior); end
# When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillingMode)) }
def billing_mode; end
sig {
params(_billing_mode: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillingMode)).returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillingMode))
}
def billing_mode=(_billing_mode); end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
sig { returns(T.nilable(T.any(String, T.any(String, Integer)))) }
def effective_date; end
sig {
params(_effective_date: T.nilable(T.any(String, T.any(String, Integer)))).returns(T.nilable(T.any(String, T.any(String, Integer))))
}
def effective_date=(_effective_date); end
# Behavior of the subscription schedule and underlying subscription when it ends.
sig { returns(T.nilable(String)) }
def end_behavior; end
sig { params(_end_behavior: T.nilable(String)).returns(T.nilable(String)) }
def end_behavior=(_end_behavior); end
# The id of a subscription that the quote will update. By default, the quote will contain the state of the subscription (such as line items, collection method and billing thresholds) unless overridden.
sig { returns(T.nilable(String)) }
def from_subscription; end
sig { params(_from_subscription: T.nilable(String)).returns(T.nilable(String)) }
def from_subscription=(_from_subscription); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
sig {
returns(T.nilable(T.any(String, ::Stripe::Quote::CreateParams::SubscriptionData::Prebilling)))
}
def prebilling; end
sig {
params(_prebilling: T.nilable(T.any(String, ::Stripe::Quote::CreateParams::SubscriptionData::Prebilling))).returns(T.nilable(T.any(String, ::Stripe::Quote::CreateParams::SubscriptionData::Prebilling)))
}
def prebilling=(_prebilling); end
# Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
#
# When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
#
# Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
#
# Prorations can be disabled by passing `none`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Integer representing the number of trial period days before the customer is charged for the first time.
sig { returns(T.nilable(T.any(String, Integer))) }
def trial_period_days; end
sig {
params(_trial_period_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def trial_period_days=(_trial_period_days); end
sig {
params(bill_on_acceptance: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillOnAcceptance), billing_behavior: T.nilable(String), billing_cycle_anchor: T.nilable(String), billing_mode: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData::BillingMode), description: T.nilable(String), effective_date: T.nilable(T.any(String, T.any(String, Integer))), end_behavior: T.nilable(String), from_subscription: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), prebilling: T.nilable(T.any(String, ::Stripe::Quote::CreateParams::SubscriptionData::Prebilling)), proration_behavior: T.nilable(String), trial_period_days: T.nilable(T.any(String, Integer))).void
}
def initialize(
bill_on_acceptance: nil,
billing_behavior: nil,
billing_cycle_anchor: nil,
billing_mode: nil,
description: nil,
effective_date: nil,
end_behavior: nil,
from_subscription: nil,
metadata: nil,
prebilling: nil,
proration_behavior: nil,
trial_period_days: nil
); end
end
class SubscriptionDataOverride < Stripe::RequestParams
class AppliesTo < Stripe::RequestParams
# A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
sig { returns(T.nilable(String)) }
def new_reference; end
sig { params(_new_reference: T.nilable(String)).returns(T.nilable(String)) }
def new_reference=(_new_reference); end
# The ID of the schedule the line applies to.
sig { returns(T.nilable(String)) }
def subscription_schedule; end
sig { params(_subscription_schedule: T.nilable(String)).returns(T.nilable(String)) }
def subscription_schedule=(_subscription_schedule); end
# Describes whether the quote line is affecting a new schedule or an existing schedule.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(new_reference: T.nilable(String), subscription_schedule: T.nilable(String), type: String).void
}
def initialize(new_reference: nil, subscription_schedule: nil, type: nil); end
end
class BillOnAcceptance < Stripe::RequestParams
class BillFrom < Stripe::RequestParams
class LineStartsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Details of a Quote line to start the bill period from.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt))
}
def line_starts_at; end
sig {
params(_line_starts_at: T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt)).returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt))
}
def line_starts_at=(_line_starts_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of method to specify the `bill_from` time.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(line_starts_at: T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(line_starts_at: nil, timestamp: nil, type: nil); end
end
class BillUntil < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
class LineEndsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Details of the duration over which to bill.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration)).returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration))
}
def duration=(_duration); end
# Details of a Quote line item from which to bill until.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt))
}
def line_ends_at; end
sig {
params(_line_ends_at: T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt)).returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt))
}
def line_ends_at=(_line_ends_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of method to specify the `bill_until` time.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration), line_ends_at: T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, line_ends_at: nil, timestamp: nil, type: nil); end
end
# The start of the period to bill from when the Quote is accepted.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom))
}
def bill_from; end
sig {
params(_bill_from: T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom)).returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom))
}
def bill_from=(_bill_from); end
# The end of the period to bill until when the Quote is accepted.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil))
}
def bill_until; end
sig {
params(_bill_until: T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil)).returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil))
}
def bill_until=(_bill_until); end
sig {
params(bill_from: T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom), bill_until: T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil)).void
}
def initialize(bill_from: nil, bill_until: nil); end
end
# Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
sig { returns(::Stripe::Quote::CreateParams::SubscriptionDataOverride::AppliesTo) }
def applies_to; end
sig {
params(_applies_to: ::Stripe::Quote::CreateParams::SubscriptionDataOverride::AppliesTo).returns(::Stripe::Quote::CreateParams::SubscriptionDataOverride::AppliesTo)
}
def applies_to=(_applies_to); end
# Describes the period to bill for upon accepting the quote.
sig {
returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance))
}
def bill_on_acceptance; end
sig {
params(_bill_on_acceptance: T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance)).returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance))
}
def bill_on_acceptance=(_bill_on_acceptance); end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
sig { params(_billing_behavior: T.nilable(String)).returns(T.nilable(String)) }
def billing_behavior=(_billing_behavior); end
# The customer the Subscription Data override applies to. This is only relevant when `applies_to.type=new_reference`.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Behavior of the subscription schedule and underlying subscription when it ends.
sig { returns(T.nilable(String)) }
def end_behavior; end
sig { params(_end_behavior: T.nilable(String)).returns(T.nilable(String)) }
def end_behavior=(_end_behavior); end
# Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
#
# When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
#
# Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
#
# Prorations can be disabled by passing `none`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
sig {
params(applies_to: ::Stripe::Quote::CreateParams::SubscriptionDataOverride::AppliesTo, bill_on_acceptance: T.nilable(::Stripe::Quote::CreateParams::SubscriptionDataOverride::BillOnAcceptance), billing_behavior: T.nilable(String), customer: T.nilable(String), description: T.nilable(String), end_behavior: T.nilable(String), proration_behavior: T.nilable(String)).void
}
def initialize(
applies_to: nil,
bill_on_acceptance: nil,
billing_behavior: nil,
customer: nil,
description: nil,
end_behavior: nil,
proration_behavior: nil
); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig {
params(amount: T.nilable(Integer), amount_percent: T.nilable(Float), destination: String).void
}
def initialize(amount: nil, amount_percent: nil, destination: nil); end
end
# Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
sig { returns(T.nilable(T::Boolean)) }
def allow_backdated_lines; end
sig { params(_allow_backdated_lines: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def allow_backdated_lines=(_allow_backdated_lines); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.
sig { returns(T.nilable(T.any(String, Integer))) }
def application_fee_amount; end
sig {
params(_application_fee_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def application_fee_amount=(_application_fee_amount); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.
sig { returns(T.nilable(T.any(String, Float))) }
def application_fee_percent; end
sig {
params(_application_fee_percent: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def application_fee_percent=(_application_fee_percent); end
# Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::Quote::CreateParams::AutomaticTax)).returns(T.nilable(::Stripe::Quote::CreateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or 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`.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# The tax rates that will apply to any line item that does not have `tax_rates` set.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The discounts applied to the quote.
sig { returns(T.nilable(T.any(String, T::Array[::Stripe::Quote::CreateParams::Discount]))) }
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Quote::CreateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Quote::CreateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::FromQuote)) }
def from_quote; end
sig {
params(_from_quote: T.nilable(::Stripe::Quote::CreateParams::FromQuote)).returns(T.nilable(::Stripe::Quote::CreateParams::FromQuote))
}
def from_quote=(_from_quote); end
# A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
sig { returns(T.nilable(String)) }
def header; end
sig { params(_header: T.nilable(String)).returns(T.nilable(String)) }
def header=(_header); end
# All invoices will be billed using the specified settings.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::InvoiceSettings)) }
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::Quote::CreateParams::InvoiceSettings)).returns(T.nilable(::Stripe::Quote::CreateParams::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
sig { returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::LineItem])) }
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::Quote::CreateParams::LineItem])).returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::LineItem]))
}
def line_items=(_line_items); end
# A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
sig { returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::Line])) }
def lines; end
sig {
params(_lines: T.nilable(T::Array[::Stripe::Quote::CreateParams::Line])).returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::Line]))
}
def lines=(_lines); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The account on behalf of which to charge.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.
sig { returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData)) }
def subscription_data; end
sig {
params(_subscription_data: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData)).returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData))
}
def subscription_data=(_subscription_data); end
# List representing overrides for `subscription_data` configurations for specific subscription schedules.
sig { returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::SubscriptionDataOverride])) }
def subscription_data_overrides; end
sig {
params(_subscription_data_overrides: T.nilable(T::Array[::Stripe::Quote::CreateParams::SubscriptionDataOverride])).returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::SubscriptionDataOverride]))
}
def subscription_data_overrides=(_subscription_data_overrides); end
# ID of the test clock to attach to the quote.
sig { returns(T.nilable(String)) }
def test_clock; end
sig { params(_test_clock: T.nilable(String)).returns(T.nilable(String)) }
def test_clock=(_test_clock); end
# The data with which to automatically create a Transfer for each of the invoices.
sig { returns(T.nilable(T.any(String, ::Stripe::Quote::CreateParams::TransferData))) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(T.any(String, ::Stripe::Quote::CreateParams::TransferData))).returns(T.nilable(T.any(String, ::Stripe::Quote::CreateParams::TransferData)))
}
def transfer_data=(_transfer_data); end
sig {
params(allow_backdated_lines: T.nilable(T::Boolean), application_fee_amount: T.nilable(T.any(String, Integer)), application_fee_percent: T.nilable(T.any(String, Float)), automatic_tax: T.nilable(::Stripe::Quote::CreateParams::AutomaticTax), collection_method: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), default_tax_rates: T.nilable(T.any(String, T::Array[String])), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::Quote::CreateParams::Discount])), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), footer: T.nilable(String), from_quote: T.nilable(::Stripe::Quote::CreateParams::FromQuote), header: T.nilable(String), invoice_settings: T.nilable(::Stripe::Quote::CreateParams::InvoiceSettings), line_items: T.nilable(T::Array[::Stripe::Quote::CreateParams::LineItem]), lines: T.nilable(T::Array[::Stripe::Quote::CreateParams::Line]), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), subscription_data: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData), subscription_data_overrides: T.nilable(T::Array[::Stripe::Quote::CreateParams::SubscriptionDataOverride]), test_clock: T.nilable(String), transfer_data: T.nilable(T.any(String, ::Stripe::Quote::CreateParams::TransferData))).void
}
def initialize(
allow_backdated_lines: nil,
application_fee_amount: nil,
application_fee_percent: nil,
automatic_tax: nil,
collection_method: nil,
customer: nil,
customer_account: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
expand: nil,
expires_at: nil,
footer: nil,
from_quote: nil,
header: nil,
invoice_settings: nil,
line_items: nil,
lines: nil,
metadata: nil,
on_behalf_of: nil,
subscription_data: nil,
subscription_data_overrides: nil,
test_clock: nil,
transfer_data: nil
); end
end
class UpdateParams < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::AutomaticTax::Liability)) }
def liability; end
sig {
params(_liability: T.nilable(::Stripe::Quote::UpdateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::Quote::UpdateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::Quote::UpdateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Discount::DiscountEnd::Duration)) }
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Quote::UpdateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Quote::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Quote::UpdateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Quote::UpdateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Quote::UpdateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Quote::UpdateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::InvoiceSettings::Issuer)) }
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::Quote::UpdateParams::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::Quote::UpdateParams::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::Quote::UpdateParams::InvoiceSettings::Issuer)).void
}
def initialize(days_until_due: nil, issuer: nil); end
end
class Line < Stripe::RequestParams
class Action < Stripe::RequestParams
class AddDiscount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
# The coupon code to redeem.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# An ID of an existing discount for a coupon that was already redeemed.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddDiscount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddDiscount::DiscountEnd)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddDiscount::DiscountEnd))
}
def discount_end=(_discount_end); end
# The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
# The promotion code to redeem.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddDiscount::DiscountEnd), index: T.nilable(Integer), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
index: nil,
promotion_code: nil
); end
end
class AddItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); end
end
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
sig {
returns(T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action::AddItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action::AddItem::Discount])).returns(T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action::AddItem::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# Quantity for this item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
# Options that configure the trial on the subscription item.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddItem::Trial)) }
def trial; end
sig {
params(_trial: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddItem::Trial)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddItem::Trial))
}
def trial=(_trial); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action::AddItem::Discount]), metadata: T.nilable(T::Hash[String, String]), price: String, quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String]), trial: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddItem::Trial)).void
}
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
class RemoveDiscount < Stripe::RequestParams
# The coupon code to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# The ID of a discount to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# The ID of a promotion code to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
class RemoveItem < Stripe::RequestParams
# ID of a price to remove.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
sig { params(price: String).void }
def initialize(price: nil); end
end
class SetDiscount < Stripe::RequestParams
# The coupon code to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# An ID of an existing discount to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# An ID of an existing promotion code to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
class SetItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); end
end
# If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.
sig {
returns(T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action::SetItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action::SetItem::Discount])).returns(T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action::SetItem::Discount]))
}
def discounts=(_discounts); end
# If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
# If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::SetItem::Trial)) }
def trial; end
sig {
params(_trial: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::SetItem::Trial)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::SetItem::Trial))
}
def trial=(_trial); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action::SetItem::Discount]), metadata: T.nilable(T::Hash[String, String]), price: String, quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String]), trial: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::SetItem::Trial)).void
}
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
# Details for the `add_discount` type.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddDiscount)) }
def add_discount; end
sig {
params(_add_discount: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddDiscount)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddDiscount))
}
def add_discount=(_add_discount); end
# Details for the `add_item` type.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddItem)) }
def add_item; end
sig {
params(_add_item: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddItem)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddItem))
}
def add_item=(_add_item); end
# Details for the `add_metadata` type: specify a hash of key-value pairs.
sig { returns(T.nilable(T::Hash[String, String])) }
def add_metadata; end
sig {
params(_add_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def add_metadata=(_add_metadata); end
# Details for the `remove_discount` type.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::RemoveDiscount)) }
def remove_discount; end
sig {
params(_remove_discount: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::RemoveDiscount)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::RemoveDiscount))
}
def remove_discount=(_remove_discount); end
# Details for the `remove_item` type.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::RemoveItem)) }
def remove_item; end
sig {
params(_remove_item: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::RemoveItem)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::Action::RemoveItem))
}
def remove_item=(_remove_item); end
# Details for the `remove_metadata` type: specify an array of metadata keys.
sig { returns(T.nilable(T::Array[String])) }
def remove_metadata; end
sig {
params(_remove_metadata: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def remove_metadata=(_remove_metadata); end
# Details for the `set_discounts` type.
sig {
returns(T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action::SetDiscount]))
}
def set_discounts; end
sig {
params(_set_discounts: T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action::SetDiscount])).returns(T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action::SetDiscount]))
}
def set_discounts=(_set_discounts); end
# Details for the `set_items` type.
sig { returns(T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action::SetItem])) }
def set_items; end
sig {
params(_set_items: T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action::SetItem])).returns(T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action::SetItem]))
}
def set_items=(_set_items); end
# Details for the `set_metadata` type: specify an array of key-value pairs.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def set_metadata; end
sig {
params(_set_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def set_metadata=(_set_metadata); end
# The type of action the quote line performs.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(add_discount: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddDiscount), add_item: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::AddItem), add_metadata: T.nilable(T::Hash[String, String]), remove_discount: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::RemoveDiscount), remove_item: T.nilable(::Stripe::Quote::UpdateParams::Line::Action::RemoveItem), remove_metadata: T.nilable(T::Array[String]), set_discounts: T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action::SetDiscount]), set_items: T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action::SetItem]), set_metadata: T.nilable(T.any(String, T::Hash[String, String])), type: String).void
}
def initialize(
add_discount: nil,
add_item: nil,
add_metadata: nil,
remove_discount: nil,
remove_item: nil,
remove_metadata: nil,
set_discounts: nil,
set_items: nil,
set_metadata: nil,
type: nil
); end
end
class AppliesTo < Stripe::RequestParams
# A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
sig { returns(T.nilable(String)) }
def new_reference; end
sig { params(_new_reference: T.nilable(String)).returns(T.nilable(String)) }
def new_reference=(_new_reference); end
# The ID of the schedule the line applies to.
sig { returns(T.nilable(String)) }
def subscription_schedule; end
sig { params(_subscription_schedule: T.nilable(String)).returns(T.nilable(String)) }
def subscription_schedule=(_subscription_schedule); end
# Describes whether the quote line is affecting a new schedule or an existing schedule.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(new_reference: T.nilable(String), subscription_schedule: T.nilable(String), type: String).void
}
def initialize(new_reference: nil, subscription_schedule: nil, type: nil); end
end
class CancelSubscriptionSchedule < Stripe::RequestParams
# Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
sig { returns(String) }
def cancel_at; end
sig { params(_cancel_at: String).returns(String) }
def cancel_at=(_cancel_at); end
# If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def invoice_now; end
sig { params(_invoice_now: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def invoice_now=(_invoice_now); end
# If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def prorate; end
sig { params(_prorate: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def prorate=(_prorate); end
sig {
params(cancel_at: String, invoice_now: T.nilable(T::Boolean), prorate: T.nilable(T::Boolean)).void
}
def initialize(cancel_at: nil, invoice_now: nil, prorate: nil); end
end
class EndsAt < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
sig { returns(String) }
def discount; end
sig { params(_discount: String).returns(String) }
def discount=(_discount); end
sig { params(discount: String).void }
def initialize(discount: nil); end
end
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Use the `end` time of a given discount.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::EndsAt::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Quote::UpdateParams::Line::EndsAt::DiscountEnd)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::EndsAt::DiscountEnd))
}
def discount_end=(_discount_end); end
# Time span for the quote line starting from the `starts_at` date.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::EndsAt::Duration)) }
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Quote::UpdateParams::Line::EndsAt::Duration)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::EndsAt::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select a way to pass in `ends_at`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(discount_end: T.nilable(::Stripe::Quote::UpdateParams::Line::EndsAt::DiscountEnd), duration: T.nilable(::Stripe::Quote::UpdateParams::Line::EndsAt::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(discount_end: nil, duration: nil, timestamp: nil, type: nil); end
end
class SetPauseCollection < Stripe::RequestParams
class Set < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(behavior: String).void }
def initialize(behavior: nil); end
end
# Details of the pause_collection behavior to apply to the amendment.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::SetPauseCollection::Set)) }
def set; end
sig {
params(_set: T.nilable(::Stripe::Quote::UpdateParams::Line::SetPauseCollection::Set)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::SetPauseCollection::Set))
}
def set=(_set); end
# Determines the type of the pause_collection amendment.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(set: T.nilable(::Stripe::Quote::UpdateParams::Line::SetPauseCollection::Set), type: String).void
}
def initialize(set: nil, type: nil); end
end
class StartsAt < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
sig { returns(String) }
def discount; end
sig { params(_discount: String).returns(String) }
def discount=(_discount); end
sig { params(discount: String).void }
def initialize(discount: nil); end
end
class LineEndsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Use the `end` time of a given discount.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::StartsAt::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Quote::UpdateParams::Line::StartsAt::DiscountEnd)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::StartsAt::DiscountEnd))
}
def discount_end=(_discount_end); end
# The timestamp the given line ends at.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::StartsAt::LineEndsAt)) }
def line_ends_at; end
sig {
params(_line_ends_at: T.nilable(::Stripe::Quote::UpdateParams::Line::StartsAt::LineEndsAt)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::StartsAt::LineEndsAt))
}
def line_ends_at=(_line_ends_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select a way to pass in `starts_at`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(discount_end: T.nilable(::Stripe::Quote::UpdateParams::Line::StartsAt::DiscountEnd), line_ends_at: T.nilable(::Stripe::Quote::UpdateParams::Line::StartsAt::LineEndsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(discount_end: nil, line_ends_at: nil, timestamp: nil, type: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
sig { params(_prorate_up_front: T.nilable(String)).returns(T.nilable(String)) }
def prorate_up_front=(_prorate_up_front); end
sig { params(prorate_up_front: T.nilable(String)).void }
def initialize(prorate_up_front: nil); end
end
# Defines how the subscription should behave when a trial ends.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::Line::TrialSettings::EndBehavior))
}
def end_behavior; end
sig {
params(_end_behavior: T.nilable(::Stripe::Quote::UpdateParams::Line::TrialSettings::EndBehavior)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::TrialSettings::EndBehavior))
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: T.nilable(::Stripe::Quote::UpdateParams::Line::TrialSettings::EndBehavior)).void
}
def initialize(end_behavior: nil); end
end
# An array of operations the quote line performs.
sig { returns(T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action])) }
def actions; end
sig {
params(_actions: T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action])).returns(T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action]))
}
def actions=(_actions); end
# Details to identify the subscription schedule the quote line applies to.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::AppliesTo)) }
def applies_to; end
sig {
params(_applies_to: T.nilable(::Stripe::Quote::UpdateParams::Line::AppliesTo)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::AppliesTo))
}
def applies_to=(_applies_to); end
# For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::CancelSubscriptionSchedule)) }
def cancel_subscription_schedule; end
sig {
params(_cancel_subscription_schedule: T.nilable(::Stripe::Quote::UpdateParams::Line::CancelSubscriptionSchedule)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::CancelSubscriptionSchedule))
}
def cancel_subscription_schedule=(_cancel_subscription_schedule); end
# Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::EndsAt)) }
def ends_at; end
sig {
params(_ends_at: T.nilable(::Stripe::Quote::UpdateParams::Line::EndsAt)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::EndsAt))
}
def ends_at=(_ends_at); end
# The ID of an existing line on the quote.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::SetPauseCollection)) }
def set_pause_collection; end
sig {
params(_set_pause_collection: T.nilable(::Stripe::Quote::UpdateParams::Line::SetPauseCollection)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::SetPauseCollection))
}
def set_pause_collection=(_set_pause_collection); end
# Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
sig { returns(T.nilable(String)) }
def set_schedule_end; end
sig { params(_set_schedule_end: T.nilable(String)).returns(T.nilable(String)) }
def set_schedule_end=(_set_schedule_end); end
# Details to identify the earliest timestamp where the proposed change should take effect.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::StartsAt)) }
def starts_at; end
sig {
params(_starts_at: T.nilable(::Stripe::Quote::UpdateParams::Line::StartsAt)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::StartsAt))
}
def starts_at=(_starts_at); end
# Settings related to subscription trials.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::Line::TrialSettings)) }
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::Quote::UpdateParams::Line::TrialSettings)).returns(T.nilable(::Stripe::Quote::UpdateParams::Line::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(actions: T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line::Action]), applies_to: T.nilable(::Stripe::Quote::UpdateParams::Line::AppliesTo), billing_cycle_anchor: T.nilable(String), cancel_subscription_schedule: T.nilable(::Stripe::Quote::UpdateParams::Line::CancelSubscriptionSchedule), ends_at: T.nilable(::Stripe::Quote::UpdateParams::Line::EndsAt), id: T.nilable(String), proration_behavior: T.nilable(String), set_pause_collection: T.nilable(::Stripe::Quote::UpdateParams::Line::SetPauseCollection), set_schedule_end: T.nilable(String), starts_at: T.nilable(::Stripe::Quote::UpdateParams::Line::StartsAt), trial_settings: T.nilable(::Stripe::Quote::UpdateParams::Line::TrialSettings)).void
}
def initialize(
actions: nil,
applies_to: nil,
billing_cycle_anchor: nil,
cancel_subscription_schedule: nil,
ends_at: nil,
id: nil,
proration_behavior: nil,
set_pause_collection: nil,
set_schedule_end: nil,
starts_at: nil,
trial_settings: nil
); end
end
class LineItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::LineItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Quote::UpdateParams::LineItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Quote::UpdateParams::LineItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Quote::UpdateParams::LineItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::LineItem::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Quote::UpdateParams::LineItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Quote::UpdateParams::LineItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Quote::UpdateParams::LineItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::LineItem::PriceData::Recurring)) }
def recurring; end
sig {
params(_recurring: T.nilable(::Stripe::Quote::UpdateParams::LineItem::PriceData::Recurring)).returns(T.nilable(::Stripe::Quote::UpdateParams::LineItem::PriceData::Recurring))
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: T.nilable(::Stripe::Quote::UpdateParams::LineItem::PriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# The discounts applied to this line item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Quote::UpdateParams::LineItem::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Quote::UpdateParams::LineItem::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Quote::UpdateParams::LineItem::Discount])))
}
def discounts=(_discounts); end
# The ID of an existing line item on the quote.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The ID of the price object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::LineItem::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Quote::UpdateParams::LineItem::PriceData)).returns(T.nilable(::Stripe::Quote::UpdateParams::LineItem::PriceData))
}
def price_data=(_price_data); end
# The quantity of the line item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(discounts: T.nilable(T.any(String, T::Array[::Stripe::Quote::UpdateParams::LineItem::Discount])), id: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::Quote::UpdateParams::LineItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
discounts: nil,
id: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class SubscriptionData < Stripe::RequestParams
class BillOnAcceptance < Stripe::RequestParams
class BillFrom < Stripe::RequestParams
class LineStartsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Details of a Quote line to start the bill period from.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt))
}
def line_starts_at; end
sig {
params(_line_starts_at: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt)).returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt))
}
def line_starts_at=(_line_starts_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of method to specify the `bill_from` time.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(line_starts_at: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(line_starts_at: nil, timestamp: nil, type: nil); end
end
class BillUntil < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
class LineEndsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Details of the duration over which to bill.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration)).returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration))
}
def duration=(_duration); end
# Details of a Quote line item from which to bill until.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt))
}
def line_ends_at; end
sig {
params(_line_ends_at: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt)).returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt))
}
def line_ends_at=(_line_ends_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of method to specify the `bill_until` time.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration), line_ends_at: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, line_ends_at: nil, timestamp: nil, type: nil); end
end
# The start of the period to bill from when the Quote is accepted.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom))
}
def bill_from; end
sig {
params(_bill_from: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom)).returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom))
}
def bill_from=(_bill_from); end
# The end of the period to bill until when the Quote is accepted.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil))
}
def bill_until; end
sig {
params(_bill_until: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil)).returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil))
}
def bill_until=(_bill_until); end
sig {
params(bill_from: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom), bill_until: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil)).void
}
def initialize(bill_from: nil, bill_until: nil); end
end
class Prebilling < Stripe::RequestParams
# This is used to determine the number of billing cycles to prebill.
sig { returns(Integer) }
def iterations; end
sig { params(_iterations: Integer).returns(Integer) }
def iterations=(_iterations); end
sig { params(iterations: Integer).void }
def initialize(iterations: nil); end
end
# Describes the period to bill for upon accepting the quote.
sig {
returns(T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance)))
}
def bill_on_acceptance; end
sig {
params(_bill_on_acceptance: T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance))).returns(T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance)))
}
def bill_on_acceptance=(_bill_on_acceptance); end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
sig { params(_billing_behavior: T.nilable(String)).returns(T.nilable(String)) }
def billing_behavior=(_billing_behavior); end
# When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
sig { returns(T.nilable(T.any(String, T.any(String, Integer)))) }
def effective_date; end
sig {
params(_effective_date: T.nilable(T.any(String, T.any(String, Integer)))).returns(T.nilable(T.any(String, T.any(String, Integer))))
}
def effective_date=(_effective_date); end
# Behavior of the subscription schedule and underlying subscription when it ends.
sig { returns(T.nilable(String)) }
def end_behavior; end
sig { params(_end_behavior: T.nilable(String)).returns(T.nilable(String)) }
def end_behavior=(_end_behavior); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
sig {
returns(T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::SubscriptionData::Prebilling)))
}
def prebilling; end
sig {
params(_prebilling: T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::SubscriptionData::Prebilling))).returns(T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::SubscriptionData::Prebilling)))
}
def prebilling=(_prebilling); end
# Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
#
# When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
#
# Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
#
# Prorations can be disabled by passing `none`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Integer representing the number of trial period days before the customer is charged for the first time.
sig { returns(T.nilable(T.any(String, Integer))) }
def trial_period_days; end
sig {
params(_trial_period_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def trial_period_days=(_trial_period_days); end
sig {
params(bill_on_acceptance: T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::SubscriptionData::BillOnAcceptance)), billing_behavior: T.nilable(String), billing_cycle_anchor: T.nilable(String), description: T.nilable(String), effective_date: T.nilable(T.any(String, T.any(String, Integer))), end_behavior: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), prebilling: T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::SubscriptionData::Prebilling)), proration_behavior: T.nilable(String), trial_period_days: T.nilable(T.any(String, Integer))).void
}
def initialize(
bill_on_acceptance: nil,
billing_behavior: nil,
billing_cycle_anchor: nil,
description: nil,
effective_date: nil,
end_behavior: nil,
metadata: nil,
prebilling: nil,
proration_behavior: nil,
trial_period_days: nil
); end
end
class SubscriptionDataOverride < Stripe::RequestParams
class AppliesTo < Stripe::RequestParams
# A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
sig { returns(T.nilable(String)) }
def new_reference; end
sig { params(_new_reference: T.nilable(String)).returns(T.nilable(String)) }
def new_reference=(_new_reference); end
# The ID of the schedule the line applies to.
sig { returns(T.nilable(String)) }
def subscription_schedule; end
sig { params(_subscription_schedule: T.nilable(String)).returns(T.nilable(String)) }
def subscription_schedule=(_subscription_schedule); end
# Describes whether the quote line is affecting a new schedule or an existing schedule.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(new_reference: T.nilable(String), subscription_schedule: T.nilable(String), type: String).void
}
def initialize(new_reference: nil, subscription_schedule: nil, type: nil); end
end
class BillOnAcceptance < Stripe::RequestParams
class BillFrom < Stripe::RequestParams
class LineStartsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Details of a Quote line to start the bill period from.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt))
}
def line_starts_at; end
sig {
params(_line_starts_at: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt)).returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt))
}
def line_starts_at=(_line_starts_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of method to specify the `bill_from` time.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(line_starts_at: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(line_starts_at: nil, timestamp: nil, type: nil); end
end
class BillUntil < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
class LineEndsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Details of the duration over which to bill.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration)).returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration))
}
def duration=(_duration); end
# Details of a Quote line item from which to bill until.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt))
}
def line_ends_at; end
sig {
params(_line_ends_at: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt)).returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt))
}
def line_ends_at=(_line_ends_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of method to specify the `bill_until` time.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration), line_ends_at: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, line_ends_at: nil, timestamp: nil, type: nil); end
end
# The start of the period to bill from when the Quote is accepted.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom))
}
def bill_from; end
sig {
params(_bill_from: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom)).returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom))
}
def bill_from=(_bill_from); end
# The end of the period to bill until when the Quote is accepted.
sig {
returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil))
}
def bill_until; end
sig {
params(_bill_until: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil)).returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil))
}
def bill_until=(_bill_until); end
sig {
params(bill_from: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom), bill_until: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil)).void
}
def initialize(bill_from: nil, bill_until: nil); end
end
# Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
sig { returns(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::AppliesTo) }
def applies_to; end
sig {
params(_applies_to: ::Stripe::Quote::UpdateParams::SubscriptionDataOverride::AppliesTo).returns(::Stripe::Quote::UpdateParams::SubscriptionDataOverride::AppliesTo)
}
def applies_to=(_applies_to); end
# Describes the period to bill for upon accepting the quote.
sig {
returns(T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance)))
}
def bill_on_acceptance; end
sig {
params(_bill_on_acceptance: T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance))).returns(T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance)))
}
def bill_on_acceptance=(_bill_on_acceptance); end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
sig { params(_billing_behavior: T.nilable(String)).returns(T.nilable(String)) }
def billing_behavior=(_billing_behavior); end
# The customer the Subscription Data override applies to.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Behavior of the subscription schedule and underlying subscription when it ends.
sig { returns(T.nilable(String)) }
def end_behavior; end
sig { params(_end_behavior: T.nilable(String)).returns(T.nilable(String)) }
def end_behavior=(_end_behavior); end
# Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
#
# When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
#
# Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
#
# Prorations can be disabled by passing `none`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
sig {
params(applies_to: ::Stripe::Quote::UpdateParams::SubscriptionDataOverride::AppliesTo, bill_on_acceptance: T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::SubscriptionDataOverride::BillOnAcceptance)), billing_behavior: T.nilable(String), customer: T.nilable(String), description: T.nilable(String), end_behavior: T.nilable(String), proration_behavior: T.nilable(String)).void
}
def initialize(
applies_to: nil,
bill_on_acceptance: nil,
billing_behavior: nil,
customer: nil,
description: nil,
end_behavior: nil,
proration_behavior: nil
); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig {
params(amount: T.nilable(Integer), amount_percent: T.nilable(Float), destination: String).void
}
def initialize(amount: nil, amount_percent: nil, destination: nil); end
end
# Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
sig { returns(T.nilable(T::Boolean)) }
def allow_backdated_lines; end
sig { params(_allow_backdated_lines: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def allow_backdated_lines=(_allow_backdated_lines); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.
sig { returns(T.nilable(T.any(String, Integer))) }
def application_fee_amount; end
sig {
params(_application_fee_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def application_fee_amount=(_application_fee_amount); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.
sig { returns(T.nilable(T.any(String, Float))) }
def application_fee_percent; end
sig {
params(_application_fee_percent: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def application_fee_percent=(_application_fee_percent); end
# Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::Quote::UpdateParams::AutomaticTax)).returns(T.nilable(::Stripe::Quote::UpdateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or 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`.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# The tax rates that will apply to any line item that does not have `tax_rates` set.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# A description that will be displayed on the quote PDF.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The discounts applied to the quote.
sig { returns(T.nilable(T.any(String, T::Array[::Stripe::Quote::UpdateParams::Discount]))) }
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Quote::UpdateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Quote::UpdateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# A footer that will be displayed on the quote PDF.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# A header that will be displayed on the quote PDF.
sig { returns(T.nilable(String)) }
def header; end
sig { params(_header: T.nilable(String)).returns(T.nilable(String)) }
def header=(_header); end
# All invoices will be billed using the specified settings.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::InvoiceSettings)) }
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::Quote::UpdateParams::InvoiceSettings)).returns(T.nilable(::Stripe::Quote::UpdateParams::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
sig { returns(T.nilable(T::Array[::Stripe::Quote::UpdateParams::LineItem])) }
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::Quote::UpdateParams::LineItem])).returns(T.nilable(T::Array[::Stripe::Quote::UpdateParams::LineItem]))
}
def line_items=(_line_items); end
# A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
sig { returns(T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line])) }
def lines; end
sig {
params(_lines: T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line])).returns(T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line]))
}
def lines=(_lines); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The account on behalf of which to charge.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.
sig { returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData)) }
def subscription_data; end
sig {
params(_subscription_data: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData)).returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData))
}
def subscription_data=(_subscription_data); end
# List representing overrides for `subscription_data` configurations for specific subscription schedules.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Quote::UpdateParams::SubscriptionDataOverride])))
}
def subscription_data_overrides; end
sig {
params(_subscription_data_overrides: T.nilable(T.any(String, T::Array[::Stripe::Quote::UpdateParams::SubscriptionDataOverride]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Quote::UpdateParams::SubscriptionDataOverride])))
}
def subscription_data_overrides=(_subscription_data_overrides); end
# The data with which to automatically create a Transfer for each of the invoices.
sig { returns(T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::TransferData))) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::TransferData))).returns(T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::TransferData)))
}
def transfer_data=(_transfer_data); end
sig {
params(allow_backdated_lines: T.nilable(T::Boolean), application_fee_amount: T.nilable(T.any(String, Integer)), application_fee_percent: T.nilable(T.any(String, Float)), automatic_tax: T.nilable(::Stripe::Quote::UpdateParams::AutomaticTax), collection_method: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), default_tax_rates: T.nilable(T.any(String, T::Array[String])), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::Quote::UpdateParams::Discount])), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), footer: T.nilable(String), header: T.nilable(String), invoice_settings: T.nilable(::Stripe::Quote::UpdateParams::InvoiceSettings), line_items: T.nilable(T::Array[::Stripe::Quote::UpdateParams::LineItem]), lines: T.nilable(T::Array[::Stripe::Quote::UpdateParams::Line]), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), subscription_data: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData), subscription_data_overrides: T.nilable(T.any(String, T::Array[::Stripe::Quote::UpdateParams::SubscriptionDataOverride])), transfer_data: T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::TransferData))).void
}
def initialize(
allow_backdated_lines: nil,
application_fee_amount: nil,
application_fee_percent: nil,
automatic_tax: nil,
collection_method: nil,
customer: nil,
customer_account: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
expand: nil,
expires_at: nil,
footer: nil,
header: nil,
invoice_settings: nil,
line_items: nil,
lines: nil,
metadata: nil,
on_behalf_of: nil,
subscription_data: nil,
subscription_data_overrides: nil,
transfer_data: nil
); end
end
class ListComputedUpfrontLineItemsParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class ListLineItemsParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class ListLinesParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class AcceptParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class FinalizeQuoteParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
sig { params(expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer)).void }
def initialize(expand: nil, expires_at: nil); end
end
class MarkDraftParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class MarkStaleParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Reason the Quote is being marked stale.
sig { returns(T.nilable(String)) }
def reason; end
sig { params(_reason: T.nilable(String)).returns(T.nilable(String)) }
def reason=(_reason); end
sig { params(expand: T.nilable(T::Array[String]), reason: T.nilable(String)).void }
def initialize(expand: nil, reason: nil); end
end
class ReestimateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class PdfParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ListPreviewInvoiceLinesParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Accepts the specified quote.
sig {
params(params: T.any(::Stripe::Quote::AcceptParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def accept(params = {}, opts = {}); end
# Accepts the specified quote.
sig {
params(quote: String, params: T.any(::Stripe::Quote::AcceptParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def self.accept(quote, params = {}, opts = {}); end
# Cancels the quote.
sig {
params(params: T.any(::Stripe::Quote::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def cancel(params = {}, opts = {}); end
# Cancels the quote.
sig {
params(quote: String, params: T.any(::Stripe::Quote::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def self.cancel(quote, params = {}, opts = {}); end
# A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the [quote template](https://dashboard.stripe.com/settings/billing/quote).
sig {
params(params: T.any(::Stripe::Quote::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def self.create(params = {}, opts = {}); end
# Finalizes the quote.
sig {
params(params: T.any(::Stripe::Quote::FinalizeQuoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def finalize_quote(params = {}, opts = {}); end
# Finalizes the quote.
sig {
params(quote: String, params: T.any(::Stripe::Quote::FinalizeQuoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def self.finalize_quote(quote, params = {}, opts = {}); end
# Returns a list of your quotes.
sig {
params(params: T.any(::Stripe::Quote::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# When retrieving a quote, there is an includable [computed.upfront.line_items](https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items) property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.
sig {
params(params: T.any(::Stripe::Quote::ListComputedUpfrontLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list_computed_upfront_line_items(params = {}, opts = {}); end
# When retrieving a quote, there is an includable [computed.upfront.line_items](https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items) property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.
sig {
params(quote: String, params: T.any(::Stripe::Quote::ListComputedUpfrontLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list_computed_upfront_line_items(quote, params = {}, opts = {}); end
# When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
sig {
params(params: T.any(::Stripe::Quote::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list_line_items(params = {}, opts = {}); end
# When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
sig {
params(quote: String, params: T.any(::Stripe::Quote::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list_line_items(quote, params = {}, opts = {}); end
# Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
sig {
params(params: T.any(::Stripe::Quote::ListLinesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list_lines(params = {}, opts = {}); end
# Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
sig {
params(quote: String, params: T.any(::Stripe::Quote::ListLinesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list_lines(quote, params = {}, opts = {}); end
# Preview the invoice line items that would be generated by accepting the quote.
sig {
params(preview_invoice: String, params: T.any(::Stripe::Quote::ListPreviewInvoiceLinesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list_preview_invoice_lines(preview_invoice, params = {}, opts = {}); end
# Preview the invoice line items that would be generated by accepting the quote.
sig {
params(quote: String, preview_invoice: String, params: T.any(::Stripe::Quote::ListPreviewInvoiceLinesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list_preview_invoice_lines(quote, preview_invoice, params = {}, opts = {}); end
# Converts a stale quote to draft.
sig {
params(params: T.any(::Stripe::Quote::MarkDraftParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def mark_draft(params = {}, opts = {}); end
# Converts a stale quote to draft.
sig {
params(quote: String, params: T.any(::Stripe::Quote::MarkDraftParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def self.mark_draft(quote, params = {}, opts = {}); end
# Converts a draft or open quote to stale.
sig {
params(params: T.any(::Stripe::Quote::MarkStaleParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def mark_stale(params = {}, opts = {}); end
# Converts a draft or open quote to stale.
sig {
params(quote: String, params: T.any(::Stripe::Quote::MarkStaleParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def self.mark_stale(quote, params = {}, opts = {}); end
# Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
sig {
params(params: T.any(::Stripe::Quote::PdfParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, read_body_chunk_block: T.untyped).returns(T.untyped)
}
def pdf(params = {}, opts = {}, &read_body_chunk_block); end
# Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
sig {
params(quote: String, params: T.any(::Stripe::Quote::PdfParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, read_body_chunk_block: T.untyped).returns(T.untyped)
}
def self.pdf(quote, params = {}, opts = {}, &read_body_chunk_block); end
# Recompute the upcoming invoice estimate for the quote.
sig {
params(params: T.any(::Stripe::Quote::ReestimateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def reestimate(params = {}, opts = {}); end
# Recompute the upcoming invoice estimate for the quote.
sig {
params(quote: String, params: T.any(::Stripe::Quote::ReestimateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def self.reestimate(quote, params = {}, opts = {}); end
# A quote models prices and services for a customer.
sig {
params(quote: String, params: T.any(::Stripe::Quote::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def self.update(quote, params = {}, opts = {}); end
end
end
# typed: 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/invoicing/integration/automatic-advancement-collection), 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://docs.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 QuotePreviewInvoice < APIResource
class AmountsDue < Stripe::StripeObject
# Incremental amount due for this payment in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
# The amount in cents (or local equivalent) that was paid for this payment.
sig { returns(Integer) }
def amount_paid; end
# The difference between the payment’s amount and amount_paid, in cents (or local equivalent).
sig { returns(Integer) }
def amount_remaining; end
# Number of days from when invoice is finalized until the payment is due.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# Date on which a payment plan’s payment is due.
sig { returns(T.nilable(Integer)) }
def due_date; end
# Timestamp when the payment was paid.
sig { returns(T.nilable(Integer)) }
def paid_at; end
# The status of the payment, one of `open`, `paid`, or `past_due`
sig { returns(String) }
def status; end
end
class AppliesTo < Stripe::StripeObject
# A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
sig { returns(T.nilable(String)) }
def new_reference; end
# The ID of the schedule the line applies to.
sig { returns(T.nilable(String)) }
def subscription_schedule; end
# Describes whether the quote line is affecting a new schedule or an existing schedule.
sig { returns(String) }
def type; end
end
class AutomaticTax < Stripe::StripeObject
class Liability < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# If Stripe disabled automatic tax, this enum describes why.
sig { returns(T.nilable(String)) }
def disabled_reason; end
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
sig { returns(T::Boolean) }
def enabled; end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(Liability)) }
def liability; end
# The tax provider powering automatic tax.
sig { returns(T.nilable(String)) }
def provider; end
# The status of the most recent automated tax calculation for this invoice.
sig { returns(T.nilable(String)) }
def status; end
end
class ConfirmationSecret < Stripe::StripeObject
# The client_secret of the payment that Stripe creates for the invoice after finalization.
sig { returns(String) }
def client_secret; end
# The type of client_secret. Currently this is always payment_intent, referencing the default payment_intent that Stripe creates during invoice finalization
sig { returns(String) }
def type; end
end
class CustomField < Stripe::StripeObject
# The name of the custom field.
sig { returns(String) }
def name; end
# The value of the custom field.
sig { returns(String) }
def value; end
end
class CustomerAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class CustomerShipping < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(T.nilable(Address)) }
def address; end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
# Recipient name.
sig { returns(T.nilable(String)) }
def name; end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
end
class CustomerTaxId < Stripe::StripeObject
# The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
sig { returns(String) }
def type; end
# The value of the tax ID.
sig { returns(T.nilable(String)) }
def value; end
end
class FromInvoice < Stripe::StripeObject
# The relation between this invoice and the cloned invoice
sig { returns(String) }
def action; end
# The invoice that was cloned.
sig { returns(T.any(String, Stripe::Invoice)) }
def invoice; end
end
class Issuer < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
class LastFinalizationError < Stripe::StripeObject
# For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.
sig { returns(T.nilable(String)) }
def advice_code; end
# For card errors, the ID of the failed charge.
sig { returns(T.nilable(String)) }
def charge; end
# For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
sig { returns(T.nilable(String)) }
def code; end
# For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.
sig { returns(T.nilable(String)) }
def decline_code; end
# A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.
sig { returns(T.nilable(String)) }
def doc_url; end
# A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
sig { returns(T.nilable(String)) }
def message; end
# For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
sig { returns(T.nilable(String)) }
def network_advice_code; end
# For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
sig { returns(T.nilable(String)) }
def network_decline_code; end
# If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
sig { returns(T.nilable(String)) }
def param; end
# 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)
sig { returns(T.nilable(Stripe::PaymentIntent)) }
def payment_intent; end
# 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).
sig { returns(T.nilable(Stripe::PaymentMethod)) }
def payment_method; end
# If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
sig { returns(T.nilable(String)) }
def payment_method_type; end
# A URL to the request log entry in your dashboard.
sig { returns(T.nilable(String)) }
def request_log_url; end
# A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
# For example, you can 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 when you're ready to collect your customer's payment credentials.
# Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
# The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/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) might need to be run through
# [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection
# to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).
# If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),
# it automatically attaches the resulting payment method to that Customer after successful setup.
# 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 to prevent saving invalid or unoptimized payment methods.
#
# By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
#
# Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)
sig { returns(T.nilable(Stripe::SetupIntent)) }
def setup_intent; end
# Attribute for field source
sig {
returns(T.nilable(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source)))
}
def source; end
# The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`
sig { returns(String) }
def type; end
end
class Parent < Stripe::StripeObject
class QuoteDetails < Stripe::StripeObject
# The quote that generated this invoice
sig { returns(String) }
def quote; end
end
class SubscriptionDetails < Stripe::StripeObject
class PauseCollection < Stripe::StripeObject
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(T.nilable(String)) }
def behavior; end
# The time after which the subscription will resume collecting payments.
sig { returns(T.nilable(Integer)) }
def resumes_at; end
end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.
# *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
sig { returns(T.nilable(PauseCollection)) }
def pause_collection; end
# The subscription that generated this invoice
sig { returns(T.any(String, Stripe::Subscription)) }
def subscription; end
# Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
sig { returns(T.nilable(Integer)) }
def subscription_proration_date; end
end
# Details about the quote that generated this invoice
sig { returns(T.nilable(QuoteDetails)) }
def quote_details; end
# Details about the subscription that generated this invoice
sig { returns(T.nilable(SubscriptionDetails)) }
def subscription_details; end
# The type of parent that generated this invoice
sig { returns(String) }
def type; end
end
class PaymentSettings < Stripe::StripeObject
class PaymentMethodOptions < Stripe::StripeObject
class AcssDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
end
class Bancontact < Stripe::StripeObject
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(String) }
def preferred_language; end
end
class Card < Stripe::StripeObject
class Installments < Stripe::StripeObject
# Whether Installments are enabled for this Invoice.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
end
# Attribute for field installments
sig { returns(T.nilable(Installments)) }
def installments; end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
end
class CustomerBalance < Stripe::StripeObject
class BankTransfer < Stripe::StripeObject
class EuBankTransfer < Stripe::StripeObject
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
end
# Attribute for field eu_bank_transfer
sig { returns(T.nilable(EuBankTransfer)) }
def eu_bank_transfer; end
# The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(T.nilable(String)) }
def type; end
end
# Attribute for field bank_transfer
sig { returns(T.nilable(BankTransfer)) }
def bank_transfer; end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
end
class IdBankTransfer < Stripe::StripeObject; end
class Konbini < Stripe::StripeObject; end
class Pix < Stripe::StripeObject
# Determines if the amount includes the IOF tax.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
end
class SepaDebit < Stripe::StripeObject; end
class Upi < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(T.nilable(String)) }
def amount_type; end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
end
class UsBankAccount < Stripe::StripeObject
class FinancialConnections < Stripe::StripeObject
class Filters < Stripe::StripeObject
# The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
# The institution to use to filter for possible accounts to link.
sig { returns(T.nilable(String)) }
def institution; end
end
# Attribute for field filters
sig { returns(T.nilable(Filters)) }
def filters; end
# The list of permissions to request. The `payment_method` permission must be included.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
# Data features requested to be retrieved upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
end
# Attribute for field financial_connections
sig { returns(T.nilable(FinancialConnections)) }
def financial_connections; end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
end
# If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(Bancontact)) }
def bancontact; end
# If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(Card)) }
def card; end
# If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(CustomerBalance)) }
def customer_balance; end
# If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(IdBankTransfer)) }
def id_bank_transfer; end
# If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(Konbini)) }
def konbini; end
# If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(Pix)) }
def pix; end
# If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(Upi)) }
def upi; end
# If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
end
# ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.
sig { returns(T.nilable(String)) }
def default_mandate; end
# Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
sig { returns(T.nilable(PaymentMethodOptions)) }
def payment_method_options; end
# The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
end
class Rendering < Stripe::StripeObject
class Pdf < Stripe::StripeObject
# Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.
sig { returns(T.nilable(String)) }
def page_size; end
end
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
sig { returns(T.nilable(String)) }
def amount_tax_display; end
# Invoice pdf rendering options
sig { returns(T.nilable(Pdf)) }
def pdf; end
# ID of the rendering template that the invoice is formatted by.
sig { returns(T.nilable(String)) }
def template; end
# Version of the rendering template that the invoice is using.
sig { returns(T.nilable(Integer)) }
def template_version; end
end
class ShippingCost < Stripe::StripeObject
class Tax < Stripe::StripeObject
# Amount of tax applied for this rate.
sig { returns(Integer) }
def amount; end
# Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
#
# Related guide: [Tax rates](/billing/taxes/tax-rates)
sig { returns(Stripe::TaxRate) }
def rate; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(T.nilable(String)) }
def taxability_reason; end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(T.nilable(Integer)) }
def taxable_amount; end
end
# Total shipping cost before any taxes are applied.
sig { returns(Integer) }
def amount_subtotal; end
# Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
sig { returns(Integer) }
def amount_tax; end
# Total shipping cost after taxes are applied.
sig { returns(Integer) }
def amount_total; end
# The ID of the ShippingRate for this invoice.
sig { returns(T.nilable(T.any(String, Stripe::ShippingRate))) }
def shipping_rate; end
# The taxes applied to the shipping rate.
sig { returns(T.nilable(T::Array[Tax])) }
def taxes; end
end
class ShippingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(T.nilable(Address)) }
def address; end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
# Recipient name.
sig { returns(T.nilable(String)) }
def name; end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
end
class StatusTransitions < Stripe::StripeObject
# The time that the invoice draft was finalized.
sig { returns(T.nilable(Integer)) }
def finalized_at; end
# The time that the invoice was marked uncollectible.
sig { returns(T.nilable(Integer)) }
def marked_uncollectible_at; end
# The time that the invoice was paid.
sig { returns(T.nilable(Integer)) }
def paid_at; end
# The time that the invoice was voided.
sig { returns(T.nilable(Integer)) }
def voided_at; end
end
class ThresholdReason < Stripe::StripeObject
class ItemReason < Stripe::StripeObject
# The IDs of the line items that triggered the threshold invoice.
sig { returns(T::Array[String]) }
def line_item_ids; end
# The quantity threshold boundary that applied to the given line item.
sig { returns(Integer) }
def usage_gte; end
end
# The total invoice amount threshold boundary if it triggered the threshold invoice.
sig { returns(T.nilable(Integer)) }
def amount_gte; end
# Indicates which line items triggered a threshold invoice.
sig { returns(T::Array[ItemReason]) }
def item_reasons; end
end
class TotalDiscountAmount < Stripe::StripeObject
# The amount, in cents (or local equivalent), of the discount.
sig { returns(Integer) }
def amount; end
# The discount that was applied to get this discount amount.
sig { returns(T.any(String, Stripe::Discount)) }
def discount; end
end
class TotalMarginAmount < Stripe::StripeObject
# The amount, in cents (or local equivalent), of the reduction in line item amount.
sig { returns(Integer) }
def amount; end
# The margin that was applied to get this margin amount.
sig { returns(T.any(String, Stripe::Margin)) }
def margin; end
end
class TotalPretaxCreditAmount < Stripe::StripeObject
# The amount, in cents (or local equivalent), of the pretax credit amount.
sig { returns(Integer) }
def amount; end
# The credit balance transaction that was applied to get this pretax credit amount.
sig { returns(T.nilable(T.any(String, Stripe::Billing::CreditBalanceTransaction))) }
def credit_balance_transaction; end
# The discount that was applied to get this pretax credit amount.
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
def discount; end
# The margin that was applied to get this pretax credit amount.
sig { returns(T.nilable(T.any(String, Stripe::Margin))) }
def margin; end
# Type of the pretax credit amount referenced.
sig { returns(String) }
def type; end
end
class TotalTax < Stripe::StripeObject
class TaxRateDetails < Stripe::StripeObject
# Attribute for field tax_rate
sig { returns(String) }
def tax_rate; end
end
# The amount of the tax, in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
# Whether this tax is inclusive or exclusive.
sig { returns(String) }
def tax_behavior; end
# Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
sig { returns(T.nilable(TaxRateDetails)) }
def tax_rate_details; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(String) }
def taxability_reason; end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(T.nilable(Integer)) }
def taxable_amount; end
# The type of tax information.
sig { returns(String) }
def type; end
end
# The country of the business associated with this invoice, most often the business creating the invoice.
sig { returns(T.nilable(String)) }
def account_country; end
# The public name of the business associated with this invoice, most often the business creating the invoice.
sig { returns(T.nilable(String)) }
def account_name; end
# The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
def account_tax_ids; end
# Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.
sig { returns(Integer) }
def amount_due; end
# Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
sig { returns(Integer) }
def amount_overpaid; end
# The amount, in cents (or local equivalent), that was paid.
sig { returns(Integer) }
def amount_paid; end
# The difference between amount_due and amount_paid, in cents (or local equivalent).
sig { returns(Integer) }
def amount_remaining; end
# This is the sum of all the shipping amounts.
sig { returns(Integer) }
def amount_shipping; end
# List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.
sig { returns(T.nilable(T::Array[AmountsDue])) }
def amounts_due; end
# ID of the Connect Application that created the invoice.
sig { returns(T.nilable(T.any(String, Stripe::Application))) }
def application; end
# Attribute for field applies_to
sig { returns(AppliesTo) }
def applies_to; end
# Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
sig { returns(Integer) }
def attempt_count; end
# Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.
sig { returns(T::Boolean) }
def attempted; end
# Attribute for field automatic_tax
sig { returns(AutomaticTax) }
def automatic_tax; end
# The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized.
sig { returns(T.nilable(Integer)) }
def automatically_finalizes_at; end
# Indicates the reason why the invoice was created.
#
# * `manual`: Unrelated to a subscription, for example, created via the invoice editor.
# * `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
# * `subscription_create`: A new subscription was created.
# * `subscription_cycle`: A subscription advanced into a new period.
# * `subscription_threshold`: A subscription reached a billing threshold.
# * `subscription_update`: A subscription was updated.
# * `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.
sig { returns(T.nilable(String)) }
def billing_reason; end
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
sig { returns(String) }
def collection_method; end
# The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
sig { returns(T.nilable(ConfirmationSecret)) }
def confirmation_secret; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# Custom fields displayed on the invoice.
sig { returns(T.nilable(T::Array[CustomField])) }
def custom_fields; end
# The ID of the account who will be billed.
sig { returns(T.nilable(String)) }
def customer_account; end
# The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.
sig { returns(T.nilable(CustomerAddress)) }
def customer_address; end
# The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.
sig { returns(T.nilable(String)) }
def customer_email; end
# The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated.
sig { returns(T.nilable(String)) }
def customer_name; end
# The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated.
sig { returns(T.nilable(String)) }
def customer_phone; end
# The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated.
sig { returns(T.nilable(CustomerShipping)) }
def customer_shipping; end
# The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated.
sig { returns(T.nilable(String)) }
def customer_tax_exempt; end
# The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.
sig { returns(T.nilable(T::Array[CustomerTaxId])) }
def customer_tax_ids; end
# The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::Margin)])) }
def default_margins; end
# ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def default_payment_method; end
# ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
sig {
returns(T.nilable(T.any(String, T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source))))
}
def default_source; end
# The tax rates applied to this invoice, if any.
sig { returns(T::Array[Stripe::TaxRate]) }
def default_tax_rates; end
# An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
sig { returns(T.nilable(String)) }
def description; end
# The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
sig { returns(T::Array[T.any(String, Stripe::Discount)]) }
def discounts; end
# The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def due_date; end
# The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
sig { returns(T.nilable(Integer)) }
def effective_at; end
# Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
sig { returns(T.nilable(Integer)) }
def ending_balance; end
# Footer displayed on the invoice.
sig { returns(T.nilable(String)) }
def footer; end
# Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.
sig { returns(T.nilable(FromInvoice)) }
def from_invoice; end
# Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`.
sig { returns(String) }
def id; end
# Attribute for field issuer
sig { returns(Issuer) }
def issuer; end
# The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
sig { returns(T.nilable(LastFinalizationError)) }
def last_finalization_error; end
# The ID of the most recent non-draft revision of this invoice
sig { returns(T.nilable(T.any(String, Stripe::Invoice))) }
def latest_revision; end
# The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.
sig { returns(Stripe::ListObject) }
def lines; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.
sig { returns(T.nilable(Integer)) }
def next_payment_attempt; end
# A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
sig { returns(T.nilable(String)) }
def number; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def on_behalf_of; end
# The parent that generated this invoice
sig { returns(T.nilable(Parent)) }
def parent; end
# Attribute for field payment_settings
sig { returns(PaymentSettings) }
def payment_settings; end
# Payments for this invoice
sig { returns(T.nilable(Stripe::ListObject)) }
def payments; end
# End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.
sig { returns(Integer) }
def period_end; end
# Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.
sig { returns(Integer) }
def period_start; end
# Total amount of all post-payment credit notes issued for this invoice.
sig { returns(Integer) }
def post_payment_credit_notes_amount; end
# Total amount of all pre-payment credit notes issued for this invoice.
sig { returns(Integer) }
def pre_payment_credit_notes_amount; end
# This is the transaction number that appears on email receipts sent for this invoice.
sig { returns(T.nilable(String)) }
def receipt_number; end
# The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
sig { returns(T.nilable(Rendering)) }
def rendering; end
# The details of the cost of shipping, including the ShippingRate applied on the invoice.
sig { returns(T.nilable(ShippingCost)) }
def shipping_cost; end
# Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.
sig { returns(T.nilable(ShippingDetails)) }
def shipping_details; end
# Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
sig { returns(Integer) }
def starting_balance; end
# Extra information about an invoice for the customer's credit card statement.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
# The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)
sig { returns(T.nilable(String)) }
def status; end
# Attribute for field status_transitions
sig { returns(StatusTransitions) }
def status_transitions; end
# Attribute for field subscription
sig { returns(T.nilable(T.any(String, Stripe::Subscription))) }
def subscription; end
# Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
sig { returns(Integer) }
def subtotal; end
# The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
sig { returns(T.nilable(Integer)) }
def subtotal_excluding_tax; end
# ID of the test clock this invoice belongs to.
sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
def test_clock; end
# Attribute for field threshold_reason
sig { returns(T.nilable(ThresholdReason)) }
def threshold_reason; end
# Total after discounts and taxes.
sig { returns(Integer) }
def total; end
# The aggregate amounts calculated per discount across all line items.
sig { returns(T.nilable(T::Array[TotalDiscountAmount])) }
def total_discount_amounts; end
# The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
sig { returns(T.nilable(Integer)) }
def total_excluding_tax; end
# The aggregate amounts calculated per margin across all line items.
sig { returns(T.nilable(T::Array[TotalMarginAmount])) }
def total_margin_amounts; end
# Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
sig { returns(T.nilable(T::Array[TotalPretaxCreditAmount])) }
def total_pretax_credit_amounts; end
# The aggregate tax information of all line items.
sig { returns(T.nilable(T::Array[TotalTax])) }
def total_taxes; end
# Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
sig { returns(T.nilable(Integer)) }
def webhooks_delivered_at; end
end
end
# typed: true
module Stripe
class QuotePreviewSubscriptionSchedule < APIResource
class AppliesTo < Stripe::StripeObject
# A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
sig { returns(T.nilable(String)) }
def new_reference; end
# The ID of the schedule the line applies to.
sig { returns(T.nilable(String)) }
def subscription_schedule; end
# Describes whether the quote line is affecting a new schedule or an existing schedule.
sig { returns(String) }
def type; end
end
class BillingMode < Stripe::StripeObject
class Flexible < Stripe::StripeObject
# When true, proration line items will show accurate discount amounts and use gross amounts, making them consistent with non-proration line items.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
end
# Configure behavior for flexible billing mode
sig { returns(T.nilable(Flexible)) }
def flexible; end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig { returns(String) }
def type; end
# Details on when the current billing_mode was adopted.
sig { returns(T.nilable(Integer)) }
def updated_at; end
end
class CurrentPhase < Stripe::StripeObject
# The end of this phase of the subscription schedule.
sig { returns(Integer) }
def end_date; end
# The start of this phase of the subscription schedule.
sig { returns(Integer) }
def start_date; end
end
class DefaultSettings < Stripe::StripeObject
class AutomaticTax < Stripe::StripeObject
class Liability < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# If Stripe disabled automatic tax, this enum describes why.
sig { returns(T.nilable(String)) }
def disabled_reason; end
# Whether Stripe automatically computes tax on invoices created during this phase.
sig { returns(T::Boolean) }
def enabled; end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(Liability)) }
def liability; end
end
class BillingThresholds < Stripe::StripeObject
# Monetary threshold that triggers the subscription to create an invoice
sig { returns(T.nilable(Integer)) }
def amount_gte; end
# 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. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
end
class InvoiceSettings < Stripe::StripeObject
class Issuer < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
def account_tax_ids; end
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
# Attribute for field issuer
sig { returns(Issuer) }
def issuer; end
end
class TransferData < Stripe::StripeObject
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
# The account where funds from the payment will be transferred to upon payment success.
sig { returns(T.any(String, Stripe::Account)) }
def destination; end
end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
# Attribute for field automatic_tax
sig { returns(T.nilable(AutomaticTax)) }
def automatic_tax; end
# Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
sig { returns(String) }
def billing_cycle_anchor; end
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
sig { returns(T.nilable(BillingThresholds)) }
def billing_thresholds; end
# 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`.
sig { returns(T.nilable(String)) }
def collection_method; end
# ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def default_payment_method; end
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
# Attribute for field invoice_settings
sig { returns(InvoiceSettings) }
def invoice_settings; end
# The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def on_behalf_of; end
# The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
sig { returns(T.nilable(TransferData)) }
def transfer_data; end
end
class LastPriceMigrationError < Stripe::StripeObject
class FailedTransition < Stripe::StripeObject
# The original price to be migrated.
sig { returns(String) }
def source_price; end
# The intended resulting price of the migration.
sig { returns(String) }
def target_price; end
end
# The time at which the price migration encountered an error.
sig { returns(Integer) }
def errored_at; end
# The involved price pairs in each failed transition.
sig { returns(T::Array[FailedTransition]) }
def failed_transitions; end
# The type of error encountered by the price migration.
sig { returns(String) }
def type; end
end
class Phase < Stripe::StripeObject
class AddInvoiceItem < Stripe::StripeObject
class Discount < Stripe::StripeObject
class DiscountEnd < Stripe::StripeObject
# The discount end timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# The discount end type.
sig { returns(String) }
def type; end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
def coupon; end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
def discount; end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(DiscountEnd)) }
def discount_end; end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
def promotion_code; end
end
class Period < Stripe::StripeObject
class End < Stripe::StripeObject
# A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# Select how to calculate the end of the invoice item period.
sig { returns(String) }
def type; end
end
class Start < Stripe::StripeObject
# A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# Select how to calculate the start of the invoice item period.
sig { returns(String) }
def type; end
end
# Attribute for field end
sig { returns(End) }
def end; end
# Attribute for field start
sig { returns(Start) }
def start; end
end
# The stackable discounts that will be applied to the item.
sig { returns(T::Array[Discount]) }
def discounts; end
# 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])) }
def metadata; end
# Attribute for field period
sig { returns(Period) }
def period; end
# ID of the price used to generate the invoice item.
sig { returns(T.any(String, Stripe::Price)) }
def price; end
# The quantity of the invoice item.
sig { returns(T.nilable(Integer)) }
def quantity; end
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
sig { returns(T.nilable(T::Array[Stripe::TaxRate])) }
def tax_rates; end
end
class AutomaticTax < Stripe::StripeObject
class Liability < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# If Stripe disabled automatic tax, this enum describes why.
sig { returns(T.nilable(String)) }
def disabled_reason; end
# Whether Stripe automatically computes tax on invoices created during this phase.
sig { returns(T::Boolean) }
def enabled; end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(Liability)) }
def liability; end
end
class BillingThresholds < Stripe::StripeObject
# Monetary threshold that triggers the subscription to create an invoice
sig { returns(T.nilable(Integer)) }
def amount_gte; end
# 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. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
end
class Discount < Stripe::StripeObject
class DiscountEnd < Stripe::StripeObject
# The discount end timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# The discount end type.
sig { returns(String) }
def type; end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
def coupon; end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
def discount; end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(DiscountEnd)) }
def discount_end; end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
def promotion_code; end
end
class InvoiceSettings < Stripe::StripeObject
class Issuer < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
def account_tax_ids; end
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig { returns(T.nilable(Issuer)) }
def issuer; end
end
class Item < Stripe::StripeObject
class BillingThresholds < Stripe::StripeObject
# Usage threshold that triggers the subscription to create an invoice
sig { returns(T.nilable(Integer)) }
def usage_gte; end
end
class Discount < Stripe::StripeObject
class DiscountEnd < Stripe::StripeObject
# The discount end timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# The discount end type.
sig { returns(String) }
def type; end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
def coupon; end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
def discount; end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(DiscountEnd)) }
def discount_end; end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
def promotion_code; end
end
class Trial < Stripe::StripeObject
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
end
# Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
sig { returns(T.nilable(BillingThresholds)) }
def billing_thresholds; end
# The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
sig { returns(T::Array[Discount]) }
def discounts; end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
# ID of the plan to which the customer should be subscribed.
sig { returns(T.any(String, Stripe::Plan)) }
def plan; end
# ID of the price to which the customer should be subscribed.
sig { returns(T.any(String, Stripe::Price)) }
def price; end
# Quantity of the plan to which the customer should be subscribed.
sig { returns(T.nilable(Integer)) }
def quantity; end
# The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
sig { returns(T.nilable(T::Array[Stripe::TaxRate])) }
def tax_rates; end
# Options that configure the trial on the subscription item.
sig { returns(T.nilable(Trial)) }
def trial; end
end
class PauseCollection < Stripe::StripeObject
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
end
class TransferData < Stripe::StripeObject
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
# The account where funds from the payment will be transferred to upon payment success.
sig { returns(T.any(String, Stripe::Account)) }
def destination; end
end
class TrialSettings < Stripe::StripeObject
class EndBehavior < Stripe::StripeObject
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
end
# Defines how the subscription should behave when a trial ends.
sig { returns(T.nilable(EndBehavior)) }
def end_behavior; end
end
# A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
sig { returns(T::Array[AddInvoiceItem]) }
def add_invoice_items; end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
# Attribute for field automatic_tax
sig { returns(T.nilable(AutomaticTax)) }
def automatic_tax; end
# Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
sig { returns(T.nilable(BillingThresholds)) }
def billing_thresholds; end
# 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`.
sig { returns(T.nilable(String)) }
def collection_method; end
# 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) }
def currency; end
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def default_payment_method; end
# The default tax rates to apply to the subscription during this phase of the subscription schedule.
sig { returns(T.nilable(T::Array[Stripe::TaxRate])) }
def default_tax_rates; end
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
# The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
sig { returns(T::Array[Discount]) }
def discounts; end
# The end of this phase of the subscription schedule.
sig { returns(Integer) }
def end_date; end
# The invoice settings applicable during this phase.
sig { returns(T.nilable(InvoiceSettings)) }
def invoice_settings; end
# Subscription items to configure the subscription to during this phase of the subscription schedule.
sig { returns(T::Array[Item]) }
def items; end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
# The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def on_behalf_of; end
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
sig { returns(T.nilable(PauseCollection)) }
def pause_collection; end
# When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.
sig { returns(String) }
def proration_behavior; end
# The start of this phase of the subscription schedule.
sig { returns(Integer) }
def start_date; end
# The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
sig { returns(T.nilable(TransferData)) }
def transfer_data; end
# Specify behavior of the trial when crossing schedule phase boundaries
sig { returns(T.nilable(String)) }
def trial_continuation; end
# When the trial ends within the phase.
sig { returns(T.nilable(Integer)) }
def trial_end; end
# Settings related to any trials on the subscription during this phase.
sig { returns(T.nilable(TrialSettings)) }
def trial_settings; end
end
class Prebilling < Stripe::StripeObject
# ID of the prebilling invoice.
sig { returns(T.any(String, Stripe::Invoice)) }
def invoice; end
# The end of the last period for which the invoice pre-bills.
sig { returns(Integer) }
def period_end; end
# The start of the first period for which the invoice pre-bills.
sig { returns(Integer) }
def period_start; end
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
sig { returns(T.nilable(String)) }
def update_behavior; end
end
# ID of the Connect Application that created the schedule.
sig { returns(T.nilable(T.any(String, Stripe::Application))) }
def application; end
# Attribute for field applies_to
sig { returns(AppliesTo) }
def applies_to; end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
# The billing mode of the subscription.
sig { returns(BillingMode) }
def billing_mode; end
# Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def canceled_at; end
# Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def completed_at; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.
sig { returns(T.nilable(CurrentPhase)) }
def current_phase; end
# ID of the customer who owns the subscription schedule.
sig { returns(T.any(String, Stripe::Customer)) }
def customer; end
# ID of the account who owns the subscription schedule.
sig { returns(T.nilable(String)) }
def customer_account; end
# Attribute for field default_settings
sig { returns(DefaultSettings) }
def default_settings; end
# Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
sig { returns(String) }
def end_behavior; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Details of the most recent price migration that failed for the subscription schedule.
sig { returns(T.nilable(LastPriceMigrationError)) }
def last_price_migration_error; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Configuration for the subscription schedule's phases.
sig { returns(T::Array[Phase]) }
def phases; end
# Time period and invoice for a Subscription billed in advance.
sig { returns(T.nilable(Prebilling)) }
def prebilling; end
# Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def released_at; end
# ID of the subscription once managed by the subscription schedule (if it is released).
sig { returns(T.nilable(String)) }
def released_subscription; end
# The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules).
sig { returns(String) }
def status; end
# ID of the subscription managed by the subscription schedule.
sig { returns(T.nilable(T.any(String, Stripe::Subscription))) }
def subscription; end
# ID of the test clock this subscription schedule belongs to.
sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
def test_clock; end
end
end
# typed: true
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
# An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later.
sig { returns(T::Boolean) }
def actionable; end
# ID of the charge this early fraud warning is for, optionally expanded.
sig { returns(T.any(String, Stripe::Charge)) }
def charge; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`.
sig { returns(String) }
def fraud_type; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# ID of the Payment Intent this early fraud warning is for, optionally expanded.
sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
def payment_intent; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return early fraud warnings for the charge specified by this charge ID.
sig { returns(T.nilable(String)) }
def charge; end
sig { params(_charge: T.nilable(String)).returns(T.nilable(String)) }
def charge=(_charge); end
# Only return early fraud warnings that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Radar::EarlyFraudWarning::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Radar::EarlyFraudWarning::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Radar::EarlyFraudWarning::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(charge: T.nilable(String), created: T.nilable(T.any(::Stripe::Radar::EarlyFraudWarning::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_intent: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
charge: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
payment_intent: nil,
starting_after: nil
); end
end
# Returns a list of early fraud warnings.
sig {
params(params: T.any(::Stripe::Radar::EarlyFraudWarning::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
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
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The name or email address of the user who added this item to the value list.
sig { returns(String) }
def created_by; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The value of the item.
sig { returns(String) }
def value; end
# The identifier of the value list this item belongs to.
sig { returns(String) }
def value_list; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return items that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Radar::ValueListItem::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Radar::ValueListItem::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Radar::ValueListItem::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Return items belonging to the parent list whose value matches the specified value (using an "is like" match).
sig { returns(T.nilable(String)) }
def value; end
sig { params(_value: T.nilable(String)).returns(T.nilable(String)) }
def value=(_value); end
# Identifier for the parent value list this item belongs to.
sig { returns(String) }
def value_list; end
sig { params(_value_list: String).returns(String) }
def value_list=(_value_list); end
sig {
params(created: T.nilable(T.any(::Stripe::Radar::ValueListItem::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), value: T.nilable(String), value_list: String).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
value: nil,
value_list: nil
); end
end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The value of the item (whose type must match the type of the parent value list).
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
# The identifier of the value list which the created item will be added to.
sig { returns(String) }
def value_list; end
sig { params(_value_list: String).returns(String) }
def value_list=(_value_list); end
sig { params(expand: T.nilable(T::Array[String]), value: String, value_list: String).void }
def initialize(expand: nil, value: nil, value_list: nil); end
end
# Creates a new ValueListItem object, which is added to the specified parent value list.
sig {
params(params: T.any(::Stripe::Radar::ValueListItem::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Radar::ValueListItem)
}
def self.create(params = {}, opts = {}); end
# Deletes a ValueListItem object, removing it from its parent value list.
sig {
params(item: String, params: T.any(::Stripe::Radar::ValueListItem::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Radar::ValueListItem)
}
def self.delete(item, params = {}, opts = {}); end
# Deletes a ValueListItem object, removing it from its parent value list.
sig {
params(params: T.any(::Stripe::Radar::ValueListItem::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Radar::ValueListItem)
}
def delete(params = {}, opts = {}); end
# Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Radar::ValueListItem::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
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
# The name of the value list for use in rules.
sig { returns(String) }
def alias; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The name or email address of the user who created this value list.
sig { returns(String) }
def created_by; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, `customer_id`, `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`.
sig { returns(String) }
def item_type; end
# List of items contained within this value list.
sig { returns(Stripe::ListObject) }
def list_items; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# The name of the value list.
sig { returns(String) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams; end
class UpdateParams < Stripe::RequestParams
# The name of the value list for use in rules.
sig { returns(T.nilable(String)) }
def alias; end
sig { params(_alias: T.nilable(String)).returns(T.nilable(String)) }
def alias=(_alias); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The human-readable name of the value list.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(alias_: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: T.nilable(String)).void
}
def initialize(alias_: nil, expand: nil, metadata: nil, name: nil); end
end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# The alias used to reference the value list when writing rules.
sig { returns(T.nilable(String)) }
def alias; end
sig { params(_alias: T.nilable(String)).returns(T.nilable(String)) }
def alias=(_alias); end
# A value contained within a value list - returns all value lists containing this value.
sig { returns(T.nilable(String)) }
def contains; end
sig { params(_contains: T.nilable(String)).returns(T.nilable(String)) }
def contains=(_contains); end
# Only return value lists that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Radar::ValueList::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Radar::ValueList::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Radar::ValueList::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(alias_: T.nilable(String), contains: T.nilable(String), created: T.nilable(T.any(::Stripe::Radar::ValueList::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
alias_: nil,
contains: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# The name of the value list for use in rules.
sig { returns(String) }
def alias; end
sig { params(_alias: String).returns(String) }
def alias=(_alias); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, `customer_id`, `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`. Use `string` if the item type is unknown or mixed.
sig { returns(T.nilable(String)) }
def item_type; end
sig { params(_item_type: T.nilable(String)).returns(T.nilable(String)) }
def item_type=(_item_type); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The human-readable name of the value list.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(alias_: String, expand: T.nilable(T::Array[String]), item_type: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), name: String).void
}
def initialize(alias_: nil, expand: nil, item_type: nil, metadata: nil, name: nil); end
end
# Creates a new ValueList object, which can then be referenced in rules.
sig {
params(params: T.any(::Stripe::Radar::ValueList::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Radar::ValueList)
}
def self.create(params = {}, opts = {}); end
# Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
sig {
params(value_list: String, params: T.any(::Stripe::Radar::ValueList::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Radar::ValueList)
}
def self.delete(value_list, params = {}, opts = {}); end
# Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
sig {
params(params: T.any(::Stripe::Radar::ValueList::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Radar::ValueList)
}
def delete(params = {}, opts = {}); end
# Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Radar::ValueList::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.
sig {
params(value_list: String, params: T.any(::Stripe::Radar::ValueList::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Radar::ValueList)
}
def self.update(value_list, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
# Refund objects allow you to refund a previously created charge that isn't
# refunded yet. Funds are refunded to the credit or debit card that's
# initially charged.
#
# Related guide: [Refunds](https://stripe.com/docs/refunds)
class Refund < APIResource
class DestinationDetails < Stripe::StripeObject
class Affirm < Stripe::StripeObject; end
class AfterpayClearpay < Stripe::StripeObject; end
class Alipay < Stripe::StripeObject; end
class Alma < Stripe::StripeObject; end
class AmazonPay < Stripe::StripeObject; end
class AuBankTransfer < Stripe::StripeObject; end
class Blik < Stripe::StripeObject
# For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.
sig { returns(T.nilable(String)) }
def network_decline_code; end
# The reference assigned to the refund.
sig { returns(T.nilable(String)) }
def reference; end
# Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
sig { returns(T.nilable(String)) }
def reference_status; end
end
class BrBankTransfer < Stripe::StripeObject
# The reference assigned to the refund.
sig { returns(T.nilable(String)) }
def reference; end
# Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
sig { returns(T.nilable(String)) }
def reference_status; end
end
class Card < Stripe::StripeObject
# Value of the reference number assigned to the refund.
sig { returns(T.nilable(String)) }
def reference; end
# Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`.
sig { returns(T.nilable(String)) }
def reference_status; end
# Type of the reference number assigned to the refund.
sig { returns(T.nilable(String)) }
def reference_type; end
# The type of refund. This can be `refund`, `reversal`, or `pending`.
sig { returns(String) }
def type; end
end
class Cashapp < Stripe::StripeObject; end
class CustomerCashBalance < Stripe::StripeObject; end
class Eps < Stripe::StripeObject; end
class EuBankTransfer < Stripe::StripeObject
# The reference assigned to the refund.
sig { returns(T.nilable(String)) }
def reference; end
# Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
sig { returns(T.nilable(String)) }
def reference_status; end
end
class GbBankTransfer < Stripe::StripeObject
# The reference assigned to the refund.
sig { returns(T.nilable(String)) }
def reference; end
# Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
sig { returns(T.nilable(String)) }
def reference_status; end
end
class Giropay < Stripe::StripeObject; end
class Grabpay < Stripe::StripeObject; end
class IdBankTransfer < Stripe::StripeObject
# The reference assigned to the refund.
sig { returns(T.nilable(String)) }
def reference; end
# Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
sig { returns(T.nilable(String)) }
def reference_status; end
end
class JpBankTransfer < Stripe::StripeObject
# The reference assigned to the refund.
sig { returns(T.nilable(String)) }
def reference; end
# Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
sig { returns(T.nilable(String)) }
def reference_status; end
end
class Klarna < Stripe::StripeObject; end
class Multibanco < Stripe::StripeObject
# The reference assigned to the refund.
sig { returns(T.nilable(String)) }
def reference; end
# Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
sig { returns(T.nilable(String)) }
def reference_status; end
end
class MxBankTransfer < Stripe::StripeObject
# The reference assigned to the refund.
sig { returns(T.nilable(String)) }
def reference; end
# Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
sig { returns(T.nilable(String)) }
def reference_status; end
end
class NzBankTransfer < Stripe::StripeObject; end
class P24 < Stripe::StripeObject
# The reference assigned to the refund.
sig { returns(T.nilable(String)) }
def reference; end
# Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
sig { returns(T.nilable(String)) }
def reference_status; end
end
class Paynow < Stripe::StripeObject; end
class Paypal < Stripe::StripeObject
# For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.
sig { returns(T.nilable(String)) }
def network_decline_code; end
end
class Pix < Stripe::StripeObject; end
class Revolut < Stripe::StripeObject; end
class Sofort < Stripe::StripeObject; end
class Swish < Stripe::StripeObject
# For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.
sig { returns(T.nilable(String)) }
def network_decline_code; end
# The reference assigned to the refund.
sig { returns(T.nilable(String)) }
def reference; end
# Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
sig { returns(T.nilable(String)) }
def reference_status; end
end
class ThBankTransfer < Stripe::StripeObject
# The reference assigned to the refund.
sig { returns(T.nilable(String)) }
def reference; end
# Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
sig { returns(T.nilable(String)) }
def reference_status; end
end
class UsBankTransfer < Stripe::StripeObject
# The reference assigned to the refund.
sig { returns(T.nilable(String)) }
def reference; end
# Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
sig { returns(T.nilable(String)) }
def reference_status; end
end
class WechatPay < Stripe::StripeObject; end
class Zip < Stripe::StripeObject; end
# Attribute for field affirm
sig { returns(T.nilable(Affirm)) }
def affirm; end
# Attribute for field afterpay_clearpay
sig { returns(T.nilable(AfterpayClearpay)) }
def afterpay_clearpay; end
# Attribute for field alipay
sig { returns(T.nilable(Alipay)) }
def alipay; end
# Attribute for field alma
sig { returns(T.nilable(Alma)) }
def alma; end
# Attribute for field amazon_pay
sig { returns(T.nilable(AmazonPay)) }
def amazon_pay; end
# Attribute for field au_bank_transfer
sig { returns(T.nilable(AuBankTransfer)) }
def au_bank_transfer; end
# Attribute for field blik
sig { returns(T.nilable(Blik)) }
def blik; end
# Attribute for field br_bank_transfer
sig { returns(T.nilable(BrBankTransfer)) }
def br_bank_transfer; end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# Attribute for field cashapp
sig { returns(T.nilable(Cashapp)) }
def cashapp; end
# Attribute for field customer_cash_balance
sig { returns(T.nilable(CustomerCashBalance)) }
def customer_cash_balance; end
# Attribute for field eps
sig { returns(T.nilable(Eps)) }
def eps; end
# Attribute for field eu_bank_transfer
sig { returns(T.nilable(EuBankTransfer)) }
def eu_bank_transfer; end
# Attribute for field gb_bank_transfer
sig { returns(T.nilable(GbBankTransfer)) }
def gb_bank_transfer; end
# Attribute for field giropay
sig { returns(T.nilable(Giropay)) }
def giropay; end
# Attribute for field grabpay
sig { returns(T.nilable(Grabpay)) }
def grabpay; end
# Attribute for field id_bank_transfer
sig { returns(T.nilable(IdBankTransfer)) }
def id_bank_transfer; end
# Attribute for field jp_bank_transfer
sig { returns(T.nilable(JpBankTransfer)) }
def jp_bank_transfer; end
# Attribute for field klarna
sig { returns(T.nilable(Klarna)) }
def klarna; end
# Attribute for field multibanco
sig { returns(T.nilable(Multibanco)) }
def multibanco; end
# Attribute for field mx_bank_transfer
sig { returns(T.nilable(MxBankTransfer)) }
def mx_bank_transfer; end
# Attribute for field nz_bank_transfer
sig { returns(T.nilable(NzBankTransfer)) }
def nz_bank_transfer; end
# Attribute for field p24
sig { returns(T.nilable(P24)) }
def p24; end
# Attribute for field paynow
sig { returns(T.nilable(Paynow)) }
def paynow; end
# Attribute for field paypal
sig { returns(T.nilable(Paypal)) }
def paypal; end
# Attribute for field pix
sig { returns(T.nilable(Pix)) }
def pix; end
# Attribute for field revolut
sig { returns(T.nilable(Revolut)) }
def revolut; end
# Attribute for field sofort
sig { returns(T.nilable(Sofort)) }
def sofort; end
# Attribute for field swish
sig { returns(T.nilable(Swish)) }
def swish; end
# Attribute for field th_bank_transfer
sig { returns(T.nilable(ThBankTransfer)) }
def th_bank_transfer; end
# The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction.
sig { returns(String) }
def type; end
# Attribute for field us_bank_transfer
sig { returns(T.nilable(UsBankTransfer)) }
def us_bank_transfer; end
# Attribute for field wechat_pay
sig { returns(T.nilable(WechatPay)) }
def wechat_pay; end
# Attribute for field zip
sig { returns(T.nilable(Zip)) }
def zip; end
end
class NextAction < Stripe::StripeObject
class DisplayDetails < Stripe::StripeObject
class EmailSent < Stripe::StripeObject
# The timestamp when the email was sent.
sig { returns(Integer) }
def email_sent_at; end
# The recipient's email address.
sig { returns(String) }
def email_sent_to; end
end
# Attribute for field email_sent
sig { returns(EmailSent) }
def email_sent; end
# The expiry timestamp.
sig { returns(Integer) }
def expires_at; end
end
# Attribute for field display_details
sig { returns(T.nilable(DisplayDetails)) }
def display_details; end
# Type of the next action to perform.
sig { returns(String) }
def type; end
end
class PresentmentDetails < Stripe::StripeObject
# Amount intended to be collected by this payment, denominated in `presentment_currency`.
sig { returns(Integer) }
def presentment_amount; end
# Currency presented to the customer during payment.
sig { returns(String) }
def presentment_currency; end
end
# Amount, in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
# Balance transaction that describes the impact on your account balance.
sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
def balance_transaction; end
# ID of the charge that's refunded.
sig { returns(T.nilable(T.any(String, Stripe::Charge))) }
def charge; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only).
sig { returns(T.nilable(String)) }
def description; end
# Attribute for field destination_details
sig { returns(T.nilable(DestinationDetails)) }
def destination_details; end
# After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.
sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
def failure_balance_transaction; end
# Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`.
sig { returns(T.nilable(String)) }
def failure_reason; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.
sig { returns(T.nilable(String)) }
def instructions_email; end
# 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])) }
def metadata; end
# Attribute for field next_action
sig { returns(T.nilable(NextAction)) }
def next_action; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# ID of the PaymentIntent that's refunded.
sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
def payment_intent; end
# Provides the reason for why the refund is pending. Possible values are: `processing`, `insufficient_funds`, or `charge_pending`.
sig { returns(T.nilable(String)) }
def pending_reason; end
# Attribute for field presentment_details
sig { returns(T.nilable(PresentmentDetails)) }
def presentment_details; end
# Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).
sig { returns(T.nilable(String)) }
def reason; end
# This is the transaction number that appears on email receipts sent for this refund.
sig { returns(T.nilable(String)) }
def receipt_number; end
# The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account.
sig { returns(T.nilable(T.any(String, Stripe::Reversal))) }
def source_transfer_reversal; end
# Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds).
sig { returns(T.nilable(String)) }
def status; end
# This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter.
sig { returns(T.nilable(T.any(String, Stripe::Reversal))) }
def transfer_reversal; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return refunds for the charge specified by this charge ID.
sig { returns(T.nilable(String)) }
def charge; end
sig { params(_charge: T.nilable(String)).returns(T.nilable(String)) }
def charge=(_charge); end
# Only return refunds that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Refund::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Refund::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Refund::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return refunds for the PaymentIntent specified by this ID.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(charge: T.nilable(String), created: T.nilable(T.any(::Stripe::Refund::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_intent: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
charge: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
payment_intent: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# Attribute for param field amount
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The identifier of the charge to refund.
sig { returns(T.nilable(String)) }
def charge; end
sig { params(_charge: T.nilable(String)).returns(T.nilable(String)) }
def charge=(_charge); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Customer whose customer balance to refund from.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.
sig { returns(T.nilable(String)) }
def instructions_email; end
sig { params(_instructions_email: T.nilable(String)).returns(T.nilable(String)) }
def instructions_email=(_instructions_email); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Origin of the refund
sig { returns(T.nilable(String)) }
def origin; end
sig { params(_origin: T.nilable(String)).returns(T.nilable(String)) }
def origin=(_origin); end
# The identifier of the PaymentIntent to refund.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms.
sig { returns(T.nilable(String)) }
def reason; end
sig { params(_reason: T.nilable(String)).returns(T.nilable(String)) }
def reason=(_reason); end
# Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.
sig { returns(T.nilable(T::Boolean)) }
def refund_application_fee; end
sig { params(_refund_application_fee: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refund_application_fee=(_refund_application_fee); end
# Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).
A transfer can be reversed only by the application that created the charge.
sig { returns(T.nilable(T::Boolean)) }
def reverse_transfer; end
sig { params(_reverse_transfer: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def reverse_transfer=(_reverse_transfer); end
sig {
params(amount: T.nilable(Integer), charge: T.nilable(String), currency: T.nilable(String), customer: T.nilable(String), expand: T.nilable(T::Array[String]), instructions_email: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), origin: T.nilable(String), payment_intent: T.nilable(String), reason: T.nilable(String), refund_application_fee: T.nilable(T::Boolean), reverse_transfer: T.nilable(T::Boolean)).void
}
def initialize(
amount: nil,
charge: nil,
currency: nil,
customer: nil,
expand: nil,
instructions_email: nil,
metadata: nil,
origin: nil,
payment_intent: nil,
reason: nil,
refund_application_fee: nil,
reverse_transfer: nil
); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, metadata: nil); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ExpireParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Cancels a refund with a status of requires_action.
#
# You can't cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.
sig {
params(params: T.any(::Stripe::Refund::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Refund)
}
def cancel(params = {}, opts = {}); end
# Cancels a refund with a status of requires_action.
#
# You can't cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.
sig {
params(refund: String, params: T.any(::Stripe::Refund::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Refund)
}
def self.cancel(refund, params = {}, opts = {}); end
# When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
#
# Creating a new refund will 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.
#
# You can optionally refund only part of a charge.
# You can do so multiple times, until the entire charge has been refunded.
#
# Once entirely refunded, a charge can't be refunded again.
# This method will raise an error when called on an already-refunded charge,
# or when trying to refund more money than is left on a charge.
sig {
params(params: T.any(::Stripe::Refund::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Refund)
}
def self.create(params = {}, opts = {}); end
# Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.
sig {
params(params: T.any(::Stripe::Refund::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don't provide remain unchanged.
#
# This request only accepts metadata as an argument.
sig {
params(refund: String, params: T.any(::Stripe::Refund::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Refund)
}
def self.update(refund, params = {}, opts = {}); end
end
end
# typed: true
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
class Parameters < Stripe::StripeObject
# The set of output columns requested for inclusion in the report run.
sig { returns(T.nilable(T::Array[String])) }
def columns; end
# Connected account ID by which to filter the report run.
sig { returns(T.nilable(String)) }
def connected_account; end
# Currency of objects to be included in the report run.
sig { returns(T.nilable(String)) }
def currency; end
# Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified `interval_start` and 1 second before this report's last `data_available_end` value.
sig { returns(T.nilable(Integer)) }
def interval_end; end
# Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's `data_available_start` and 1 second before the user specified `interval_end` value.
sig { returns(T.nilable(Integer)) }
def interval_start; end
# Payout ID by which to filter the report run.
sig { returns(T.nilable(String)) }
def payout; end
# Category of balance transactions to be included in the report run.
sig { returns(T.nilable(String)) }
def reporting_category; end
# Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`.
sig { returns(T.nilable(String)) }
def timezone; end
end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# If something should go wrong during the run, a message about the failure (populated when
# `status=failed`).
sig { returns(T.nilable(String)) }
def error; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# `true` if the report is run on live mode data and `false` if it is run on test mode data.
sig { returns(T::Boolean) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Attribute for field parameters
sig { returns(Parameters) }
def parameters; end
# The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`.
sig { returns(String) }
def report_type; end
# The file object representing the result of the report run (populated when
# `status=succeeded`).
sig { returns(T.nilable(Stripe::File)) }
def result; end
# Status of this report run. This will be `pending` when the run is initially created.
# When the run finishes, this will be set to `succeeded` and the `result` field will be populated.
# Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated.
sig { returns(String) }
def status; end
# Timestamp at which this run successfully finished (populated when
# `status=succeeded`). Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def succeeded_at; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return Report Runs that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Reporting::ReportRun::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Reporting::ReportRun::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Reporting::ReportRun::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::Reporting::ReportRun::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Parameters < Stripe::RequestParams
# The set of report columns to include in the report output. If omitted, the Report Type is run with its default column set.
sig { returns(T.nilable(T::Array[String])) }
def columns; end
sig { params(_columns: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def columns=(_columns); end
# Connected account ID to filter for in the report run.
sig { returns(T.nilable(String)) }
def connected_account; end
sig { params(_connected_account: T.nilable(String)).returns(T.nilable(String)) }
def connected_account=(_connected_account); end
# Currency of objects to be included in the report run.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Ending timestamp of data to be included in the report run (exclusive).
sig { returns(T.nilable(Integer)) }
def interval_end; end
sig { params(_interval_end: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_end=(_interval_end); end
# Starting timestamp of data to be included in the report run.
sig { returns(T.nilable(Integer)) }
def interval_start; end
sig { params(_interval_start: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_start=(_interval_start); end
# Payout ID by which to filter the report run.
sig { returns(T.nilable(String)) }
def payout; end
sig { params(_payout: T.nilable(String)).returns(T.nilable(String)) }
def payout=(_payout); end
# Category of balance transactions to be included in the report run.
sig { returns(T.nilable(String)) }
def reporting_category; end
sig { params(_reporting_category: T.nilable(String)).returns(T.nilable(String)) }
def reporting_category=(_reporting_category); end
# Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`.
sig { returns(T.nilable(String)) }
def timezone; end
sig { params(_timezone: T.nilable(String)).returns(T.nilable(String)) }
def timezone=(_timezone); end
sig {
params(columns: T.nilable(T::Array[String]), connected_account: T.nilable(String), currency: T.nilable(String), interval_end: T.nilable(Integer), interval_start: T.nilable(Integer), payout: T.nilable(String), reporting_category: T.nilable(String), timezone: T.nilable(String)).void
}
def initialize(
columns: nil,
connected_account: nil,
currency: nil,
interval_end: nil,
interval_start: nil,
payout: nil,
reporting_category: nil,
timezone: nil
); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://stripe.com/docs/reporting/statements/api) documentation.
sig { returns(T.nilable(::Stripe::Reporting::ReportRun::CreateParams::Parameters)) }
def parameters; end
sig {
params(_parameters: T.nilable(::Stripe::Reporting::ReportRun::CreateParams::Parameters)).returns(T.nilable(::Stripe::Reporting::ReportRun::CreateParams::Parameters))
}
def parameters=(_parameters); end
# The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`.
sig { returns(String) }
def report_type; end
sig { params(_report_type: String).returns(String) }
def report_type=(_report_type); end
sig {
params(expand: T.nilable(T::Array[String]), parameters: T.nilable(::Stripe::Reporting::ReportRun::CreateParams::Parameters), report_type: String).void
}
def initialize(expand: nil, parameters: nil, report_type: nil); end
end
# Creates a new object and begin running the report. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)
sig {
params(params: T.any(::Stripe::Reporting::ReportRun::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Reporting::ReportRun)
}
def self.create(params = {}, opts = {}); end
# Returns a list of Report Runs, with the most recent appearing first.
sig {
params(params: T.any(::Stripe::Reporting::ReportRun::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
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
# Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def data_available_end; end
# Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def data_available_start; end
# List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.)
sig { returns(T.nilable(T::Array[String])) }
def default_columns; end
# The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# Human-readable name of the Report Type
sig { returns(String) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# When this Report Type was latest updated. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def updated; end
# Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.
sig { returns(Integer) }
def version; end
class ListParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a full list of Report Types.
sig {
params(params: T.any(::Stripe::Reporting::ReportType::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
# Reviews can be used to supplement automated fraud detection with human expertise.
#
# Learn more about [Radar](https://docs.stripe.com/radar) and reviewing payments
# [here](https://stripe.com/docs/radar/reviews).
class Review < APIResource
class IpAddressLocation < Stripe::StripeObject
# The city where the payment originated.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter ISO code representing the country where the payment originated.
sig { returns(T.nilable(String)) }
def country; end
# The geographic latitude where the payment originated.
sig { returns(T.nilable(Float)) }
def latitude; end
# The geographic longitude where the payment originated.
sig { returns(T.nilable(Float)) }
def longitude; end
# The state/county/province/region where the payment originated.
sig { returns(T.nilable(String)) }
def region; end
end
class Session < Stripe::StripeObject
# The browser used in this browser session (e.g., `Chrome`).
sig { returns(T.nilable(String)) }
def browser; end
# Information about the device used for the browser session (e.g., `Samsung SM-G930T`).
sig { returns(T.nilable(String)) }
def device; end
# The platform for the browser session (e.g., `Macintosh`).
sig { returns(T.nilable(String)) }
def platform; end
# The version for the browser session (e.g., `61.0.3163.100`).
sig { returns(T.nilable(String)) }
def version; end
end
# The ZIP or postal code of the card used, if applicable.
sig { returns(T.nilable(String)) }
def billing_zip; end
# The charge associated with this review.
sig { returns(T.nilable(T.any(String, Stripe::Charge))) }
def charge; end
# The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`.
sig { returns(T.nilable(String)) }
def closed_reason; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The IP address where the payment originated.
sig { returns(T.nilable(String)) }
def ip_address; end
# Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.
sig { returns(T.nilable(IpAddressLocation)) }
def ip_address_location; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# If `true`, the review needs action.
sig { returns(T::Boolean) }
def open; end
# The reason the review was opened. One of `rule` or `manual`.
sig { returns(String) }
def opened_reason; end
# The PaymentIntent ID associated with this review, if one exists.
sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
def payment_intent; end
# The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`.
sig { returns(String) }
def reason; end
# Information related to the browsing session of the user who initiated the payment.
sig { returns(T.nilable(Session)) }
def session; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return reviews that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Review::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Review::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Review::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::Review::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class ApproveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Approves a Review object, closing it and removing it from the list of reviews.
sig {
params(params: T.any(::Stripe::Review::ApproveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Review)
}
def approve(params = {}, opts = {}); end
# Approves a Review object, closing it and removing it from the list of reviews.
sig {
params(review: String, params: T.any(::Stripe::Review::ApproveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Review)
}
def self.approve(review, params = {}, opts = {}); end
# Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Review::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# A SetupAttempt describes one attempted confirmation of a SetupIntent,
# whether that confirmation is 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
class PaymentMethodDetails < Stripe::StripeObject
class AcssDebit < Stripe::StripeObject; end
class AmazonPay < Stripe::StripeObject; end
class AuBecsDebit < Stripe::StripeObject; end
class BacsDebit < Stripe::StripeObject; end
class Bancontact < Stripe::StripeObject
# Bank code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_code; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Bank Identifier Code of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bic; end
# The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def generated_sepa_debit; end
# The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def generated_sepa_debit_mandate; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def iban_last4; end
# Preferred language of the Bancontact authorization page that the customer is redirected to.
# Can be one of `en`, `de`, `fr`, or `nl`
sig { returns(T.nilable(String)) }
def preferred_language; end
# Owner's verified full name. Values are verified or provided by Bancontact directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class Boleto < Stripe::StripeObject; end
class Card < Stripe::StripeObject
class Checks < Stripe::StripeObject
# If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
sig { returns(T.nilable(String)) }
def address_line1_check; end
# If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
sig { returns(T.nilable(String)) }
def address_postal_code_check; end
# If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
sig { returns(T.nilable(String)) }
def cvc_check; end
end
class ThreeDSecure < Stripe::StripeObject
# For authenticated transactions: how the customer was authenticated by
# the issuing bank.
sig { returns(T.nilable(String)) }
def authentication_flow; end
# The Electronic Commerce Indicator (ECI). A protocol-level field
# indicating what degree of authentication was performed.
sig { returns(T.nilable(String)) }
def electronic_commerce_indicator; end
# Indicates the outcome of 3D Secure authentication.
sig { returns(T.nilable(String)) }
def result; end
# Additional information about why 3D Secure succeeded or failed based
# on the `result`.
sig { returns(T.nilable(String)) }
def result_reason; end
# The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID
# (dsTransId) for this payment.
sig { returns(T.nilable(String)) }
def transaction_id; end
# The version of 3D Secure that was used.
sig { returns(T.nilable(String)) }
def version; end
end
class Wallet < Stripe::StripeObject
class ApplePay < Stripe::StripeObject; end
class GooglePay < Stripe::StripeObject; end
# Attribute for field apple_pay
sig { returns(T.nilable(ApplePay)) }
def apple_pay; end
# Attribute for field google_pay
sig { returns(T.nilable(GooglePay)) }
def google_pay; end
# The type of the card wallet, one of `apple_pay`, `google_pay`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.
sig { returns(String) }
def type; end
end
# Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
sig { returns(T.nilable(String)) }
def brand; end
# Check results by Card networks on Card address and CVC at the time of authorization
sig { returns(T.nilable(Checks)) }
def checks; end
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
sig { returns(T.nilable(String)) }
def country; end
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def description; end
# Two-digit number representing the card's expiration month.
sig { returns(T.nilable(Integer)) }
def exp_month; end
# Four-digit number representing the card's expiration year.
sig { returns(T.nilable(Integer)) }
def exp_year; end
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
sig { returns(T.nilable(String)) }
def fingerprint; end
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
sig { returns(T.nilable(String)) }
def funding; end
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def iin; end
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
sig { returns(T.nilable(String)) }
def issuer; end
# The last four digits of the card.
sig { returns(T.nilable(String)) }
def last4; end
# Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
sig { returns(T.nilable(String)) }
def network; end
# Populated if this authorization used 3D Secure authentication.
sig { returns(T.nilable(ThreeDSecure)) }
def three_d_secure; end
# If this Card is part of a card wallet, this contains the details of the card wallet.
sig { returns(T.nilable(Wallet)) }
def wallet; end
end
class CardPresent < Stripe::StripeObject
class Offline < Stripe::StripeObject
# Time at which the payment was collected while offline
sig { returns(T.nilable(Integer)) }
def stored_at; end
# The method used to process this payment method offline. Only deferred is allowed.
sig { returns(T.nilable(String)) }
def type; end
end
# The ID of the Card PaymentMethod which was generated by this SetupAttempt.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def generated_card; end
# Details about payments collected offline.
sig { returns(T.nilable(Offline)) }
def offline; end
end
class Cashapp < Stripe::StripeObject; end
class IdBankTransfer < Stripe::StripeObject
# Bank where the account is located.
sig { returns(T.nilable(String)) }
def bank; end
# Local bank code of the bank.
sig { returns(T.nilable(String)) }
def bank_code; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
sig { returns(T.nilable(String)) }
def display_name; end
end
class Ideal < Stripe::StripeObject
# The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
sig { returns(T.nilable(String)) }
def bank; end
# The Bank Identifier Code of the customer's bank.
sig { returns(T.nilable(String)) }
def bic; end
# The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def generated_sepa_debit; end
# The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def generated_sepa_debit_mandate; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def iban_last4; end
# Owner's verified full name. Values are verified or provided by iDEAL directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class KakaoPay < Stripe::StripeObject; end
class Klarna < Stripe::StripeObject; end
class KrCard < Stripe::StripeObject; end
class Link < Stripe::StripeObject; end
class NaverPay < Stripe::StripeObject
# Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.
sig { returns(T.nilable(String)) }
def buyer_id; end
end
class NzBankAccount < Stripe::StripeObject; end
class Paypal < Stripe::StripeObject; end
class Payto < Stripe::StripeObject; end
class Pix < Stripe::StripeObject; end
class RevolutPay < Stripe::StripeObject; end
class SepaDebit < Stripe::StripeObject; end
class Sofort < Stripe::StripeObject
# Bank code of bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_code; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Bank Identifier Code of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bic; end
# The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def generated_sepa_debit; end
# The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def generated_sepa_debit_mandate; end
# Last four characters of the IBAN.
sig { returns(T.nilable(String)) }
def iban_last4; end
# Preferred language of the Sofort authorization page that the customer is redirected to.
# Can be one of `en`, `de`, `fr`, or `nl`
sig { returns(T.nilable(String)) }
def preferred_language; end
# Owner's verified full name. Values are verified or provided by Sofort directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_name; end
end
class StripeBalance < Stripe::StripeObject; end
class UsBankAccount < Stripe::StripeObject; end
# Attribute for field acss_debit
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# Attribute for field amazon_pay
sig { returns(T.nilable(AmazonPay)) }
def amazon_pay; end
# Attribute for field au_becs_debit
sig { returns(T.nilable(AuBecsDebit)) }
def au_becs_debit; end
# Attribute for field bacs_debit
sig { returns(T.nilable(BacsDebit)) }
def bacs_debit; end
# Attribute for field bancontact
sig { returns(T.nilable(Bancontact)) }
def bancontact; end
# Attribute for field boleto
sig { returns(T.nilable(Boleto)) }
def boleto; end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# Attribute for field card_present
sig { returns(T.nilable(CardPresent)) }
def card_present; end
# Attribute for field cashapp
sig { returns(T.nilable(Cashapp)) }
def cashapp; end
# Attribute for field id_bank_transfer
sig { returns(T.nilable(IdBankTransfer)) }
def id_bank_transfer; end
# Attribute for field ideal
sig { returns(T.nilable(Ideal)) }
def ideal; end
# Attribute for field kakao_pay
sig { returns(T.nilable(KakaoPay)) }
def kakao_pay; end
# Attribute for field klarna
sig { returns(T.nilable(Klarna)) }
def klarna; end
# Attribute for field kr_card
sig { returns(T.nilable(KrCard)) }
def kr_card; end
# Attribute for field link
sig { returns(T.nilable(Link)) }
def link; end
# Attribute for field naver_pay
sig { returns(T.nilable(NaverPay)) }
def naver_pay; end
# Attribute for field nz_bank_account
sig { returns(T.nilable(NzBankAccount)) }
def nz_bank_account; end
# Attribute for field paypal
sig { returns(T.nilable(Paypal)) }
def paypal; end
# Attribute for field payto
sig { returns(T.nilable(Payto)) }
def payto; end
# Attribute for field pix
sig { returns(T.nilable(Pix)) }
def pix; end
# Attribute for field revolut_pay
sig { returns(T.nilable(RevolutPay)) }
def revolut_pay; end
# Attribute for field sepa_debit
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# Attribute for field sofort
sig { returns(T.nilable(Sofort)) }
def sofort; end
# Attribute for field stripe_balance
sig { returns(T.nilable(StripeBalance)) }
def stripe_balance; end
# The type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method.
sig { returns(String) }
def type; end
# Attribute for field us_bank_account
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
end
class SetupError < Stripe::StripeObject
# For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.
sig { returns(T.nilable(String)) }
def advice_code; end
# For card errors, the ID of the failed charge.
sig { returns(T.nilable(String)) }
def charge; end
# For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
sig { returns(T.nilable(String)) }
def code; end
# For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.
sig { returns(T.nilable(String)) }
def decline_code; end
# A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.
sig { returns(T.nilable(String)) }
def doc_url; end
# A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
sig { returns(T.nilable(String)) }
def message; end
# For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
sig { returns(T.nilable(String)) }
def network_advice_code; end
# For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
sig { returns(T.nilable(String)) }
def network_decline_code; end
# If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
sig { returns(T.nilable(String)) }
def param; end
# 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)
sig { returns(T.nilable(Stripe::PaymentIntent)) }
def payment_intent; end
# 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).
sig { returns(T.nilable(Stripe::PaymentMethod)) }
def payment_method; end
# If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
sig { returns(T.nilable(String)) }
def payment_method_type; end
# A URL to the request log entry in your dashboard.
sig { returns(T.nilable(String)) }
def request_log_url; end
# A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
# For example, you can 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 when you're ready to collect your customer's payment credentials.
# Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
# The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/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) might need to be run through
# [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection
# to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).
# If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),
# it automatically attaches the resulting payment method to that Customer after successful setup.
# 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 to prevent saving invalid or unoptimized payment methods.
#
# By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
#
# Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)
sig { returns(T.nilable(Stripe::SetupIntent)) }
def setup_intent; end
# Attribute for field source
sig {
returns(T.nilable(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source)))
}
def source; end
# The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`
sig { returns(String) }
def type; end
end
# The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation.
sig { returns(T.nilable(T.any(String, Stripe::Application))) }
def application; end
# If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
#
# It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
sig { returns(T.nilable(T::Boolean)) }
def attach_to_self; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# The value of [customer_account](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer_account) on the SetupIntent at the time of this confirmation.
sig { returns(T.nilable(String)) }
def customer_account; end
# Indicates the directions of money movement for which this payment method is intended to be used.
#
# Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.
sig { returns(T.nilable(T::Array[String])) }
def flow_directions; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def on_behalf_of; end
# ID of the payment method used with this SetupAttempt.
sig { returns(T.any(String, Stripe::PaymentMethod)) }
def payment_method; end
# Attribute for field payment_method_details
sig { returns(PaymentMethodDetails) }
def payment_method_details; end
# The error encountered during this attempt to confirm the SetupIntent, if any.
sig { returns(T.nilable(SetupError)) }
def setup_error; end
# ID of the SetupIntent that this attempt belongs to.
sig { returns(T.any(String, Stripe::SetupIntent)) }
def setup_intent; end
# Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`.
sig { returns(String) }
def status; end
# The value of [usage](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`.
sig { returns(String) }
def usage; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# A filter on the list, based on the object `created` field. The value
# can be a string with an integer Unix timestamp or a
# dictionary with a number of different query options.
sig { returns(T.nilable(T.any(::Stripe::SetupAttempt::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::SetupAttempt::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::SetupAttempt::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return SetupAttempts created by the SetupIntent specified by
# this ID.
sig { returns(String) }
def setup_intent; end
sig { params(_setup_intent: String).returns(String) }
def setup_intent=(_setup_intent); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::SetupAttempt::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), setup_intent: String, starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
setup_intent: nil,
starting_after: nil
); end
end
# Returns a list of SetupAttempts that associate with a provided SetupIntent.
sig {
params(params: T.any(::Stripe::SetupAttempt::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
# typed: 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 can 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 when you're ready to collect your customer's payment credentials.
# Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
# The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/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) might need to be run through
# [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection
# to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).
# If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),
# it automatically attaches the resulting payment method to that Customer after successful setup.
# 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 to prevent saving invalid or unoptimized payment methods.
#
# By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
#
# Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)
class SetupIntent < APIResource
class AutomaticPaymentMethods < Stripe::StripeObject
# Controls whether this SetupIntent will accept redirect-based payment methods.
#
# Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup.
sig { returns(T.nilable(String)) }
def allow_redirects; end
# Automatically calculates compatible payment methods
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
end
class LastSetupError < Stripe::StripeObject
# For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.
sig { returns(T.nilable(String)) }
def advice_code; end
# For card errors, the ID of the failed charge.
sig { returns(T.nilable(String)) }
def charge; end
# For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
sig { returns(T.nilable(String)) }
def code; end
# For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.
sig { returns(T.nilable(String)) }
def decline_code; end
# A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.
sig { returns(T.nilable(String)) }
def doc_url; end
# A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
sig { returns(T.nilable(String)) }
def message; end
# For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
sig { returns(T.nilable(String)) }
def network_advice_code; end
# For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
sig { returns(T.nilable(String)) }
def network_decline_code; end
# If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
sig { returns(T.nilable(String)) }
def param; end
# 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)
sig { returns(T.nilable(Stripe::PaymentIntent)) }
def payment_intent; end
# 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).
sig { returns(T.nilable(Stripe::PaymentMethod)) }
def payment_method; end
# If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
sig { returns(T.nilable(String)) }
def payment_method_type; end
# A URL to the request log entry in your dashboard.
sig { returns(T.nilable(String)) }
def request_log_url; end
# A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
# For example, you can 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 when you're ready to collect your customer's payment credentials.
# Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
# The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/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) might need to be run through
# [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection
# to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).
# If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),
# it automatically attaches the resulting payment method to that Customer after successful setup.
# 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 to prevent saving invalid or unoptimized payment methods.
#
# By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
#
# Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)
sig { returns(T.nilable(Stripe::SetupIntent)) }
def setup_intent; end
# Attribute for field source
sig {
returns(T.nilable(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source)))
}
def source; end
# The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`
sig { returns(String) }
def type; end
end
class NextAction < Stripe::StripeObject
class CashappHandleRedirectOrDisplayQrCode < Stripe::StripeObject
class QrCode < Stripe::StripeObject
# The date (unix timestamp) when the QR code expires.
sig { returns(Integer) }
def expires_at; end
# The image_url_png string used to render QR code
sig { returns(String) }
def image_url_png; end
# The image_url_svg string used to render QR code
sig { returns(String) }
def image_url_svg; end
end
# The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.
sig { returns(String) }
def hosted_instructions_url; end
# The url for mobile redirect based auth
sig { returns(String) }
def mobile_auth_url; end
# Attribute for field qr_code
sig { returns(QrCode) }
def qr_code; end
end
class PixDisplayQrCode < Stripe::StripeObject
# The raw data string used to generate QR code, it should be used together with QR code library.
sig { returns(T.nilable(String)) }
def data; end
# The date (unix timestamp) when the PIX expires.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# The URL to the hosted pix instructions page, which allows customers to view the pix QR code.
sig { returns(T.nilable(String)) }
def hosted_instructions_url; end
# The image_url_png string used to render png QR code
sig { returns(T.nilable(String)) }
def image_url_png; end
# The image_url_svg string used to render svg QR code
sig { returns(T.nilable(String)) }
def image_url_svg; end
end
class RedirectToUrl < Stripe::StripeObject
# If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
sig { returns(T.nilable(String)) }
def return_url; end
# The URL you must redirect your customer to in order to authenticate.
sig { returns(T.nilable(String)) }
def url; end
end
class VerifyWithMicrodeposits < Stripe::StripeObject
# The timestamp when the microdeposits are expected to land.
sig { returns(Integer) }
def arrival_date; end
# The URL for the hosted verification page, which allows customers to verify their bank account.
sig { returns(String) }
def hosted_verification_url; end
# The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
sig { returns(T.nilable(String)) }
def microdeposit_type; end
end
# Attribute for field cashapp_handle_redirect_or_display_qr_code
sig { returns(T.nilable(CashappHandleRedirectOrDisplayQrCode)) }
def cashapp_handle_redirect_or_display_qr_code; end
# Attribute for field pix_display_qr_code
sig { returns(T.nilable(PixDisplayQrCode)) }
def pix_display_qr_code; end
# Attribute for field redirect_to_url
sig { returns(T.nilable(RedirectToUrl)) }
def redirect_to_url; end
# Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.
sig { returns(String) }
def type; end
# When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.
sig { returns(T.nilable(T::Hash[String, T.untyped])) }
def use_stripe_sdk; end
# Attribute for field verify_with_microdeposits
sig { returns(T.nilable(VerifyWithMicrodeposits)) }
def verify_with_microdeposits; end
end
class PaymentMethodConfigurationDetails < Stripe::StripeObject
# ID of the payment method configuration used.
sig { returns(String) }
def id; end
# ID of the parent payment method configuration used.
sig { returns(T.nilable(String)) }
def parent; end
end
class PaymentMethodOptions < Stripe::StripeObject
class AcssDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# A URL for custom mandate text
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
# List of Stripe products where this mandate can be selected automatically.
sig { returns(T.nilable(T::Array[String])) }
def default_for; end
# Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
end
# Currency supported by the bank account
sig { returns(T.nilable(String)) }
def currency; end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
end
class AmazonPay < Stripe::StripeObject; end
class BacsDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
end
class Card < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Amount to be charged for future payments.
sig { returns(Integer) }
def amount; end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(String) }
def amount_type; end
# 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) }
def currency; end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
sig { returns(String) }
def interval; end
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
sig { returns(T.nilable(Integer)) }
def interval_count; end
# Unique identifier for the mandate or subscription.
sig { returns(String) }
def reference; end
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
sig { returns(Integer) }
def start_date; end
# Specifies the type of mandates supported. Possible values are `india`.
sig { returns(T.nilable(T::Array[String])) }
def supported_types; end
end
# Configuration options for setting up an eMandate for cards issued in India.
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
end
class CardPresent < Stripe::StripeObject; end
class Klarna < Stripe::StripeObject
# The currency of the setup intent. Three letter ISO currency code.
sig { returns(T.nilable(String)) }
def currency; end
# Preferred locale of the Klarna checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
end
class Link < Stripe::StripeObject
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
end
class Paypal < Stripe::StripeObject
# The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
sig { returns(T.nilable(String)) }
def billing_agreement_id; end
# 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(T.nilable(String)) }
def currency; end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
end
class Payto < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
sig { returns(T.nilable(String)) }
def start_date; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
end
class Pix < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
# Determines if the amount includes the IOF tax.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
# Type of amount.
sig { returns(T.nilable(String)) }
def amount_type; end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
sig { returns(T.nilable(String)) }
def currency; end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
sig { returns(T.nilable(String)) }
def end_date; end
# Schedule at which the future payments will be charged.
sig { returns(T.nilable(String)) }
def payment_schedule; end
# Subscription name displayed to buyers in their bank app.
sig { returns(T.nilable(String)) }
def reference; end
# Start date of the mandate, in `YYYY-MM-DD`.
sig { returns(T.nilable(String)) }
def start_date; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
end
class SepaDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
end
class UsBankAccount < Stripe::StripeObject
class FinancialConnections < Stripe::StripeObject
class Filters < Stripe::StripeObject
# The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
# The institution to use to filter for possible accounts to link.
sig { returns(T.nilable(String)) }
def institution; end
end
class ManualEntry < Stripe::StripeObject
# Settings for configuring manual entry of account details.
sig { returns(T.nilable(String)) }
def mode; end
end
# Attribute for field filters
sig { returns(T.nilable(Filters)) }
def filters; end
# Attribute for field manual_entry
sig { returns(T.nilable(ManualEntry)) }
def manual_entry; end
# The list of permissions to request. The `payment_method` permission must be included.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
# Data features requested to be retrieved upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
end
class MandateOptions < Stripe::StripeObject
# Mandate collection method
sig { returns(T.nilable(String)) }
def collection_method; end
end
# Attribute for field financial_connections
sig { returns(T.nilable(FinancialConnections)) }
def financial_connections; end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
end
# Attribute for field acss_debit
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# Attribute for field amazon_pay
sig { returns(T.nilable(AmazonPay)) }
def amazon_pay; end
# Attribute for field bacs_debit
sig { returns(T.nilable(BacsDebit)) }
def bacs_debit; end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# Attribute for field card_present
sig { returns(T.nilable(CardPresent)) }
def card_present; end
# Attribute for field klarna
sig { returns(T.nilable(Klarna)) }
def klarna; end
# Attribute for field link
sig { returns(T.nilable(Link)) }
def link; end
# Attribute for field paypal
sig { returns(T.nilable(Paypal)) }
def paypal; end
# Attribute for field payto
sig { returns(T.nilable(Payto)) }
def payto; end
# Attribute for field pix
sig { returns(T.nilable(Pix)) }
def pix; end
# Attribute for field sepa_debit
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# Attribute for field us_bank_account
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
end
# ID of the Connect application that created the SetupIntent.
sig { returns(T.nilable(T.any(String, Stripe::Application))) }
def application; end
# If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
#
# It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
sig { returns(T.nilable(T::Boolean)) }
def attach_to_self; end
# Settings for dynamic payment methods compatible with this Setup Intent
sig { returns(T.nilable(AutomaticPaymentMethods)) }
def automatic_payment_methods; end
# Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.
sig { returns(T.nilable(String)) }
def cancellation_reason; end
# The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.
#
# The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
sig { returns(T.nilable(String)) }
def client_secret; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# ID of the Customer this SetupIntent belongs to, if one exists.
#
# If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# ID of the Account this SetupIntent belongs to, if one exists.
#
# If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.
sig { returns(T.nilable(String)) }
def customer_account; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# Indicates the directions of money movement for which this payment method is intended to be used.
#
# Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.
sig { returns(T.nilable(T::Array[String])) }
def flow_directions; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The error encountered in the previous SetupIntent confirmation.
sig { returns(T.nilable(LastSetupError)) }
def last_setup_error; end
# The most recent SetupAttempt for this SetupIntent.
sig { returns(T.nilable(T.any(String, Stripe::SetupAttempt))) }
def latest_attempt; end
# 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) }
def livemode; end
# ID of the multi use Mandate generated by the SetupIntent.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def mandate; end
# 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])) }
def metadata; end
# If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
sig { returns(T.nilable(NextAction)) }
def next_action; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The account (if any) for which the setup is intended.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def on_behalf_of; end
# ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def payment_method; end
# Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this Setup Intent.
sig { returns(T.nilable(PaymentMethodConfigurationDetails)) }
def payment_method_configuration_details; end
# Payment method-specific configuration for this SetupIntent.
sig { returns(T.nilable(PaymentMethodOptions)) }
def payment_method_options; end
# The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
sig { returns(T::Array[String]) }
def payment_method_types; end
# ID of the single_use Mandate generated by the SetupIntent.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def single_use_mandate; end
# [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.
sig { returns(String) }
def status; end
# Indicates how the payment method is intended to be used in the future.
#
# Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`.
sig { returns(String) }
def usage; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
#
# It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
sig { returns(T.nilable(T::Boolean)) }
def attach_to_self; end
sig { params(_attach_to_self: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def attach_to_self=(_attach_to_self); end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
sig { returns(T.nilable(T.any(::Stripe::SetupIntent::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::SetupIntent::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::SetupIntent::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return SetupIntents for the customer specified by this customer ID.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Only return SetupIntents for the account specified by this customer ID.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return SetupIntents that associate with the specified payment method.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(attach_to_self: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::SetupIntent::ListParams::Created, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_method: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
attach_to_self: nil,
created: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
limit: nil,
payment_method: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class AutomaticPaymentMethods < Stripe::RequestParams
# Controls whether this SetupIntent will accept redirect-based payment methods.
#
# Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup.
sig { returns(T.nilable(String)) }
def allow_redirects; end
sig { params(_allow_redirects: T.nilable(String)).returns(T.nilable(String)) }
def allow_redirects=(_allow_redirects); end
# Whether this feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(allow_redirects: T.nilable(String), enabled: T::Boolean).void }
def initialize(allow_redirects: nil, enabled: nil); end
end
class MandateData < Stripe::RequestParams
class CustomerAcceptance < Stripe::RequestParams
class Offline < Stripe::RequestParams; end
class Online < Stripe::RequestParams
# The IP address from which the Mandate was accepted by the customer.
sig { returns(String) }
def ip_address; end
sig { params(_ip_address: String).returns(String) }
def ip_address=(_ip_address); end
# The user agent of the browser from which the Mandate was accepted by the customer.
sig { returns(String) }
def user_agent; end
sig { params(_user_agent: String).returns(String) }
def user_agent=(_user_agent); end
sig { params(ip_address: String, user_agent: String).void }
def initialize(ip_address: nil, user_agent: nil); end
end
# The time at which the customer accepted the Mandate.
sig { returns(T.nilable(Integer)) }
def accepted_at; end
sig { params(_accepted_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def accepted_at=(_accepted_at); end
# If this is a Mandate accepted offline, this hash contains details about the offline acceptance.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance::Offline))
}
def offline; end
sig {
params(_offline: T.nilable(::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance::Offline)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance::Offline))
}
def offline=(_offline); end
# If this is a Mandate accepted online, this hash contains details about the online acceptance.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance::Online))
}
def online; end
sig {
params(_online: T.nilable(::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance::Online)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance::Online))
}
def online=(_online); end
# The type of customer acceptance information included with the Mandate. One of `online` or `offline`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(accepted_at: T.nilable(Integer), offline: T.nilable(::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance::Offline), online: T.nilable(::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance::Online), type: String).void
}
def initialize(accepted_at: nil, offline: nil, online: nil, type: nil); end
end
# This hash contains details about the customer acceptance of the Mandate.
sig { returns(::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance) }
def customer_acceptance; end
sig {
params(_customer_acceptance: ::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance).returns(::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance)
}
def customer_acceptance=(_customer_acceptance); end
sig {
params(customer_acceptance: ::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance).void
}
def initialize(customer_acceptance: nil); end
end
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Institution number of the customer's bank.
sig { returns(String) }
def institution_number; end
sig { params(_institution_number: String).returns(String) }
def institution_number=(_institution_number); end
# Transit number of the customer's bank.
sig { returns(String) }
def transit_number; end
sig { params(_transit_number: String).returns(String) }
def transit_number=(_transit_number); end
sig {
params(account_number: String, institution_number: String, transit_number: String).void
}
def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(String) }
def bsb_number; end
sig { params(_bsb_number: String).returns(String) }
def bsb_number=(_bsb_number); end
sig { params(account_number: String, bsb_number: String).void }
def initialize(account_number: nil, bsb_number: nil); end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
sig { params(_sort_code: T.nilable(String)).returns(T.nilable(String)) }
def sort_code=(_sort_code); end
sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
def initialize(account_number: nil, sort_code: nil); end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::SetupIntent::CreateParams::PaymentMethodData::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::SetupIntent::CreateParams::PaymentMethodData::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::SetupIntent::CreateParams::PaymentMethodData::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::SetupIntent::CreateParams::PaymentMethodData::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
sig { params(_tax_id: String).returns(String) }
def tax_id=(_tax_id); end
sig { params(tax_id: String).void }
def initialize(tax_id: nil); end
end
class Cashapp < Stripe::RequestParams; end
class Crypto < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The customer's bank.
sig { returns(String) }
def bank; end
sig { params(_bank: String).returns(String) }
def bank=(_bank); end
sig { params(account_holder_type: T.nilable(String), bank: String).void }
def initialize(account_holder_type: nil, bank: nil); end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Klarna::Dob))
}
def dob; end
sig {
params(_dob: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Klarna::Dob)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Klarna::Dob))
}
def dob=(_dob); end
sig {
params(dob: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Klarna::Dob)).void
}
def initialize(dob: nil); end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
sig { returns(T.nilable(String)) }
def funding; end
sig { params(_funding: T.nilable(String)).returns(T.nilable(String)) }
def funding=(_funding); end
sig { params(funding: T.nilable(String)).void }
def initialize(funding: nil); end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
sig { params(_bank_code: String).returns(String) }
def bank_code=(_bank_code); end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
sig { params(_branch_code: String).returns(String) }
def branch_code=(_branch_code); end
# Attribute for param field reference
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# The suffix of the bank account number.
sig { returns(String) }
def suffix; end
sig { params(_suffix: String).returns(String) }
def suffix=(_suffix); end
sig {
params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
); end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Paypay < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig { returns(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Rechnung::Dob) }
def dob; end
sig {
params(_dob: ::Stripe::SetupIntent::CreateParams::PaymentMethodData::Rechnung::Dob).returns(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Rechnung::Dob)
}
def dob=(_dob); end
sig {
params(dob: ::Stripe::SetupIntent::CreateParams::PaymentMethodData::Rechnung::Dob).void
}
def initialize(dob: nil); end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
sig { returns(String) }
def iban; end
sig { params(_iban: String).returns(String) }
def iban=(_iban); end
sig { params(iban: String).void }
def initialize(iban: nil); end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
sig { params(account: T.nilable(String), source_type: T.nilable(String)).void }
def initialize(account: nil, source_type: nil); end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig {
params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String))
}
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AcssDebit)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Affirm)) }
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Affirm)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Affirm))
}
def affirm=(_affirm); end
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AfterpayClearpay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Alipay)) }
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Alipay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Alipay))
}
def alipay=(_alipay); end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Alma)) }
def alma; end
sig {
params(_alma: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Alma)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Alma))
}
def alma=(_alma); end
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AmazonPay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AuBecsDebit)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::BacsDebit)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Bancontact)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Bancontact))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Billie)) }
def billie; end
sig {
params(_billie: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Billie)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Billie))
}
def billie=(_billie); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::BillingDetails)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Blik)) }
def blik; end
sig {
params(_blik: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Blik)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Blik))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Boleto)) }
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Boleto)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Boleto))
}
def boleto=(_boleto); end
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Cashapp)) }
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Cashapp)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Cashapp))
}
def cashapp=(_cashapp); end
# If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Crypto)) }
def crypto; end
sig {
params(_crypto: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Crypto)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Crypto))
}
def crypto=(_crypto); end
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::CustomerBalance)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Eps)) }
def eps; end
sig {
params(_eps: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Eps)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Eps))
}
def eps=(_eps); end
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Fpx)) }
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Fpx)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Fpx))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Giropay)) }
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Giropay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Giropay))
}
def giropay=(_giropay); end
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Gopay)) }
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Gopay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Gopay))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Grabpay)) }
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Grabpay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Grabpay))
}
def grabpay=(_grabpay); end
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::IdBankTransfer)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Ideal)) }
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Ideal)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Ideal))
}
def ideal=(_ideal); end
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::InteracPresent))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::InteracPresent)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::InteracPresent))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::KakaoPay)) }
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::KakaoPay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Klarna)) }
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Klarna)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Klarna))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Konbini)) }
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Konbini)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Konbini))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::KrCard)) }
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::KrCard)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::KrCard))
}
def kr_card=(_kr_card); end
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Link)) }
def link; end
sig {
params(_link: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Link)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Link))
}
def link=(_link); end
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::MbWay)) }
def mb_way; end
sig {
params(_mb_way: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::MbWay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::MbWay))
}
def mb_way=(_mb_way); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Mobilepay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Mobilepay))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Multibanco)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Multibanco))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::NaverPay)) }
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::NaverPay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::NaverPay))
}
def naver_pay=(_naver_pay); end
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::NzBankAccount)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Oxxo)) }
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Oxxo)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Oxxo))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::P24)) }
def p24; end
sig {
params(_p24: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::P24)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::P24))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::PayByBank)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Payco)) }
def payco; end
sig {
params(_payco: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Payco)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Payco))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Paynow)) }
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Paynow)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Paynow))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Paypal)) }
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Paypal)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Paypal))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Paypay)) }
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Paypay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Paypay))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Payto)) }
def payto; end
sig {
params(_payto: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Payto)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Payto))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Pix)) }
def pix; end
sig {
params(_pix: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Pix)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Pix))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Promptpay))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Promptpay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Promptpay))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Qris)) }
def qris; end
sig {
params(_qris: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Qris)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Qris))
}
def qris=(_qris); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::RadarOptions))
}
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::RadarOptions)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::RadarOptions))
}
def radar_options=(_radar_options); end
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Rechnung)) }
def rechnung; end
sig {
params(_rechnung: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Rechnung)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Rechnung))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::RevolutPay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::SamsungPay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Satispay)) }
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Satispay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Satispay))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::SepaDebit)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Shopeepay))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Shopeepay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Shopeepay))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Sofort)) }
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Sofort)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Sofort))
}
def sofort=(_sofort); end
# This hash contains details about the Stripe balance payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::StripeBalance)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Swish)) }
def swish; end
sig {
params(_swish: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Swish)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Swish))
}
def swish=(_swish); end
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Twint)) }
def twint; end
sig {
params(_twint: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Twint)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Twint))
}
def twint=(_twint); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::UsBankAccount)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::WechatPay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Zip)) }
def zip; end
sig {
params(_zip: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Zip)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Cashapp), crypto: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Crypto), customer_balance: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Giropay), gopay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Gopay), grabpay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Grabpay), id_bank_transfer: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::IdBankTransfer), ideal: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Link), mb_way: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::MbWay), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Paypal), paypay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Paypay), payto: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Payto), pix: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Promptpay), qris: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Qris), radar_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::RadarOptions), rechnung: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Rechnung), revolut_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::SepaDebit), shopeepay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Shopeepay), sofort: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Sofort), stripe_balance: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::StripeBalance), swish: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# List of Stripe products where this mandate can be selected automatically.
sig { returns(T.nilable(T::Array[String])) }
def default_for; end
sig {
params(_default_for: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def default_for=(_default_for); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), default_for: T.nilable(T::Array[String]), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
default_for: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(currency: T.nilable(String), mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
}
def initialize(currency: nil, mandate_options: nil, verification_method: nil); end
end
class AmazonPay < Stripe::RequestParams; end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class Card < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(String) }
def amount_type; end
sig { params(_amount_type: String).returns(String) }
def amount_type=(_amount_type); end
# Currency in which future payments will be charged. 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Unique identifier for the mandate or subscription.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
sig { returns(Integer) }
def start_date; end
sig { params(_start_date: Integer).returns(Integer) }
def start_date=(_start_date); end
# Specifies the type of mandates supported. Possible values are `india`.
sig { returns(T.nilable(T::Array[String])) }
def supported_types; end
sig {
params(_supported_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def supported_types=(_supported_types); end
sig {
params(amount: Integer, amount_type: String, currency: String, description: T.nilable(String), end_date: T.nilable(Integer), interval: String, interval_count: T.nilable(Integer), reference: String, start_date: Integer, supported_types: T.nilable(T::Array[String])).void
}
def initialize(
amount: nil,
amount_type: nil,
currency: nil,
description: nil,
end_date: nil,
interval: nil,
interval_count: nil,
reference: nil,
start_date: nil,
supported_types: nil
); end
end
class ThreeDSecure < Stripe::RequestParams
class NetworkOptions < Stripe::RequestParams
class CartesBancaires < Stripe::RequestParams
# The cryptogram calculation algorithm used by the card Issuer's ACS
# to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
# messageExtension: CB-AVALGO
sig { returns(String) }
def cb_avalgo; end
sig { params(_cb_avalgo: String).returns(String) }
def cb_avalgo=(_cb_avalgo); end
# The exemption indicator returned from Cartes Bancaires in the ARes.
# message extension: CB-EXEMPTION; string (4 characters)
# This is a 3 byte bitmap (low significant byte first and most significant
# bit first) that has been Base64 encoded
sig { returns(T.nilable(String)) }
def cb_exemption; end
sig { params(_cb_exemption: T.nilable(String)).returns(T.nilable(String)) }
def cb_exemption=(_cb_exemption); end
# The risk score returned from Cartes Bancaires in the ARes.
# message extension: CB-SCORE; numeric value 0-99
sig { returns(T.nilable(Integer)) }
def cb_score; end
sig { params(_cb_score: T.nilable(Integer)).returns(T.nilable(Integer)) }
def cb_score=(_cb_score); end
sig {
params(cb_avalgo: String, cb_exemption: T.nilable(String), cb_score: T.nilable(Integer)).void
}
def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil); end
end
# Cartes Bancaires-specific 3DS fields.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires; end
sig {
params(_cartes_bancaires: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires=(_cartes_bancaires); end
sig {
params(cartes_bancaires: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).void
}
def initialize(cartes_bancaires: nil); end
end
# The `transStatus` returned from the card Issuer’s ACS in the ARes.
sig { returns(T.nilable(String)) }
def ares_trans_status; end
sig { params(_ares_trans_status: T.nilable(String)).returns(T.nilable(String)) }
def ares_trans_status=(_ares_trans_status); end
# The cryptogram, also known as the "authentication value" (AAV, CAVV or
# AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
# (Most 3D Secure providers will return the base64-encoded version, which
# is what you should specify here.)
sig { returns(T.nilable(String)) }
def cryptogram; end
sig { params(_cryptogram: T.nilable(String)).returns(T.nilable(String)) }
def cryptogram=(_cryptogram); end
# The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
# provider and indicates what degree of authentication was performed.
sig { returns(T.nilable(String)) }
def electronic_commerce_indicator; end
sig {
params(_electronic_commerce_indicator: T.nilable(String)).returns(T.nilable(String))
}
def electronic_commerce_indicator=(_electronic_commerce_indicator); end
# Network specific 3DS fields. Network specific arguments require an
# explicit card brand choice. The parameter `payment_method_options.card.network``
# must be populated accordingly
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options; end
sig {
params(_network_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options=(_network_options); end
# The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
# AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
sig { returns(T.nilable(String)) }
def requestor_challenge_indicator; end
sig {
params(_requestor_challenge_indicator: T.nilable(String)).returns(T.nilable(String))
}
def requestor_challenge_indicator=(_requestor_challenge_indicator); end
# For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
# Transaction ID (dsTransID).
sig { returns(T.nilable(String)) }
def transaction_id; end
sig { params(_transaction_id: T.nilable(String)).returns(T.nilable(String)) }
def transaction_id=(_transaction_id); end
# The version of 3D Secure that was performed.
sig { returns(T.nilable(String)) }
def version; end
sig { params(_version: T.nilable(String)).returns(T.nilable(String)) }
def version=(_version); end
sig {
params(ares_trans_status: T.nilable(String), cryptogram: T.nilable(String), electronic_commerce_indicator: T.nilable(String), network_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions), requestor_challenge_indicator: T.nilable(String), transaction_id: T.nilable(String), version: T.nilable(String)).void
}
def initialize(
ares_trans_status: nil,
cryptogram: nil,
electronic_commerce_indicator: nil,
network_options: nil,
requestor_challenge_indicator: nil,
transaction_id: nil,
version: nil
); end
end
# Configuration options for setting up an eMandate for cards issued in India.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options=(_mandate_options); end
# When specified, this parameter signals that a card has been collected
# as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
# parameter can only be provided during confirmation.
sig { returns(T.nilable(T::Boolean)) }
def moto; end
sig { params(_moto: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def moto=(_moto); end
# Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
# If 3D Secure authentication was performed with a third-party provider,
# the authentication details to use for this setup.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure; end
sig {
params(_three_d_secure: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure=(_three_d_secure); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::MandateOptions), moto: T.nilable(T::Boolean), network: T.nilable(String), request_three_d_secure: T.nilable(String), three_d_secure: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure)).void
}
def initialize(
mandate_options: nil,
moto: nil,
network: nil,
request_three_d_secure: nil,
three_d_secure: nil
); end
end
class CardPresent < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class OnDemand < Stripe::RequestParams
# Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def average_amount; end
sig { params(_average_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def average_amount=(_average_amount); end
# The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def maximum_amount; end
sig { params(_maximum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_amount=(_maximum_amount); end
# The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Interval at which the customer is making purchases
sig { returns(T.nilable(String)) }
def purchase_interval; end
sig { params(_purchase_interval: T.nilable(String)).returns(T.nilable(String)) }
def purchase_interval=(_purchase_interval); end
# The number of `purchase_interval` between charges
sig { returns(T.nilable(Integer)) }
def purchase_interval_count; end
sig { params(_purchase_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def purchase_interval_count=(_purchase_interval_count); end
sig {
params(average_amount: T.nilable(Integer), maximum_amount: T.nilable(Integer), minimum_amount: T.nilable(Integer), purchase_interval: T.nilable(String), purchase_interval_count: T.nilable(Integer)).void
}
def initialize(
average_amount: nil,
maximum_amount: nil,
minimum_amount: nil,
purchase_interval: nil,
purchase_interval_count: nil
); end
end
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
}
def next_billing; end
sig {
params(_next_billing: ::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling).returns(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: ::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling, reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# The currency of the SetupIntent. Three letter ISO currency code.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# On-demand details if setting up a payment method for on-demand payments.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand; end
sig {
params(_on_demand: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Klarna::OnDemand)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand=(_on_demand); end
# Preferred language of the Klarna authorization page that the customer is redirected to
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Subscription details if setting up or charging a subscription
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(currency: T.nilable(String), on_demand: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Klarna::OnDemand), preferred_locale: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(
currency: nil,
on_demand: nil,
preferred_locale: nil,
subscriptions: nil
); end
end
class Link < Stripe::RequestParams
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
sig { params(_persistent_token: T.nilable(String)).returns(T.nilable(String)) }
def persistent_token=(_persistent_token); end
sig { params(persistent_token: T.nilable(String)).void }
def initialize(persistent_token: nil); end
end
class Paypal < Stripe::RequestParams
# The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
sig { returns(T.nilable(String)) }
def billing_agreement_id; end
sig { params(_billing_agreement_id: T.nilable(String)).returns(T.nilable(String)) }
def billing_agreement_id=(_billing_agreement_id); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(billing_agreement_id: T.nilable(String), currency: T.nilable(String), subsellers: T.nilable(T::Array[String])).void
}
def initialize(billing_agreement_id: nil, currency: nil, subsellers: nil); end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
sig { params(_payments_per_period: T.nilable(Integer)).returns(T.nilable(Integer)) }
def payments_per_period=(_payments_per_period); end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
sig { params(_purpose: T.nilable(String)).returns(T.nilable(String)) }
def purpose=(_purpose); end
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), payments_per_period: T.nilable(Integer), purpose: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil,
start_date: nil
); end
end
# Additional fields for Mandate creation.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Payto::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Payto::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Type of amount. Defaults to `maximum`.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), amount_type: T.nilable(String), currency: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), reference: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
amount_type: nil,
currency: nil,
end_date: nil,
payment_schedule: nil,
reference: nil,
start_date: nil
); end
end
# Additional fields for mandate creation.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Pix::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
class ManualEntry < Stripe::RequestParams
# Settings for configuring manual entry of account details.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
sig { params(mode: String).void }
def initialize(mode: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# Customize manual entry behavior
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry; end
sig {
params(_manual_entry: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry=(_manual_entry); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(filters: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), manual_entry: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
}
def initialize(
filters: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
); end
end
class MandateOptions < Stripe::RequestParams
# The method used to collect offline mandate customer acceptance.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
sig { params(collection_method: T.nilable(String)).void }
def initialize(collection_method: nil); end
end
class Networks < Stripe::RequestParams
# Triggers validations to run across the selected networks
sig { returns(T.nilable(T::Array[String])) }
def requested; end
sig {
params(_requested: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested=(_requested); end
sig { params(requested: T.nilable(T::Array[String])).void }
def initialize(requested: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Additional fields for network related functions
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks; end
sig {
params(_networks: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::Networks)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks=(_networks); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::Networks), verification_method: T.nilable(String)).void
}
def initialize(
financial_connections: nil,
mandate_options: nil,
networks: nil,
verification_method: nil
); end
end
# If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AcssDebit)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AmazonPay)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::BacsDebit)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# Configuration for any card setup attempted on this SetupIntent.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card)) }
def card; end
sig {
params(_card: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card))
}
def card=(_card); end
# If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::CardPresent))
}
def card_present=(_card_present); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Link)) }
def link; end
sig {
params(_link: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Link)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Link))
}
def link=(_link); end
# If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
# If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Payto)) }
def payto; end
sig {
params(_payto: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Payto)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Payto))
}
def payto=(_payto); end
# If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Pix)) }
def pix; end
sig {
params(_pix: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Pix)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Pix))
}
def pix=(_pix); end
# If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::SepaDebit)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
sig {
params(acss_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AcssDebit), amazon_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AmazonPay), bacs_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::BacsDebit), card: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::CardPresent), klarna: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Klarna), link: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Link), paypal: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Paypal), payto: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Payto), pix: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Pix), sepa_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::SepaDebit), us_bank_account: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount)).void
}
def initialize(
acss_debit: nil,
amazon_pay: nil,
bacs_debit: nil,
card: nil,
card_present: nil,
klarna: nil,
link: nil,
paypal: nil,
payto: nil,
pix: nil,
sepa_debit: nil,
us_bank_account: nil
); end
end
class SingleUse < Stripe::RequestParams
# Amount the customer is granting permission to collect later. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
sig { params(amount: Integer, currency: String).void }
def initialize(amount: nil, currency: nil); end
end
# If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
#
# It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
sig { returns(T.nilable(T::Boolean)) }
def attach_to_self; end
sig { params(_attach_to_self: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def attach_to_self=(_attach_to_self); end
# When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::AutomaticPaymentMethods)) }
def automatic_payment_methods; end
sig {
params(_automatic_payment_methods: T.nilable(::Stripe::SetupIntent::CreateParams::AutomaticPaymentMethods)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::AutomaticPaymentMethods))
}
def automatic_payment_methods=(_automatic_payment_methods); end
# Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary.
sig { returns(T.nilable(T::Boolean)) }
def confirm; end
sig { params(_confirm: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def confirm=(_confirm); end
# ID of the ConfirmationToken used to confirm this SetupIntent.
#
# If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.
sig { returns(T.nilable(String)) }
def confirmation_token; end
sig { params(_confirmation_token: T.nilable(String)).returns(T.nilable(String)) }
def confirmation_token=(_confirmation_token); end
# ID of the Customer this SetupIntent belongs to, if one exists.
#
# If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# ID of the Account this SetupIntent belongs to, if one exists.
#
# If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Indicates the directions of money movement for which this payment method is intended to be used.
#
# Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.
sig { returns(T.nilable(T::Array[String])) }
def flow_directions; end
sig {
params(_flow_directions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def flow_directions=(_flow_directions); end
# This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm).
sig { returns(T.nilable(T.any(String, ::Stripe::SetupIntent::CreateParams::MandateData))) }
def mandate_data; end
sig {
params(_mandate_data: T.nilable(T.any(String, ::Stripe::SetupIntent::CreateParams::MandateData))).returns(T.nilable(T.any(String, ::Stripe::SetupIntent::CreateParams::MandateData)))
}
def mandate_data=(_mandate_data); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The Stripe account ID created for this SetupIntent.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent.
sig { returns(T.nilable(String)) }
def payment_method_configuration; end
sig { params(_payment_method_configuration: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_configuration=(_payment_method_configuration); end
# When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)
# value in the SetupIntent.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData)) }
def payment_method_data; end
sig {
params(_payment_method_data: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData))
}
def payment_method_data=(_payment_method_data); end
# Payment method-specific configuration for this SetupIntent.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions)) }
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
# The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm).
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion.
#
# Single-use mandates are only valid for the following payment methods: `acss_debit`, `alipay`, `au_becs_debit`, `bacs_debit`, `bancontact`, `boleto`, `ideal`, `link`, `sepa_debit`, and `us_bank_account`.
sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::SingleUse)) }
def single_use; end
sig {
params(_single_use: T.nilable(::Stripe::SetupIntent::CreateParams::SingleUse)).returns(T.nilable(::Stripe::SetupIntent::CreateParams::SingleUse))
}
def single_use=(_single_use); end
# Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`.
sig { returns(T.nilable(String)) }
def usage; end
sig { params(_usage: T.nilable(String)).returns(T.nilable(String)) }
def usage=(_usage); end
# Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
sig { returns(T.nilable(T::Boolean)) }
def use_stripe_sdk; end
sig { params(_use_stripe_sdk: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def use_stripe_sdk=(_use_stripe_sdk); end
sig {
params(attach_to_self: T.nilable(T::Boolean), automatic_payment_methods: T.nilable(::Stripe::SetupIntent::CreateParams::AutomaticPaymentMethods), confirm: T.nilable(T::Boolean), confirmation_token: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), description: T.nilable(String), expand: T.nilable(T::Array[String]), flow_directions: T.nilable(T::Array[String]), mandate_data: T.nilable(T.any(String, ::Stripe::SetupIntent::CreateParams::MandateData)), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), payment_method: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), return_url: T.nilable(String), single_use: T.nilable(::Stripe::SetupIntent::CreateParams::SingleUse), usage: T.nilable(String), use_stripe_sdk: T.nilable(T::Boolean)).void
}
def initialize(
attach_to_self: nil,
automatic_payment_methods: nil,
confirm: nil,
confirmation_token: nil,
customer: nil,
customer_account: nil,
description: nil,
expand: nil,
flow_directions: nil,
mandate_data: nil,
metadata: nil,
on_behalf_of: nil,
payment_method: nil,
payment_method_configuration: nil,
payment_method_data: nil,
payment_method_options: nil,
payment_method_types: nil,
return_url: nil,
single_use: nil,
usage: nil,
use_stripe_sdk: nil
); end
end
class UpdateParams < Stripe::RequestParams
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Institution number of the customer's bank.
sig { returns(String) }
def institution_number; end
sig { params(_institution_number: String).returns(String) }
def institution_number=(_institution_number); end
# Transit number of the customer's bank.
sig { returns(String) }
def transit_number; end
sig { params(_transit_number: String).returns(String) }
def transit_number=(_transit_number); end
sig {
params(account_number: String, institution_number: String, transit_number: String).void
}
def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(String) }
def bsb_number; end
sig { params(_bsb_number: String).returns(String) }
def bsb_number=(_bsb_number); end
sig { params(account_number: String, bsb_number: String).void }
def initialize(account_number: nil, bsb_number: nil); end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
sig { params(_sort_code: T.nilable(String)).returns(T.nilable(String)) }
def sort_code=(_sort_code); end
sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
def initialize(account_number: nil, sort_code: nil); end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
sig { params(_tax_id: String).returns(String) }
def tax_id=(_tax_id); end
sig { params(tax_id: String).void }
def initialize(tax_id: nil); end
end
class Cashapp < Stripe::RequestParams; end
class Crypto < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The customer's bank.
sig { returns(String) }
def bank; end
sig { params(_bank: String).returns(String) }
def bank=(_bank); end
sig { params(account_holder_type: T.nilable(String), bank: String).void }
def initialize(account_holder_type: nil, bank: nil); end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Klarna::Dob))
}
def dob; end
sig {
params(_dob: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Klarna::Dob)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Klarna::Dob))
}
def dob=(_dob); end
sig {
params(dob: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Klarna::Dob)).void
}
def initialize(dob: nil); end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
sig { returns(T.nilable(String)) }
def funding; end
sig { params(_funding: T.nilable(String)).returns(T.nilable(String)) }
def funding=(_funding); end
sig { params(funding: T.nilable(String)).void }
def initialize(funding: nil); end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
sig { params(_bank_code: String).returns(String) }
def bank_code=(_bank_code); end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
sig { params(_branch_code: String).returns(String) }
def branch_code=(_branch_code); end
# Attribute for param field reference
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# The suffix of the bank account number.
sig { returns(String) }
def suffix; end
sig { params(_suffix: String).returns(String) }
def suffix=(_suffix); end
sig {
params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
); end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Paypay < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig { returns(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Rechnung::Dob) }
def dob; end
sig {
params(_dob: ::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Rechnung::Dob).returns(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Rechnung::Dob)
}
def dob=(_dob); end
sig {
params(dob: ::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Rechnung::Dob).void
}
def initialize(dob: nil); end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
sig { returns(String) }
def iban; end
sig { params(_iban: String).returns(String) }
def iban=(_iban); end
sig { params(iban: String).void }
def initialize(iban: nil); end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
sig { params(account: T.nilable(String), source_type: T.nilable(String)).void }
def initialize(account: nil, source_type: nil); end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig {
params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String))
}
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AcssDebit)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Affirm)) }
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Affirm)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Affirm))
}
def affirm=(_affirm); end
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AfterpayClearpay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Alipay)) }
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Alipay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Alipay))
}
def alipay=(_alipay); end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Alma)) }
def alma; end
sig {
params(_alma: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Alma)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Alma))
}
def alma=(_alma); end
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AmazonPay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AuBecsDebit)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BacsDebit)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Bancontact)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Bancontact))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Billie)) }
def billie; end
sig {
params(_billie: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Billie)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Billie))
}
def billie=(_billie); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BillingDetails)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Blik)) }
def blik; end
sig {
params(_blik: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Blik)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Blik))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Boleto)) }
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Boleto)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Boleto))
}
def boleto=(_boleto); end
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Cashapp)) }
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Cashapp)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Cashapp))
}
def cashapp=(_cashapp); end
# If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Crypto)) }
def crypto; end
sig {
params(_crypto: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Crypto)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Crypto))
}
def crypto=(_crypto); end
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::CustomerBalance)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Eps)) }
def eps; end
sig {
params(_eps: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Eps)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Eps))
}
def eps=(_eps); end
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Fpx)) }
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Fpx)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Fpx))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Giropay)) }
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Giropay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Giropay))
}
def giropay=(_giropay); end
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Gopay)) }
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Gopay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Gopay))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Grabpay)) }
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Grabpay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Grabpay))
}
def grabpay=(_grabpay); end
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::IdBankTransfer)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Ideal)) }
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Ideal)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Ideal))
}
def ideal=(_ideal); end
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::InteracPresent))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::InteracPresent)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::InteracPresent))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::KakaoPay)) }
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::KakaoPay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Klarna)) }
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Klarna)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Klarna))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Konbini)) }
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Konbini)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Konbini))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::KrCard)) }
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::KrCard)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::KrCard))
}
def kr_card=(_kr_card); end
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Link)) }
def link; end
sig {
params(_link: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Link)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Link))
}
def link=(_link); end
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::MbWay)) }
def mb_way; end
sig {
params(_mb_way: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::MbWay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::MbWay))
}
def mb_way=(_mb_way); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Mobilepay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Mobilepay))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Multibanco)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Multibanco))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::NaverPay)) }
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::NaverPay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::NaverPay))
}
def naver_pay=(_naver_pay); end
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::NzBankAccount)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Oxxo)) }
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Oxxo)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Oxxo))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::P24)) }
def p24; end
sig {
params(_p24: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::P24)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::P24))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::PayByBank)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Payco)) }
def payco; end
sig {
params(_payco: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Payco)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Payco))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Paynow)) }
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Paynow)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Paynow))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Paypal)) }
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Paypal)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Paypal))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Paypay)) }
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Paypay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Paypay))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Payto)) }
def payto; end
sig {
params(_payto: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Payto)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Payto))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Pix)) }
def pix; end
sig {
params(_pix: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Pix)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Pix))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Promptpay))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Promptpay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Promptpay))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Qris)) }
def qris; end
sig {
params(_qris: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Qris)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Qris))
}
def qris=(_qris); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::RadarOptions))
}
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::RadarOptions)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::RadarOptions))
}
def radar_options=(_radar_options); end
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Rechnung)) }
def rechnung; end
sig {
params(_rechnung: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Rechnung)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Rechnung))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::RevolutPay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::SamsungPay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Satispay)) }
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Satispay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Satispay))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::SepaDebit)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Shopeepay))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Shopeepay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Shopeepay))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Sofort)) }
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Sofort)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Sofort))
}
def sofort=(_sofort); end
# This hash contains details about the Stripe balance payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::StripeBalance)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Swish)) }
def swish; end
sig {
params(_swish: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Swish)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Swish))
}
def swish=(_swish); end
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Twint)) }
def twint; end
sig {
params(_twint: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Twint)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Twint))
}
def twint=(_twint); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::UsBankAccount)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::WechatPay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Zip)) }
def zip; end
sig {
params(_zip: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Zip)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Cashapp), crypto: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Crypto), customer_balance: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Giropay), gopay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Gopay), grabpay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Grabpay), id_bank_transfer: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::IdBankTransfer), ideal: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Link), mb_way: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::MbWay), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Paypal), paypay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Paypay), payto: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Payto), pix: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Promptpay), qris: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Qris), radar_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::RadarOptions), rechnung: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Rechnung), revolut_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::SepaDebit), shopeepay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Shopeepay), sofort: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Sofort), stripe_balance: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::StripeBalance), swish: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# List of Stripe products where this mandate can be selected automatically.
sig { returns(T.nilable(T::Array[String])) }
def default_for; end
sig {
params(_default_for: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def default_for=(_default_for); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), default_for: T.nilable(T::Array[String]), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
default_for: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(currency: T.nilable(String), mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
}
def initialize(currency: nil, mandate_options: nil, verification_method: nil); end
end
class AmazonPay < Stripe::RequestParams; end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class Card < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(String) }
def amount_type; end
sig { params(_amount_type: String).returns(String) }
def amount_type=(_amount_type); end
# Currency in which future payments will be charged. 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Unique identifier for the mandate or subscription.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
sig { returns(Integer) }
def start_date; end
sig { params(_start_date: Integer).returns(Integer) }
def start_date=(_start_date); end
# Specifies the type of mandates supported. Possible values are `india`.
sig { returns(T.nilable(T::Array[String])) }
def supported_types; end
sig {
params(_supported_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def supported_types=(_supported_types); end
sig {
params(amount: Integer, amount_type: String, currency: String, description: T.nilable(String), end_date: T.nilable(Integer), interval: String, interval_count: T.nilable(Integer), reference: String, start_date: Integer, supported_types: T.nilable(T::Array[String])).void
}
def initialize(
amount: nil,
amount_type: nil,
currency: nil,
description: nil,
end_date: nil,
interval: nil,
interval_count: nil,
reference: nil,
start_date: nil,
supported_types: nil
); end
end
class ThreeDSecure < Stripe::RequestParams
class NetworkOptions < Stripe::RequestParams
class CartesBancaires < Stripe::RequestParams
# The cryptogram calculation algorithm used by the card Issuer's ACS
# to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
# messageExtension: CB-AVALGO
sig { returns(String) }
def cb_avalgo; end
sig { params(_cb_avalgo: String).returns(String) }
def cb_avalgo=(_cb_avalgo); end
# The exemption indicator returned from Cartes Bancaires in the ARes.
# message extension: CB-EXEMPTION; string (4 characters)
# This is a 3 byte bitmap (low significant byte first and most significant
# bit first) that has been Base64 encoded
sig { returns(T.nilable(String)) }
def cb_exemption; end
sig { params(_cb_exemption: T.nilable(String)).returns(T.nilable(String)) }
def cb_exemption=(_cb_exemption); end
# The risk score returned from Cartes Bancaires in the ARes.
# message extension: CB-SCORE; numeric value 0-99
sig { returns(T.nilable(Integer)) }
def cb_score; end
sig { params(_cb_score: T.nilable(Integer)).returns(T.nilable(Integer)) }
def cb_score=(_cb_score); end
sig {
params(cb_avalgo: String, cb_exemption: T.nilable(String), cb_score: T.nilable(Integer)).void
}
def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil); end
end
# Cartes Bancaires-specific 3DS fields.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires; end
sig {
params(_cartes_bancaires: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires=(_cartes_bancaires); end
sig {
params(cartes_bancaires: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).void
}
def initialize(cartes_bancaires: nil); end
end
# The `transStatus` returned from the card Issuer’s ACS in the ARes.
sig { returns(T.nilable(String)) }
def ares_trans_status; end
sig { params(_ares_trans_status: T.nilable(String)).returns(T.nilable(String)) }
def ares_trans_status=(_ares_trans_status); end
# The cryptogram, also known as the "authentication value" (AAV, CAVV or
# AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
# (Most 3D Secure providers will return the base64-encoded version, which
# is what you should specify here.)
sig { returns(T.nilable(String)) }
def cryptogram; end
sig { params(_cryptogram: T.nilable(String)).returns(T.nilable(String)) }
def cryptogram=(_cryptogram); end
# The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
# provider and indicates what degree of authentication was performed.
sig { returns(T.nilable(String)) }
def electronic_commerce_indicator; end
sig {
params(_electronic_commerce_indicator: T.nilable(String)).returns(T.nilable(String))
}
def electronic_commerce_indicator=(_electronic_commerce_indicator); end
# Network specific 3DS fields. Network specific arguments require an
# explicit card brand choice. The parameter `payment_method_options.card.network``
# must be populated accordingly
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options; end
sig {
params(_network_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options=(_network_options); end
# The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
# AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
sig { returns(T.nilable(String)) }
def requestor_challenge_indicator; end
sig {
params(_requestor_challenge_indicator: T.nilable(String)).returns(T.nilable(String))
}
def requestor_challenge_indicator=(_requestor_challenge_indicator); end
# For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
# Transaction ID (dsTransID).
sig { returns(T.nilable(String)) }
def transaction_id; end
sig { params(_transaction_id: T.nilable(String)).returns(T.nilable(String)) }
def transaction_id=(_transaction_id); end
# The version of 3D Secure that was performed.
sig { returns(T.nilable(String)) }
def version; end
sig { params(_version: T.nilable(String)).returns(T.nilable(String)) }
def version=(_version); end
sig {
params(ares_trans_status: T.nilable(String), cryptogram: T.nilable(String), electronic_commerce_indicator: T.nilable(String), network_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions), requestor_challenge_indicator: T.nilable(String), transaction_id: T.nilable(String), version: T.nilable(String)).void
}
def initialize(
ares_trans_status: nil,
cryptogram: nil,
electronic_commerce_indicator: nil,
network_options: nil,
requestor_challenge_indicator: nil,
transaction_id: nil,
version: nil
); end
end
# Configuration options for setting up an eMandate for cards issued in India.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options=(_mandate_options); end
# When specified, this parameter signals that a card has been collected
# as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
# parameter can only be provided during confirmation.
sig { returns(T.nilable(T::Boolean)) }
def moto; end
sig { params(_moto: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def moto=(_moto); end
# Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
# If 3D Secure authentication was performed with a third-party provider,
# the authentication details to use for this setup.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure; end
sig {
params(_three_d_secure: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure=(_three_d_secure); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::MandateOptions), moto: T.nilable(T::Boolean), network: T.nilable(String), request_three_d_secure: T.nilable(String), three_d_secure: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure)).void
}
def initialize(
mandate_options: nil,
moto: nil,
network: nil,
request_three_d_secure: nil,
three_d_secure: nil
); end
end
class CardPresent < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class OnDemand < Stripe::RequestParams
# Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def average_amount; end
sig { params(_average_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def average_amount=(_average_amount); end
# The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def maximum_amount; end
sig { params(_maximum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_amount=(_maximum_amount); end
# The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Interval at which the customer is making purchases
sig { returns(T.nilable(String)) }
def purchase_interval; end
sig { params(_purchase_interval: T.nilable(String)).returns(T.nilable(String)) }
def purchase_interval=(_purchase_interval); end
# The number of `purchase_interval` between charges
sig { returns(T.nilable(Integer)) }
def purchase_interval_count; end
sig { params(_purchase_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def purchase_interval_count=(_purchase_interval_count); end
sig {
params(average_amount: T.nilable(Integer), maximum_amount: T.nilable(Integer), minimum_amount: T.nilable(Integer), purchase_interval: T.nilable(String), purchase_interval_count: T.nilable(Integer)).void
}
def initialize(
average_amount: nil,
maximum_amount: nil,
minimum_amount: nil,
purchase_interval: nil,
purchase_interval_count: nil
); end
end
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
}
def next_billing; end
sig {
params(_next_billing: ::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling).returns(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: ::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling, reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# The currency of the SetupIntent. Three letter ISO currency code.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# On-demand details if setting up a payment method for on-demand payments.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand; end
sig {
params(_on_demand: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Klarna::OnDemand)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand=(_on_demand); end
# Preferred language of the Klarna authorization page that the customer is redirected to
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Subscription details if setting up or charging a subscription
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(currency: T.nilable(String), on_demand: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Klarna::OnDemand), preferred_locale: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(
currency: nil,
on_demand: nil,
preferred_locale: nil,
subscriptions: nil
); end
end
class Link < Stripe::RequestParams
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
sig { params(_persistent_token: T.nilable(String)).returns(T.nilable(String)) }
def persistent_token=(_persistent_token); end
sig { params(persistent_token: T.nilable(String)).void }
def initialize(persistent_token: nil); end
end
class Paypal < Stripe::RequestParams
# The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
sig { returns(T.nilable(String)) }
def billing_agreement_id; end
sig { params(_billing_agreement_id: T.nilable(String)).returns(T.nilable(String)) }
def billing_agreement_id=(_billing_agreement_id); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(billing_agreement_id: T.nilable(String), currency: T.nilable(String), subsellers: T.nilable(T::Array[String])).void
}
def initialize(billing_agreement_id: nil, currency: nil, subsellers: nil); end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
sig { params(_payments_per_period: T.nilable(Integer)).returns(T.nilable(Integer)) }
def payments_per_period=(_payments_per_period); end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
sig { params(_purpose: T.nilable(String)).returns(T.nilable(String)) }
def purpose=(_purpose); end
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), payments_per_period: T.nilable(Integer), purpose: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil,
start_date: nil
); end
end
# Additional fields for Mandate creation.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Payto::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Payto::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Type of amount. Defaults to `maximum`.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), amount_type: T.nilable(String), currency: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), reference: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
amount_type: nil,
currency: nil,
end_date: nil,
payment_schedule: nil,
reference: nil,
start_date: nil
); end
end
# Additional fields for mandate creation.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Pix::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
class ManualEntry < Stripe::RequestParams
# Settings for configuring manual entry of account details.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
sig { params(mode: String).void }
def initialize(mode: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# Customize manual entry behavior
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry; end
sig {
params(_manual_entry: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry=(_manual_entry); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(filters: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), manual_entry: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
}
def initialize(
filters: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
); end
end
class MandateOptions < Stripe::RequestParams
# The method used to collect offline mandate customer acceptance.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
sig { params(collection_method: T.nilable(String)).void }
def initialize(collection_method: nil); end
end
class Networks < Stripe::RequestParams
# Triggers validations to run across the selected networks
sig { returns(T.nilable(T::Array[String])) }
def requested; end
sig {
params(_requested: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested=(_requested); end
sig { params(requested: T.nilable(T::Array[String])).void }
def initialize(requested: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Additional fields for network related functions
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks; end
sig {
params(_networks: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks=(_networks); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks), verification_method: T.nilable(String)).void
}
def initialize(
financial_connections: nil,
mandate_options: nil,
networks: nil,
verification_method: nil
); end
end
# If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AcssDebit)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AmazonPay)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::BacsDebit)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# Configuration for any card setup attempted on this SetupIntent.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card)) }
def card; end
sig {
params(_card: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card))
}
def card=(_card); end
# If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::CardPresent))
}
def card_present=(_card_present); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Link)) }
def link; end
sig {
params(_link: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Link)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Link))
}
def link=(_link); end
# If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
# If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Payto)) }
def payto; end
sig {
params(_payto: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Payto)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Payto))
}
def payto=(_payto); end
# If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Pix)) }
def pix; end
sig {
params(_pix: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Pix)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Pix))
}
def pix=(_pix); end
# If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::SepaDebit)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
sig {
params(acss_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AcssDebit), amazon_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AmazonPay), bacs_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::BacsDebit), card: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::CardPresent), klarna: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Klarna), link: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Link), paypal: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Paypal), payto: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Payto), pix: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Pix), sepa_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::SepaDebit), us_bank_account: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount)).void
}
def initialize(
acss_debit: nil,
amazon_pay: nil,
bacs_debit: nil,
card: nil,
card_present: nil,
klarna: nil,
link: nil,
paypal: nil,
payto: nil,
pix: nil,
sepa_debit: nil,
us_bank_account: nil
); end
end
# If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
#
# It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
sig { returns(T.nilable(T::Boolean)) }
def attach_to_self; end
sig { params(_attach_to_self: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def attach_to_self=(_attach_to_self); end
# ID of the Customer this SetupIntent belongs to, if one exists.
#
# If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# ID of the Account this SetupIntent belongs to, if one exists.
#
# If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Indicates the directions of money movement for which this payment method is intended to be used.
#
# Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.
sig { returns(T.nilable(T::Array[String])) }
def flow_directions; end
sig {
params(_flow_directions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def flow_directions=(_flow_directions); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. To unset this field to null, pass in an empty string.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent.
sig { returns(T.nilable(String)) }
def payment_method_configuration; end
sig { params(_payment_method_configuration: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_configuration=(_payment_method_configuration); end
# When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)
# value in the SetupIntent.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData)) }
def payment_method_data; end
sig {
params(_payment_method_data: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData))
}
def payment_method_data=(_payment_method_data); end
# Payment method-specific configuration for this SetupIntent.
sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions)) }
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
sig {
params(attach_to_self: T.nilable(T::Boolean), customer: T.nilable(String), customer_account: T.nilable(String), description: T.nilable(String), expand: T.nilable(T::Array[String]), flow_directions: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), payment_method: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String])).void
}
def initialize(
attach_to_self: nil,
customer: nil,
customer_account: nil,
description: nil,
expand: nil,
flow_directions: nil,
metadata: nil,
payment_method: nil,
payment_method_configuration: nil,
payment_method_data: nil,
payment_method_options: nil,
payment_method_types: nil
); end
end
class CancelParams < Stripe::RequestParams
# Reason for canceling this SetupIntent. Possible values are: `abandoned`, `requested_by_customer`, or `duplicate`
sig { returns(T.nilable(String)) }
def cancellation_reason; end
sig { params(_cancellation_reason: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_reason=(_cancellation_reason); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(cancellation_reason: T.nilable(String), expand: T.nilable(T::Array[String])).void
}
def initialize(cancellation_reason: nil, expand: nil); end
end
class ConfirmParams < Stripe::RequestParams
class MandateData < Stripe::RequestParams
class CustomerAcceptance < Stripe::RequestParams
class Offline < Stripe::RequestParams; end
class Online < Stripe::RequestParams
# The IP address from which the Mandate was accepted by the customer.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# The user agent of the browser from which the Mandate was accepted by the customer.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig { params(ip_address: T.nilable(String), user_agent: T.nilable(String)).void }
def initialize(ip_address: nil, user_agent: nil); end
end
# The time at which the customer accepted the Mandate.
sig { returns(T.nilable(Integer)) }
def accepted_at; end
sig { params(_accepted_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def accepted_at=(_accepted_at); end
# If this is a Mandate accepted offline, this hash contains details about the offline acceptance.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance::Offline))
}
def offline; end
sig {
params(_offline: T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance::Offline)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance::Offline))
}
def offline=(_offline); end
# If this is a Mandate accepted online, this hash contains details about the online acceptance.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance::Online))
}
def online; end
sig {
params(_online: T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance::Online)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance::Online))
}
def online=(_online); end
# The type of customer acceptance information included with the Mandate. One of `online` or `offline`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(accepted_at: T.nilable(Integer), offline: T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance::Offline), online: T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance::Online), type: String).void
}
def initialize(accepted_at: nil, offline: nil, online: nil, type: nil); end
end
# This hash contains details about the customer acceptance of the Mandate.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance))
}
def customer_acceptance; end
sig {
params(_customer_acceptance: T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance))
}
def customer_acceptance=(_customer_acceptance); end
sig {
params(customer_acceptance: T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance)).void
}
def initialize(customer_acceptance: nil); end
end
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Institution number of the customer's bank.
sig { returns(String) }
def institution_number; end
sig { params(_institution_number: String).returns(String) }
def institution_number=(_institution_number); end
# Transit number of the customer's bank.
sig { returns(String) }
def transit_number; end
sig { params(_transit_number: String).returns(String) }
def transit_number=(_transit_number); end
sig {
params(account_number: String, institution_number: String, transit_number: String).void
}
def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(String) }
def bsb_number; end
sig { params(_bsb_number: String).returns(String) }
def bsb_number=(_bsb_number); end
sig { params(account_number: String, bsb_number: String).void }
def initialize(account_number: nil, bsb_number: nil); end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
sig { params(_sort_code: T.nilable(String)).returns(T.nilable(String)) }
def sort_code=(_sort_code); end
sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
def initialize(account_number: nil, sort_code: nil); end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
sig { params(_tax_id: String).returns(String) }
def tax_id=(_tax_id); end
sig { params(tax_id: String).void }
def initialize(tax_id: nil); end
end
class Cashapp < Stripe::RequestParams; end
class Crypto < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The customer's bank.
sig { returns(String) }
def bank; end
sig { params(_bank: String).returns(String) }
def bank=(_bank); end
sig { params(account_holder_type: T.nilable(String), bank: String).void }
def initialize(account_holder_type: nil, bank: nil); end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Klarna::Dob))
}
def dob; end
sig {
params(_dob: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Klarna::Dob)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Klarna::Dob))
}
def dob=(_dob); end
sig {
params(dob: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Klarna::Dob)).void
}
def initialize(dob: nil); end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
sig { returns(T.nilable(String)) }
def funding; end
sig { params(_funding: T.nilable(String)).returns(T.nilable(String)) }
def funding=(_funding); end
sig { params(funding: T.nilable(String)).void }
def initialize(funding: nil); end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
sig { params(_bank_code: String).returns(String) }
def bank_code=(_bank_code); end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
sig { params(_branch_code: String).returns(String) }
def branch_code=(_branch_code); end
# Attribute for param field reference
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# The suffix of the bank account number.
sig { returns(String) }
def suffix; end
sig { params(_suffix: String).returns(String) }
def suffix=(_suffix); end
sig {
params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
); end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Paypay < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig { returns(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Rechnung::Dob) }
def dob; end
sig {
params(_dob: ::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Rechnung::Dob).returns(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Rechnung::Dob)
}
def dob=(_dob); end
sig {
params(dob: ::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Rechnung::Dob).void
}
def initialize(dob: nil); end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
sig { returns(String) }
def iban; end
sig { params(_iban: String).returns(String) }
def iban=(_iban); end
sig { params(iban: String).void }
def initialize(iban: nil); end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
sig { params(account: T.nilable(String), source_type: T.nilable(String)).void }
def initialize(account: nil, source_type: nil); end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig {
params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String))
}
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AcssDebit)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Affirm)) }
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Affirm)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Affirm))
}
def affirm=(_affirm); end
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AfterpayClearpay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Alipay)) }
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Alipay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Alipay))
}
def alipay=(_alipay); end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Alma)) }
def alma; end
sig {
params(_alma: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Alma)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Alma))
}
def alma=(_alma); end
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AmazonPay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AuBecsDebit)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BacsDebit)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Bancontact)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Bancontact))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Billie)) }
def billie; end
sig {
params(_billie: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Billie)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Billie))
}
def billie=(_billie); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BillingDetails)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Blik)) }
def blik; end
sig {
params(_blik: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Blik)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Blik))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Boleto)) }
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Boleto)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Boleto))
}
def boleto=(_boleto); end
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Cashapp)) }
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Cashapp)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Cashapp))
}
def cashapp=(_cashapp); end
# If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Crypto)) }
def crypto; end
sig {
params(_crypto: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Crypto)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Crypto))
}
def crypto=(_crypto); end
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::CustomerBalance)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Eps)) }
def eps; end
sig {
params(_eps: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Eps)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Eps))
}
def eps=(_eps); end
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Fpx)) }
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Fpx)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Fpx))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Giropay)) }
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Giropay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Giropay))
}
def giropay=(_giropay); end
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Gopay)) }
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Gopay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Gopay))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Grabpay)) }
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Grabpay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Grabpay))
}
def grabpay=(_grabpay); end
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::IdBankTransfer)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Ideal)) }
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Ideal)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Ideal))
}
def ideal=(_ideal); end
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::InteracPresent))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::InteracPresent)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::InteracPresent))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::KakaoPay))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::KakaoPay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Klarna)) }
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Klarna)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Klarna))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Konbini)) }
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Konbini)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Konbini))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::KrCard)) }
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::KrCard)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::KrCard))
}
def kr_card=(_kr_card); end
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Link)) }
def link; end
sig {
params(_link: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Link)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Link))
}
def link=(_link); end
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::MbWay)) }
def mb_way; end
sig {
params(_mb_way: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::MbWay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::MbWay))
}
def mb_way=(_mb_way); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Mobilepay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Mobilepay))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Multibanco)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Multibanco))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::NaverPay))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::NaverPay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::NaverPay))
}
def naver_pay=(_naver_pay); end
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::NzBankAccount)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Oxxo)) }
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Oxxo)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Oxxo))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::P24)) }
def p24; end
sig {
params(_p24: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::P24)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::P24))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::PayByBank)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Payco)) }
def payco; end
sig {
params(_payco: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Payco)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Payco))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Paynow)) }
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Paynow)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Paynow))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Paypal)) }
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Paypal)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Paypal))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Paypay)) }
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Paypay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Paypay))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Payto)) }
def payto; end
sig {
params(_payto: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Payto)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Payto))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Pix)) }
def pix; end
sig {
params(_pix: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Pix)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Pix))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Promptpay))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Promptpay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Promptpay))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Qris)) }
def qris; end
sig {
params(_qris: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Qris)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Qris))
}
def qris=(_qris); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::RadarOptions))
}
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::RadarOptions)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::RadarOptions))
}
def radar_options=(_radar_options); end
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Rechnung))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Rechnung)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Rechnung))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::RevolutPay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::SamsungPay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Satispay))
}
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Satispay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Satispay))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::SepaDebit)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Shopeepay))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Shopeepay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Shopeepay))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Sofort)) }
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Sofort)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Sofort))
}
def sofort=(_sofort); end
# This hash contains details about the Stripe balance payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::StripeBalance))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::StripeBalance)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Swish)) }
def swish; end
sig {
params(_swish: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Swish)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Swish))
}
def swish=(_swish); end
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Twint)) }
def twint; end
sig {
params(_twint: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Twint)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Twint))
}
def twint=(_twint); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::UsBankAccount)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::WechatPay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Zip)) }
def zip; end
sig {
params(_zip: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Zip)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Cashapp), crypto: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Crypto), customer_balance: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Giropay), gopay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Gopay), grabpay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Grabpay), id_bank_transfer: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::IdBankTransfer), ideal: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Link), mb_way: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::MbWay), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Paypal), paypay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Paypay), payto: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Payto), pix: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Promptpay), qris: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Qris), radar_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::RadarOptions), rechnung: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Rechnung), revolut_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::SepaDebit), shopeepay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Shopeepay), sofort: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Sofort), stripe_balance: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::StripeBalance), swish: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# List of Stripe products where this mandate can be selected automatically.
sig { returns(T.nilable(T::Array[String])) }
def default_for; end
sig {
params(_default_for: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def default_for=(_default_for); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), default_for: T.nilable(T::Array[String]), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
default_for: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(currency: T.nilable(String), mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
}
def initialize(currency: nil, mandate_options: nil, verification_method: nil); end
end
class AmazonPay < Stripe::RequestParams; end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class Card < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(String) }
def amount_type; end
sig { params(_amount_type: String).returns(String) }
def amount_type=(_amount_type); end
# Currency in which future payments will be charged. 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Unique identifier for the mandate or subscription.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
sig { returns(Integer) }
def start_date; end
sig { params(_start_date: Integer).returns(Integer) }
def start_date=(_start_date); end
# Specifies the type of mandates supported. Possible values are `india`.
sig { returns(T.nilable(T::Array[String])) }
def supported_types; end
sig {
params(_supported_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def supported_types=(_supported_types); end
sig {
params(amount: Integer, amount_type: String, currency: String, description: T.nilable(String), end_date: T.nilable(Integer), interval: String, interval_count: T.nilable(Integer), reference: String, start_date: Integer, supported_types: T.nilable(T::Array[String])).void
}
def initialize(
amount: nil,
amount_type: nil,
currency: nil,
description: nil,
end_date: nil,
interval: nil,
interval_count: nil,
reference: nil,
start_date: nil,
supported_types: nil
); end
end
class ThreeDSecure < Stripe::RequestParams
class NetworkOptions < Stripe::RequestParams
class CartesBancaires < Stripe::RequestParams
# The cryptogram calculation algorithm used by the card Issuer's ACS
# to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
# messageExtension: CB-AVALGO
sig { returns(String) }
def cb_avalgo; end
sig { params(_cb_avalgo: String).returns(String) }
def cb_avalgo=(_cb_avalgo); end
# The exemption indicator returned from Cartes Bancaires in the ARes.
# message extension: CB-EXEMPTION; string (4 characters)
# This is a 3 byte bitmap (low significant byte first and most significant
# bit first) that has been Base64 encoded
sig { returns(T.nilable(String)) }
def cb_exemption; end
sig { params(_cb_exemption: T.nilable(String)).returns(T.nilable(String)) }
def cb_exemption=(_cb_exemption); end
# The risk score returned from Cartes Bancaires in the ARes.
# message extension: CB-SCORE; numeric value 0-99
sig { returns(T.nilable(Integer)) }
def cb_score; end
sig { params(_cb_score: T.nilable(Integer)).returns(T.nilable(Integer)) }
def cb_score=(_cb_score); end
sig {
params(cb_avalgo: String, cb_exemption: T.nilable(String), cb_score: T.nilable(Integer)).void
}
def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil); end
end
# Cartes Bancaires-specific 3DS fields.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires; end
sig {
params(_cartes_bancaires: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires=(_cartes_bancaires); end
sig {
params(cartes_bancaires: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).void
}
def initialize(cartes_bancaires: nil); end
end
# The `transStatus` returned from the card Issuer’s ACS in the ARes.
sig { returns(T.nilable(String)) }
def ares_trans_status; end
sig { params(_ares_trans_status: T.nilable(String)).returns(T.nilable(String)) }
def ares_trans_status=(_ares_trans_status); end
# The cryptogram, also known as the "authentication value" (AAV, CAVV or
# AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
# (Most 3D Secure providers will return the base64-encoded version, which
# is what you should specify here.)
sig { returns(T.nilable(String)) }
def cryptogram; end
sig { params(_cryptogram: T.nilable(String)).returns(T.nilable(String)) }
def cryptogram=(_cryptogram); end
# The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
# provider and indicates what degree of authentication was performed.
sig { returns(T.nilable(String)) }
def electronic_commerce_indicator; end
sig {
params(_electronic_commerce_indicator: T.nilable(String)).returns(T.nilable(String))
}
def electronic_commerce_indicator=(_electronic_commerce_indicator); end
# Network specific 3DS fields. Network specific arguments require an
# explicit card brand choice. The parameter `payment_method_options.card.network``
# must be populated accordingly
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options; end
sig {
params(_network_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options=(_network_options); end
# The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
# AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
sig { returns(T.nilable(String)) }
def requestor_challenge_indicator; end
sig {
params(_requestor_challenge_indicator: T.nilable(String)).returns(T.nilable(String))
}
def requestor_challenge_indicator=(_requestor_challenge_indicator); end
# For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
# Transaction ID (dsTransID).
sig { returns(T.nilable(String)) }
def transaction_id; end
sig { params(_transaction_id: T.nilable(String)).returns(T.nilable(String)) }
def transaction_id=(_transaction_id); end
# The version of 3D Secure that was performed.
sig { returns(T.nilable(String)) }
def version; end
sig { params(_version: T.nilable(String)).returns(T.nilable(String)) }
def version=(_version); end
sig {
params(ares_trans_status: T.nilable(String), cryptogram: T.nilable(String), electronic_commerce_indicator: T.nilable(String), network_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions), requestor_challenge_indicator: T.nilable(String), transaction_id: T.nilable(String), version: T.nilable(String)).void
}
def initialize(
ares_trans_status: nil,
cryptogram: nil,
electronic_commerce_indicator: nil,
network_options: nil,
requestor_challenge_indicator: nil,
transaction_id: nil,
version: nil
); end
end
# Configuration options for setting up an eMandate for cards issued in India.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options=(_mandate_options); end
# When specified, this parameter signals that a card has been collected
# as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
# parameter can only be provided during confirmation.
sig { returns(T.nilable(T::Boolean)) }
def moto; end
sig { params(_moto: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def moto=(_moto); end
# Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
# If 3D Secure authentication was performed with a third-party provider,
# the authentication details to use for this setup.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure; end
sig {
params(_three_d_secure: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure=(_three_d_secure); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::MandateOptions), moto: T.nilable(T::Boolean), network: T.nilable(String), request_three_d_secure: T.nilable(String), three_d_secure: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure)).void
}
def initialize(
mandate_options: nil,
moto: nil,
network: nil,
request_three_d_secure: nil,
three_d_secure: nil
); end
end
class CardPresent < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class OnDemand < Stripe::RequestParams
# Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def average_amount; end
sig { params(_average_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def average_amount=(_average_amount); end
# The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def maximum_amount; end
sig { params(_maximum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_amount=(_maximum_amount); end
# The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Interval at which the customer is making purchases
sig { returns(T.nilable(String)) }
def purchase_interval; end
sig { params(_purchase_interval: T.nilable(String)).returns(T.nilable(String)) }
def purchase_interval=(_purchase_interval); end
# The number of `purchase_interval` between charges
sig { returns(T.nilable(Integer)) }
def purchase_interval_count; end
sig { params(_purchase_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def purchase_interval_count=(_purchase_interval_count); end
sig {
params(average_amount: T.nilable(Integer), maximum_amount: T.nilable(Integer), minimum_amount: T.nilable(Integer), purchase_interval: T.nilable(String), purchase_interval_count: T.nilable(Integer)).void
}
def initialize(
average_amount: nil,
maximum_amount: nil,
minimum_amount: nil,
purchase_interval: nil,
purchase_interval_count: nil
); end
end
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
}
def next_billing; end
sig {
params(_next_billing: ::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Klarna::Subscription::NextBilling).returns(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: ::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Klarna::Subscription::NextBilling, reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# The currency of the SetupIntent. Three letter ISO currency code.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# On-demand details if setting up a payment method for on-demand payments.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand; end
sig {
params(_on_demand: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Klarna::OnDemand)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand=(_on_demand); end
# Preferred language of the Klarna authorization page that the customer is redirected to
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Subscription details if setting up or charging a subscription
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(currency: T.nilable(String), on_demand: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Klarna::OnDemand), preferred_locale: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(
currency: nil,
on_demand: nil,
preferred_locale: nil,
subscriptions: nil
); end
end
class Link < Stripe::RequestParams
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
sig { params(_persistent_token: T.nilable(String)).returns(T.nilable(String)) }
def persistent_token=(_persistent_token); end
sig { params(persistent_token: T.nilable(String)).void }
def initialize(persistent_token: nil); end
end
class Paypal < Stripe::RequestParams
# The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
sig { returns(T.nilable(String)) }
def billing_agreement_id; end
sig { params(_billing_agreement_id: T.nilable(String)).returns(T.nilable(String)) }
def billing_agreement_id=(_billing_agreement_id); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(billing_agreement_id: T.nilable(String), currency: T.nilable(String), subsellers: T.nilable(T::Array[String])).void
}
def initialize(billing_agreement_id: nil, currency: nil, subsellers: nil); end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
sig { params(_payments_per_period: T.nilable(Integer)).returns(T.nilable(Integer)) }
def payments_per_period=(_payments_per_period); end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
sig { params(_purpose: T.nilable(String)).returns(T.nilable(String)) }
def purpose=(_purpose); end
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), payments_per_period: T.nilable(Integer), purpose: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil,
start_date: nil
); end
end
# Additional fields for Mandate creation.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Payto::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Payto::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Type of amount. Defaults to `maximum`.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), amount_type: T.nilable(String), currency: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), reference: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
amount_type: nil,
currency: nil,
end_date: nil,
payment_schedule: nil,
reference: nil,
start_date: nil
); end
end
# Additional fields for mandate creation.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
class ManualEntry < Stripe::RequestParams
# Settings for configuring manual entry of account details.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
sig { params(mode: String).void }
def initialize(mode: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# Customize manual entry behavior
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry; end
sig {
params(_manual_entry: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry=(_manual_entry); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(filters: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), manual_entry: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
}
def initialize(
filters: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
); end
end
class MandateOptions < Stripe::RequestParams
# The method used to collect offline mandate customer acceptance.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
sig { params(collection_method: T.nilable(String)).void }
def initialize(collection_method: nil); end
end
class Networks < Stripe::RequestParams
# Triggers validations to run across the selected networks
sig { returns(T.nilable(T::Array[String])) }
def requested; end
sig {
params(_requested: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested=(_requested); end
sig { params(requested: T.nilable(T::Array[String])).void }
def initialize(requested: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Additional fields for network related functions
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks; end
sig {
params(_networks: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks=(_networks); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks), verification_method: T.nilable(String)).void
}
def initialize(
financial_connections: nil,
mandate_options: nil,
networks: nil,
verification_method: nil
); end
end
# If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AcssDebit)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AmazonPay)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::BacsDebit)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# Configuration for any card setup attempted on this SetupIntent.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card)) }
def card; end
sig {
params(_card: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card))
}
def card=(_card); end
# If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::CardPresent))
}
def card_present=(_card_present); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Link)) }
def link; end
sig {
params(_link: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Link)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Link))
}
def link=(_link); end
# If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
# If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Payto))
}
def payto; end
sig {
params(_payto: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Payto)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Payto))
}
def payto=(_payto); end
# If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Pix)) }
def pix; end
sig {
params(_pix: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Pix)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Pix))
}
def pix=(_pix); end
# If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::SepaDebit)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
sig {
params(acss_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AcssDebit), amazon_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AmazonPay), bacs_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::BacsDebit), card: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::CardPresent), klarna: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Klarna), link: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Link), paypal: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Paypal), payto: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Payto), pix: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Pix), sepa_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::SepaDebit), us_bank_account: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount)).void
}
def initialize(
acss_debit: nil,
amazon_pay: nil,
bacs_debit: nil,
card: nil,
card_present: nil,
klarna: nil,
link: nil,
paypal: nil,
payto: nil,
pix: nil,
sepa_debit: nil,
us_bank_account: nil
); end
end
# ID of the ConfirmationToken used to confirm this SetupIntent.
#
# If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.
sig { returns(T.nilable(String)) }
def confirmation_token; end
sig { params(_confirmation_token: T.nilable(String)).returns(T.nilable(String)) }
def confirmation_token=(_confirmation_token); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Attribute for param field mandate_data
sig { returns(T.nilable(T.any(String, ::Stripe::SetupIntent::ConfirmParams::MandateData))) }
def mandate_data; end
sig {
params(_mandate_data: T.nilable(T.any(String, ::Stripe::SetupIntent::ConfirmParams::MandateData))).returns(T.nilable(T.any(String, ::Stripe::SetupIntent::ConfirmParams::MandateData)))
}
def mandate_data=(_mandate_data); end
# ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)
# value in the SetupIntent.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData)) }
def payment_method_data; end
sig {
params(_payment_method_data: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData))
}
def payment_method_data=(_payment_method_data); end
# Payment method-specific configuration for this SetupIntent.
sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions)) }
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The URL to redirect your customer back to after they authenticate on the payment method's app or site.
# If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
# This parameter is only used for cards and other redirect-based payment methods.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
sig { returns(T.nilable(T::Boolean)) }
def use_stripe_sdk; end
sig { params(_use_stripe_sdk: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def use_stripe_sdk=(_use_stripe_sdk); end
sig {
params(confirmation_token: T.nilable(String), expand: T.nilable(T::Array[String]), mandate_data: T.nilable(T.any(String, ::Stripe::SetupIntent::ConfirmParams::MandateData)), payment_method: T.nilable(String), payment_method_data: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions), return_url: T.nilable(String), use_stripe_sdk: T.nilable(T::Boolean)).void
}
def initialize(
confirmation_token: nil,
expand: nil,
mandate_data: nil,
payment_method: nil,
payment_method_data: nil,
payment_method_options: nil,
return_url: nil,
use_stripe_sdk: nil
); end
end
class VerifyMicrodepositsParams < Stripe::RequestParams
# Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.
sig { returns(T.nilable(T::Array[Integer])) }
def amounts; end
sig { params(_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer])) }
def amounts=(_amounts); end
# A six-character code starting with SM present in the microdeposit sent to the bank account.
sig { returns(T.nilable(String)) }
def descriptor_code; end
sig { params(_descriptor_code: T.nilable(String)).returns(T.nilable(String)) }
def descriptor_code=(_descriptor_code); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(amounts: T.nilable(T::Array[Integer]), descriptor_code: T.nilable(String), expand: T.nilable(T::Array[String])).void
}
def initialize(amounts: nil, descriptor_code: nil, expand: nil); end
end
# You can cancel a SetupIntent object when it's in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
#
# After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead.
sig {
params(params: T.any(::Stripe::SetupIntent::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
}
def cancel(params = {}, opts = {}); end
# You can cancel a SetupIntent object when it's in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
#
# After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead.
sig {
params(intent: String, params: T.any(::Stripe::SetupIntent::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
}
def self.cancel(intent, params = {}, opts = {}); end
# Confirm that your customer intends to set up the current or
# provided payment method. For example, you would confirm a SetupIntent
# when a customer hits the “Save” button on a payment method management
# page on your website.
#
# If the selected payment method does not require any additional
# steps from the customer, the SetupIntent will transition to the
# succeeded status.
#
# Otherwise, it will transition to the requires_action status and
# suggest additional actions via next_action. If setup fails,
# the SetupIntent will transition to the
# requires_payment_method status or the canceled status if the
# confirmation limit is reached.
sig {
params(params: T.any(::Stripe::SetupIntent::ConfirmParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
}
def confirm(params = {}, opts = {}); end
# Confirm that your customer intends to set up the current or
# provided payment method. For example, you would confirm a SetupIntent
# when a customer hits the “Save” button on a payment method management
# page on your website.
#
# If the selected payment method does not require any additional
# steps from the customer, the SetupIntent will transition to the
# succeeded status.
#
# Otherwise, it will transition to the requires_action status and
# suggest additional actions via next_action. If setup fails,
# the SetupIntent will transition to the
# requires_payment_method status or the canceled status if the
# confirmation limit is reached.
sig {
params(intent: String, params: T.any(::Stripe::SetupIntent::ConfirmParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
}
def self.confirm(intent, params = {}, opts = {}); end
# Creates a SetupIntent object.
#
# After you create the SetupIntent, attach a payment method and [confirm](https://docs.stripe.com/docs/api/setup_intents/confirm)
# it to collect any required permissions to charge the payment method later.
sig {
params(params: T.any(::Stripe::SetupIntent::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
}
def self.create(params = {}, opts = {}); end
# Returns a list of SetupIntents.
sig {
params(params: T.any(::Stripe::SetupIntent::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates a SetupIntent object.
sig {
params(intent: String, params: T.any(::Stripe::SetupIntent::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
}
def self.update(intent, params = {}, opts = {}); end
# Verifies microdeposits on a SetupIntent object.
sig {
params(params: T.any(::Stripe::SetupIntent::VerifyMicrodepositsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
}
def verify_microdeposits(params = {}, opts = {}); end
# Verifies microdeposits on a SetupIntent object.
sig {
params(intent: String, params: T.any(::Stripe::SetupIntent::VerifyMicrodepositsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
}
def self.verify_microdeposits(intent, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# Shipping rates describe the price of shipping presented to your customers and
# applied to a purchase. For more information, see [Charge for shipping](https://stripe.com/docs/payments/during-payment/charge-shipping).
class ShippingRate < APIResource
class DeliveryEstimate < Stripe::StripeObject
class Maximum < Stripe::StripeObject
# A unit of time.
sig { returns(String) }
def unit; end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
end
class Minimum < Stripe::StripeObject
# A unit of time.
sig { returns(String) }
def unit; end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
end
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
sig { returns(T.nilable(Maximum)) }
def maximum; end
# The lower bound of the estimated range. If empty, represents no lower bound.
sig { returns(T.nilable(Minimum)) }
def minimum; end
end
class FixedAmount < Stripe::StripeObject
class CurrencyOptions < Stripe::StripeObject
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(String) }
def tax_behavior; end
end
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig { returns(T.nilable(T::Hash[String, CurrencyOptions])) }
def currency_options; end
end
# Whether the shipping rate can be used for new purchases. Defaults to `true`.
sig { returns(T::Boolean) }
def active; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(T.nilable(DeliveryEstimate)) }
def delivery_estimate; end
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(T.nilable(String)) }
def display_name; end
# Attribute for field fixed_amount
sig { returns(T.nilable(FixedAmount)) }
def fixed_amount; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
sig { returns(T.nilable(T.any(String, Stripe::TaxCode))) }
def tax_code; end
# The type of calculation to use on the shipping rate.
sig { returns(String) }
def type; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return shipping rates that are active or inactive.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
sig { returns(T.nilable(T.any(::Stripe::ShippingRate::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::ShippingRate::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::ShippingRate::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return shipping rates for the given currency.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::ShippingRate::ListParams::Created, Integer)), currency: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
active: nil,
created: nil,
currency: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class DeliveryEstimate < Stripe::RequestParams
class Maximum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
class Minimum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
sig { returns(T.nilable(::Stripe::ShippingRate::CreateParams::DeliveryEstimate::Maximum)) }
def maximum; end
sig {
params(_maximum: T.nilable(::Stripe::ShippingRate::CreateParams::DeliveryEstimate::Maximum)).returns(T.nilable(::Stripe::ShippingRate::CreateParams::DeliveryEstimate::Maximum))
}
def maximum=(_maximum); end
# The lower bound of the estimated range. If empty, represents no lower bound.
sig { returns(T.nilable(::Stripe::ShippingRate::CreateParams::DeliveryEstimate::Minimum)) }
def minimum; end
sig {
params(_minimum: T.nilable(::Stripe::ShippingRate::CreateParams::DeliveryEstimate::Minimum)).returns(T.nilable(::Stripe::ShippingRate::CreateParams::DeliveryEstimate::Minimum))
}
def minimum=(_minimum); end
sig {
params(maximum: T.nilable(::Stripe::ShippingRate::CreateParams::DeliveryEstimate::Maximum), minimum: T.nilable(::Stripe::ShippingRate::CreateParams::DeliveryEstimate::Minimum)).void
}
def initialize(maximum: nil, minimum: nil); end
end
class FixedAmount < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig { params(amount: Integer, tax_behavior: T.nilable(String)).void }
def initialize(amount: nil, tax_behavior: nil); end
end
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::ShippingRate::CreateParams::FixedAmount::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::ShippingRate::CreateParams::FixedAmount::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::ShippingRate::CreateParams::FixedAmount::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(amount: Integer, currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::ShippingRate::CreateParams::FixedAmount::CurrencyOptions])).void
}
def initialize(amount: nil, currency: nil, currency_options: nil); end
end
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(T.nilable(::Stripe::ShippingRate::CreateParams::DeliveryEstimate)) }
def delivery_estimate; end
sig {
params(_delivery_estimate: T.nilable(::Stripe::ShippingRate::CreateParams::DeliveryEstimate)).returns(T.nilable(::Stripe::ShippingRate::CreateParams::DeliveryEstimate))
}
def delivery_estimate=(_delivery_estimate); end
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
sig { returns(T.nilable(::Stripe::ShippingRate::CreateParams::FixedAmount)) }
def fixed_amount; end
sig {
params(_fixed_amount: T.nilable(::Stripe::ShippingRate::CreateParams::FixedAmount)).returns(T.nilable(::Stripe::ShippingRate::CreateParams::FixedAmount))
}
def fixed_amount=(_fixed_amount); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The type of calculation to use on the shipping rate.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(delivery_estimate: T.nilable(::Stripe::ShippingRate::CreateParams::DeliveryEstimate), display_name: String, expand: T.nilable(T::Array[String]), fixed_amount: T.nilable(::Stripe::ShippingRate::CreateParams::FixedAmount), metadata: T.nilable(T::Hash[String, String]), tax_behavior: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
delivery_estimate: nil,
display_name: nil,
expand: nil,
fixed_amount: nil,
metadata: nil,
tax_behavior: nil,
tax_code: nil,
type: nil
); end
end
class UpdateParams < Stripe::RequestParams
class FixedAmount < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A non-negative integer in cents representing how much to charge.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig { params(amount: T.nilable(Integer), tax_behavior: T.nilable(String)).void }
def initialize(amount: nil, tax_behavior: nil); end
end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::ShippingRate::UpdateParams::FixedAmount::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::ShippingRate::UpdateParams::FixedAmount::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::ShippingRate::UpdateParams::FixedAmount::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(currency_options: T.nilable(T::Hash[String, ::Stripe::ShippingRate::UpdateParams::FixedAmount::CurrencyOptions])).void
}
def initialize(currency_options: nil); end
end
# Whether the shipping rate can be used for new purchases. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
sig { returns(T.nilable(::Stripe::ShippingRate::UpdateParams::FixedAmount)) }
def fixed_amount; end
sig {
params(_fixed_amount: T.nilable(::Stripe::ShippingRate::UpdateParams::FixedAmount)).returns(T.nilable(::Stripe::ShippingRate::UpdateParams::FixedAmount))
}
def fixed_amount=(_fixed_amount); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig {
params(active: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), fixed_amount: T.nilable(::Stripe::ShippingRate::UpdateParams::FixedAmount), metadata: T.nilable(T.any(String, T::Hash[String, String])), tax_behavior: T.nilable(String)).void
}
def initialize(
active: nil,
expand: nil,
fixed_amount: nil,
metadata: nil,
tax_behavior: nil
); end
end
# Creates a new shipping rate object.
sig {
params(params: T.any(::Stripe::ShippingRate::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ShippingRate)
}
def self.create(params = {}, opts = {}); end
# Returns a list of your shipping rates.
sig {
params(params: T.any(::Stripe::ShippingRate::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates an existing shipping rate object.
sig {
params(shipping_rate_token: String, params: T.any(::Stripe::ShippingRate::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ShippingRate)
}
def self.update(shipping_rate_token, params = {}, opts = {}); end
end
end
# typed: true
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
class Error < Stripe::StripeObject
# Information about the run failure.
sig { returns(String) }
def message; end
end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# When the query was run, Sigma contained a snapshot of your Stripe data at this time.
sig { returns(Integer) }
def data_load_time; end
# Attribute for field error
sig { returns(T.nilable(Error)) }
def error; end
# The file object representing the results of the query.
sig { returns(T.nilable(Stripe::File)) }
def file; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Time at which the result expires and is no longer available for download.
sig { returns(Integer) }
def result_available_until; end
# SQL for the query.
sig { returns(String) }
def sql; end
# The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise.
sig { returns(String) }
def status; end
# Title of the query.
sig { returns(String) }
def title; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Returns a list of scheduled query runs.
sig {
params(params: T.any(::Stripe::Sigma::ScheduledQueryRun::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: 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
class AchCreditTransfer < Stripe::StripeObject
# Customer data associated with the transfer.
sig { returns(T.nilable(String)) }
def customer_data; end
# Bank account fingerprint associated with the transfer.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last 4 digits of the account number associated with the transfer.
sig { returns(T.nilable(String)) }
def last4; end
# Routing number associated with the transfer.
sig { returns(T.nilable(String)) }
def routing_number; end
end
class ChfCreditTransfer < Stripe::StripeObject
# Reference associated with the transfer.
sig { returns(T.nilable(String)) }
def reference; end
# Sender's country address.
sig { returns(T.nilable(String)) }
def sender_address_country; end
# Sender's line 1 address.
sig { returns(T.nilable(String)) }
def sender_address_line1; end
# Sender's bank account IBAN.
sig { returns(T.nilable(String)) }
def sender_iban; end
# Sender's name.
sig { returns(T.nilable(String)) }
def sender_name; end
end
class GbpCreditTransfer < Stripe::StripeObject
# Bank account fingerprint associated with the Stripe owned bank account receiving the transfer.
sig { returns(T.nilable(String)) }
def fingerprint; end
# The credit transfer rails the sender used to push this transfer. The possible rails are: Faster Payments, BACS, CHAPS, and wire transfers. Currently only Faster Payments is supported.
sig { returns(T.nilable(String)) }
def funding_method; end
# Last 4 digits of sender account number associated with the transfer.
sig { returns(T.nilable(String)) }
def last4; end
# Sender entered arbitrary information about the transfer.
sig { returns(T.nilable(String)) }
def reference; end
# Sender account number associated with the transfer.
sig { returns(T.nilable(String)) }
def sender_account_number; end
# Sender name associated with the transfer.
sig { returns(T.nilable(String)) }
def sender_name; end
# Sender sort code associated with the transfer.
sig { returns(T.nilable(String)) }
def sender_sort_code; end
end
class PaperCheck < Stripe::StripeObject
# Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(String)) }
def available_at; end
# Comma-separated list of invoice IDs associated with the paper check.
sig { returns(T.nilable(String)) }
def invoices; end
end
class SepaCreditTransfer < Stripe::StripeObject
# Reference associated with the transfer.
sig { returns(T.nilable(String)) }
def reference; end
# Sender's bank account IBAN.
sig { returns(T.nilable(String)) }
def sender_iban; end
# Sender's name.
sig { returns(T.nilable(String)) }
def sender_name; end
end
# Attribute for field ach_credit_transfer
sig { returns(T.nilable(AchCreditTransfer)) }
def ach_credit_transfer; end
# A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount your customer has pushed to the receiver.
sig { returns(Integer) }
def amount; end
# Attribute for field chf_credit_transfer
sig { returns(T.nilable(ChfCreditTransfer)) }
def chf_credit_transfer; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# Attribute for field gbp_credit_transfer
sig { returns(T.nilable(GbpCreditTransfer)) }
def gbp_credit_transfer; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Attribute for field paper_check
sig { returns(T.nilable(PaperCheck)) }
def paper_check; end
# Attribute for field sepa_credit_transfer
sig { returns(T.nilable(SepaCreditTransfer)) }
def sepa_credit_transfer; end
# The ID of the source this transaction is attached to.
sig { returns(String) }
def source; end
# The status of the transaction, one of `succeeded`, `pending`, or `failed`.
sig { returns(String) }
def status; end
# The type of source this transaction is attached to.
sig { returns(String) }
def type; end
end
end
# typed: 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.
#
# Stripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).
# We recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).
# This newer API provides access to our latest features and payment method types.
#
# Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).
class Source < APIResource
class AchCreditTransfer < Stripe::StripeObject
# Attribute for field account_number
sig { returns(T.nilable(String)) }
def account_number; end
# Attribute for field bank_name
sig { returns(T.nilable(String)) }
def bank_name; end
# Attribute for field fingerprint
sig { returns(T.nilable(String)) }
def fingerprint; end
# Attribute for field refund_account_holder_name
sig { returns(T.nilable(String)) }
def refund_account_holder_name; end
# Attribute for field refund_account_holder_type
sig { returns(T.nilable(String)) }
def refund_account_holder_type; end
# Attribute for field refund_routing_number
sig { returns(T.nilable(String)) }
def refund_routing_number; end
# Attribute for field routing_number
sig { returns(T.nilable(String)) }
def routing_number; end
# Attribute for field swift_code
sig { returns(T.nilable(String)) }
def swift_code; end
end
class AchDebit < Stripe::StripeObject
# Attribute for field bank_name
sig { returns(T.nilable(String)) }
def bank_name; end
# Attribute for field country
sig { returns(T.nilable(String)) }
def country; end
# Attribute for field fingerprint
sig { returns(T.nilable(String)) }
def fingerprint; end
# Attribute for field last4
sig { returns(T.nilable(String)) }
def last4; end
# Attribute for field routing_number
sig { returns(T.nilable(String)) }
def routing_number; end
# Attribute for field type
sig { returns(T.nilable(String)) }
def type; end
end
class AcssDebit < Stripe::StripeObject
# Attribute for field bank_address_city
sig { returns(T.nilable(String)) }
def bank_address_city; end
# Attribute for field bank_address_line_1
sig { returns(T.nilable(String)) }
def bank_address_line_1; end
# Attribute for field bank_address_line_2
sig { returns(T.nilable(String)) }
def bank_address_line_2; end
# Attribute for field bank_address_postal_code
sig { returns(T.nilable(String)) }
def bank_address_postal_code; end
# Attribute for field bank_name
sig { returns(T.nilable(String)) }
def bank_name; end
# Attribute for field category
sig { returns(T.nilable(String)) }
def category; end
# Attribute for field country
sig { returns(T.nilable(String)) }
def country; end
# Attribute for field fingerprint
sig { returns(T.nilable(String)) }
def fingerprint; end
# Attribute for field last4
sig { returns(T.nilable(String)) }
def last4; end
# Attribute for field routing_number
sig { returns(T.nilable(String)) }
def routing_number; end
end
class Alipay < Stripe::StripeObject
# Attribute for field data_string
sig { returns(T.nilable(String)) }
def data_string; end
# Attribute for field native_url
sig { returns(T.nilable(String)) }
def native_url; end
# Attribute for field statement_descriptor
sig { returns(T.nilable(String)) }
def statement_descriptor; end
end
class AuBecsDebit < Stripe::StripeObject
# Attribute for field bsb_number
sig { returns(T.nilable(String)) }
def bsb_number; end
# Attribute for field fingerprint
sig { returns(T.nilable(String)) }
def fingerprint; end
# Attribute for field last4
sig { returns(T.nilable(String)) }
def last4; end
end
class Bancontact < Stripe::StripeObject
# Attribute for field bank_code
sig { returns(T.nilable(String)) }
def bank_code; end
# Attribute for field bank_name
sig { returns(T.nilable(String)) }
def bank_name; end
# Attribute for field bic
sig { returns(T.nilable(String)) }
def bic; end
# Attribute for field iban_last4
sig { returns(T.nilable(String)) }
def iban_last4; end
# Attribute for field preferred_language
sig { returns(T.nilable(String)) }
def preferred_language; end
# Attribute for field statement_descriptor
sig { returns(T.nilable(String)) }
def statement_descriptor; end
end
class Card < Stripe::StripeObject
# Attribute for field address_line1_check
sig { returns(T.nilable(String)) }
def address_line1_check; end
# Attribute for field address_zip_check
sig { returns(T.nilable(String)) }
def address_zip_check; end
# Attribute for field brand
sig { returns(T.nilable(String)) }
def brand; end
# Attribute for field brand_product
sig { returns(T.nilable(String)) }
def brand_product; end
# Attribute for field country
sig { returns(T.nilable(String)) }
def country; end
# Attribute for field cvc_check
sig { returns(T.nilable(String)) }
def cvc_check; end
# Attribute for field description
sig { returns(T.nilable(String)) }
def description; end
# Attribute for field dynamic_last4
sig { returns(T.nilable(String)) }
def dynamic_last4; end
# Attribute for field exp_month
sig { returns(T.nilable(Integer)) }
def exp_month; end
# Attribute for field exp_year
sig { returns(T.nilable(Integer)) }
def exp_year; end
# Attribute for field fingerprint
sig { returns(T.nilable(String)) }
def fingerprint; end
# Attribute for field funding
sig { returns(T.nilable(String)) }
def funding; end
# Attribute for field iin
sig { returns(T.nilable(String)) }
def iin; end
# Attribute for field issuer
sig { returns(T.nilable(String)) }
def issuer; end
# Attribute for field last4
sig { returns(T.nilable(String)) }
def last4; end
# Attribute for field name
sig { returns(T.nilable(String)) }
def name; end
# Attribute for field three_d_secure
sig { returns(T.nilable(String)) }
def three_d_secure; end
# Attribute for field tokenization_method
sig { returns(T.nilable(String)) }
def tokenization_method; end
end
class CardPresent < Stripe::StripeObject
# Attribute for field application_cryptogram
sig { returns(T.nilable(String)) }
def application_cryptogram; end
# Attribute for field application_preferred_name
sig { returns(T.nilable(String)) }
def application_preferred_name; end
# Attribute for field authorization_code
sig { returns(T.nilable(String)) }
def authorization_code; end
# Attribute for field authorization_response_code
sig { returns(T.nilable(String)) }
def authorization_response_code; end
# Attribute for field brand
sig { returns(T.nilable(String)) }
def brand; end
# Attribute for field brand_product
sig { returns(T.nilable(String)) }
def brand_product; end
# Attribute for field country
sig { returns(T.nilable(String)) }
def country; end
# Attribute for field cvm_type
sig { returns(T.nilable(String)) }
def cvm_type; end
# Attribute for field data_type
sig { returns(T.nilable(String)) }
def data_type; end
# Attribute for field dedicated_file_name
sig { returns(T.nilable(String)) }
def dedicated_file_name; end
# Attribute for field description
sig { returns(T.nilable(String)) }
def description; end
# Attribute for field emv_auth_data
sig { returns(T.nilable(String)) }
def emv_auth_data; end
# Attribute for field evidence_customer_signature
sig { returns(T.nilable(String)) }
def evidence_customer_signature; end
# Attribute for field evidence_transaction_certificate
sig { returns(T.nilable(String)) }
def evidence_transaction_certificate; end
# Attribute for field exp_month
sig { returns(T.nilable(Integer)) }
def exp_month; end
# Attribute for field exp_year
sig { returns(T.nilable(Integer)) }
def exp_year; end
# Attribute for field fingerprint
sig { returns(T.nilable(String)) }
def fingerprint; end
# Attribute for field funding
sig { returns(T.nilable(String)) }
def funding; end
# Attribute for field iin
sig { returns(T.nilable(String)) }
def iin; end
# Attribute for field issuer
sig { returns(T.nilable(String)) }
def issuer; end
# Attribute for field last4
sig { returns(T.nilable(String)) }
def last4; end
# Attribute for field pos_device_id
sig { returns(T.nilable(String)) }
def pos_device_id; end
# Attribute for field pos_entry_mode
sig { returns(T.nilable(String)) }
def pos_entry_mode; end
# Attribute for field read_method
sig { returns(T.nilable(String)) }
def read_method; end
# Attribute for field reader
sig { returns(T.nilable(String)) }
def reader; end
# Attribute for field terminal_verification_results
sig { returns(T.nilable(String)) }
def terminal_verification_results; end
# Attribute for field transaction_status_information
sig { returns(T.nilable(String)) }
def transaction_status_information; end
end
class CodeVerification < Stripe::StripeObject
# The number of attempts remaining to authenticate the source object with a verification code.
sig { returns(Integer) }
def attempts_remaining; end
# The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0).
sig { returns(String) }
def status; end
end
class Eps < Stripe::StripeObject
# Attribute for field reference
sig { returns(T.nilable(String)) }
def reference; end
# Attribute for field statement_descriptor
sig { returns(T.nilable(String)) }
def statement_descriptor; end
end
class Giropay < Stripe::StripeObject
# Attribute for field bank_code
sig { returns(T.nilable(String)) }
def bank_code; end
# Attribute for field bank_name
sig { returns(T.nilable(String)) }
def bank_name; end
# Attribute for field bic
sig { returns(T.nilable(String)) }
def bic; end
# Attribute for field statement_descriptor
sig { returns(T.nilable(String)) }
def statement_descriptor; end
end
class Ideal < Stripe::StripeObject
# Attribute for field bank
sig { returns(T.nilable(String)) }
def bank; end
# Attribute for field bic
sig { returns(T.nilable(String)) }
def bic; end
# Attribute for field iban_last4
sig { returns(T.nilable(String)) }
def iban_last4; end
# Attribute for field statement_descriptor
sig { returns(T.nilable(String)) }
def statement_descriptor; end
end
class Klarna < Stripe::StripeObject
# Attribute for field background_image_url
sig { returns(T.nilable(String)) }
def background_image_url; end
# Attribute for field client_token
sig { returns(T.nilable(String)) }
def client_token; end
# Attribute for field first_name
sig { returns(T.nilable(String)) }
def first_name; end
# Attribute for field last_name
sig { returns(T.nilable(String)) }
def last_name; end
# Attribute for field locale
sig { returns(T.nilable(String)) }
def locale; end
# Attribute for field logo_url
sig { returns(T.nilable(String)) }
def logo_url; end
# Attribute for field page_title
sig { returns(T.nilable(String)) }
def page_title; end
# Attribute for field pay_later_asset_urls_descriptive
sig { returns(T.nilable(String)) }
def pay_later_asset_urls_descriptive; end
# Attribute for field pay_later_asset_urls_standard
sig { returns(T.nilable(String)) }
def pay_later_asset_urls_standard; end
# Attribute for field pay_later_name
sig { returns(T.nilable(String)) }
def pay_later_name; end
# Attribute for field pay_later_redirect_url
sig { returns(T.nilable(String)) }
def pay_later_redirect_url; end
# Attribute for field pay_now_asset_urls_descriptive
sig { returns(T.nilable(String)) }
def pay_now_asset_urls_descriptive; end
# Attribute for field pay_now_asset_urls_standard
sig { returns(T.nilable(String)) }
def pay_now_asset_urls_standard; end
# Attribute for field pay_now_name
sig { returns(T.nilable(String)) }
def pay_now_name; end
# Attribute for field pay_now_redirect_url
sig { returns(T.nilable(String)) }
def pay_now_redirect_url; end
# Attribute for field pay_over_time_asset_urls_descriptive
sig { returns(T.nilable(String)) }
def pay_over_time_asset_urls_descriptive; end
# Attribute for field pay_over_time_asset_urls_standard
sig { returns(T.nilable(String)) }
def pay_over_time_asset_urls_standard; end
# Attribute for field pay_over_time_name
sig { returns(T.nilable(String)) }
def pay_over_time_name; end
# Attribute for field pay_over_time_redirect_url
sig { returns(T.nilable(String)) }
def pay_over_time_redirect_url; end
# Attribute for field payment_method_categories
sig { returns(T.nilable(String)) }
def payment_method_categories; end
# Attribute for field purchase_country
sig { returns(T.nilable(String)) }
def purchase_country; end
# Attribute for field purchase_type
sig { returns(T.nilable(String)) }
def purchase_type; end
# Attribute for field redirect_url
sig { returns(T.nilable(String)) }
def redirect_url; end
# Attribute for field shipping_delay
sig { returns(T.nilable(Integer)) }
def shipping_delay; end
# Attribute for field shipping_first_name
sig { returns(T.nilable(String)) }
def shipping_first_name; end
# Attribute for field shipping_last_name
sig { returns(T.nilable(String)) }
def shipping_last_name; end
end
class Multibanco < Stripe::StripeObject
# Attribute for field entity
sig { returns(T.nilable(String)) }
def entity; end
# Attribute for field reference
sig { returns(T.nilable(String)) }
def reference; end
# Attribute for field refund_account_holder_address_city
sig { returns(T.nilable(String)) }
def refund_account_holder_address_city; end
# Attribute for field refund_account_holder_address_country
sig { returns(T.nilable(String)) }
def refund_account_holder_address_country; end
# Attribute for field refund_account_holder_address_line1
sig { returns(T.nilable(String)) }
def refund_account_holder_address_line1; end
# Attribute for field refund_account_holder_address_line2
sig { returns(T.nilable(String)) }
def refund_account_holder_address_line2; end
# Attribute for field refund_account_holder_address_postal_code
sig { returns(T.nilable(String)) }
def refund_account_holder_address_postal_code; end
# Attribute for field refund_account_holder_address_state
sig { returns(T.nilable(String)) }
def refund_account_holder_address_state; end
# Attribute for field refund_account_holder_name
sig { returns(T.nilable(String)) }
def refund_account_holder_name; end
# Attribute for field refund_iban
sig { returns(T.nilable(String)) }
def refund_iban; end
end
class Owner < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class VerifiedAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Owner's address.
sig { returns(T.nilable(Address)) }
def address; end
# Owner's email address.
sig { returns(T.nilable(String)) }
def email; end
# Owner's full name.
sig { returns(T.nilable(String)) }
def name; end
# Owner's phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
# Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(VerifiedAddress)) }
def verified_address; end
# Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_email; end
# Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_name; end
# Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
sig { returns(T.nilable(String)) }
def verified_phone; end
end
class P24 < Stripe::StripeObject
# Attribute for field reference
sig { returns(T.nilable(String)) }
def reference; end
end
class Paypal < Stripe::StripeObject
# Attribute for field billing_agreement
sig { returns(T.nilable(String)) }
def billing_agreement; end
# Attribute for field fingerprint
sig { returns(T.nilable(String)) }
def fingerprint; end
# Attribute for field payer_id
sig { returns(T.nilable(String)) }
def payer_id; end
# Attribute for field reference_id
sig { returns(T.nilable(String)) }
def reference_id; end
# Attribute for field reference_transaction_amount
sig { returns(T.nilable(String)) }
def reference_transaction_amount; end
# Attribute for field reference_transaction_charged
sig { returns(T.nilable(T::Boolean)) }
def reference_transaction_charged; end
# Attribute for field statement_descriptor
sig { returns(T.nilable(String)) }
def statement_descriptor; end
# Attribute for field transaction_id
sig { returns(T.nilable(String)) }
def transaction_id; end
# Attribute for field verified_email
sig { returns(T.nilable(String)) }
def verified_email; end
end
class Receiver < Stripe::StripeObject
# The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
sig { returns(T.nilable(String)) }
def address; end
# The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.
sig { returns(Integer) }
def amount_charged; end
# The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.
sig { returns(Integer) }
def amount_received; end
# The total amount that was returned to the customer. The amount returned is expressed in the source's currency.
sig { returns(Integer) }
def amount_returned; end
# Type of refund attribute method, one of `email`, `manual`, or `none`.
sig { returns(String) }
def refund_attributes_method; end
# Type of refund attribute status, one of `missing`, `requested`, or `available`.
sig { returns(String) }
def refund_attributes_status; end
end
class Redirect < Stripe::StripeObject
# The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`.
sig { returns(T.nilable(String)) }
def failure_reason; end
# The URL you provide to redirect the customer to after they authenticated their payment.
sig { returns(String) }
def return_url; end
# The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (successful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused).
sig { returns(String) }
def status; end
# The URL provided to you to redirect a customer to as part of a `redirect` authentication flow.
sig { returns(String) }
def url; end
end
class SepaCreditTransfer < Stripe::StripeObject
# Attribute for field bank_name
sig { returns(T.nilable(String)) }
def bank_name; end
# Attribute for field bic
sig { returns(T.nilable(String)) }
def bic; end
# Attribute for field iban
sig { returns(T.nilable(String)) }
def iban; end
# Attribute for field refund_account_holder_address_city
sig { returns(T.nilable(String)) }
def refund_account_holder_address_city; end
# Attribute for field refund_account_holder_address_country
sig { returns(T.nilable(String)) }
def refund_account_holder_address_country; end
# Attribute for field refund_account_holder_address_line1
sig { returns(T.nilable(String)) }
def refund_account_holder_address_line1; end
# Attribute for field refund_account_holder_address_line2
sig { returns(T.nilable(String)) }
def refund_account_holder_address_line2; end
# Attribute for field refund_account_holder_address_postal_code
sig { returns(T.nilable(String)) }
def refund_account_holder_address_postal_code; end
# Attribute for field refund_account_holder_address_state
sig { returns(T.nilable(String)) }
def refund_account_holder_address_state; end
# Attribute for field refund_account_holder_name
sig { returns(T.nilable(String)) }
def refund_account_holder_name; end
# Attribute for field refund_iban
sig { returns(T.nilable(String)) }
def refund_iban; end
end
class SepaDebit < Stripe::StripeObject
# Attribute for field bank_code
sig { returns(T.nilable(String)) }
def bank_code; end
# Attribute for field branch_code
sig { returns(T.nilable(String)) }
def branch_code; end
# Attribute for field country
sig { returns(T.nilable(String)) }
def country; end
# Attribute for field fingerprint
sig { returns(T.nilable(String)) }
def fingerprint; end
# Attribute for field last4
sig { returns(T.nilable(String)) }
def last4; end
# Attribute for field mandate_reference
sig { returns(T.nilable(String)) }
def mandate_reference; end
# Attribute for field mandate_url
sig { returns(T.nilable(String)) }
def mandate_url; end
end
class Sofort < Stripe::StripeObject
# Attribute for field bank_code
sig { returns(T.nilable(String)) }
def bank_code; end
# Attribute for field bank_name
sig { returns(T.nilable(String)) }
def bank_name; end
# Attribute for field bic
sig { returns(T.nilable(String)) }
def bic; end
# Attribute for field country
sig { returns(T.nilable(String)) }
def country; end
# Attribute for field iban_last4
sig { returns(T.nilable(String)) }
def iban_last4; end
# Attribute for field preferred_language
sig { returns(T.nilable(String)) }
def preferred_language; end
# Attribute for field statement_descriptor
sig { returns(T.nilable(String)) }
def statement_descriptor; end
end
class SourceOrder < Stripe::StripeObject
class Item < Stripe::StripeObject
# The amount (price) for this order item.
sig { returns(T.nilable(Integer)) }
def amount; end
# This currency of this order item. Required when `amount` is present.
sig { returns(T.nilable(String)) }
def currency; end
# Human-readable description for this order item.
sig { returns(T.nilable(String)) }
def description; end
# The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).
sig { returns(T.nilable(String)) }
def parent; end
# The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.
sig { returns(T.nilable(Integer)) }
def quantity; end
# The type of this order item. Must be `sku`, `tax`, or `shipping`.
sig { returns(T.nilable(String)) }
def type; end
end
class Shipping < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(T.nilable(Address)) }
def address; end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
# Recipient name.
sig { returns(T.nilable(String)) }
def name; end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
end
# A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.
sig { returns(Integer) }
def amount; end
# 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) }
def currency; end
# The email address of the customer placing the order.
sig { returns(T.nilable(String)) }
def email; end
# List of items constituting the order.
sig { returns(T.nilable(T::Array[Item])) }
def items; end
# Attribute for field shipping
sig { returns(T.nilable(Shipping)) }
def shipping; end
end
class ThreeDSecure < Stripe::StripeObject
# Attribute for field address_line1_check
sig { returns(T.nilable(String)) }
def address_line1_check; end
# Attribute for field address_zip_check
sig { returns(T.nilable(String)) }
def address_zip_check; end
# Attribute for field authenticated
sig { returns(T.nilable(T::Boolean)) }
def authenticated; end
# Attribute for field brand
sig { returns(T.nilable(String)) }
def brand; end
# Attribute for field brand_product
sig { returns(T.nilable(String)) }
def brand_product; end
# Attribute for field card
sig { returns(T.nilable(String)) }
def card; end
# Attribute for field country
sig { returns(T.nilable(String)) }
def country; end
# Attribute for field customer
sig { returns(T.nilable(String)) }
def customer; end
# Attribute for field cvc_check
sig { returns(T.nilable(String)) }
def cvc_check; end
# Attribute for field description
sig { returns(T.nilable(String)) }
def description; end
# Attribute for field dynamic_last4
sig { returns(T.nilable(String)) }
def dynamic_last4; end
# Attribute for field exp_month
sig { returns(T.nilable(Integer)) }
def exp_month; end
# Attribute for field exp_year
sig { returns(T.nilable(Integer)) }
def exp_year; end
# Attribute for field fingerprint
sig { returns(T.nilable(String)) }
def fingerprint; end
# Attribute for field funding
sig { returns(T.nilable(String)) }
def funding; end
# Attribute for field iin
sig { returns(T.nilable(String)) }
def iin; end
# Attribute for field issuer
sig { returns(T.nilable(String)) }
def issuer; end
# Attribute for field last4
sig { returns(T.nilable(String)) }
def last4; end
# Attribute for field name
sig { returns(T.nilable(String)) }
def name; end
# Attribute for field three_d_secure
sig { returns(T.nilable(String)) }
def three_d_secure; end
# Attribute for field tokenization_method
sig { returns(T.nilable(String)) }
def tokenization_method; end
end
class Wechat < Stripe::StripeObject
# Attribute for field prepay_id
sig { returns(T.nilable(String)) }
def prepay_id; end
# Attribute for field qr_code_url
sig { returns(T.nilable(String)) }
def qr_code_url; end
# Attribute for field statement_descriptor
sig { returns(T.nilable(String)) }
def statement_descriptor; end
end
# Attribute for field ach_credit_transfer
sig { returns(T.nilable(AchCreditTransfer)) }
def ach_credit_transfer; end
# Attribute for field ach_debit
sig { returns(T.nilable(AchDebit)) }
def ach_debit; end
# Attribute for field acss_debit
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# Attribute for field alipay
sig { returns(T.nilable(Alipay)) }
def alipay; end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
# A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.
sig { returns(T.nilable(Integer)) }
def amount; end
# Attribute for field au_becs_debit
sig { returns(T.nilable(AuBecsDebit)) }
def au_becs_debit; end
# Attribute for field bancontact
sig { returns(T.nilable(Bancontact)) }
def bancontact; end
# Attribute for field card
sig { returns(T.nilable(Card)) }
def card; end
# Attribute for field card_present
sig { returns(T.nilable(CardPresent)) }
def card_present; end
# The client secret of the source. Used for client-side retrieval using a publishable key.
sig { returns(String) }
def client_secret; end
# Attribute for field code_verification
sig { returns(T.nilable(CodeVerification)) }
def code_verification; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources.
sig { returns(T.nilable(String)) }
def currency; end
# The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
sig { returns(T.nilable(String)) }
def customer; end
# Attribute for field eps
sig { returns(T.nilable(Eps)) }
def eps; end
# The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.
sig { returns(String) }
def flow; end
# Attribute for field giropay
sig { returns(T.nilable(Giropay)) }
def giropay; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Attribute for field ideal
sig { returns(T.nilable(Ideal)) }
def ideal; end
# Attribute for field klarna
sig { returns(T.nilable(Klarna)) }
def klarna; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# Attribute for field multibanco
sig { returns(T.nilable(Multibanco)) }
def multibanco; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Information about the owner of the payment instrument that may be used or required by particular source types.
sig { returns(T.nilable(Owner)) }
def owner; end
# Attribute for field p24
sig { returns(T.nilable(P24)) }
def p24; end
# Attribute for field paypal
sig { returns(T.nilable(Paypal)) }
def paypal; end
# Attribute for field receiver
sig { returns(T.nilable(Receiver)) }
def receiver; end
# Attribute for field redirect
sig { returns(T.nilable(Redirect)) }
def redirect; end
# Attribute for field sepa_credit_transfer
sig { returns(T.nilable(SepaCreditTransfer)) }
def sepa_credit_transfer; end
# Attribute for field sepa_debit
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# Attribute for field sofort
sig { returns(T.nilable(Sofort)) }
def sofort; end
# Attribute for field source_order
sig { returns(T.nilable(SourceOrder)) }
def source_order; end
# Extra information about a source. This will appear on your customer's statement every time you charge the source.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
# The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge.
sig { returns(String) }
def status; end
# Attribute for field three_d_secure
sig { returns(T.nilable(ThreeDSecure)) }
def three_d_secure; end
# The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used.
sig { returns(String) }
def type; end
# Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
sig { returns(T.nilable(String)) }
def usage; end
# Attribute for field wechat
sig { returns(T.nilable(Wechat)) }
def wechat; end
class UpdateParams < Stripe::RequestParams
class Mandate < Stripe::RequestParams
class Acceptance < Stripe::RequestParams
class Offline < Stripe::RequestParams
# An email to contact you with if a copy of the mandate is requested, required if `type` is `offline`.
sig { returns(String) }
def contact_email; end
sig { params(_contact_email: String).returns(String) }
def contact_email=(_contact_email); end
sig { params(contact_email: String).void }
def initialize(contact_email: nil); end
end
class Online < Stripe::RequestParams
# The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the mandate was accepted or refused by the customer.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the mandate was accepted or refused by the customer.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the mandate was accepted or refused by the customer.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`
sig { returns(T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance::Offline)) }
def offline; end
sig {
params(_offline: T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance::Offline)).returns(T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance::Offline))
}
def offline=(_offline); end
# The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`
sig { returns(T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance::Online)) }
def online; end
sig {
params(_online: T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance::Online)).returns(T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance::Online))
}
def online=(_online); end
# The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).
sig { returns(String) }
def status; end
sig { params(_status: String).returns(String) }
def status=(_status); end
# The type of acceptance information included with the mandate. Either `online` or `offline`
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# The user agent of the browser from which the mandate was accepted or refused by the customer.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), offline: T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance::Offline), online: T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance::Online), status: String, type: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(
date: nil,
ip: nil,
offline: nil,
online: nil,
status: nil,
type: nil,
user_agent: nil
); end
end
# The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
sig { returns(T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance)) }
def acceptance; end
sig {
params(_acceptance: T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance)).returns(T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance))
}
def acceptance=(_acceptance); end
# The amount specified by the mandate. (Leave null for a mandate covering all amounts)
sig { returns(T.nilable(T.any(String, Integer))) }
def amount; end
sig {
params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def amount=(_amount); end
# The currency specified by the mandate. (Must match `currency` of the source)
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency)
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification).
sig { returns(T.nilable(String)) }
def notification_method; end
sig { params(_notification_method: T.nilable(String)).returns(T.nilable(String)) }
def notification_method=(_notification_method); end
sig {
params(acceptance: T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance), amount: T.nilable(T.any(String, Integer)), currency: T.nilable(String), interval: T.nilable(String), notification_method: T.nilable(String)).void
}
def initialize(
acceptance: nil,
amount: nil,
currency: nil,
interval: nil,
notification_method: nil
); end
end
class Owner < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Owner's address.
sig { returns(T.nilable(::Stripe::Source::UpdateParams::Owner::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::Source::UpdateParams::Owner::Address)).returns(T.nilable(::Stripe::Source::UpdateParams::Owner::Address))
}
def address=(_address); end
# Owner's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Owner's full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Owner's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::Source::UpdateParams::Owner::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil); end
end
class SourceOrder < Stripe::RequestParams
class Item < Stripe::RequestParams
# Attribute for param field amount
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Attribute for param field description
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The ID of the SKU being ordered.
sig { returns(T.nilable(String)) }
def parent; end
sig { params(_parent: T.nilable(String)).returns(T.nilable(String)) }
def parent=(_parent); end
# The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# Attribute for param field type
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(amount: T.nilable(Integer), currency: T.nilable(String), description: T.nilable(String), parent: T.nilable(String), quantity: T.nilable(Integer), type: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
parent: nil,
quantity: nil,
type: nil
); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(String) }
def line1; end
sig { params(_line1: String).returns(String) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: String, line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address.
sig { returns(::Stripe::Source::UpdateParams::SourceOrder::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::Source::UpdateParams::SourceOrder::Shipping::Address).returns(::Stripe::Source::UpdateParams::SourceOrder::Shipping::Address)
}
def address=(_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Recipient name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
sig { params(_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def tracking_number=(_tracking_number); end
sig {
params(address: ::Stripe::Source::UpdateParams::SourceOrder::Shipping::Address, carrier: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tracking_number: T.nilable(String)).void
}
def initialize(
address: nil,
carrier: nil,
name: nil,
phone: nil,
tracking_number: nil
); end
end
# List of items constituting the order.
sig { returns(T.nilable(T::Array[::Stripe::Source::UpdateParams::SourceOrder::Item])) }
def items; end
sig {
params(_items: T.nilable(T::Array[::Stripe::Source::UpdateParams::SourceOrder::Item])).returns(T.nilable(T::Array[::Stripe::Source::UpdateParams::SourceOrder::Item]))
}
def items=(_items); end
# Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.
sig { returns(T.nilable(::Stripe::Source::UpdateParams::SourceOrder::Shipping)) }
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::Source::UpdateParams::SourceOrder::Shipping)).returns(T.nilable(::Stripe::Source::UpdateParams::SourceOrder::Shipping))
}
def shipping=(_shipping); end
sig {
params(items: T.nilable(T::Array[::Stripe::Source::UpdateParams::SourceOrder::Item]), shipping: T.nilable(::Stripe::Source::UpdateParams::SourceOrder::Shipping)).void
}
def initialize(items: nil, shipping: nil); end
end
# Amount associated with the source.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
sig { returns(T.nilable(::Stripe::Source::UpdateParams::Mandate)) }
def mandate; end
sig {
params(_mandate: T.nilable(::Stripe::Source::UpdateParams::Mandate)).returns(T.nilable(::Stripe::Source::UpdateParams::Mandate))
}
def mandate=(_mandate); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Information about the owner of the payment instrument that may be used or required by particular source types.
sig { returns(T.nilable(::Stripe::Source::UpdateParams::Owner)) }
def owner; end
sig {
params(_owner: T.nilable(::Stripe::Source::UpdateParams::Owner)).returns(T.nilable(::Stripe::Source::UpdateParams::Owner))
}
def owner=(_owner); end
# Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.
sig { returns(T.nilable(::Stripe::Source::UpdateParams::SourceOrder)) }
def source_order; end
sig {
params(_source_order: T.nilable(::Stripe::Source::UpdateParams::SourceOrder)).returns(T.nilable(::Stripe::Source::UpdateParams::SourceOrder))
}
def source_order=(_source_order); end
sig {
params(amount: T.nilable(Integer), expand: T.nilable(T::Array[String]), mandate: T.nilable(::Stripe::Source::UpdateParams::Mandate), metadata: T.nilable(T.any(String, T::Hash[String, String])), owner: T.nilable(::Stripe::Source::UpdateParams::Owner), source_order: T.nilable(::Stripe::Source::UpdateParams::SourceOrder)).void
}
def initialize(
amount: nil,
expand: nil,
mandate: nil,
metadata: nil,
owner: nil,
source_order: nil
); end
end
class CreateParams < Stripe::RequestParams
class Mandate < Stripe::RequestParams
class Acceptance < Stripe::RequestParams
class Offline < Stripe::RequestParams
# An email to contact you with if a copy of the mandate is requested, required if `type` is `offline`.
sig { returns(String) }
def contact_email; end
sig { params(_contact_email: String).returns(String) }
def contact_email=(_contact_email); end
sig { params(contact_email: String).void }
def initialize(contact_email: nil); end
end
class Online < Stripe::RequestParams
# The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the mandate was accepted or refused by the customer.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the mandate was accepted or refused by the customer.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the mandate was accepted or refused by the customer.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`
sig { returns(T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance::Offline)) }
def offline; end
sig {
params(_offline: T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance::Offline)).returns(T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance::Offline))
}
def offline=(_offline); end
# The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`
sig { returns(T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance::Online)) }
def online; end
sig {
params(_online: T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance::Online)).returns(T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance::Online))
}
def online=(_online); end
# The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).
sig { returns(String) }
def status; end
sig { params(_status: String).returns(String) }
def status=(_status); end
# The type of acceptance information included with the mandate. Either `online` or `offline`
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# The user agent of the browser from which the mandate was accepted or refused by the customer.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), offline: T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance::Offline), online: T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance::Online), status: String, type: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(
date: nil,
ip: nil,
offline: nil,
online: nil,
status: nil,
type: nil,
user_agent: nil
); end
end
# The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
sig { returns(T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance)) }
def acceptance; end
sig {
params(_acceptance: T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance)).returns(T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance))
}
def acceptance=(_acceptance); end
# The amount specified by the mandate. (Leave null for a mandate covering all amounts)
sig { returns(T.nilable(T.any(String, Integer))) }
def amount; end
sig {
params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def amount=(_amount); end
# The currency specified by the mandate. (Must match `currency` of the source)
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency)
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification).
sig { returns(T.nilable(String)) }
def notification_method; end
sig { params(_notification_method: T.nilable(String)).returns(T.nilable(String)) }
def notification_method=(_notification_method); end
sig {
params(acceptance: T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance), amount: T.nilable(T.any(String, Integer)), currency: T.nilable(String), interval: T.nilable(String), notification_method: T.nilable(String)).void
}
def initialize(
acceptance: nil,
amount: nil,
currency: nil,
interval: nil,
notification_method: nil
); end
end
class Owner < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Owner's address.
sig { returns(T.nilable(::Stripe::Source::CreateParams::Owner::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::Source::CreateParams::Owner::Address)).returns(T.nilable(::Stripe::Source::CreateParams::Owner::Address))
}
def address=(_address); end
# Owner's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Owner's full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Owner's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::Source::CreateParams::Owner::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil); end
end
class Receiver < Stripe::RequestParams
# The method Stripe should use to request information needed to process a refund or mispayment. Either `email` (an email is sent directly to the customer) or `manual` (a `source.refund_attributes_required` event is sent to your webhooks endpoint). Refer to each payment method's documentation to learn which refund attributes may be required.
sig { returns(T.nilable(String)) }
def refund_attributes_method; end
sig { params(_refund_attributes_method: T.nilable(String)).returns(T.nilable(String)) }
def refund_attributes_method=(_refund_attributes_method); end
sig { params(refund_attributes_method: T.nilable(String)).void }
def initialize(refund_attributes_method: nil); end
end
class Redirect < Stripe::RequestParams
# The URL you provide to redirect the customer back to you after they authenticated their payment. It can use your application URI scheme in the context of a mobile application.
sig { returns(String) }
def return_url; end
sig { params(_return_url: String).returns(String) }
def return_url=(_return_url); end
sig { params(return_url: String).void }
def initialize(return_url: nil); end
end
class SourceOrder < Stripe::RequestParams
class Item < Stripe::RequestParams
# Attribute for param field amount
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Attribute for param field description
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The ID of the SKU being ordered.
sig { returns(T.nilable(String)) }
def parent; end
sig { params(_parent: T.nilable(String)).returns(T.nilable(String)) }
def parent=(_parent); end
# The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# Attribute for param field type
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(amount: T.nilable(Integer), currency: T.nilable(String), description: T.nilable(String), parent: T.nilable(String), quantity: T.nilable(Integer), type: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
parent: nil,
quantity: nil,
type: nil
); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(String) }
def line1; end
sig { params(_line1: String).returns(String) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: String, line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address.
sig { returns(::Stripe::Source::CreateParams::SourceOrder::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::Source::CreateParams::SourceOrder::Shipping::Address).returns(::Stripe::Source::CreateParams::SourceOrder::Shipping::Address)
}
def address=(_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Recipient name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
sig { params(_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def tracking_number=(_tracking_number); end
sig {
params(address: ::Stripe::Source::CreateParams::SourceOrder::Shipping::Address, carrier: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tracking_number: T.nilable(String)).void
}
def initialize(
address: nil,
carrier: nil,
name: nil,
phone: nil,
tracking_number: nil
); end
end
# List of items constituting the order.
sig { returns(T.nilable(T::Array[::Stripe::Source::CreateParams::SourceOrder::Item])) }
def items; end
sig {
params(_items: T.nilable(T::Array[::Stripe::Source::CreateParams::SourceOrder::Item])).returns(T.nilable(T::Array[::Stripe::Source::CreateParams::SourceOrder::Item]))
}
def items=(_items); end
# Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.
sig { returns(T.nilable(::Stripe::Source::CreateParams::SourceOrder::Shipping)) }
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::Source::CreateParams::SourceOrder::Shipping)).returns(T.nilable(::Stripe::Source::CreateParams::SourceOrder::Shipping))
}
def shipping=(_shipping); end
sig {
params(items: T.nilable(T::Array[::Stripe::Source::CreateParams::SourceOrder::Item]), shipping: T.nilable(::Stripe::Source::CreateParams::SourceOrder::Shipping)).void
}
def initialize(items: nil, shipping: nil); end
end
# Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`).
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows.
sig { returns(T.nilable(String)) }
def flow; end
sig { params(_flow: T.nilable(String)).returns(T.nilable(String)) }
def flow=(_flow); end
# Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
sig { returns(T.nilable(::Stripe::Source::CreateParams::Mandate)) }
def mandate; end
sig {
params(_mandate: T.nilable(::Stripe::Source::CreateParams::Mandate)).returns(T.nilable(::Stripe::Source::CreateParams::Mandate))
}
def mandate=(_mandate); end
# Attribute for param field metadata
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The source to share.
sig { returns(T.nilable(String)) }
def original_source; end
sig { params(_original_source: T.nilable(String)).returns(T.nilable(String)) }
def original_source=(_original_source); end
# Information about the owner of the payment instrument that may be used or required by particular source types.
sig { returns(T.nilable(::Stripe::Source::CreateParams::Owner)) }
def owner; end
sig {
params(_owner: T.nilable(::Stripe::Source::CreateParams::Owner)).returns(T.nilable(::Stripe::Source::CreateParams::Owner))
}
def owner=(_owner); end
# Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`).
sig { returns(T.nilable(::Stripe::Source::CreateParams::Receiver)) }
def receiver; end
sig {
params(_receiver: T.nilable(::Stripe::Source::CreateParams::Receiver)).returns(T.nilable(::Stripe::Source::CreateParams::Receiver))
}
def receiver=(_receiver); end
# Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`).
sig { returns(T.nilable(::Stripe::Source::CreateParams::Redirect)) }
def redirect; end
sig {
params(_redirect: T.nilable(::Stripe::Source::CreateParams::Redirect)).returns(T.nilable(::Stripe::Source::CreateParams::Redirect))
}
def redirect=(_redirect); end
# Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.
sig { returns(T.nilable(::Stripe::Source::CreateParams::SourceOrder)) }
def source_order; end
sig {
params(_source_order: T.nilable(::Stripe::Source::CreateParams::SourceOrder)).returns(T.nilable(::Stripe::Source::CreateParams::SourceOrder))
}
def source_order=(_source_order); end
# An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# An optional token used to create the source. When passed, token properties will override source parameters.
sig { returns(T.nilable(String)) }
def token; end
sig { params(_token: T.nilable(String)).returns(T.nilable(String)) }
def token=(_token); end
# The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide)
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# Attribute for param field usage
sig { returns(T.nilable(String)) }
def usage; end
sig { params(_usage: T.nilable(String)).returns(T.nilable(String)) }
def usage=(_usage); end
sig {
params(amount: T.nilable(Integer), currency: T.nilable(String), customer: T.nilable(String), expand: T.nilable(T::Array[String]), flow: T.nilable(String), mandate: T.nilable(::Stripe::Source::CreateParams::Mandate), metadata: T.nilable(T::Hash[String, String]), original_source: T.nilable(String), owner: T.nilable(::Stripe::Source::CreateParams::Owner), receiver: T.nilable(::Stripe::Source::CreateParams::Receiver), redirect: T.nilable(::Stripe::Source::CreateParams::Redirect), source_order: T.nilable(::Stripe::Source::CreateParams::SourceOrder), statement_descriptor: T.nilable(String), token: T.nilable(String), type: T.nilable(String), usage: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
customer: nil,
expand: nil,
flow: nil,
mandate: nil,
metadata: nil,
original_source: nil,
owner: nil,
receiver: nil,
redirect: nil,
source_order: nil,
statement_descriptor: nil,
token: nil,
type: nil,
usage: nil
); end
end
class VerifyParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The values needed to verify the source.
sig { returns(T::Array[String]) }
def values; end
sig { params(_values: T::Array[String]).returns(T::Array[String]) }
def values=(_values); end
sig { params(expand: T.nilable(T::Array[String]), values: T::Array[String]).void }
def initialize(expand: nil, values: nil); end
end
# Creates a new source object.
sig {
params(params: T.any(::Stripe::Source::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
}
def self.create(params = {}, opts = {}); end
# Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
#
# This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment method guides](https://docs.stripe.com/docs/sources) for more detail.
sig {
params(source: String, params: T.any(::Stripe::Source::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
}
def self.update(source, params = {}, opts = {}); end
# Verify a given source.
sig {
params(params: T.any(::Stripe::Source::VerifyParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
}
def verify(params = {}, opts = {}); end
# Verify a given source.
sig {
params(source: String, params: T.any(::Stripe::Source::VerifyParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
}
def self.verify(source, params = {}, opts = {}); end
end
end
# typed: 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
class BillingThresholds < Stripe::StripeObject
# Usage threshold that triggers the subscription to create an invoice
sig { returns(T.nilable(Integer)) }
def usage_gte; end
end
class Trial < Stripe::StripeObject
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
end
# Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
sig { returns(T.nilable(BillingThresholds)) }
def billing_thresholds; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The end time of this subscription item's current billing period.
sig { returns(Integer) }
def current_period_end; end
# The start time of this subscription item's current billing period.
sig { returns(Integer) }
def current_period_start; end
# The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
sig { returns(T::Array[T.any(String, Stripe::Discount)]) }
def discounts; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# 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).
sig { returns(Stripe::Plan) }
def plan; end
# 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).
sig { returns(Stripe::Price) }
def price; end
# The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed.
sig { returns(T.nilable(Integer)) }
def quantity; end
# The `subscription` this `subscription_item` belongs to.
sig { returns(String) }
def subscription; end
# The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
sig { returns(T.nilable(T::Array[Stripe::TaxRate])) }
def tax_rates; end
# Options that configure the trial on the subscription item.
sig { returns(T.nilable(Trial)) }
def trial; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams
# Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`.
sig { returns(T.nilable(T::Boolean)) }
def clear_usage; end
sig { params(_clear_usage: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def clear_usage=(_clear_usage); end
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
sig { returns(T.nilable(Integer)) }
def proration_date; end
sig { params(_proration_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def proration_date=(_proration_date); end
sig {
params(clear_usage: T.nilable(T::Boolean), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer)).void
}
def initialize(clear_usage: nil, proration_behavior: nil, proration_date: nil); end
end
class UpdateParams < 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))
sig { returns(Integer) }
def usage_gte; end
sig { params(_usage_gte: Integer).returns(Integer) }
def usage_gte=(_usage_gte); end
sig { params(usage_gte: Integer).void }
def initialize(usage_gte: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionItem::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionItem::UpdateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionItem::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionItem::UpdateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::SubscriptionItem::UpdateParams::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionItem::UpdateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionItem::UpdateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionItem::UpdateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig { returns(::Stripe::SubscriptionItem::UpdateParams::PriceData::Recurring) }
def recurring; end
sig {
params(_recurring: ::Stripe::SubscriptionItem::UpdateParams::PriceData::Recurring).returns(::Stripe::SubscriptionItem::UpdateParams::PriceData::Recurring)
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: ::Stripe::SubscriptionItem::UpdateParams::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionItem::UpdateParams::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionItem::UpdateParams::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionItem::UpdateParams::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# The coupons to redeem into discounts for the subscription item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::UpdateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::UpdateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::UpdateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
sig { returns(T.nilable(T::Boolean)) }
def off_session; end
sig { params(_off_session: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def off_session=(_off_session); end
# Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
#
# Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
#
# Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
#
# Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
sig { returns(T.nilable(String)) }
def payment_behavior; end
sig { params(_payment_behavior: T.nilable(String)).returns(T.nilable(String)) }
def payment_behavior=(_payment_behavior); end
# The identifier of the new plan for this subscription item.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig { returns(T.nilable(::Stripe::SubscriptionItem::UpdateParams::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::SubscriptionItem::UpdateParams::PriceData)).returns(T.nilable(::Stripe::SubscriptionItem::UpdateParams::PriceData))
}
def price_data=(_price_data); end
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
sig { returns(T.nilable(Integer)) }
def proration_date; end
sig { params(_proration_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def proration_date=(_proration_date); end
# The quantity you'd like to apply to the subscription item you're creating.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionItem::UpdateParams::BillingThresholds)), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::UpdateParams::Discount])), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), off_session: T.nilable(T::Boolean), payment_behavior: T.nilable(String), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionItem::UpdateParams::PriceData), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
billing_thresholds: nil,
discounts: nil,
expand: nil,
metadata: nil,
off_session: nil,
payment_behavior: nil,
plan: nil,
price: nil,
price_data: nil,
proration_behavior: nil,
proration_date: nil,
quantity: nil,
tax_rates: nil
); end
end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# The ID of the subscription whose items will be retrieved.
sig { returns(String) }
def subscription; end
sig { params(_subscription: String).returns(String) }
def subscription=(_subscription); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), subscription: String).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
subscription: nil
); end
end
class CreateParams < 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))
sig { returns(Integer) }
def usage_gte; end
sig { params(_usage_gte: Integer).returns(Integer) }
def usage_gte=(_usage_gte); end
sig { params(usage_gte: Integer).void }
def initialize(usage_gte: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionItem::CreateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionItem::CreateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionItem::CreateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionItem::CreateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::SubscriptionItem::CreateParams::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionItem::CreateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionItem::CreateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionItem::CreateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig { returns(::Stripe::SubscriptionItem::CreateParams::PriceData::Recurring) }
def recurring; end
sig {
params(_recurring: ::Stripe::SubscriptionItem::CreateParams::PriceData::Recurring).returns(::Stripe::SubscriptionItem::CreateParams::PriceData::Recurring)
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: ::Stripe::SubscriptionItem::CreateParams::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionItem::CreateParams::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionItem::CreateParams::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionItem::CreateParams::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# The coupons to redeem into discounts for the subscription item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::CreateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::CreateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::CreateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
#
# Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
#
# Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
#
# Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
sig { returns(T.nilable(String)) }
def payment_behavior; end
sig { params(_payment_behavior: T.nilable(String)).returns(T.nilable(String)) }
def payment_behavior=(_payment_behavior); end
# The identifier of the plan to add to the subscription.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig { returns(T.nilable(::Stripe::SubscriptionItem::CreateParams::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::SubscriptionItem::CreateParams::PriceData)).returns(T.nilable(::Stripe::SubscriptionItem::CreateParams::PriceData))
}
def price_data=(_price_data); end
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
sig { returns(T.nilable(Integer)) }
def proration_date; end
sig { params(_proration_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def proration_date=(_proration_date); end
# The quantity you'd like to apply to the subscription item you're creating.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The identifier of the subscription to modify.
sig { returns(String) }
def subscription; end
sig { params(_subscription: String).returns(String) }
def subscription=(_subscription); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# Options that configure the trial on the subscription item.
sig { returns(T.nilable(::Stripe::SubscriptionItem::CreateParams::Trial)) }
def trial; end
sig {
params(_trial: T.nilable(::Stripe::SubscriptionItem::CreateParams::Trial)).returns(T.nilable(::Stripe::SubscriptionItem::CreateParams::Trial))
}
def trial=(_trial); end
sig {
params(billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionItem::CreateParams::BillingThresholds)), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::CreateParams::Discount])), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), payment_behavior: T.nilable(String), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionItem::CreateParams::PriceData), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), quantity: T.nilable(Integer), subscription: String, tax_rates: T.nilable(T.any(String, T::Array[String])), trial: T.nilable(::Stripe::SubscriptionItem::CreateParams::Trial)).void
}
def initialize(
billing_thresholds: nil,
discounts: nil,
expand: nil,
metadata: nil,
payment_behavior: nil,
plan: nil,
price: nil,
price_data: nil,
proration_behavior: nil,
proration_date: nil,
quantity: nil,
subscription: nil,
tax_rates: nil,
trial: nil
); end
end
# Adds a new item to an existing subscription. No existing items will be changed or replaced.
sig {
params(params: T.any(::Stripe::SubscriptionItem::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionItem)
}
def self.create(params = {}, opts = {}); end
# Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.
sig {
params(item: String, params: T.any(::Stripe::SubscriptionItem::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionItem)
}
def self.delete(item, params = {}, opts = {}); end
# Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.
sig {
params(params: T.any(::Stripe::SubscriptionItem::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionItem)
}
def delete(params = {}, opts = {}); end
# Returns a list of your subscription items for a given subscription.
sig {
params(params: T.any(::Stripe::SubscriptionItem::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates the plan or quantity of an item on a current subscription.
sig {
params(item: String, params: T.any(::Stripe::SubscriptionItem::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionItem)
}
def self.update(item, params = {}, opts = {}); end
end
end
# typed: 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
class BillingMode < Stripe::StripeObject
class Flexible < Stripe::StripeObject
# When true, proration line items will show accurate discount amounts and use gross amounts, making them consistent with non-proration line items.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
end
# Configure behavior for flexible billing mode
sig { returns(T.nilable(Flexible)) }
def flexible; end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig { returns(String) }
def type; end
# Details on when the current billing_mode was adopted.
sig { returns(T.nilable(Integer)) }
def updated_at; end
end
class CurrentPhase < Stripe::StripeObject
# The end of this phase of the subscription schedule.
sig { returns(Integer) }
def end_date; end
# The start of this phase of the subscription schedule.
sig { returns(Integer) }
def start_date; end
end
class DefaultSettings < Stripe::StripeObject
class AutomaticTax < Stripe::StripeObject
class Liability < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# If Stripe disabled automatic tax, this enum describes why.
sig { returns(T.nilable(String)) }
def disabled_reason; end
# Whether Stripe automatically computes tax on invoices created during this phase.
sig { returns(T::Boolean) }
def enabled; end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(Liability)) }
def liability; end
end
class BillingThresholds < Stripe::StripeObject
# Monetary threshold that triggers the subscription to create an invoice
sig { returns(T.nilable(Integer)) }
def amount_gte; end
# 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. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
end
class InvoiceSettings < Stripe::StripeObject
class Issuer < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
def account_tax_ids; end
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
# Attribute for field issuer
sig { returns(Issuer) }
def issuer; end
end
class TransferData < Stripe::StripeObject
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
# The account where funds from the payment will be transferred to upon payment success.
sig { returns(T.any(String, Stripe::Account)) }
def destination; end
end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
# Attribute for field automatic_tax
sig { returns(T.nilable(AutomaticTax)) }
def automatic_tax; end
# Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
sig { returns(String) }
def billing_cycle_anchor; end
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
sig { returns(T.nilable(BillingThresholds)) }
def billing_thresholds; end
# 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`.
sig { returns(T.nilable(String)) }
def collection_method; end
# ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def default_payment_method; end
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
# Attribute for field invoice_settings
sig { returns(InvoiceSettings) }
def invoice_settings; end
# The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def on_behalf_of; end
# The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
sig { returns(T.nilable(TransferData)) }
def transfer_data; end
end
class LastPriceMigrationError < Stripe::StripeObject
class FailedTransition < Stripe::StripeObject
# The original price to be migrated.
sig { returns(String) }
def source_price; end
# The intended resulting price of the migration.
sig { returns(String) }
def target_price; end
end
# The time at which the price migration encountered an error.
sig { returns(Integer) }
def errored_at; end
# The involved price pairs in each failed transition.
sig { returns(T::Array[FailedTransition]) }
def failed_transitions; end
# The type of error encountered by the price migration.
sig { returns(String) }
def type; end
end
class Phase < Stripe::StripeObject
class AddInvoiceItem < Stripe::StripeObject
class Discount < Stripe::StripeObject
class DiscountEnd < Stripe::StripeObject
# The discount end timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# The discount end type.
sig { returns(String) }
def type; end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
def coupon; end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
def discount; end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(DiscountEnd)) }
def discount_end; end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
def promotion_code; end
end
class Period < Stripe::StripeObject
class End < Stripe::StripeObject
# A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# Select how to calculate the end of the invoice item period.
sig { returns(String) }
def type; end
end
class Start < Stripe::StripeObject
# A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# Select how to calculate the start of the invoice item period.
sig { returns(String) }
def type; end
end
# Attribute for field end
sig { returns(End) }
def end; end
# Attribute for field start
sig { returns(Start) }
def start; end
end
# The stackable discounts that will be applied to the item.
sig { returns(T::Array[Discount]) }
def discounts; end
# 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])) }
def metadata; end
# Attribute for field period
sig { returns(Period) }
def period; end
# ID of the price used to generate the invoice item.
sig { returns(T.any(String, Stripe::Price)) }
def price; end
# The quantity of the invoice item.
sig { returns(T.nilable(Integer)) }
def quantity; end
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
sig { returns(T.nilable(T::Array[Stripe::TaxRate])) }
def tax_rates; end
end
class AutomaticTax < Stripe::StripeObject
class Liability < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# If Stripe disabled automatic tax, this enum describes why.
sig { returns(T.nilable(String)) }
def disabled_reason; end
# Whether Stripe automatically computes tax on invoices created during this phase.
sig { returns(T::Boolean) }
def enabled; end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(Liability)) }
def liability; end
end
class BillingThresholds < Stripe::StripeObject
# Monetary threshold that triggers the subscription to create an invoice
sig { returns(T.nilable(Integer)) }
def amount_gte; end
# 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. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
end
class Discount < Stripe::StripeObject
class DiscountEnd < Stripe::StripeObject
# The discount end timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# The discount end type.
sig { returns(String) }
def type; end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
def coupon; end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
def discount; end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(DiscountEnd)) }
def discount_end; end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
def promotion_code; end
end
class InvoiceSettings < Stripe::StripeObject
class Issuer < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
def account_tax_ids; end
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig { returns(T.nilable(Issuer)) }
def issuer; end
end
class Item < Stripe::StripeObject
class BillingThresholds < Stripe::StripeObject
# Usage threshold that triggers the subscription to create an invoice
sig { returns(T.nilable(Integer)) }
def usage_gte; end
end
class Discount < Stripe::StripeObject
class DiscountEnd < Stripe::StripeObject
# The discount end timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
# The discount end type.
sig { returns(String) }
def type; end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
def coupon; end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
def discount; end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(DiscountEnd)) }
def discount_end; end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
def promotion_code; end
end
class Trial < Stripe::StripeObject
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
end
# Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
sig { returns(T.nilable(BillingThresholds)) }
def billing_thresholds; end
# The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
sig { returns(T::Array[Discount]) }
def discounts; end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
# ID of the plan to which the customer should be subscribed.
sig { returns(T.any(String, Stripe::Plan)) }
def plan; end
# ID of the price to which the customer should be subscribed.
sig { returns(T.any(String, Stripe::Price)) }
def price; end
# Quantity of the plan to which the customer should be subscribed.
sig { returns(T.nilable(Integer)) }
def quantity; end
# The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
sig { returns(T.nilable(T::Array[Stripe::TaxRate])) }
def tax_rates; end
# Options that configure the trial on the subscription item.
sig { returns(T.nilable(Trial)) }
def trial; end
end
class PauseCollection < Stripe::StripeObject
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
end
class TransferData < Stripe::StripeObject
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
# The account where funds from the payment will be transferred to upon payment success.
sig { returns(T.any(String, Stripe::Account)) }
def destination; end
end
class TrialSettings < Stripe::StripeObject
class EndBehavior < Stripe::StripeObject
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
end
# Defines how the subscription should behave when a trial ends.
sig { returns(T.nilable(EndBehavior)) }
def end_behavior; end
end
# A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
sig { returns(T::Array[AddInvoiceItem]) }
def add_invoice_items; end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
# Attribute for field automatic_tax
sig { returns(T.nilable(AutomaticTax)) }
def automatic_tax; end
# Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
sig { returns(T.nilable(BillingThresholds)) }
def billing_thresholds; end
# 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`.
sig { returns(T.nilable(String)) }
def collection_method; end
# 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) }
def currency; end
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def default_payment_method; end
# The default tax rates to apply to the subscription during this phase of the subscription schedule.
sig { returns(T.nilable(T::Array[Stripe::TaxRate])) }
def default_tax_rates; end
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
# The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
sig { returns(T::Array[Discount]) }
def discounts; end
# The end of this phase of the subscription schedule.
sig { returns(Integer) }
def end_date; end
# The invoice settings applicable during this phase.
sig { returns(T.nilable(InvoiceSettings)) }
def invoice_settings; end
# Subscription items to configure the subscription to during this phase of the subscription schedule.
sig { returns(T::Array[Item]) }
def items; end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
# The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def on_behalf_of; end
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
sig { returns(T.nilable(PauseCollection)) }
def pause_collection; end
# When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.
sig { returns(String) }
def proration_behavior; end
# The start of this phase of the subscription schedule.
sig { returns(Integer) }
def start_date; end
# The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
sig { returns(T.nilable(TransferData)) }
def transfer_data; end
# Specify behavior of the trial when crossing schedule phase boundaries
sig { returns(T.nilable(String)) }
def trial_continuation; end
# When the trial ends within the phase.
sig { returns(T.nilable(Integer)) }
def trial_end; end
# Settings related to any trials on the subscription during this phase.
sig { returns(T.nilable(TrialSettings)) }
def trial_settings; end
end
class Prebilling < Stripe::StripeObject
# ID of the prebilling invoice.
sig { returns(T.any(String, Stripe::Invoice)) }
def invoice; end
# The end of the last period for which the invoice pre-bills.
sig { returns(Integer) }
def period_end; end
# The start of the first period for which the invoice pre-bills.
sig { returns(Integer) }
def period_start; end
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
sig { returns(T.nilable(String)) }
def update_behavior; end
end
# ID of the Connect Application that created the schedule.
sig { returns(T.nilable(T.any(String, Stripe::Application))) }
def application; end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
# The billing mode of the subscription.
sig { returns(BillingMode) }
def billing_mode; end
# Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def canceled_at; end
# Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def completed_at; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.
sig { returns(T.nilable(CurrentPhase)) }
def current_phase; end
# ID of the customer who owns the subscription schedule.
sig { returns(T.any(String, Stripe::Customer)) }
def customer; end
# ID of the account who owns the subscription schedule.
sig { returns(T.nilable(String)) }
def customer_account; end
# Attribute for field default_settings
sig { returns(DefaultSettings) }
def default_settings; end
# Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
sig { returns(String) }
def end_behavior; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Details of the most recent price migration that failed for the subscription schedule.
sig { returns(T.nilable(LastPriceMigrationError)) }
def last_price_migration_error; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Configuration for the subscription schedule's phases.
sig { returns(T::Array[Phase]) }
def phases; end
# Time period and invoice for a Subscription billed in advance.
sig { returns(T.nilable(Prebilling)) }
def prebilling; end
# Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def released_at; end
# ID of the subscription once managed by the subscription schedule (if it is released).
sig { returns(T.nilable(String)) }
def released_subscription; end
# The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules).
sig { returns(String) }
def status; end
# ID of the subscription managed by the subscription schedule.
sig { returns(T.nilable(T.any(String, Stripe::Subscription))) }
def subscription; end
# ID of the test clock this subscription schedule belongs to.
sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
def test_clock; end
class ListParams < Stripe::RequestParams
class CanceledAt < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class CompletedAt < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class ReleasedAt < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return subscription schedules that were created canceled the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::SubscriptionSchedule::ListParams::CanceledAt, Integer)))
}
def canceled_at; end
sig {
params(_canceled_at: T.nilable(T.any(::Stripe::SubscriptionSchedule::ListParams::CanceledAt, Integer))).returns(T.nilable(T.any(::Stripe::SubscriptionSchedule::ListParams::CanceledAt, Integer)))
}
def canceled_at=(_canceled_at); end
# Only return subscription schedules that completed during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::SubscriptionSchedule::ListParams::CompletedAt, Integer)))
}
def completed_at; end
sig {
params(_completed_at: T.nilable(T.any(::Stripe::SubscriptionSchedule::ListParams::CompletedAt, Integer))).returns(T.nilable(T.any(::Stripe::SubscriptionSchedule::ListParams::CompletedAt, Integer)))
}
def completed_at=(_completed_at); end
# Only return subscription schedules that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::SubscriptionSchedule::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::SubscriptionSchedule::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::SubscriptionSchedule::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return subscription schedules for the given customer.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Only return subscription schedules for the given account.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return subscription schedules that were released during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::SubscriptionSchedule::ListParams::ReleasedAt, Integer)))
}
def released_at; end
sig {
params(_released_at: T.nilable(T.any(::Stripe::SubscriptionSchedule::ListParams::ReleasedAt, Integer))).returns(T.nilable(T.any(::Stripe::SubscriptionSchedule::ListParams::ReleasedAt, Integer)))
}
def released_at=(_released_at); end
# Only return subscription schedules that have not started yet.
sig { returns(T.nilable(T::Boolean)) }
def scheduled; end
sig { params(_scheduled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def scheduled=(_scheduled); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(canceled_at: T.nilable(T.any(::Stripe::SubscriptionSchedule::ListParams::CanceledAt, Integer)), completed_at: T.nilable(T.any(::Stripe::SubscriptionSchedule::ListParams::CompletedAt, Integer)), created: T.nilable(T.any(::Stripe::SubscriptionSchedule::ListParams::Created, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), released_at: T.nilable(T.any(::Stripe::SubscriptionSchedule::ListParams::ReleasedAt, Integer)), scheduled: T.nilable(T::Boolean), starting_after: T.nilable(String)).void
}
def initialize(
canceled_at: nil,
completed_at: nil,
created: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
limit: nil,
released_at: nil,
scheduled: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class BillingMode < Stripe::RequestParams
class Flexible < Stripe::RequestParams
# Set to `true` to display gross amounts, net amounts, and discount amounts consistently between prorations and non-proration items on invoices, line items, and invoice items. Once set to `true`, you can't change it back to `false`.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
sig {
params(_consistent_proration_discount_amounts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consistent_proration_discount_amounts=(_consistent_proration_discount_amounts); end
sig { params(consistent_proration_discount_amounts: T.nilable(T::Boolean)).void }
def initialize(consistent_proration_discount_amounts: nil); end
end
# Configure behavior for flexible billing mode.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::BillingMode::Flexible))
}
def flexible; end
sig {
params(_flexible: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::BillingMode::Flexible)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::BillingMode::Flexible))
}
def flexible=(_flexible); end
# Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(flexible: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::BillingMode::Flexible), type: String).void
}
def initialize(flexible: nil, type: nil); end
end
class DefaultSettings < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::AutomaticTax::Liability)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class BillingThresholds < Stripe::RequestParams
# Monetary threshold that triggers the subscription to advance to a new billing period
sig { returns(T.nilable(Integer)) }
def amount_gte; end
sig { params(_amount_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_gte=(_amount_gte); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
sig {
params(_reset_billing_cycle_anchor: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def reset_billing_cycle_anchor=(_reset_billing_cycle_anchor); end
sig {
params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
}
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::InvoiceSettings::Issuer)).void
}
def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end
end
class TransferData < Stripe::RequestParams
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount_percent: T.nilable(Float), destination: String).void }
def initialize(amount_percent: nil, destination: nil); end
end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
sig { params(_application_fee_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def application_fee_percent=(_application_fee_percent); end
# Default settings for automatic tax computation.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::AutomaticTax))
}
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::AutomaticTax)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# 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).
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::InvoiceSettings)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# The account on behalf of which to charge, for each of the associated subscription's invoices.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::TransferData)))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::TransferData))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::TransferData)))
}
def transfer_data=(_transfer_data); end
sig {
params(application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::BillingThresholds)), collection_method: T.nilable(String), default_payment_method: T.nilable(String), description: T.nilable(String), invoice_settings: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::InvoiceSettings), on_behalf_of: T.nilable(String), transfer_data: T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::TransferData))).void
}
def initialize(
application_fee_percent: nil,
automatic_tax: nil,
billing_cycle_anchor: nil,
billing_thresholds: nil,
collection_method: nil,
default_payment_method: nil,
description: nil,
invoice_settings: nil,
on_behalf_of: nil,
transfer_data: nil
); end
end
class Phase < Stripe::RequestParams
class AddInvoiceItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
class End < Stripe::RequestParams
# A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the end of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
class Start < Stripe::RequestParams
# A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the start of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
# End of the invoice item period.
sig {
returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Period::End)
}
def end; end
sig {
params(_end: ::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Period::End).returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Period::End)
}
def end=(_end); end
# Start of the invoice item period.
sig {
returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Period::Start)
}
def start; end
sig {
params(_start: ::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Period::Start).returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Period::Start)
}
def start=(_start); end
sig {
params(end_: ::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Period::End, start: ::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Period::Start).void
}
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# The coupons to redeem into discounts for the item.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount])).returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Period))
}
def period; end
sig {
params(_period: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Period)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Period))
}
def period=(_period); end
# The ID of the price object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::PriceData)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::PriceData))
}
def price_data=(_price_data); end
# Quantity for this item. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount]), metadata: T.nilable(T::Hash[String, String]), period: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Period), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
discounts: nil,
metadata: nil,
period: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AutomaticTax::Liability)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class BillingThresholds < Stripe::RequestParams
# Monetary threshold that triggers the subscription to advance to a new billing period
sig { returns(T.nilable(Integer)) }
def amount_gte; end
sig { params(_amount_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_gte=(_amount_gte); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
sig {
params(_reset_billing_cycle_anchor: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def reset_billing_cycle_anchor=(_reset_billing_cycle_anchor); end
sig {
params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
}
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Duration < Stripe::RequestParams
# Specifies phase duration. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The multiplier applied to the interval.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::InvoiceSettings::Issuer)).void
}
def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end
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))
sig { returns(Integer) }
def usage_gte; end
sig { params(_usage_gte: Integer).returns(Integer) }
def usage_gte=(_usage_gte); end
sig { params(usage_gte: Integer).void }
def initialize(usage_gte: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::PriceData::Recurring)
}
def recurring; end
sig {
params(_recurring: ::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::PriceData::Recurring).returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::PriceData::Recurring)
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: ::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# The coupons to redeem into discounts for the subscription item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount])))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::PriceData)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::PriceData))
}
def price_data=(_price_data); end
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# Options that configure the trial on the subscription item.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Trial)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Trial))
}
def trial=(_trial); end
sig {
params(billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::BillingThresholds)), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount])), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String])), trial: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Trial)).void
}
def initialize(
billing_thresholds: nil,
discounts: nil,
metadata: nil,
plan: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
class PauseCollection < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(behavior: String).void }
def initialize(behavior: nil); end
end
class TransferData < Stripe::RequestParams
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount_percent: T.nilable(Float), destination: String).void }
def initialize(amount_percent: nil, destination: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
sig { params(_prorate_up_front: T.nilable(String)).returns(T.nilable(String)) }
def prorate_up_front=(_prorate_up_front); end
sig { params(prorate_up_front: T.nilable(String)).void }
def initialize(prorate_up_front: nil); end
end
# Defines how the subscription should behave when a trial ends.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::TrialSettings::EndBehavior))
}
def end_behavior; end
sig {
params(_end_behavior: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::TrialSettings::EndBehavior)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::TrialSettings::EndBehavior))
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::TrialSettings::EndBehavior)).void
}
def initialize(end_behavior: nil); end
end
# A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem]))
}
def add_invoice_items; end
sig {
params(_add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem])).returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem]))
}
def add_invoice_items=(_add_invoice_items); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
sig { params(_application_fee_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def application_fee_percent=(_application_fee_percent); end
# Automatic tax settings for this phase.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AutomaticTax))
}
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AutomaticTax)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# 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).
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::Phase::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::Phase::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::Phase::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount])))
}
def discounts=(_discounts); end
# The number of intervals the phase should last. If set, `end_date` must not be set.
sig { returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Duration)) }
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Duration)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Duration))
}
def duration=(_duration); end
# The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::InvoiceSettings)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
sig { returns(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item]) }
def items; end
sig {
params(_items: T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item]).returns(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item])
}
def items=(_items); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The account on behalf of which to charge, for each of the associated subscription's invoices.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::PauseCollection))
}
def pause_collection; end
sig {
params(_pause_collection: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::PauseCollection)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::PauseCollection))
}
def pause_collection=(_pause_collection); end
# 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.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::TransferData))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::TransferData)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::TransferData))
}
def transfer_data=(_transfer_data); end
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
sig { returns(T.nilable(T::Boolean)) }
def trial; end
sig { params(_trial: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def trial=(_trial); end
# Specify trial behavior when crossing phase boundaries
sig { returns(T.nilable(String)) }
def trial_continuation; end
sig { params(_trial_continuation: T.nilable(String)).returns(T.nilable(String)) }
def trial_continuation=(_trial_continuation); end
# Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
sig { returns(T.nilable(Integer)) }
def trial_end; end
sig { params(_trial_end: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_end=(_trial_end); end
# Settings related to subscription trials.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::TrialSettings))
}
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::TrialSettings)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::Phase::BillingThresholds)), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.any(String, T::Array[String])), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount])), duration: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Duration), end_date: T.nilable(Integer), invoice_settings: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::InvoiceSettings), items: T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item], metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), pause_collection: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::PauseCollection), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::TransferData), trial: T.nilable(T::Boolean), trial_continuation: T.nilable(String), trial_end: T.nilable(Integer), trial_settings: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::TrialSettings)).void
}
def initialize(
add_invoice_items: nil,
application_fee_percent: nil,
automatic_tax: nil,
billing_cycle_anchor: nil,
billing_thresholds: nil,
collection_method: nil,
currency: nil,
default_payment_method: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
duration: nil,
end_date: nil,
invoice_settings: nil,
items: nil,
metadata: nil,
on_behalf_of: nil,
pause_collection: nil,
proration_behavior: nil,
transfer_data: nil,
trial: nil,
trial_continuation: nil,
trial_end: nil,
trial_settings: nil
); end
end
class Prebilling < Stripe::RequestParams
# This is used to determine the number of billing cycles to prebill.
sig { returns(Integer) }
def iterations; end
sig { params(_iterations: Integer).returns(Integer) }
def iterations=(_iterations); end
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
sig { returns(T.nilable(String)) }
def update_behavior; end
sig { params(_update_behavior: T.nilable(String)).returns(T.nilable(String)) }
def update_behavior=(_update_behavior); end
sig { params(iterations: Integer, update_behavior: T.nilable(String)).void }
def initialize(iterations: nil, update_behavior: nil); end
end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
sig { params(_billing_behavior: T.nilable(String)).returns(T.nilable(String)) }
def billing_behavior=(_billing_behavior); end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig { returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::BillingMode)) }
def billing_mode; end
sig {
params(_billing_mode: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::BillingMode)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::BillingMode))
}
def billing_mode=(_billing_mode); end
# The identifier of the customer to create the subscription schedule for.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The identifier of the account to create the subscription schedule for.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Object representing the subscription schedule's default settings.
sig { returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings)) }
def default_settings; end
sig {
params(_default_settings: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings))
}
def default_settings=(_default_settings); end
# Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
sig { returns(T.nilable(String)) }
def end_behavior; end
sig { params(_end_behavior: T.nilable(String)).returns(T.nilable(String)) }
def end_behavior=(_end_behavior); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
sig { returns(T.nilable(String)) }
def from_subscription; end
sig { params(_from_subscription: T.nilable(String)).returns(T.nilable(String)) }
def from_subscription=(_from_subscription); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
sig { returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase])) }
def phases; end
sig {
params(_phases: T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase])).returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase]))
}
def phases=(_phases); end
# If specified, the invoicing for the given billing cycle iterations will be processed now.
sig { returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Prebilling)) }
def prebilling; end
sig {
params(_prebilling: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Prebilling)).returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Prebilling))
}
def prebilling=(_prebilling); end
# When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
sig { returns(T.nilable(T.any(Integer, String))) }
def start_date; end
sig {
params(_start_date: T.nilable(T.any(Integer, String))).returns(T.nilable(T.any(Integer, String)))
}
def start_date=(_start_date); end
sig {
params(billing_behavior: T.nilable(String), billing_mode: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::BillingMode), customer: T.nilable(String), customer_account: T.nilable(String), default_settings: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings), end_behavior: T.nilable(String), expand: T.nilable(T::Array[String]), from_subscription: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), phases: T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase]), prebilling: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Prebilling), start_date: T.nilable(T.any(Integer, String))).void
}
def initialize(
billing_behavior: nil,
billing_mode: nil,
customer: nil,
customer_account: nil,
default_settings: nil,
end_behavior: nil,
expand: nil,
from_subscription: nil,
metadata: nil,
phases: nil,
prebilling: nil,
start_date: nil
); end
end
class UpdateParams < Stripe::RequestParams
class DefaultSettings < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::AutomaticTax::Liability)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class BillingThresholds < Stripe::RequestParams
# Monetary threshold that triggers the subscription to advance to a new billing period
sig { returns(T.nilable(Integer)) }
def amount_gte; end
sig { params(_amount_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_gte=(_amount_gte); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
sig {
params(_reset_billing_cycle_anchor: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def reset_billing_cycle_anchor=(_reset_billing_cycle_anchor); end
sig {
params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
}
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::InvoiceSettings::Issuer)).void
}
def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end
end
class TransferData < Stripe::RequestParams
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount_percent: T.nilable(Float), destination: String).void }
def initialize(amount_percent: nil, destination: nil); end
end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
sig { params(_application_fee_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def application_fee_percent=(_application_fee_percent); end
# Default settings for automatic tax computation.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::AutomaticTax))
}
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::AutomaticTax)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# 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).
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::InvoiceSettings)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# The account on behalf of which to charge, for each of the associated subscription's invoices.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::TransferData)))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::TransferData))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::TransferData)))
}
def transfer_data=(_transfer_data); end
sig {
params(application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::BillingThresholds)), collection_method: T.nilable(String), default_payment_method: T.nilable(String), description: T.nilable(String), invoice_settings: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::InvoiceSettings), on_behalf_of: T.nilable(String), transfer_data: T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::TransferData))).void
}
def initialize(
application_fee_percent: nil,
automatic_tax: nil,
billing_cycle_anchor: nil,
billing_thresholds: nil,
collection_method: nil,
default_payment_method: nil,
description: nil,
invoice_settings: nil,
on_behalf_of: nil,
transfer_data: nil
); end
end
class Phase < Stripe::RequestParams
class AddInvoiceItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
class End < Stripe::RequestParams
# A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the end of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
class Start < Stripe::RequestParams
# A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the start of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
# End of the invoice item period.
sig {
returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Period::End)
}
def end; end
sig {
params(_end: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Period::End).returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Period::End)
}
def end=(_end); end
# Start of the invoice item period.
sig {
returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Period::Start)
}
def start; end
sig {
params(_start: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Period::Start).returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Period::Start)
}
def start=(_start); end
sig {
params(end_: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Period::End, start: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Period::Start).void
}
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# The coupons to redeem into discounts for the item.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount])).returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Period))
}
def period; end
sig {
params(_period: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Period)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Period))
}
def period=(_period); end
# The ID of the price object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::PriceData)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::PriceData))
}
def price_data=(_price_data); end
# Quantity for this item. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount]), metadata: T.nilable(T::Hash[String, String]), period: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Period), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
discounts: nil,
metadata: nil,
period: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AutomaticTax::Liability)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class BillingThresholds < Stripe::RequestParams
# Monetary threshold that triggers the subscription to advance to a new billing period
sig { returns(T.nilable(Integer)) }
def amount_gte; end
sig { params(_amount_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_gte=(_amount_gte); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
sig {
params(_reset_billing_cycle_anchor: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def reset_billing_cycle_anchor=(_reset_billing_cycle_anchor); end
sig {
params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
}
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Duration < Stripe::RequestParams
# Specifies phase duration. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The multiplier applied to the interval.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::InvoiceSettings::Issuer)).void
}
def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end
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))
sig { returns(Integer) }
def usage_gte; end
sig { params(_usage_gte: Integer).returns(Integer) }
def usage_gte=(_usage_gte); end
sig { params(usage_gte: Integer).void }
def initialize(usage_gte: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::PriceData::Recurring)
}
def recurring; end
sig {
params(_recurring: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::PriceData::Recurring).returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::PriceData::Recurring)
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# The coupons to redeem into discounts for the subscription item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount])))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::PriceData)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::PriceData))
}
def price_data=(_price_data); end
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# Options that configure the trial on the subscription item.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Trial)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Trial))
}
def trial=(_trial); end
sig {
params(billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::BillingThresholds)), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount])), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String])), trial: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Trial)).void
}
def initialize(
billing_thresholds: nil,
discounts: nil,
metadata: nil,
plan: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
class PauseCollection < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(behavior: String).void }
def initialize(behavior: nil); end
end
class TransferData < Stripe::RequestParams
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount_percent: T.nilable(Float), destination: String).void }
def initialize(amount_percent: nil, destination: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
sig { params(_prorate_up_front: T.nilable(String)).returns(T.nilable(String)) }
def prorate_up_front=(_prorate_up_front); end
sig { params(prorate_up_front: T.nilable(String)).void }
def initialize(prorate_up_front: nil); end
end
# Defines how the subscription should behave when a trial ends.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TrialSettings::EndBehavior))
}
def end_behavior; end
sig {
params(_end_behavior: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TrialSettings::EndBehavior)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TrialSettings::EndBehavior))
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TrialSettings::EndBehavior)).void
}
def initialize(end_behavior: nil); end
end
# A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem]))
}
def add_invoice_items; end
sig {
params(_add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem])).returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem]))
}
def add_invoice_items=(_add_invoice_items); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
sig { params(_application_fee_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def application_fee_percent=(_application_fee_percent); end
# Automatic tax settings for this phase.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AutomaticTax))
}
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AutomaticTax)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# 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).
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::Phase::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::Phase::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::Phase::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount])))
}
def discounts=(_discounts); end
# The number of intervals the phase should last. If set, `end_date` must not be set.
sig { returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Duration)) }
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Duration)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Duration))
}
def duration=(_duration); end
# The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
sig { returns(T.nilable(T.any(Integer, String))) }
def end_date; end
sig {
params(_end_date: T.nilable(T.any(Integer, String))).returns(T.nilable(T.any(Integer, String)))
}
def end_date=(_end_date); end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::InvoiceSettings)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
sig { returns(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item]) }
def items; end
sig {
params(_items: T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item]).returns(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item])
}
def items=(_items); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The account on behalf of which to charge, for each of the associated subscription's invoices.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::PauseCollection))
}
def pause_collection; end
sig {
params(_pause_collection: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::PauseCollection)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::PauseCollection))
}
def pause_collection=(_pause_collection); end
# 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.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
sig { returns(T.nilable(T.any(Integer, String))) }
def start_date; end
sig {
params(_start_date: T.nilable(T.any(Integer, String))).returns(T.nilable(T.any(Integer, String)))
}
def start_date=(_start_date); end
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TransferData))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TransferData)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TransferData))
}
def transfer_data=(_transfer_data); end
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
sig { returns(T.nilable(T::Boolean)) }
def trial; end
sig { params(_trial: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def trial=(_trial); end
# Specify trial behavior when crossing phase boundaries
sig { returns(T.nilable(String)) }
def trial_continuation; end
sig { params(_trial_continuation: T.nilable(String)).returns(T.nilable(String)) }
def trial_continuation=(_trial_continuation); end
# Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
sig { returns(T.nilable(T.any(Integer, String))) }
def trial_end; end
sig {
params(_trial_end: T.nilable(T.any(Integer, String))).returns(T.nilable(T.any(Integer, String)))
}
def trial_end=(_trial_end); end
# Settings related to subscription trials.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TrialSettings))
}
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TrialSettings)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::Phase::BillingThresholds)), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.any(String, T::Array[String])), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount])), duration: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Duration), end_date: T.nilable(T.any(Integer, String)), invoice_settings: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::InvoiceSettings), items: T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item], metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), pause_collection: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::PauseCollection), proration_behavior: T.nilable(String), start_date: T.nilable(T.any(Integer, String)), transfer_data: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TransferData), trial: T.nilable(T::Boolean), trial_continuation: T.nilable(String), trial_end: T.nilable(T.any(Integer, String)), trial_settings: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TrialSettings)).void
}
def initialize(
add_invoice_items: nil,
application_fee_percent: nil,
automatic_tax: nil,
billing_cycle_anchor: nil,
billing_thresholds: nil,
collection_method: nil,
currency: nil,
default_payment_method: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
duration: nil,
end_date: nil,
invoice_settings: nil,
items: nil,
metadata: nil,
on_behalf_of: nil,
pause_collection: nil,
proration_behavior: nil,
start_date: nil,
transfer_data: nil,
trial: nil,
trial_continuation: nil,
trial_end: nil,
trial_settings: nil
); end
end
class Prebilling < Stripe::RequestParams
# This is used to determine the number of billing cycles to prebill.
sig { returns(Integer) }
def iterations; end
sig { params(_iterations: Integer).returns(Integer) }
def iterations=(_iterations); end
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
sig { returns(T.nilable(String)) }
def update_behavior; end
sig { params(_update_behavior: T.nilable(String)).returns(T.nilable(String)) }
def update_behavior=(_update_behavior); end
sig { params(iterations: Integer, update_behavior: T.nilable(String)).void }
def initialize(iterations: nil, update_behavior: nil); end
end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
sig { params(_billing_behavior: T.nilable(String)).returns(T.nilable(String)) }
def billing_behavior=(_billing_behavior); end
# Object representing the subscription schedule's default settings.
sig { returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings)) }
def default_settings; end
sig {
params(_default_settings: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings))
}
def default_settings=(_default_settings); end
# Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
sig { returns(T.nilable(String)) }
def end_behavior; end
sig { params(_end_behavior: T.nilable(String)).returns(T.nilable(String)) }
def end_behavior=(_end_behavior); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted.
sig { returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase])) }
def phases; end
sig {
params(_phases: T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase])).returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase]))
}
def phases=(_phases); end
# If specified, the invoicing for the given billing cycle iterations will be processed now.
sig { returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Prebilling)) }
def prebilling; end
sig {
params(_prebilling: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Prebilling)).returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Prebilling))
}
def prebilling=(_prebilling); end
# If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
sig {
params(billing_behavior: T.nilable(String), default_settings: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings), end_behavior: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), phases: T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase]), prebilling: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Prebilling), proration_behavior: T.nilable(String)).void
}
def initialize(
billing_behavior: nil,
default_settings: nil,
end_behavior: nil,
expand: nil,
metadata: nil,
phases: nil,
prebilling: nil,
proration_behavior: nil
); end
end
class AmendParams < Stripe::RequestParams
class Amendment < Stripe::RequestParams
class AmendmentEnd < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
sig { returns(String) }
def discount; end
sig { params(_discount: String).returns(String) }
def discount=(_discount); end
sig { params(discount: String).void }
def initialize(discount: nil); end
end
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Use the `end` time of a given discount.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd::DiscountEnd))
}
def discount_end=(_discount_end); end
# Time span for the amendment starting from the `amendment_start`.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select one of three ways to pass the `amendment_end`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(discount_end: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd::DiscountEnd), duration: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(discount_end: nil, duration: nil, timestamp: nil, type: nil); end
end
class AmendmentStart < Stripe::RequestParams
class AmendmentEnd < Stripe::RequestParams
# The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array.
sig { returns(Integer) }
def index; end
sig { params(_index: Integer).returns(Integer) }
def index=(_index); end
sig { params(index: Integer).void }
def initialize(index: nil); end
end
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
sig { returns(String) }
def discount; end
sig { params(_discount: String).returns(String) }
def discount=(_discount); end
sig { params(discount: String).void }
def initialize(discount: nil); end
end
# Details of another amendment in the same array, immediately after which this amendment should begin.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart::AmendmentEnd))
}
def amendment_end; end
sig {
params(_amendment_end: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart::AmendmentEnd)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart::AmendmentEnd))
}
def amendment_end=(_amendment_end); end
# Use the `end` time of a given discount.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart::DiscountEnd))
}
def discount_end=(_discount_end); end
# A precise Unix timestamp for the amendment to start.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select one of three ways to pass the `amendment_start`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(amendment_end: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart::AmendmentEnd), discount_end: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart::DiscountEnd), timestamp: T.nilable(Integer), type: String).void
}
def initialize(amendment_end: nil, discount_end: nil, timestamp: nil, type: nil); end
end
class DiscountAction < Stripe::RequestParams
class Add < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
# The coupon code to redeem.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# An ID of an existing discount for a coupon that was already redeemed.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Add::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Add::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Add::DiscountEnd))
}
def discount_end=(_discount_end); end
# The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
# The promotion code to redeem.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Add::DiscountEnd), index: T.nilable(Integer), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
index: nil,
promotion_code: nil
); end
end
class Remove < Stripe::RequestParams
# The coupon code to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# The ID of a discount to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# The ID of a promotion code to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
class Set < Stripe::RequestParams
# The coupon code to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# An ID of an existing discount to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# An ID of an existing promotion code to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
# Details of the discount to add.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Add))
}
def add; end
sig {
params(_add: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Add)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Add))
}
def add=(_add); end
# Details of the discount to remove.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Remove))
}
def remove; end
sig {
params(_remove: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Remove)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Remove))
}
def remove=(_remove); end
# Details of the discount to replace the existing discounts with.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Set))
}
def set; end
sig {
params(_set: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Set)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Set))
}
def set=(_set); end
# Determines the type of discount action.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(add: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Add), remove: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Remove), set: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Set), type: String).void
}
def initialize(add: nil, remove: nil, set: nil, type: nil); end
end
class ItemAction < Stripe::RequestParams
class Add < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); end
end
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount])).returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# Quantity for this item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
# Options that configure the trial on the subscription item.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Trial)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Trial))
}
def trial=(_trial); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount]), metadata: T.nilable(T::Hash[String, String]), price: String, quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String]), trial: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Trial)).void
}
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
class Remove < Stripe::RequestParams
# ID of a price to remove.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
sig { params(price: String).void }
def initialize(price: nil); end
end
class Set < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); end
end
# If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount])).returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount]))
}
def discounts=(_discounts); end
# If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
# If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Trial)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Trial))
}
def trial=(_trial); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount]), metadata: T.nilable(T::Hash[String, String]), price: String, quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String]), trial: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Trial)).void
}
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
# Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add))
}
def add; end
sig {
params(_add: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add))
}
def add=(_add); end
# Details of the subscription item to remove.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Remove))
}
def remove; end
sig {
params(_remove: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Remove)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Remove))
}
def remove=(_remove); end
# Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set))
}
def set; end
sig {
params(_set: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set))
}
def set=(_set); end
# Determines the type of item action.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(add: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add), remove: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Remove), set: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set), type: String).void
}
def initialize(add: nil, remove: nil, set: nil, type: nil); end
end
class MetadataAction < Stripe::RequestParams
# Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
sig { returns(T.nilable(T::Hash[String, String])) }
def add; end
sig {
params(_add: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def add=(_add); end
# Keys to remove from schedule phase metadata.
sig { returns(T.nilable(T::Array[String])) }
def remove; end
sig { params(_remove: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def remove=(_remove); end
# Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def set; end
sig {
params(_set: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def set=(_set); end
# Select one of three ways to update phase-level `metadata` on subscription schedules.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(add: T.nilable(T::Hash[String, String]), remove: T.nilable(T::Array[String]), set: T.nilable(T.any(String, T::Hash[String, String])), type: String).void
}
def initialize(add: nil, remove: nil, set: nil, type: nil); end
end
class SetPauseCollection < Stripe::RequestParams
class Set < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(behavior: String).void }
def initialize(behavior: nil); end
end
# Details of the pause_collection behavior to apply to the amendment.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::SetPauseCollection::Set))
}
def set; end
sig {
params(_set: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::SetPauseCollection::Set)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::SetPauseCollection::Set))
}
def set=(_set); end
# Determines the type of the pause_collection amendment.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(set: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::SetPauseCollection::Set), type: String).void
}
def initialize(set: nil, type: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
sig { params(_prorate_up_front: T.nilable(String)).returns(T.nilable(String)) }
def prorate_up_front=(_prorate_up_front); end
sig { params(prorate_up_front: T.nilable(String)).void }
def initialize(prorate_up_front: nil); end
end
# Defines how the subscription should behave when a trial ends.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::TrialSettings::EndBehavior))
}
def end_behavior; end
sig {
params(_end_behavior: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::TrialSettings::EndBehavior)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::TrialSettings::EndBehavior))
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::TrialSettings::EndBehavior)).void
}
def initialize(end_behavior: nil); end
end
# Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd))
}
def amendment_end; end
sig {
params(_amendment_end: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd))
}
def amendment_end=(_amendment_end); end
# Details to identify the earliest timestamp where the proposed change should take effect.
sig { returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart) }
def amendment_start; end
sig {
params(_amendment_start: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart).returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart)
}
def amendment_start=(_amendment_start); end
# For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# Changes to the coupons being redeemed or discounts being applied during the amendment time span.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction]))
}
def discount_actions; end
sig {
params(_discount_actions: T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction])).returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction]))
}
def discount_actions=(_discount_actions); end
# Changes to the subscription items during the amendment time span.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction]))
}
def item_actions; end
sig {
params(_item_actions: T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction])).returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction]))
}
def item_actions=(_item_actions); end
# Instructions for how to modify phase metadata
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::MetadataAction]))
}
def metadata_actions; end
sig {
params(_metadata_actions: T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::MetadataAction])).returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::MetadataAction]))
}
def metadata_actions=(_metadata_actions); end
# Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::SetPauseCollection))
}
def set_pause_collection; end
sig {
params(_set_pause_collection: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::SetPauseCollection)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::SetPauseCollection))
}
def set_pause_collection=(_set_pause_collection); end
# Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
sig { returns(T.nilable(String)) }
def set_schedule_end; end
sig { params(_set_schedule_end: T.nilable(String)).returns(T.nilable(String)) }
def set_schedule_end=(_set_schedule_end); end
# Settings related to subscription trials.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::TrialSettings))
}
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::TrialSettings)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(amendment_end: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd), amendment_start: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart, billing_cycle_anchor: T.nilable(String), discount_actions: T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction]), item_actions: T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction]), metadata_actions: T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::MetadataAction]), proration_behavior: T.nilable(String), set_pause_collection: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::SetPauseCollection), set_schedule_end: T.nilable(String), trial_settings: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Amendment::TrialSettings)).void
}
def initialize(
amendment_end: nil,
amendment_start: nil,
billing_cycle_anchor: nil,
discount_actions: nil,
item_actions: nil,
metadata_actions: nil,
proration_behavior: nil,
set_pause_collection: nil,
set_schedule_end: nil,
trial_settings: nil
); end
end
class Prebilling < Stripe::RequestParams
class BillFrom < Stripe::RequestParams
class AmendmentStart < Stripe::RequestParams
# The position of the amendment in the `amendments` array with which prebilling should begin. Indexes start from 0 and must be less than the total number of supplied amendments.
sig { returns(Integer) }
def index; end
sig { params(_index: Integer).returns(Integer) }
def index=(_index); end
sig { params(index: Integer).void }
def initialize(index: nil); end
end
# Start the prebilled period when a specified amendment begins.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillFrom::AmendmentStart))
}
def amendment_start; end
sig {
params(_amendment_start: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillFrom::AmendmentStart)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillFrom::AmendmentStart))
}
def amendment_start=(_amendment_start); end
# Start the prebilled period at a precise integer timestamp, starting from the Unix epoch.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select one of several ways to pass the `bill_from` value.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(amendment_start: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillFrom::AmendmentStart), timestamp: T.nilable(Integer), type: String).void
}
def initialize(amendment_start: nil, timestamp: nil, type: nil); end
end
class BillUntil < Stripe::RequestParams
class AmendmentEnd < Stripe::RequestParams
# The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments.
sig { returns(Integer) }
def index; end
sig { params(_index: Integer).returns(Integer) }
def index=(_index); end
sig { params(index: Integer).void }
def initialize(index: nil); end
end
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# End the prebilled period when a specified amendment ends.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil::AmendmentEnd))
}
def amendment_end; end
sig {
params(_amendment_end: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil::AmendmentEnd)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil::AmendmentEnd))
}
def amendment_end=(_amendment_end); end
# Time span for prebilling, starting from `bill_from`.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil::Duration)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil::Duration))
}
def duration=(_duration); end
# End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select one of several ways to pass the `bill_until` value.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(amendment_end: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil::AmendmentEnd), duration: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(amendment_end: nil, duration: nil, timestamp: nil, type: nil); end
end
# The beginning of the prebilled time period. The default value is `now`.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillFrom))
}
def bill_from; end
sig {
params(_bill_from: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillFrom)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillFrom))
}
def bill_from=(_bill_from); end
# The end of the prebilled time period.
sig {
returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil))
}
def bill_until; end
sig {
params(_bill_until: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil))
}
def bill_until=(_bill_until); end
# When the prebilling invoice should be created. The default value is `now`.
sig { returns(T.nilable(String)) }
def invoice_at; end
sig { params(_invoice_at: T.nilable(String)).returns(T.nilable(String)) }
def invoice_at=(_invoice_at); end
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
sig { returns(T.nilable(String)) }
def update_behavior; end
sig { params(_update_behavior: T.nilable(String)).returns(T.nilable(String)) }
def update_behavior=(_update_behavior); end
sig {
params(bill_from: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillFrom), bill_until: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil), invoice_at: T.nilable(String), update_behavior: T.nilable(String)).void
}
def initialize(bill_from: nil, bill_until: nil, invoice_at: nil, update_behavior: nil); end
end
class ScheduleSettings < Stripe::RequestParams
# Behavior of the subscription schedule and underlying subscription when it ends.
sig { returns(T.nilable(String)) }
def end_behavior; end
sig { params(_end_behavior: T.nilable(String)).returns(T.nilable(String)) }
def end_behavior=(_end_behavior); end
sig { params(end_behavior: T.nilable(String)).void }
def initialize(end_behavior: nil); end
end
# Changes to apply to the phases of the subscription schedule, in the order provided.
sig { returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment])) }
def amendments; end
sig {
params(_amendments: T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment])).returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment]))
}
def amendments=(_amendments); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Provide any time periods to bill in advance.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::AmendParams::Prebilling])))
}
def prebilling; end
sig {
params(_prebilling: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::AmendParams::Prebilling]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::AmendParams::Prebilling])))
}
def prebilling=(_prebilling); end
# In cases where the amendment changes the currently active phase,
# specifies if and how to prorate at the time of the request.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Changes to apply to the subscription schedule.
sig { returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::ScheduleSettings)) }
def schedule_settings; end
sig {
params(_schedule_settings: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::ScheduleSettings)).returns(T.nilable(::Stripe::SubscriptionSchedule::AmendParams::ScheduleSettings))
}
def schedule_settings=(_schedule_settings); end
sig {
params(amendments: T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment]), expand: T.nilable(T::Array[String]), prebilling: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::AmendParams::Prebilling])), proration_behavior: T.nilable(String), schedule_settings: T.nilable(::Stripe::SubscriptionSchedule::AmendParams::ScheduleSettings)).void
}
def initialize(
amendments: nil,
expand: nil,
prebilling: nil,
proration_behavior: nil,
schedule_settings: nil
); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def invoice_now; end
sig { params(_invoice_now: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def invoice_now=(_invoice_now); end
# If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def prorate; end
sig { params(_prorate: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def prorate=(_prorate); end
sig {
params(expand: T.nilable(T::Array[String]), invoice_now: T.nilable(T::Boolean), prorate: T.nilable(T::Boolean)).void
}
def initialize(expand: nil, invoice_now: nil, prorate: nil); end
end
class ReleaseParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Keep any cancellation on the subscription that the schedule has set
sig { returns(T.nilable(T::Boolean)) }
def preserve_cancel_date; end
sig { params(_preserve_cancel_date: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def preserve_cancel_date=(_preserve_cancel_date); end
sig {
params(expand: T.nilable(T::Array[String]), preserve_cancel_date: T.nilable(T::Boolean)).void
}
def initialize(expand: nil, preserve_cancel_date: nil); end
end
# Amends an existing subscription schedule.
sig {
params(params: T.any(::Stripe::SubscriptionSchedule::AmendParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
}
def amend(params = {}, opts = {}); end
# Amends an existing subscription schedule.
sig {
params(schedule: String, params: T.any(::Stripe::SubscriptionSchedule::AmendParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
}
def self.amend(schedule, params = {}, opts = {}); end
# Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
sig {
params(params: T.any(::Stripe::SubscriptionSchedule::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
}
def cancel(params = {}, opts = {}); end
# Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
sig {
params(schedule: String, params: T.any(::Stripe::SubscriptionSchedule::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
}
def self.cancel(schedule, params = {}, opts = {}); end
# Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.
sig {
params(params: T.any(::Stripe::SubscriptionSchedule::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
}
def self.create(params = {}, opts = {}); end
# Retrieves the list of your subscription schedules.
sig {
params(params: T.any(::Stripe::SubscriptionSchedule::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
sig {
params(params: T.any(::Stripe::SubscriptionSchedule::ReleaseParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
}
def release(params = {}, opts = {}); end
# Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
sig {
params(schedule: String, params: T.any(::Stripe::SubscriptionSchedule::ReleaseParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
}
def self.release(schedule, params = {}, opts = {}); end
# Updates an existing subscription schedule.
sig {
params(schedule: String, params: T.any(::Stripe::SubscriptionSchedule::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
}
def self.update(schedule, params = {}, opts = {}); end
end
end
# typed: 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
class AutomaticTax < Stripe::StripeObject
class Liability < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# If Stripe disabled automatic tax, this enum describes why.
sig { returns(T.nilable(String)) }
def disabled_reason; end
# Whether Stripe automatically computes tax on this subscription.
sig { returns(T::Boolean) }
def enabled; end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(Liability)) }
def liability; end
end
class BillingCycleAnchorConfig < Stripe::StripeObject
# The day of the month of the billing_cycle_anchor.
sig { returns(Integer) }
def day_of_month; end
# The hour of the day of the billing_cycle_anchor.
sig { returns(T.nilable(Integer)) }
def hour; end
# The minute of the hour of the billing_cycle_anchor.
sig { returns(T.nilable(Integer)) }
def minute; end
# The month to start full cycle billing periods.
sig { returns(T.nilable(Integer)) }
def month; end
# The second of the minute of the billing_cycle_anchor.
sig { returns(T.nilable(Integer)) }
def second; end
end
class BillingMode < Stripe::StripeObject
class Flexible < Stripe::StripeObject
# When true, proration line items will show accurate discount amounts and use gross amounts, making them consistent with non-proration line items.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
end
# Configure behavior for flexible billing mode
sig { returns(T.nilable(Flexible)) }
def flexible; end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig { returns(String) }
def type; end
# Details on when the current billing_mode was adopted.
sig { returns(T.nilable(Integer)) }
def updated_at; end
end
class BillingThresholds < Stripe::StripeObject
# Monetary threshold that triggers the subscription to create an invoice
sig { returns(T.nilable(Integer)) }
def amount_gte; end
# 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. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
end
class CancellationDetails < Stripe::StripeObject
# Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
sig { returns(T.nilable(String)) }
def comment; end
# The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
sig { returns(T.nilable(String)) }
def feedback; end
# Why this subscription was canceled.
sig { returns(T.nilable(String)) }
def reason; end
end
class InvoiceSettings < Stripe::StripeObject
class Issuer < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# Type of the account referenced.
sig { returns(String) }
def type; end
end
# The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
def account_tax_ids; end
# Attribute for field issuer
sig { returns(Issuer) }
def issuer; end
end
class LastPriceMigrationError < Stripe::StripeObject
class FailedTransition < Stripe::StripeObject
# The original price to be migrated.
sig { returns(String) }
def source_price; end
# The intended resulting price of the migration.
sig { returns(String) }
def target_price; end
end
# The time at which the price migration encountered an error.
sig { returns(Integer) }
def errored_at; end
# The involved price pairs in each failed transition.
sig { returns(T::Array[FailedTransition]) }
def failed_transitions; end
# The type of error encountered by the price migration.
sig { returns(String) }
def type; end
end
class PauseCollection < Stripe::StripeObject
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
# The time after which the subscription will resume collecting payments.
sig { returns(T.nilable(Integer)) }
def resumes_at; end
end
class PaymentSettings < Stripe::StripeObject
class PaymentMethodOptions < Stripe::StripeObject
class AcssDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
end
class Bancontact < Stripe::StripeObject
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(String) }
def preferred_language; end
end
class Card < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(T.nilable(String)) }
def amount_type; end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
# Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
end
class CustomerBalance < Stripe::StripeObject
class BankTransfer < Stripe::StripeObject
class EuBankTransfer < Stripe::StripeObject
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
end
# Attribute for field eu_bank_transfer
sig { returns(T.nilable(EuBankTransfer)) }
def eu_bank_transfer; end
# The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(T.nilable(String)) }
def type; end
end
# Attribute for field bank_transfer
sig { returns(T.nilable(BankTransfer)) }
def bank_transfer; end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
end
class IdBankTransfer < Stripe::StripeObject; end
class Konbini < Stripe::StripeObject; end
class Pix < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
# Determines if the amount includes the IOF tax.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
sig { returns(T.nilable(String)) }
def end_date; end
# Schedule at which the future payments will be charged.
sig { returns(T.nilable(String)) }
def payment_schedule; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
end
class SepaDebit < Stripe::StripeObject; end
class Upi < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(T.nilable(String)) }
def amount_type; end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
end
# Attribute for field mandate_options
sig { returns(T.nilable(MandateOptions)) }
def mandate_options; end
end
class UsBankAccount < Stripe::StripeObject
class FinancialConnections < Stripe::StripeObject
class Filters < Stripe::StripeObject
# The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
# The institution to use to filter for possible accounts to link.
sig { returns(T.nilable(String)) }
def institution; end
end
# Attribute for field filters
sig { returns(T.nilable(Filters)) }
def filters; end
# The list of permissions to request. The `payment_method` permission must be included.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
# Data features requested to be retrieved upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
end
# Attribute for field financial_connections
sig { returns(T.nilable(FinancialConnections)) }
def financial_connections; end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
end
# This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.
sig { returns(T.nilable(AcssDebit)) }
def acss_debit; end
# This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.
sig { returns(T.nilable(Bancontact)) }
def bancontact; end
# This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
sig { returns(T.nilable(Card)) }
def card; end
# This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
sig { returns(T.nilable(CustomerBalance)) }
def customer_balance; end
# This sub-hash contains details about the Indonesia bank transfer payment method options to pass to invoices created by the subscription.
sig { returns(T.nilable(IdBankTransfer)) }
def id_bank_transfer; end
# This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.
sig { returns(T.nilable(Konbini)) }
def konbini; end
# This sub-hash contains details about the Pix payment method options to pass to invoices created by the subscription.
sig { returns(T.nilable(Pix)) }
def pix; end
# This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.
sig { returns(T.nilable(SepaDebit)) }
def sepa_debit; end
# This sub-hash contains details about the UPI payment method options to pass to invoices created by the subscription.
sig { returns(T.nilable(Upi)) }
def upi; end
# This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
end
# Payment-method-specific configuration to provide to invoices created by the subscription.
sig { returns(T.nilable(PaymentMethodOptions)) }
def payment_method_options; end
# The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
# Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`.
sig { returns(T.nilable(String)) }
def save_default_payment_method; end
end
class PendingInvoiceItemInterval < Stripe::StripeObject
# Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
# The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
sig { returns(Integer) }
def interval_count; end
end
class PendingUpdate < Stripe::StripeObject
# If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
sig { returns(T.nilable(Integer)) }
def billing_cycle_anchor; end
# The point after which the changes reflected by this update will be discarded and no longer applied.
sig { returns(Integer) }
def expires_at; end
# The number of iterations of prebilling to apply.
sig { returns(T.nilable(Integer)) }
def prebilling_iterations; end
# List of subscription items, each with an attached plan, that will be set if the update is applied.
sig { returns(T.nilable(T::Array[Stripe::SubscriptionItem])) }
def subscription_items; end
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
sig { returns(T.nilable(Integer)) }
def trial_end; end
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
sig { returns(T.nilable(T::Boolean)) }
def trial_from_plan; end
end
class Prebilling < Stripe::StripeObject
# ID of the prebilling invoice.
sig { returns(T.any(String, Stripe::Invoice)) }
def invoice; end
# The end of the last period for which the invoice pre-bills.
sig { returns(Integer) }
def period_end; end
# The start of the first period for which the invoice pre-bills.
sig { returns(Integer) }
def period_start; end
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
sig { returns(T.nilable(String)) }
def update_behavior; end
end
class TransferData < Stripe::StripeObject
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
# The account where funds from the payment will be transferred to upon payment success.
sig { returns(T.any(String, Stripe::Account)) }
def destination; end
end
class TrialSettings < Stripe::StripeObject
class EndBehavior < Stripe::StripeObject
# Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
sig { returns(String) }
def missing_payment_method; end
end
# Defines how a subscription behaves when a free trial ends.
sig { returns(EndBehavior) }
def end_behavior; end
end
# ID of the Connect Application that created the subscription.
sig { returns(T.nilable(T.any(String, Stripe::Application))) }
def application; end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
# Attribute for field automatic_tax
sig { returns(AutomaticTax) }
def automatic_tax; end
# The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.
sig { returns(Integer) }
def billing_cycle_anchor; end
# The fixed values used to calculate the `billing_cycle_anchor`.
sig { returns(T.nilable(BillingCycleAnchorConfig)) }
def billing_cycle_anchor_config; end
# The billing mode of the subscription.
sig { returns(BillingMode) }
def billing_mode; end
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
sig { returns(T.nilable(BillingThresholds)) }
def billing_thresholds; end
# A date in the future at which the subscription will automatically get canceled
sig { returns(T.nilable(Integer)) }
def cancel_at; end
# Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.
sig { returns(T::Boolean) }
def cancel_at_period_end; end
# If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
sig { returns(T.nilable(Integer)) }
def canceled_at; end
# Details about why this subscription was cancelled
sig { returns(T.nilable(CancellationDetails)) }
def cancellation_details; end
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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`.
sig { returns(String) }
def collection_method; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# ID of the customer who owns the subscription.
sig { returns(T.any(String, Stripe::Customer)) }
def customer; end
# ID of the account who owns the subscription.
sig { returns(T.nilable(String)) }
def customer_account; end
# Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
# ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
def default_payment_method; end
# ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
sig {
returns(T.nilable(T.any(String, T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source))))
}
def default_source; end
# The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
sig { returns(T.nilable(T::Array[Stripe::TaxRate])) }
def default_tax_rates; end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
# The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
sig { returns(T::Array[T.any(String, Stripe::Discount)]) }
def discounts; end
# If the subscription has ended, the date the subscription ended.
sig { returns(T.nilable(Integer)) }
def ended_at; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Attribute for field invoice_settings
sig { returns(InvoiceSettings) }
def invoice_settings; end
# List of subscription items, each with an attached price.
sig { returns(Stripe::ListObject) }
def items; end
# Details of the most recent price migration that failed for the subscription.
sig { returns(T.nilable(LastPriceMigrationError)) }
def last_price_migration_error; end
# The most recent invoice this subscription has generated.
sig { returns(T.nilable(T.any(String, Stripe::Invoice))) }
def latest_invoice; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.
sig { returns(T.nilable(Integer)) }
def next_pending_invoice_item_invoice; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://stripe.com/docs/connect/subscriptions#on-behalf-of) for details.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def on_behalf_of; end
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
sig { returns(T.nilable(PauseCollection)) }
def pause_collection; end
# Payment settings passed on to invoices created by the subscription.
sig { returns(T.nilable(PaymentSettings)) }
def payment_settings; end
# Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
sig { returns(T.nilable(PendingInvoiceItemInterval)) }
def pending_invoice_item_interval; end
# You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2).
sig { returns(T.nilable(T.any(String, Stripe::SetupIntent))) }
def pending_setup_intent; end
# If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
sig { returns(T.nilable(PendingUpdate)) }
def pending_update; end
# Time period and invoice for a Subscription billed in advance.
sig { returns(T.nilable(Prebilling)) }
def prebilling; end
# The schedule attached to the subscription
sig { returns(T.nilable(T.any(String, Stripe::SubscriptionSchedule))) }
def schedule; end
# Date when the subscription was first created. The date might differ from the `created` date due to backdating.
sig { returns(Integer) }
def start_date; end
# Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`.
#
# For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, the open invoice will be voided and no further invoices will be generated.
#
# A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over.
#
# A subscription can only enter a `paused` status [when a trial ends without a payment method](https://stripe.com/docs/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged.
#
# If subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings).
#
# If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.
sig { returns(String) }
def status; end
# ID of the test clock this subscription belongs to.
sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
def test_clock; end
# The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
sig { returns(T.nilable(TransferData)) }
def transfer_data; end
# If the subscription has a trial, the end of that trial.
sig { returns(T.nilable(Integer)) }
def trial_end; end
# Settings related to subscription trials.
sig { returns(T.nilable(TrialSettings)) }
def trial_settings; end
# If the subscription has a trial, the beginning of that trial.
sig { returns(T.nilable(Integer)) }
def trial_start; end
class CancelParams < Stripe::RequestParams
class CancellationDetails < Stripe::RequestParams
# Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
sig { returns(T.nilable(String)) }
def comment; end
sig { params(_comment: T.nilable(String)).returns(T.nilable(String)) }
def comment=(_comment); end
# The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
sig { returns(T.nilable(T.any(String, String))) }
def feedback; end
sig {
params(_feedback: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def feedback=(_feedback); end
sig { params(comment: T.nilable(String), feedback: T.nilable(T.any(String, String))).void }
def initialize(comment: nil, feedback: nil); end
end
# Details about why this subscription was cancelled
sig { returns(T.nilable(::Stripe::Subscription::CancelParams::CancellationDetails)) }
def cancellation_details; end
sig {
params(_cancellation_details: T.nilable(::Stripe::Subscription::CancelParams::CancellationDetails)).returns(T.nilable(::Stripe::Subscription::CancelParams::CancellationDetails))
}
def cancellation_details=(_cancellation_details); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def invoice_now; end
sig { params(_invoice_now: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def invoice_now=(_invoice_now); end
# Will generate a proration invoice item that credits remaining unused time until the subscription period end. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def prorate; end
sig { params(_prorate: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def prorate=(_prorate); end
sig {
params(cancellation_details: T.nilable(::Stripe::Subscription::CancelParams::CancellationDetails), expand: T.nilable(T::Array[String]), invoice_now: T.nilable(T::Boolean), prorate: T.nilable(T::Boolean)).void
}
def initialize(cancellation_details: nil, expand: nil, invoice_now: nil, prorate: nil); end
end
class UpdateParams < Stripe::RequestParams
class AddInvoiceItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
class End < Stripe::RequestParams
# A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the end of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
class Start < Stripe::RequestParams
# A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the start of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
# End of the invoice item period.
sig { returns(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Period::End) }
def end; end
sig {
params(_end: ::Stripe::Subscription::UpdateParams::AddInvoiceItem::Period::End).returns(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Period::End)
}
def end=(_end); end
# Start of the invoice item period.
sig { returns(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Period::Start) }
def start; end
sig {
params(_start: ::Stripe::Subscription::UpdateParams::AddInvoiceItem::Period::Start).returns(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Period::Start)
}
def start=(_start); end
sig {
params(end_: ::Stripe::Subscription::UpdateParams::AddInvoiceItem::Period::End, start: ::Stripe::Subscription::UpdateParams::AddInvoiceItem::Period::Start).void
}
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# The coupons to redeem into discounts for the item.
sig {
returns(T.nilable(T::Array[::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount])).returns(T.nilable(T::Array[::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Period)) }
def period; end
sig {
params(_period: T.nilable(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Period)).returns(T.nilable(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Period))
}
def period=(_period); end
# The ID of the price object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::AddInvoiceItem::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Subscription::UpdateParams::AddInvoiceItem::PriceData)).returns(T.nilable(::Stripe::Subscription::UpdateParams::AddInvoiceItem::PriceData))
}
def price_data=(_price_data); end
# Quantity for this item. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount]), metadata: T.nilable(T::Hash[String, String]), period: T.nilable(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Period), price: T.nilable(String), price_data: T.nilable(::Stripe::Subscription::UpdateParams::AddInvoiceItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
discounts: nil,
metadata: nil,
period: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::AutomaticTax::Liability)) }
def liability; end
sig {
params(_liability: T.nilable(::Stripe::Subscription::UpdateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::Subscription::UpdateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::Subscription::UpdateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class BillingThresholds < Stripe::RequestParams
# Monetary threshold that triggers the subscription to advance to a new billing period
sig { returns(T.nilable(Integer)) }
def amount_gte; end
sig { params(_amount_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_gte=(_amount_gte); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
sig {
params(_reset_billing_cycle_anchor: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def reset_billing_cycle_anchor=(_reset_billing_cycle_anchor); end
sig {
params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
}
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
end
class CancellationDetails < Stripe::RequestParams
# Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
sig { returns(T.nilable(String)) }
def comment; end
sig { params(_comment: T.nilable(String)).returns(T.nilable(String)) }
def comment=(_comment); end
# The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
sig { returns(T.nilable(T.any(String, String))) }
def feedback; end
sig {
params(_feedback: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def feedback=(_feedback); end
sig { params(comment: T.nilable(String), feedback: T.nilable(T.any(String, String))).void }
def initialize(comment: nil, feedback: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Subscription::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Subscription::UpdateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Subscription::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Subscription::UpdateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Subscription::UpdateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Subscription::UpdateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Subscription::UpdateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::InvoiceSettings::Issuer)) }
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::Subscription::UpdateParams::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::Subscription::UpdateParams::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), issuer: T.nilable(::Stripe::Subscription::UpdateParams::InvoiceSettings::Issuer)).void
}
def initialize(account_tax_ids: nil, issuer: nil); end
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))
sig { returns(Integer) }
def usage_gte; end
sig { params(_usage_gte: Integer).returns(Integer) }
def usage_gte=(_usage_gte); end
sig { params(usage_gte: Integer).void }
def initialize(usage_gte: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Subscription::UpdateParams::Item::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Subscription::UpdateParams::Item::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Subscription::UpdateParams::Item::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Subscription::UpdateParams::Item::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Subscription::UpdateParams::Item::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Subscription::UpdateParams::Item::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Subscription::UpdateParams::Item::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Subscription::UpdateParams::Item::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig { returns(::Stripe::Subscription::UpdateParams::Item::PriceData::Recurring) }
def recurring; end
sig {
params(_recurring: ::Stripe::Subscription::UpdateParams::Item::PriceData::Recurring).returns(::Stripe::Subscription::UpdateParams::Item::PriceData::Recurring)
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: ::Stripe::Subscription::UpdateParams::Item::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::Item::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::Item::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::Item::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def clear_usage; end
sig { params(_clear_usage: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def clear_usage=(_clear_usage); end
# A flag that, if set to `true`, will delete the specified item.
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
sig { params(_deleted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def deleted=(_deleted); end
# The coupons to redeem into discounts for the subscription item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Subscription::UpdateParams::Item::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Subscription::UpdateParams::Item::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Subscription::UpdateParams::Item::Discount])))
}
def discounts=(_discounts); end
# Subscription item to update.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Plan ID for this item, as a string.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::Item::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Subscription::UpdateParams::Item::PriceData)).returns(T.nilable(::Stripe::Subscription::UpdateParams::Item::PriceData))
}
def price_data=(_price_data); end
# Quantity for this item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(billing_thresholds: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::Item::BillingThresholds)), clear_usage: T.nilable(T::Boolean), deleted: T.nilable(T::Boolean), discounts: T.nilable(T.any(String, T::Array[::Stripe::Subscription::UpdateParams::Item::Discount])), id: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::Subscription::UpdateParams::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
billing_thresholds: nil,
clear_usage: nil,
deleted: nil,
discounts: nil,
id: nil,
metadata: nil,
plan: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class PauseCollection < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
# The time after which the subscription will resume collecting payments.
sig { returns(T.nilable(Integer)) }
def resumes_at; end
sig { params(_resumes_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def resumes_at=(_resumes_at); end
sig { params(behavior: String, resumes_at: T.nilable(Integer)).void }
def initialize(behavior: nil, resumes_at: nil); end
end
class PaymentSettings < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig { params(transaction_type: T.nilable(String)).void }
def initialize(transaction_type: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
}
def initialize(mandate_options: nil, verification_method: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
sig { params(preferred_language: T.nilable(String)).void }
def initialize(preferred_language: nil); end
end
class Card < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), description: T.nilable(String)).void
}
def initialize(amount: nil, amount_type: nil, description: nil); end
end
# Configuration options for setting up an eMandate for cards issued in India.
sig {
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions)).returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
sig {
params(mandate_options: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions), network: T.nilable(String), request_three_d_secure: T.nilable(String)).void
}
def initialize(mandate_options: nil, network: nil, request_three_d_secure: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), type: T.nilable(String)).void
}
def initialize(eu_bank_transfer: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
sig {
params(bank_transfer: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil); end
end
class IdBankTransfer < Stripe::RequestParams; end
class Konbini < Stripe::RequestParams; end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. If not provided, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
end_date: nil,
payment_schedule: nil
); end
end
# Configuration options for setting up a mandate
sig {
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class SepaDebit < Stripe::RequestParams; end
class Upi < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), description: T.nilable(String), end_date: T.nilable(Integer)).void
}
def initialize(amount: nil, amount_type: nil, description: nil, end_date: nil); end
end
# Configuration options for setting up an eMandate
sig {
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions)).returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
sig {
params(filters: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String])).void
}
def initialize(filters: nil, permissions: nil, prefetch: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections), verification_method: T.nilable(String)).void
}
def initialize(financial_connections: nil, verification_method: nil); end
end
# This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit))).returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit=(_acss_debit); end
# This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact)))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact))).returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact)))
}
def bancontact=(_bancontact); end
# This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Card)))
}
def card; end
sig {
params(_card: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Card))).returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Card)))
}
def card=(_card); end
# This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance))).returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance=(_customer_balance); end
# This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer))).returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer=(_id_bank_transfer); end
# This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini)))
}
def konbini; end
sig {
params(_konbini: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini))).returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini)))
}
def konbini=(_konbini); end
# This sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix)))
}
def pix; end
sig {
params(_pix: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix))).returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix)))
}
def pix=(_pix); end
# This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit))).returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit=(_sepa_debit); end
# This sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi)))
}
def upi; end
sig {
params(_upi: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi))).returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi)))
}
def upi=(_upi); end
# This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
sig {
params(acss_debit: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)), bancontact: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact)), card: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Card)), customer_balance: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)), id_bank_transfer: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)), konbini: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini)), pix: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix)), sepa_debit: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)), upi: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi)), us_bank_account: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))).void
}
def initialize(
acss_debit: nil,
bancontact: nil,
card: nil,
customer_balance: nil,
id_bank_transfer: nil,
konbini: nil,
pix: nil,
sepa_debit: nil,
upi: nil,
us_bank_account: nil
); end
end
# Payment-method-specific configuration to provide to invoices created by the subscription.
sig {
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions)).returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def payment_method_types=(_payment_method_types); end
# Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.
sig { returns(T.nilable(String)) }
def save_default_payment_method; end
sig { params(_save_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def save_default_payment_method=(_save_default_payment_method); end
sig {
params(payment_method_options: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions), payment_method_types: T.nilable(T.any(String, T::Array[String])), save_default_payment_method: T.nilable(String)).void
}
def initialize(
payment_method_options: nil,
payment_method_types: nil,
save_default_payment_method: nil
); end
end
class PendingInvoiceItemInterval < Stripe::RequestParams
# Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
class Prebilling < Stripe::RequestParams
# This is used to determine the number of billing cycles to prebill.
sig { returns(Integer) }
def iterations; end
sig { params(_iterations: Integer).returns(Integer) }
def iterations=(_iterations); end
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
sig { returns(T.nilable(String)) }
def update_behavior; end
sig { params(_update_behavior: T.nilable(String)).returns(T.nilable(String)) }
def update_behavior=(_update_behavior); end
sig { params(iterations: Integer, update_behavior: T.nilable(String)).void }
def initialize(iterations: nil, update_behavior: nil); end
end
class TransferData < Stripe::RequestParams
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount_percent: T.nilable(Float), destination: String).void }
def initialize(amount_percent: nil, destination: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
sig { returns(String) }
def missing_payment_method; end
sig { params(_missing_payment_method: String).returns(String) }
def missing_payment_method=(_missing_payment_method); end
sig { params(missing_payment_method: String).void }
def initialize(missing_payment_method: nil); end
end
# Defines how the subscription should behave when the user's free trial ends.
sig { returns(::Stripe::Subscription::UpdateParams::TrialSettings::EndBehavior) }
def end_behavior; end
sig {
params(_end_behavior: ::Stripe::Subscription::UpdateParams::TrialSettings::EndBehavior).returns(::Stripe::Subscription::UpdateParams::TrialSettings::EndBehavior)
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: ::Stripe::Subscription::UpdateParams::TrialSettings::EndBehavior).void
}
def initialize(end_behavior: nil); end
end
# A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
sig { returns(T.nilable(T::Array[::Stripe::Subscription::UpdateParams::AddInvoiceItem])) }
def add_invoice_items; end
sig {
params(_add_invoice_items: T.nilable(T::Array[::Stripe::Subscription::UpdateParams::AddInvoiceItem])).returns(T.nilable(T::Array[::Stripe::Subscription::UpdateParams::AddInvoiceItem]))
}
def add_invoice_items=(_add_invoice_items); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
sig { returns(T.nilable(T.any(String, Float))) }
def application_fee_percent; end
sig {
params(_application_fee_percent: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def application_fee_percent=(_application_fee_percent); end
# Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::Subscription::UpdateParams::AutomaticTax)).returns(T.nilable(::Stripe::Subscription::UpdateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(T.any(String, T.any(Integer, String)))) }
def cancel_at; end
sig {
params(_cancel_at: T.nilable(T.any(String, T.any(Integer, String)))).returns(T.nilable(T.any(String, T.any(Integer, String))))
}
def cancel_at=(_cancel_at); end
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def cancel_at_period_end; end
sig { params(_cancel_at_period_end: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def cancel_at_period_end=(_cancel_at_period_end); end
# Details about why this subscription was cancelled
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::CancellationDetails)) }
def cancellation_details; end
sig {
params(_cancellation_details: T.nilable(::Stripe::Subscription::UpdateParams::CancellationDetails)).returns(T.nilable(::Stripe::Subscription::UpdateParams::CancellationDetails))
}
def cancellation_details=(_cancellation_details); end
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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`.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
sig { returns(T.nilable(String)) }
def default_source; end
sig { params(_default_source: T.nilable(String)).returns(T.nilable(String)) }
def default_source=(_default_source); end
# The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Subscription::UpdateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Subscription::UpdateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Subscription::UpdateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# All invoices will be billed using the specified settings.
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::InvoiceSettings)) }
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::Subscription::UpdateParams::InvoiceSettings)).returns(T.nilable(::Stripe::Subscription::UpdateParams::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# A list of up to 20 subscription items, each with an attached price.
sig { returns(T.nilable(T::Array[::Stripe::Subscription::UpdateParams::Item])) }
def items; end
sig {
params(_items: T.nilable(T::Array[::Stripe::Subscription::UpdateParams::Item])).returns(T.nilable(T::Array[::Stripe::Subscription::UpdateParams::Item]))
}
def items=(_items); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
sig { returns(T.nilable(T::Boolean)) }
def off_session; end
sig { params(_off_session: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def off_session=(_off_session); end
# The account on behalf of which to charge, for each of the subscription's invoices.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PauseCollection)))
}
def pause_collection; end
sig {
params(_pause_collection: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PauseCollection))).returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PauseCollection)))
}
def pause_collection=(_pause_collection); end
# Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
#
# Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
#
# Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
#
# Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
sig { returns(T.nilable(String)) }
def payment_behavior; end
sig { params(_payment_behavior: T.nilable(String)).returns(T.nilable(String)) }
def payment_behavior=(_payment_behavior); end
# Payment settings to pass to invoices created by the subscription.
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings)) }
def payment_settings; end
sig {
params(_payment_settings: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings)).returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings))
}
def payment_settings=(_payment_settings); end
# Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PendingInvoiceItemInterval)))
}
def pending_invoice_item_interval; end
sig {
params(_pending_invoice_item_interval: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PendingInvoiceItemInterval))).returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PendingInvoiceItemInterval)))
}
def pending_invoice_item_interval=(_pending_invoice_item_interval); end
# If specified, the invoicing for the given billing cycle iterations will be processed now.
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::Prebilling)) }
def prebilling; end
sig {
params(_prebilling: T.nilable(::Stripe::Subscription::UpdateParams::Prebilling)).returns(T.nilable(::Stripe::Subscription::UpdateParams::Prebilling))
}
def prebilling=(_prebilling); end
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
sig { returns(T.nilable(Integer)) }
def proration_date; end
sig { params(_proration_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def proration_date=(_proration_date); end
# If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value.
sig { returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::TransferData))) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::TransferData))).returns(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::TransferData)))
}
def transfer_data=(_transfer_data); end
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, `trial_end` will override the default trial period of the plan the customer is being subscribed to. The `billing_cycle_anchor` will be updated to the `trial_end` value. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
sig { returns(T.nilable(T.any(String, Integer))) }
def trial_end; end
sig {
params(_trial_end: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def trial_end=(_trial_end); end
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
sig { returns(T.nilable(T::Boolean)) }
def trial_from_plan; end
sig { params(_trial_from_plan: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def trial_from_plan=(_trial_from_plan); end
# Settings related to subscription trials.
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::TrialSettings)) }
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::Subscription::UpdateParams::TrialSettings)).returns(T.nilable(::Stripe::Subscription::UpdateParams::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(add_invoice_items: T.nilable(T::Array[::Stripe::Subscription::UpdateParams::AddInvoiceItem]), application_fee_percent: T.nilable(T.any(String, Float)), automatic_tax: T.nilable(::Stripe::Subscription::UpdateParams::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::BillingThresholds)), cancel_at: T.nilable(T.any(String, T.any(Integer, String))), cancel_at_period_end: T.nilable(T::Boolean), cancellation_details: T.nilable(::Stripe::Subscription::UpdateParams::CancellationDetails), collection_method: T.nilable(String), days_until_due: T.nilable(Integer), default_payment_method: T.nilable(String), default_source: T.nilable(String), default_tax_rates: T.nilable(T.any(String, T::Array[String])), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::Subscription::UpdateParams::Discount])), expand: T.nilable(T::Array[String]), invoice_settings: T.nilable(::Stripe::Subscription::UpdateParams::InvoiceSettings), items: T.nilable(T::Array[::Stripe::Subscription::UpdateParams::Item]), metadata: T.nilable(T.any(String, T::Hash[String, String])), off_session: T.nilable(T::Boolean), on_behalf_of: T.nilable(String), pause_collection: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PauseCollection)), payment_behavior: T.nilable(String), payment_settings: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings), pending_invoice_item_interval: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PendingInvoiceItemInterval)), prebilling: T.nilable(::Stripe::Subscription::UpdateParams::Prebilling), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), transfer_data: T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::TransferData)), trial_end: T.nilable(T.any(String, Integer)), trial_from_plan: T.nilable(T::Boolean), trial_settings: T.nilable(::Stripe::Subscription::UpdateParams::TrialSettings)).void
}
def initialize(
add_invoice_items: nil,
application_fee_percent: nil,
automatic_tax: nil,
billing_cycle_anchor: nil,
billing_thresholds: nil,
cancel_at: nil,
cancel_at_period_end: nil,
cancellation_details: nil,
collection_method: nil,
days_until_due: nil,
default_payment_method: nil,
default_source: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
expand: nil,
invoice_settings: nil,
items: nil,
metadata: nil,
off_session: nil,
on_behalf_of: nil,
pause_collection: nil,
payment_behavior: nil,
payment_settings: nil,
pending_invoice_item_interval: nil,
prebilling: nil,
proration_behavior: nil,
proration_date: nil,
transfer_data: nil,
trial_end: nil,
trial_from_plan: nil,
trial_settings: nil
); end
end
class DeleteDiscountParams < Stripe::RequestParams; end
class ListParams < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class CurrentPeriodEnd < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class CurrentPeriodStart < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Filter subscriptions by their automatic tax settings.
sig { returns(T.nilable(::Stripe::Subscription::ListParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::Subscription::ListParams::AutomaticTax)).returns(T.nilable(::Stripe::Subscription::ListParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# Only return subscriptions that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Subscription::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Subscription::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Subscription::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return subscriptions whose minimum item current_period_end falls within the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Subscription::ListParams::CurrentPeriodEnd, Integer)))
}
def current_period_end; end
sig {
params(_current_period_end: T.nilable(T.any(::Stripe::Subscription::ListParams::CurrentPeriodEnd, Integer))).returns(T.nilable(T.any(::Stripe::Subscription::ListParams::CurrentPeriodEnd, Integer)))
}
def current_period_end=(_current_period_end); end
# Only return subscriptions whose maximum item current_period_start falls within the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Subscription::ListParams::CurrentPeriodStart, Integer)))
}
def current_period_start; end
sig {
params(_current_period_start: T.nilable(T.any(::Stripe::Subscription::ListParams::CurrentPeriodStart, Integer))).returns(T.nilable(T.any(::Stripe::Subscription::ListParams::CurrentPeriodStart, Integer)))
}
def current_period_start=(_current_period_start); end
# The ID of the customer whose subscriptions will be retrieved.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The ID of the account whose subscriptions will be retrieved.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The ID of the plan whose subscriptions will be retrieved.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# Filter for subscriptions that contain this recurring price ID.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.
sig { returns(T.nilable(String)) }
def test_clock; end
sig { params(_test_clock: T.nilable(String)).returns(T.nilable(String)) }
def test_clock=(_test_clock); end
sig {
params(automatic_tax: T.nilable(::Stripe::Subscription::ListParams::AutomaticTax), collection_method: T.nilable(String), created: T.nilable(T.any(::Stripe::Subscription::ListParams::Created, Integer)), current_period_end: T.nilable(T.any(::Stripe::Subscription::ListParams::CurrentPeriodEnd, Integer)), current_period_start: T.nilable(T.any(::Stripe::Subscription::ListParams::CurrentPeriodStart, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), plan: T.nilable(String), price: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String), test_clock: T.nilable(String)).void
}
def initialize(
automatic_tax: nil,
collection_method: nil,
created: nil,
current_period_end: nil,
current_period_start: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
limit: nil,
plan: nil,
price: nil,
starting_after: nil,
status: nil,
test_clock: nil
); end
end
class CreateParams < Stripe::RequestParams
class AddInvoiceItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
class End < Stripe::RequestParams
# A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the end of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
class Start < Stripe::RequestParams
# A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the start of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
# End of the invoice item period.
sig { returns(::Stripe::Subscription::CreateParams::AddInvoiceItem::Period::End) }
def end; end
sig {
params(_end: ::Stripe::Subscription::CreateParams::AddInvoiceItem::Period::End).returns(::Stripe::Subscription::CreateParams::AddInvoiceItem::Period::End)
}
def end=(_end); end
# Start of the invoice item period.
sig { returns(::Stripe::Subscription::CreateParams::AddInvoiceItem::Period::Start) }
def start; end
sig {
params(_start: ::Stripe::Subscription::CreateParams::AddInvoiceItem::Period::Start).returns(::Stripe::Subscription::CreateParams::AddInvoiceItem::Period::Start)
}
def start=(_start); end
sig {
params(end_: ::Stripe::Subscription::CreateParams::AddInvoiceItem::Period::End, start: ::Stripe::Subscription::CreateParams::AddInvoiceItem::Period::Start).void
}
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# The coupons to redeem into discounts for the item.
sig {
returns(T.nilable(T::Array[::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount])).returns(T.nilable(T::Array[::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::AddInvoiceItem::Period)) }
def period; end
sig {
params(_period: T.nilable(::Stripe::Subscription::CreateParams::AddInvoiceItem::Period)).returns(T.nilable(::Stripe::Subscription::CreateParams::AddInvoiceItem::Period))
}
def period=(_period); end
# The ID of the price object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::AddInvoiceItem::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Subscription::CreateParams::AddInvoiceItem::PriceData)).returns(T.nilable(::Stripe::Subscription::CreateParams::AddInvoiceItem::PriceData))
}
def price_data=(_price_data); end
# Quantity for this item. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount]), metadata: T.nilable(T::Hash[String, String]), period: T.nilable(::Stripe::Subscription::CreateParams::AddInvoiceItem::Period), price: T.nilable(String), price_data: T.nilable(::Stripe::Subscription::CreateParams::AddInvoiceItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
discounts: nil,
metadata: nil,
period: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::AutomaticTax::Liability)) }
def liability; end
sig {
params(_liability: T.nilable(::Stripe::Subscription::CreateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::Subscription::CreateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::Subscription::CreateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class BillingCycleAnchorConfig < Stripe::RequestParams
# The day of the month the anchor should be. Ranges from 1 to 31.
sig { returns(Integer) }
def day_of_month; end
sig { params(_day_of_month: Integer).returns(Integer) }
def day_of_month=(_day_of_month); end
# The hour of the day the anchor should be. Ranges from 0 to 23.
sig { returns(T.nilable(Integer)) }
def hour; end
sig { params(_hour: T.nilable(Integer)).returns(T.nilable(Integer)) }
def hour=(_hour); end
# The minute of the hour the anchor should be. Ranges from 0 to 59.
sig { returns(T.nilable(Integer)) }
def minute; end
sig { params(_minute: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minute=(_minute); end
# The month to start full cycle periods. Ranges from 1 to 12.
sig { returns(T.nilable(Integer)) }
def month; end
sig { params(_month: T.nilable(Integer)).returns(T.nilable(Integer)) }
def month=(_month); end
# The second of the minute the anchor should be. Ranges from 0 to 59.
sig { returns(T.nilable(Integer)) }
def second; end
sig { params(_second: T.nilable(Integer)).returns(T.nilable(Integer)) }
def second=(_second); end
sig {
params(day_of_month: Integer, hour: T.nilable(Integer), minute: T.nilable(Integer), month: T.nilable(Integer), second: T.nilable(Integer)).void
}
def initialize(day_of_month: nil, hour: nil, minute: nil, month: nil, second: nil); end
end
class BillingMode < Stripe::RequestParams
class Flexible < Stripe::RequestParams
# Set to `true` to display gross amounts, net amounts, and discount amounts consistently between prorations and non-proration items on invoices, line items, and invoice items. Once set to `true`, you can't change it back to `false`.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
sig {
params(_consistent_proration_discount_amounts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consistent_proration_discount_amounts=(_consistent_proration_discount_amounts); end
sig { params(consistent_proration_discount_amounts: T.nilable(T::Boolean)).void }
def initialize(consistent_proration_discount_amounts: nil); end
end
# Configure behavior for flexible billing mode.
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::BillingMode::Flexible)) }
def flexible; end
sig {
params(_flexible: T.nilable(::Stripe::Subscription::CreateParams::BillingMode::Flexible)).returns(T.nilable(::Stripe::Subscription::CreateParams::BillingMode::Flexible))
}
def flexible=(_flexible); end
# Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(flexible: T.nilable(::Stripe::Subscription::CreateParams::BillingMode::Flexible), type: String).void
}
def initialize(flexible: nil, type: nil); end
end
class BillingThresholds < Stripe::RequestParams
# Monetary threshold that triggers the subscription to advance to a new billing period
sig { returns(T.nilable(Integer)) }
def amount_gte; end
sig { params(_amount_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_gte=(_amount_gte); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
sig {
params(_reset_billing_cycle_anchor: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def reset_billing_cycle_anchor=(_reset_billing_cycle_anchor); end
sig {
params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
}
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Subscription::CreateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Subscription::CreateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Subscription::CreateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Subscription::CreateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Subscription::CreateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Subscription::CreateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Subscription::CreateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::InvoiceSettings::Issuer)) }
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::Subscription::CreateParams::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::Subscription::CreateParams::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), issuer: T.nilable(::Stripe::Subscription::CreateParams::InvoiceSettings::Issuer)).void
}
def initialize(account_tax_ids: nil, issuer: nil); end
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))
sig { returns(Integer) }
def usage_gte; end
sig { params(_usage_gte: Integer).returns(Integer) }
def usage_gte=(_usage_gte); end
sig { params(usage_gte: Integer).void }
def initialize(usage_gte: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::Subscription::CreateParams::Item::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::Subscription::CreateParams::Item::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::Subscription::CreateParams::Item::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::Subscription::CreateParams::Item::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::Subscription::CreateParams::Item::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::Subscription::CreateParams::Item::Discount::DiscountEnd)).returns(T.nilable(::Stripe::Subscription::CreateParams::Item::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::Subscription::CreateParams::Item::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig { returns(::Stripe::Subscription::CreateParams::Item::PriceData::Recurring) }
def recurring; end
sig {
params(_recurring: ::Stripe::Subscription::CreateParams::Item::PriceData::Recurring).returns(::Stripe::Subscription::CreateParams::Item::PriceData::Recurring)
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: ::Stripe::Subscription::CreateParams::Item::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::Item::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::Item::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::Item::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# The coupons to redeem into discounts for the subscription item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Subscription::CreateParams::Item::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Subscription::CreateParams::Item::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Subscription::CreateParams::Item::Discount])))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Plan ID for this item, as a string.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::Item::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Subscription::CreateParams::Item::PriceData)).returns(T.nilable(::Stripe::Subscription::CreateParams::Item::PriceData))
}
def price_data=(_price_data); end
# Quantity for this item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# Define options to configure the trial on the subscription item.
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::Item::Trial)) }
def trial; end
sig {
params(_trial: T.nilable(::Stripe::Subscription::CreateParams::Item::Trial)).returns(T.nilable(::Stripe::Subscription::CreateParams::Item::Trial))
}
def trial=(_trial); end
sig {
params(billing_thresholds: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::Item::BillingThresholds)), discounts: T.nilable(T.any(String, T::Array[::Stripe::Subscription::CreateParams::Item::Discount])), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::Subscription::CreateParams::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String])), trial: T.nilable(::Stripe::Subscription::CreateParams::Item::Trial)).void
}
def initialize(
billing_thresholds: nil,
discounts: nil,
metadata: nil,
plan: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
class PaymentSettings < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig { params(transaction_type: T.nilable(String)).void }
def initialize(transaction_type: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
}
def initialize(mandate_options: nil, verification_method: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
sig { params(preferred_language: T.nilable(String)).void }
def initialize(preferred_language: nil); end
end
class Card < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), description: T.nilable(String)).void
}
def initialize(amount: nil, amount_type: nil, description: nil); end
end
# Configuration options for setting up an eMandate for cards issued in India.
sig {
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions)).returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
sig {
params(mandate_options: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions), network: T.nilable(String), request_three_d_secure: T.nilable(String)).void
}
def initialize(mandate_options: nil, network: nil, request_three_d_secure: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), type: T.nilable(String)).void
}
def initialize(eu_bank_transfer: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
sig {
params(bank_transfer: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil); end
end
class IdBankTransfer < Stripe::RequestParams; end
class Konbini < Stripe::RequestParams; end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. If not provided, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
end_date: nil,
payment_schedule: nil
); end
end
# Configuration options for setting up a mandate
sig {
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Pix::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class SepaDebit < Stripe::RequestParams; end
class Upi < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), description: T.nilable(String), end_date: T.nilable(Integer)).void
}
def initialize(amount: nil, amount_type: nil, description: nil, end_date: nil); end
end
# Configuration options for setting up an eMandate
sig {
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions)).returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
sig {
params(filters: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String])).void
}
def initialize(filters: nil, permissions: nil, prefetch: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections), verification_method: T.nilable(String)).void
}
def initialize(financial_connections: nil, verification_method: nil); end
end
# This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit))).returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit=(_acss_debit); end
# This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact)))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact))).returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact)))
}
def bancontact=(_bancontact); end
# This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Card)))
}
def card; end
sig {
params(_card: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Card))).returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Card)))
}
def card=(_card); end
# This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance))).returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance=(_customer_balance); end
# This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer))).returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer=(_id_bank_transfer); end
# This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini)))
}
def konbini; end
sig {
params(_konbini: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini))).returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini)))
}
def konbini=(_konbini); end
# This sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Pix)))
}
def pix; end
sig {
params(_pix: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Pix))).returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Pix)))
}
def pix=(_pix); end
# This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit))).returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit=(_sepa_debit); end
# This sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Upi)))
}
def upi; end
sig {
params(_upi: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Upi))).returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Upi)))
}
def upi=(_upi); end
# This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
sig {
params(acss_debit: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)), bancontact: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact)), card: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Card)), customer_balance: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)), id_bank_transfer: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)), konbini: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini)), pix: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Pix)), sepa_debit: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)), upi: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Upi)), us_bank_account: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))).void
}
def initialize(
acss_debit: nil,
bancontact: nil,
card: nil,
customer_balance: nil,
id_bank_transfer: nil,
konbini: nil,
pix: nil,
sepa_debit: nil,
upi: nil,
us_bank_account: nil
); end
end
# Payment-method-specific configuration to provide to invoices created by the subscription.
sig {
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions)).returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def payment_method_types=(_payment_method_types); end
# Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.
sig { returns(T.nilable(String)) }
def save_default_payment_method; end
sig { params(_save_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def save_default_payment_method=(_save_default_payment_method); end
sig {
params(payment_method_options: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions), payment_method_types: T.nilable(T.any(String, T::Array[String])), save_default_payment_method: T.nilable(String)).void
}
def initialize(
payment_method_options: nil,
payment_method_types: nil,
save_default_payment_method: nil
); end
end
class PendingInvoiceItemInterval < Stripe::RequestParams
# Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
class Prebilling < Stripe::RequestParams
# This is used to determine the number of billing cycles to prebill.
sig { returns(Integer) }
def iterations; end
sig { params(_iterations: Integer).returns(Integer) }
def iterations=(_iterations); end
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
sig { returns(T.nilable(String)) }
def update_behavior; end
sig { params(_update_behavior: T.nilable(String)).returns(T.nilable(String)) }
def update_behavior=(_update_behavior); end
sig { params(iterations: Integer, update_behavior: T.nilable(String)).void }
def initialize(iterations: nil, update_behavior: nil); end
end
class TransferData < Stripe::RequestParams
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount_percent: T.nilable(Float), destination: String).void }
def initialize(amount_percent: nil, destination: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
sig { returns(String) }
def missing_payment_method; end
sig { params(_missing_payment_method: String).returns(String) }
def missing_payment_method=(_missing_payment_method); end
sig { params(missing_payment_method: String).void }
def initialize(missing_payment_method: nil); end
end
# Defines how the subscription should behave when the user's free trial ends.
sig { returns(::Stripe::Subscription::CreateParams::TrialSettings::EndBehavior) }
def end_behavior; end
sig {
params(_end_behavior: ::Stripe::Subscription::CreateParams::TrialSettings::EndBehavior).returns(::Stripe::Subscription::CreateParams::TrialSettings::EndBehavior)
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: ::Stripe::Subscription::CreateParams::TrialSettings::EndBehavior).void
}
def initialize(end_behavior: nil); end
end
# A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
sig { returns(T.nilable(T::Array[::Stripe::Subscription::CreateParams::AddInvoiceItem])) }
def add_invoice_items; end
sig {
params(_add_invoice_items: T.nilable(T::Array[::Stripe::Subscription::CreateParams::AddInvoiceItem])).returns(T.nilable(T::Array[::Stripe::Subscription::CreateParams::AddInvoiceItem]))
}
def add_invoice_items=(_add_invoice_items); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
sig { returns(T.nilable(T.any(String, Float))) }
def application_fee_percent; end
sig {
params(_application_fee_percent: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def application_fee_percent=(_application_fee_percent); end
# Automatic tax settings for this subscription.
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::Subscription::CreateParams::AutomaticTax)).returns(T.nilable(::Stripe::Subscription::CreateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
sig { returns(T.nilable(Integer)) }
def backdate_start_date; end
sig { params(_backdate_start_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def backdate_start_date=(_backdate_start_date); end
# A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.
sig { returns(T.nilable(Integer)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(Integer)).returns(T.nilable(Integer)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurrence of the day_of_month at the hour, minute, and second UTC.
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::BillingCycleAnchorConfig)) }
def billing_cycle_anchor_config; end
sig {
params(_billing_cycle_anchor_config: T.nilable(::Stripe::Subscription::CreateParams::BillingCycleAnchorConfig)).returns(T.nilable(::Stripe::Subscription::CreateParams::BillingCycleAnchorConfig))
}
def billing_cycle_anchor_config=(_billing_cycle_anchor_config); end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::BillingMode)) }
def billing_mode; end
sig {
params(_billing_mode: T.nilable(::Stripe::Subscription::CreateParams::BillingMode)).returns(T.nilable(::Stripe::Subscription::CreateParams::BillingMode))
}
def billing_mode=(_billing_mode); end
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(T.any(Integer, String))) }
def cancel_at; end
sig {
params(_cancel_at: T.nilable(T.any(Integer, String))).returns(T.nilable(T.any(Integer, String)))
}
def cancel_at=(_cancel_at); end
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def cancel_at_period_end; end
sig { params(_cancel_at_period_end: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def cancel_at_period_end=(_cancel_at_period_end); end
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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`.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The identifier of the customer to subscribe.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The identifier of the account to subscribe.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
sig { returns(T.nilable(String)) }
def default_source; end
sig { params(_default_source: T.nilable(String)).returns(T.nilable(String)) }
def default_source=(_default_source); end
# The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Subscription::CreateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Subscription::CreateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Subscription::CreateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# All invoices will be billed using the specified settings.
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::InvoiceSettings)) }
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::Subscription::CreateParams::InvoiceSettings)).returns(T.nilable(::Stripe::Subscription::CreateParams::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# A list of up to 20 subscription items, each with an attached price.
sig { returns(T.nilable(T::Array[::Stripe::Subscription::CreateParams::Item])) }
def items; end
sig {
params(_items: T.nilable(T::Array[::Stripe::Subscription::CreateParams::Item])).returns(T.nilable(T::Array[::Stripe::Subscription::CreateParams::Item]))
}
def items=(_items); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
sig { returns(T.nilable(T::Boolean)) }
def off_session; end
sig { params(_off_session: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def off_session=(_off_session); end
# The account on behalf of which to charge, for each of the subscription's invoices.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Only applies to subscriptions with `collection_method=charge_automatically`.
#
# Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
#
# Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state.
#
# Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.
#
# `pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription.
#
# Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status.
sig { returns(T.nilable(String)) }
def payment_behavior; end
sig { params(_payment_behavior: T.nilable(String)).returns(T.nilable(String)) }
def payment_behavior=(_payment_behavior); end
# Payment settings to pass to invoices created by the subscription.
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings)) }
def payment_settings; end
sig {
params(_payment_settings: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings)).returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings))
}
def payment_settings=(_payment_settings); end
# Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
sig {
returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PendingInvoiceItemInterval)))
}
def pending_invoice_item_interval; end
sig {
params(_pending_invoice_item_interval: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PendingInvoiceItemInterval))).returns(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PendingInvoiceItemInterval)))
}
def pending_invoice_item_interval=(_pending_invoice_item_interval); end
# If specified, the invoicing for the given billing cycle iterations will be processed now.
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::Prebilling)) }
def prebilling; end
sig {
params(_prebilling: T.nilable(::Stripe::Subscription::CreateParams::Prebilling)).returns(T.nilable(::Stripe::Subscription::CreateParams::Prebilling))
}
def prebilling=(_prebilling); end
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::Subscription::CreateParams::TransferData)).returns(T.nilable(::Stripe::Subscription::CreateParams::TransferData))
}
def transfer_data=(_transfer_data); end
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
sig { returns(T.nilable(T.any(String, Integer))) }
def trial_end; end
sig {
params(_trial_end: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def trial_end=(_trial_end); end
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
sig { returns(T.nilable(T::Boolean)) }
def trial_from_plan; end
sig { params(_trial_from_plan: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def trial_from_plan=(_trial_from_plan); end
# Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
sig { returns(T.nilable(Integer)) }
def trial_period_days; end
sig { params(_trial_period_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_period_days=(_trial_period_days); end
# Settings related to subscription trials.
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::TrialSettings)) }
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::Subscription::CreateParams::TrialSettings)).returns(T.nilable(::Stripe::Subscription::CreateParams::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(add_invoice_items: T.nilable(T::Array[::Stripe::Subscription::CreateParams::AddInvoiceItem]), application_fee_percent: T.nilable(T.any(String, Float)), automatic_tax: T.nilable(::Stripe::Subscription::CreateParams::AutomaticTax), backdate_start_date: T.nilable(Integer), billing_cycle_anchor: T.nilable(Integer), billing_cycle_anchor_config: T.nilable(::Stripe::Subscription::CreateParams::BillingCycleAnchorConfig), billing_mode: T.nilable(::Stripe::Subscription::CreateParams::BillingMode), billing_thresholds: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::BillingThresholds)), cancel_at: T.nilable(T.any(Integer, String)), cancel_at_period_end: T.nilable(T::Boolean), collection_method: T.nilable(String), currency: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), days_until_due: T.nilable(Integer), default_payment_method: T.nilable(String), default_source: T.nilable(String), default_tax_rates: T.nilable(T.any(String, T::Array[String])), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::Subscription::CreateParams::Discount])), expand: T.nilable(T::Array[String]), invoice_settings: T.nilable(::Stripe::Subscription::CreateParams::InvoiceSettings), items: T.nilable(T::Array[::Stripe::Subscription::CreateParams::Item]), metadata: T.nilable(T.any(String, T::Hash[String, String])), off_session: T.nilable(T::Boolean), on_behalf_of: T.nilable(String), payment_behavior: T.nilable(String), payment_settings: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings), pending_invoice_item_interval: T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PendingInvoiceItemInterval)), prebilling: T.nilable(::Stripe::Subscription::CreateParams::Prebilling), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::Subscription::CreateParams::TransferData), trial_end: T.nilable(T.any(String, Integer)), trial_from_plan: T.nilable(T::Boolean), trial_period_days: T.nilable(Integer), trial_settings: T.nilable(::Stripe::Subscription::CreateParams::TrialSettings)).void
}
def initialize(
add_invoice_items: nil,
application_fee_percent: nil,
automatic_tax: nil,
backdate_start_date: nil,
billing_cycle_anchor: nil,
billing_cycle_anchor_config: nil,
billing_mode: nil,
billing_thresholds: nil,
cancel_at: nil,
cancel_at_period_end: nil,
collection_method: nil,
currency: nil,
customer: nil,
customer_account: nil,
days_until_due: nil,
default_payment_method: nil,
default_source: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
expand: nil,
invoice_settings: nil,
items: nil,
metadata: nil,
off_session: nil,
on_behalf_of: nil,
payment_behavior: nil,
payment_settings: nil,
pending_invoice_item_interval: nil,
prebilling: nil,
proration_behavior: nil,
transfer_data: nil,
trial_end: nil,
trial_from_plan: nil,
trial_period_days: nil,
trial_settings: nil
); end
end
class SearchParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
sig { returns(T.nilable(String)) }
def page; end
sig { params(_page: T.nilable(String)).returns(T.nilable(String)) }
def page=(_page); end
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions).
sig { returns(String) }
def query; end
sig { params(_query: String).returns(String) }
def query=(_query); end
sig {
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
}
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
end
class MigrateParams < Stripe::RequestParams
class BillingMode < Stripe::RequestParams
class Flexible < Stripe::RequestParams
# Set to `true` to display gross amounts, net amounts, and discount amounts consistently between prorations and non-proration items on invoices, line items, and invoice items. Once set to `true`, you can't change it back to `false`.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
sig {
params(_consistent_proration_discount_amounts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consistent_proration_discount_amounts=(_consistent_proration_discount_amounts); end
sig { params(consistent_proration_discount_amounts: T.nilable(T::Boolean)).void }
def initialize(consistent_proration_discount_amounts: nil); end
end
# Configure behavior for flexible billing mode.
sig { returns(T.nilable(::Stripe::Subscription::MigrateParams::BillingMode::Flexible)) }
def flexible; end
sig {
params(_flexible: T.nilable(::Stripe::Subscription::MigrateParams::BillingMode::Flexible)).returns(T.nilable(::Stripe::Subscription::MigrateParams::BillingMode::Flexible))
}
def flexible=(_flexible); end
# Controls the calculation and orchestration of prorations and invoices for subscriptions.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(flexible: T.nilable(::Stripe::Subscription::MigrateParams::BillingMode::Flexible), type: String).void
}
def initialize(flexible: nil, type: nil); end
end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig { returns(::Stripe::Subscription::MigrateParams::BillingMode) }
def billing_mode; end
sig {
params(_billing_mode: ::Stripe::Subscription::MigrateParams::BillingMode).returns(::Stripe::Subscription::MigrateParams::BillingMode)
}
def billing_mode=(_billing_mode); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(billing_mode: ::Stripe::Subscription::MigrateParams::BillingMode, expand: T.nilable(T::Array[String])).void
}
def initialize(billing_mode: nil, expand: nil); end
end
class ResumeParams < Stripe::RequestParams
# The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint.
sig { returns(T.nilable(Integer)) }
def proration_date; end
sig { params(_proration_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def proration_date=(_proration_date); end
sig {
params(billing_cycle_anchor: T.nilable(String), expand: T.nilable(T::Array[String]), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer)).void
}
def initialize(
billing_cycle_anchor: nil,
expand: nil,
proration_behavior: nil,
proration_date: nil
); end
end
# Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata).
#
# Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true.
#
# By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
sig {
params(params: T.any(::Stripe::Subscription::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
}
def cancel(params = {}, opts = {}); end
# Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata).
#
# Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true.
#
# By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
sig {
params(subscription_exposed_id: String, params: T.any(::Stripe::Subscription::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
}
def self.cancel(subscription_exposed_id, params = {}, opts = {}); end
# Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.
#
# When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.
# The payment_behavior parameter determines the exact behavior of the initial payment.
#
# To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://docs.stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead.
# Schedules provide the flexibility to model more complex billing configurations that change over time.
sig {
params(params: T.any(::Stripe::Subscription::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
}
def self.create(params = {}, opts = {}); end
# Removes the currently applied discount on a subscription.
sig {
params(params: T.any(::Stripe::Subscription::DeleteDiscountParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Discount)
}
def delete_discount(params = {}, opts = {}); end
# Removes the currently applied discount on a subscription.
sig {
params(subscription_exposed_id: String, params: T.any(::Stripe::Subscription::DeleteDiscountParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Discount)
}
def self.delete_discount(subscription_exposed_id, params = {}, opts = {}); end
# By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.
sig {
params(params: T.any(::Stripe::Subscription::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Upgrade the billing_mode of an existing subscription.
sig {
params(params: T.any(::Stripe::Subscription::MigrateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
}
def migrate(params = {}, opts = {}); end
# Upgrade the billing_mode of an existing subscription.
sig {
params(subscription: String, params: T.any(::Stripe::Subscription::MigrateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
}
def self.migrate(subscription, params = {}, opts = {}); end
# Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.
sig {
params(params: T.any(::Stripe::Subscription::ResumeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
}
def resume(params = {}, opts = {}); end
# Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.
sig {
params(subscription: String, params: T.any(::Stripe::Subscription::ResumeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
}
def self.resume(subscription, params = {}, opts = {}); end
sig {
params(params: T.any(::Stripe::Subscription::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
}
def self.search(params = {}, opts = {}); end
sig {
params(params: T.any(::Stripe::Subscription::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, blk: T.untyped).returns(Stripe::SearchResultObject)
}
def self.search_auto_paging_each(params = {}, opts = {}, &blk); end
# Updates an existing subscription to match the specified parameters.
# When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.
# To preview how the proration is calculated, use the [create preview](https://docs.stripe.com/docs/api/invoices/create_preview) endpoint.
#
# By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.
#
# Switching prices does not normally change the billing date or generate an immediate charge unless:
#
#
# The billing interval is changed (for example, from monthly to yearly).
# The subscription moves from free to paid.
# A trial starts or ends.
#
#
# In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://docs.stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment).
#
# If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://docs.stripe.com/docs/api/invoices/create).
#
# If you don't want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don't generate any credits for the old subscription's unused time. We still reset the billing date and bill immediately for the new subscription.
#
# Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing](https://docs.stripe.com/docs/rate-limits) instead.
sig {
params(subscription_exposed_id: String, params: T.any(::Stripe::Subscription::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
}
def self.update(subscription_exposed_id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
module Tax
# A Tax Calculation allows you to calculate the tax to collect from your customer.
#
# Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom)
class Calculation < APIResource
class CustomerDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
sig { returns(T.nilable(String)) }
def state; end
end
class TaxId < Stripe::StripeObject
# The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
sig { returns(String) }
def type; end
# The value of the tax ID.
sig { returns(String) }
def value; end
end
# The customer's postal address (for example, home or business location).
sig { returns(T.nilable(Address)) }
def address; end
# The type of customer address provided.
sig { returns(T.nilable(String)) }
def address_source; end
# The customer's IP address (IPv4 or IPv6).
sig { returns(T.nilable(String)) }
def ip_address; end
# The customer's tax IDs (for example, EU VAT numbers).
sig { returns(T::Array[TaxId]) }
def tax_ids; end
# The taxability override used for taxation.
sig { returns(String) }
def taxability_override; end
end
class ShipFromDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(Address) }
def address; end
end
class ShippingCost < Stripe::StripeObject
class TaxBreakdown < Stripe::StripeObject
class Jurisdiction < Stripe::StripeObject
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
# A human-readable name for the jurisdiction imposing the tax.
sig { returns(String) }
def display_name; end
# Indicates the level of the jurisdiction imposing the tax.
sig { returns(String) }
def level; end
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.
sig { returns(T.nilable(String)) }
def state; end
end
class TaxRateDetails < Stripe::StripeObject
# A localized display name for tax type, intended to be human-readable. For example, "Local Sales and Use Tax", "Value-added tax (VAT)", or "Umsatzsteuer (USt.)".
sig { returns(String) }
def display_name; end
# The tax rate percentage as a string. For example, 8.5% is represented as "8.5".
sig { returns(String) }
def percentage_decimal; end
# The tax type, such as `vat` or `sales_tax`.
sig { returns(String) }
def tax_type; end
end
# The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
# Attribute for field jurisdiction
sig { returns(Jurisdiction) }
def jurisdiction; end
# Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address).
sig { returns(String) }
def sourcing; end
# Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax.
sig { returns(T.nilable(TaxRateDetails)) }
def tax_rate_details; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(String) }
def taxability_reason; end
# The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def taxable_amount; end
end
# The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
sig { returns(Integer) }
def amount; end
# The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount_tax; end
# The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object).
sig { returns(T.nilable(String)) }
def shipping_rate; end
# Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.
sig { returns(String) }
def tax_behavior; end
# Detailed account of taxes relevant to shipping cost.
sig { returns(T.nilable(T::Array[TaxBreakdown])) }
def tax_breakdown; end
# The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping.
sig { returns(String) }
def tax_code; end
end
class TaxBreakdown < Stripe::StripeObject
class TaxRateDetails < Stripe::StripeObject
class FlatAmount < Stripe::StripeObject
# Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
sig { returns(Integer) }
def amount; end
# Three-letter ISO currency code, in lowercase.
sig { returns(String) }
def currency; end
end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.
sig { returns(T.nilable(FlatAmount)) }
def flat_amount; end
# The tax rate percentage as a string. For example, 8.5% is represented as `"8.5"`.
sig { returns(String) }
def percentage_decimal; end
# Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.
sig { returns(T.nilable(String)) }
def rate_type; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
# The tax type, such as `vat` or `sales_tax`.
sig { returns(T.nilable(String)) }
def tax_type; end
end
# The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
# Specifies whether the tax amount is included in the line item amount.
sig { returns(T::Boolean) }
def inclusive; end
# Attribute for field tax_rate_details
sig { returns(TaxRateDetails) }
def tax_rate_details; end
# The reasoning behind this tax, for example, if the product is tax exempt. We might extend the possible values for this field to support new tax rules.
sig { returns(String) }
def taxability_reason; end
# The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def taxable_amount; end
end
# Total amount after taxes in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount_total; end
# 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) }
def currency; end
# The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.
sig { returns(T.nilable(String)) }
def customer; end
# Attribute for field customer_details
sig { returns(CustomerDetails) }
def customer_details; end
# Timestamp of date at which the tax calculation will expire.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# Unique identifier for the calculation.
sig { returns(T.nilable(String)) }
def id; end
# The list of items the customer is purchasing.
sig { returns(T.nilable(Stripe::ListObject)) }
def line_items; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The details of the ship from location, such as the address.
sig { returns(T.nilable(ShipFromDetails)) }
def ship_from_details; end
# The shipping cost details for the calculation.
sig { returns(T.nilable(ShippingCost)) }
def shipping_cost; end
# The amount of tax to be collected on top of the line item prices.
sig { returns(Integer) }
def tax_amount_exclusive; end
# The amount of tax already included in the line item prices.
sig { returns(Integer) }
def tax_amount_inclusive; end
# Breakdown of individual tax amounts that add up to the total.
sig { returns(T::Array[TaxBreakdown]) }
def tax_breakdown; end
# Timestamp of date at which the tax rules and rates in effect applies for the calculation.
sig { returns(Integer) }
def tax_date; end
class ListLineItemsParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateParams < Stripe::RequestParams
class CustomerDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region. We recommend sending [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code value when possible.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class TaxId < Stripe::RequestParams
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Value of the tax ID.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(type: String, value: String).void }
def initialize(type: nil, value: nil); end
end
# The customer's postal address (for example, home or business location).
sig {
returns(T.nilable(::Stripe::Tax::Calculation::CreateParams::CustomerDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::Tax::Calculation::CreateParams::CustomerDetails::Address)).returns(T.nilable(::Stripe::Tax::Calculation::CreateParams::CustomerDetails::Address))
}
def address=(_address); end
# The type of customer address provided.
sig { returns(T.nilable(String)) }
def address_source; end
sig { params(_address_source: T.nilable(String)).returns(T.nilable(String)) }
def address_source=(_address_source); end
# The customer's IP address (IPv4 or IPv6).
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# The customer's tax IDs. Stripe Tax might consider a transaction with applicable tax IDs to be B2B, which might affect the tax calculation result. Stripe Tax doesn't validate tax IDs for correctness.
sig {
returns(T.nilable(T::Array[::Stripe::Tax::Calculation::CreateParams::CustomerDetails::TaxId]))
}
def tax_ids; end
sig {
params(_tax_ids: T.nilable(T::Array[::Stripe::Tax::Calculation::CreateParams::CustomerDetails::TaxId])).returns(T.nilable(T::Array[::Stripe::Tax::Calculation::CreateParams::CustomerDetails::TaxId]))
}
def tax_ids=(_tax_ids); end
# Overrides the tax calculation result to allow you to not collect tax from your customer. Use this if you've manually checked your customer's tax exemptions. Prefer providing the customer's `tax_ids` where possible, which automatically determines whether `reverse_charge` applies.
sig { returns(T.nilable(String)) }
def taxability_override; end
sig { params(_taxability_override: T.nilable(String)).returns(T.nilable(String)) }
def taxability_override=(_taxability_override); end
sig {
params(address: T.nilable(::Stripe::Tax::Calculation::CreateParams::CustomerDetails::Address), address_source: T.nilable(String), ip_address: T.nilable(String), tax_ids: T.nilable(T::Array[::Stripe::Tax::Calculation::CreateParams::CustomerDetails::TaxId]), taxability_override: T.nilable(String)).void
}
def initialize(
address: nil,
address_source: nil,
ip_address: nil,
tax_ids: nil,
taxability_override: nil
); end
end
class LineItem < Stripe::RequestParams
# A positive integer representing the line item's total price in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
# If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If provided, the product's `tax_code` will be used as the line item's `tax_code`.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# The number of units of the item being purchased. Used to calculate the per-unit price from the total `amount` for the line. For example, if `amount=100` and `quantity=4`, the calculated unit price is 25.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A custom identifier for this line item, which must be unique across the line items in the calculation. The reference helps identify each line item in exported [tax reports](https://stripe.com/docs/tax/reports).
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Specifies whether the `amount` includes taxes. Defaults to `exclusive`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID to use for this line item. If not provided, we will use the tax code from the provided `product` param. If neither `tax_code` nor `product` is provided, we will use the default tax code from your Tax Settings.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
sig {
params(amount: Integer, metadata: T.nilable(T::Hash[String, String]), product: T.nilable(String), quantity: T.nilable(Integer), reference: T.nilable(String), tax_behavior: T.nilable(String), tax_code: T.nilable(String)).void
}
def initialize(
amount: nil,
metadata: nil,
product: nil,
quantity: nil,
reference: nil,
tax_behavior: nil,
tax_code: nil
); end
end
class ShipFromDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The address from which the goods are being shipped from.
sig { returns(::Stripe::Tax::Calculation::CreateParams::ShipFromDetails::Address) }
def address; end
sig {
params(_address: ::Stripe::Tax::Calculation::CreateParams::ShipFromDetails::Address).returns(::Stripe::Tax::Calculation::CreateParams::ShipFromDetails::Address)
}
def address=(_address); end
sig {
params(address: ::Stripe::Tax::Calculation::CreateParams::ShipFromDetails::Address).void
}
def initialize(address: nil); end
end
class ShippingCost < Stripe::RequestParams
# A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing the shipping charge. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# If provided, the [shipping rate](https://stripe.com/docs/api/shipping_rates/object)'s `amount`, `tax_code` and `tax_behavior` are used. If you provide a shipping rate, then you cannot pass the `amount`, `tax_code`, or `tax_behavior` parameters.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
# Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. Defaults to `exclusive`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# The [tax code](https://stripe.com/docs/tax/tax-categories) used to calculate tax on shipping. If not provided, the default shipping tax code from your [Tax Settings](https://dashboard.stripe.com/settings/tax) is used.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
sig {
params(amount: T.nilable(Integer), shipping_rate: T.nilable(String), tax_behavior: T.nilable(String), tax_code: T.nilable(String)).void
}
def initialize(amount: nil, shipping_rate: nil, tax_behavior: nil, tax_code: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of an existing customer to use for this calculation. If provided, the customer's address and tax IDs are copied to `customer_details`.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Details about the customer, including address and tax IDs.
sig { returns(T.nilable(::Stripe::Tax::Calculation::CreateParams::CustomerDetails)) }
def customer_details; end
sig {
params(_customer_details: T.nilable(::Stripe::Tax::Calculation::CreateParams::CustomerDetails)).returns(T.nilable(::Stripe::Tax::Calculation::CreateParams::CustomerDetails))
}
def customer_details=(_customer_details); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A list of items the customer is purchasing.
sig { returns(T::Array[::Stripe::Tax::Calculation::CreateParams::LineItem]) }
def line_items; end
sig {
params(_line_items: T::Array[::Stripe::Tax::Calculation::CreateParams::LineItem]).returns(T::Array[::Stripe::Tax::Calculation::CreateParams::LineItem])
}
def line_items=(_line_items); end
# Details about the address from which the goods are being shipped.
sig { returns(T.nilable(::Stripe::Tax::Calculation::CreateParams::ShipFromDetails)) }
def ship_from_details; end
sig {
params(_ship_from_details: T.nilable(::Stripe::Tax::Calculation::CreateParams::ShipFromDetails)).returns(T.nilable(::Stripe::Tax::Calculation::CreateParams::ShipFromDetails))
}
def ship_from_details=(_ship_from_details); end
# Shipping cost details to be used for the calculation.
sig { returns(T.nilable(::Stripe::Tax::Calculation::CreateParams::ShippingCost)) }
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(::Stripe::Tax::Calculation::CreateParams::ShippingCost)).returns(T.nilable(::Stripe::Tax::Calculation::CreateParams::ShippingCost))
}
def shipping_cost=(_shipping_cost); end
# Timestamp of date at which the tax rules and rates in effect applies for the calculation. Measured in seconds since the Unix epoch. Can be up to 48 hours in the past, and up to 48 hours in the future.
sig { returns(T.nilable(Integer)) }
def tax_date; end
sig { params(_tax_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def tax_date=(_tax_date); end
sig {
params(currency: String, customer: T.nilable(String), customer_details: T.nilable(::Stripe::Tax::Calculation::CreateParams::CustomerDetails), expand: T.nilable(T::Array[String]), line_items: T::Array[::Stripe::Tax::Calculation::CreateParams::LineItem], ship_from_details: T.nilable(::Stripe::Tax::Calculation::CreateParams::ShipFromDetails), shipping_cost: T.nilable(::Stripe::Tax::Calculation::CreateParams::ShippingCost), tax_date: T.nilable(Integer)).void
}
def initialize(
currency: nil,
customer: nil,
customer_details: nil,
expand: nil,
line_items: nil,
ship_from_details: nil,
shipping_cost: nil,
tax_date: nil
); end
end
# Calculates tax based on the input and returns a Tax Calculation object.
sig {
params(params: T.any(::Stripe::Tax::Calculation::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Calculation)
}
def self.create(params = {}, opts = {}); end
# Retrieves the line items of a tax calculation as a collection, if the calculation hasn't expired.
sig {
params(params: T.any(::Stripe::Tax::Calculation::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list_line_items(params = {}, opts = {}); end
# Retrieves the line items of a tax calculation as a collection, if the calculation hasn't expired.
sig {
params(calculation: String, params: T.any(::Stripe::Tax::Calculation::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list_line_items(calculation, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Tax
# Tax forms are legal documents which are delivered to one or more tax authorities for information reporting purposes.
#
# Related guide: [US tax reporting for Connect platforms](https://stripe.com/docs/connect/tax-reporting)
class Form < APIResource
class AuSerr < Stripe::StripeObject
# End date of the period represented by the information reported on the tax form.
sig { returns(String) }
def reporting_period_end_date; end
# Start date of the period represented by the information reported on the tax form.
sig { returns(String) }
def reporting_period_start_date; end
end
class CaMrdp < Stripe::StripeObject
# End date of the period represented by the information reported on the tax form.
sig { returns(String) }
def reporting_period_end_date; end
# Start date of the period represented by the information reported on the tax form.
sig { returns(String) }
def reporting_period_start_date; end
end
class EuDac7 < Stripe::StripeObject
# End date of the period represented by the information reported on the tax form.
sig { returns(String) }
def reporting_period_end_date; end
# Start date of the period represented by the information reported on the tax form.
sig { returns(String) }
def reporting_period_start_date; end
end
class FilingStatus < Stripe::StripeObject
class Jurisdiction < Stripe::StripeObject
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
# Indicates the level of the jurisdiction where the form was filed.
sig { returns(String) }
def level; end
# [ISO 3166-2 U.S. state code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix, if any. For example, "NY" for New York, United States. Null for non-U.S. forms.
sig { returns(T.nilable(String)) }
def state; end
end
# Time when the filing status was updated.
sig { returns(Integer) }
def effective_at; end
# Attribute for field jurisdiction
sig { returns(Jurisdiction) }
def jurisdiction; end
# The current status of the filed form.
sig { returns(String) }
def value; end
end
class GbMrdp < Stripe::StripeObject
# End date of the period represented by the information reported on the tax form.
sig { returns(String) }
def reporting_period_end_date; end
# Start date of the period represented by the information reported on the tax form.
sig { returns(String) }
def reporting_period_start_date; end
end
class NzMrdp < Stripe::StripeObject
# End date of the period represented by the information reported on the tax form.
sig { returns(String) }
def reporting_period_end_date; end
# Start date of the period represented by the information reported on the tax form.
sig { returns(String) }
def reporting_period_start_date; end
end
class Payee < Stripe::StripeObject
# The ID of the payee's Stripe account.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# The external reference to this payee.
sig { returns(T.nilable(String)) }
def external_reference; end
# Either `account` or `external_reference`.
sig { returns(String) }
def type; end
end
class Us1099K < Stripe::StripeObject
# Year represented by the information reported on the tax form.
sig { returns(Integer) }
def reporting_year; end
end
class Us1099Misc < Stripe::StripeObject
# Year represented by the information reported on the tax form.
sig { returns(Integer) }
def reporting_year; end
end
class Us1099Nec < Stripe::StripeObject
# Year represented by the information reported on the tax form.
sig { returns(Integer) }
def reporting_year; end
end
# Attribute for field au_serr
sig { returns(T.nilable(AuSerr)) }
def au_serr; end
# Attribute for field ca_mrdp
sig { returns(T.nilable(CaMrdp)) }
def ca_mrdp; end
# The form that corrects this form, if any.
sig { returns(T.nilable(T.any(String, Stripe::Tax::Form))) }
def corrected_by; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Attribute for field eu_dac7
sig { returns(T.nilable(EuDac7)) }
def eu_dac7; end
# A list of tax filing statuses. Note that a filing status will only be included if the form has been filed directly with the jurisdiction’s tax authority.
sig { returns(T::Array[FilingStatus]) }
def filing_statuses; end
# Attribute for field gb_mrdp
sig { returns(T.nilable(GbMrdp)) }
def gb_mrdp; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# Attribute for field nz_mrdp
sig { returns(T.nilable(NzMrdp)) }
def nz_mrdp; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Attribute for field payee
sig { returns(Payee) }
def payee; end
# The type of the tax form. An additional hash is included on the tax form with a name matching this value. It contains additional information specific to the tax form type.
sig { returns(String) }
def type; end
# Attribute for field us_1099_k
sig { returns(T.nilable(Us1099K)) }
def us_1099_k; end
# Attribute for field us_1099_misc
sig { returns(T.nilable(Us1099Misc)) }
def us_1099_misc; end
# Attribute for field us_1099_nec
sig { returns(T.nilable(Us1099Nec)) }
def us_1099_nec; end
class ListParams < Stripe::RequestParams
class Payee < Stripe::RequestParams
# The ID of the Stripe account whose forms will be retrieved.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The external reference to the payee whose forms will be retrieved.
sig { returns(T.nilable(String)) }
def external_reference; end
sig { params(_external_reference: T.nilable(String)).returns(T.nilable(String)) }
def external_reference=(_external_reference); end
# Specifies the payee type. Either `account` or `external_reference`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(account: T.nilable(String), external_reference: T.nilable(String), type: T.nilable(String)).void
}
def initialize(account: nil, external_reference: nil, type: nil); end
end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The payee whose volume is represented on the tax form.
sig { returns(::Stripe::Tax::Form::ListParams::Payee) }
def payee; end
sig {
params(_payee: ::Stripe::Tax::Form::ListParams::Payee).returns(::Stripe::Tax::Form::ListParams::Payee)
}
def payee=(_payee); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future tax form types. If your integration expects only one type of tax form in the response, make sure to provide a type value in the request.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payee: ::Stripe::Tax::Form::ListParams::Payee, starting_after: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
payee: nil,
starting_after: nil,
type: nil
); end
end
class PdfParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
sig {
params(params: T.any(::Stripe::Tax::Form::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Download the PDF for a tax form.
sig {
params(params: T.any(::Stripe::Tax::Form::PdfParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, read_body_chunk_block: T.untyped).returns(T.untyped)
}
def pdf(params = {}, opts = {}, &read_body_chunk_block); end
# Download the PDF for a tax form.
sig {
params(id: String, params: T.any(::Stripe::Tax::Form::PdfParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, read_body_chunk_block: T.untyped).returns(T.untyped)
}
def self.pdf(id, params = {}, opts = {}, &read_body_chunk_block); end
end
end
end
# typed: true
module Stripe
module Tax
# A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://stripe.com/docs/tax).
#
# Stripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://stripe.com/docs/tax/registering).
#
# Related guide: [Using the Registrations API](https://stripe.com/docs/tax/registrations-api)
class Registration < APIResource
class CountryOptions < Stripe::StripeObject
class Ae < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an Default standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Al < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Am < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Ao < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class At < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Au < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an Default standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Aw < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Az < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Ba < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Bb < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Bd < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Be < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Bf < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Bg < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Bh < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Bj < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Bs < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class By < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Ca < Stripe::StripeObject
class ProvinceStandard < Stripe::StripeObject
# Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
sig { returns(String) }
def province; end
end
# Attribute for field province_standard
sig { returns(T.nilable(ProvinceStandard)) }
def province_standard; end
# Type of registration in Canada.
sig { returns(String) }
def type; end
end
class Cd < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Ch < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an Default standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Cl < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Cm < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Co < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Cr < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Cv < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Cy < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Cz < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class De < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Dk < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Ec < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Ee < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Eg < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Es < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Et < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Fi < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Fr < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Gb < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an Default standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Ge < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Gn < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Gr < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Hr < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Hu < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Id < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Ie < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class In < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Is < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class It < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Jp < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an Default standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Ke < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Kg < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Kh < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Kr < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Kz < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class La < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Lt < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Lu < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Lv < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Ma < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Md < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Me < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Mk < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Mr < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Mt < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Mx < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class My < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Ng < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Nl < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class No < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an Default standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Np < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Nz < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an Default standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Om < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Pe < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Ph < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Pl < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Pt < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Ro < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Rs < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Ru < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Sa < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Se < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Sg < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an Default standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Si < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Sk < Stripe::StripeObject
class Standard < Stripe::StripeObject
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
end
# Attribute for field standard
sig { returns(T.nilable(Standard)) }
def standard; end
# Type of registration in an EU country.
sig { returns(String) }
def type; end
end
class Sn < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Sr < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Th < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Tj < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Tr < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Tz < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Ua < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Ug < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Us < Stripe::StripeObject
class LocalAmusementTax < Stripe::StripeObject
# A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.
sig { returns(String) }
def jurisdiction; end
end
class LocalLeaseTax < Stripe::StripeObject
# A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.
sig { returns(String) }
def jurisdiction; end
end
class StateSalesTax < Stripe::StripeObject
class Election < Stripe::StripeObject
# A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.
sig { returns(T.nilable(String)) }
def jurisdiction; end
# The type of the election for the state sales tax registration.
sig { returns(String) }
def type; end
end
# Elections for the state sales tax registration.
sig { returns(T.nilable(T::Array[Election])) }
def elections; end
end
# Attribute for field local_amusement_tax
sig { returns(T.nilable(LocalAmusementTax)) }
def local_amusement_tax; end
# Attribute for field local_lease_tax
sig { returns(T.nilable(LocalLeaseTax)) }
def local_lease_tax; end
# Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
sig { returns(String) }
def state; end
# Attribute for field state_sales_tax
sig { returns(T.nilable(StateSalesTax)) }
def state_sales_tax; end
# Type of registration in the US.
sig { returns(String) }
def type; end
end
class Uy < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Uz < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Vn < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Za < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Zm < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
class Zw < Stripe::StripeObject
# Type of registration in `country`.
sig { returns(String) }
def type; end
end
# Attribute for field ae
sig { returns(T.nilable(Ae)) }
def ae; end
# Attribute for field al
sig { returns(T.nilable(Al)) }
def al; end
# Attribute for field am
sig { returns(T.nilable(Am)) }
def am; end
# Attribute for field ao
sig { returns(T.nilable(Ao)) }
def ao; end
# Attribute for field at
sig { returns(T.nilable(At)) }
def at; end
# Attribute for field au
sig { returns(T.nilable(Au)) }
def au; end
# Attribute for field aw
sig { returns(T.nilable(Aw)) }
def aw; end
# Attribute for field az
sig { returns(T.nilable(Az)) }
def az; end
# Attribute for field ba
sig { returns(T.nilable(Ba)) }
def ba; end
# Attribute for field bb
sig { returns(T.nilable(Bb)) }
def bb; end
# Attribute for field bd
sig { returns(T.nilable(Bd)) }
def bd; end
# Attribute for field be
sig { returns(T.nilable(Be)) }
def be; end
# Attribute for field bf
sig { returns(T.nilable(Bf)) }
def bf; end
# Attribute for field bg
sig { returns(T.nilable(Bg)) }
def bg; end
# Attribute for field bh
sig { returns(T.nilable(Bh)) }
def bh; end
# Attribute for field bj
sig { returns(T.nilable(Bj)) }
def bj; end
# Attribute for field bs
sig { returns(T.nilable(Bs)) }
def bs; end
# Attribute for field by
sig { returns(T.nilable(By)) }
def by; end
# Attribute for field ca
sig { returns(T.nilable(Ca)) }
def ca; end
# Attribute for field cd
sig { returns(T.nilable(Cd)) }
def cd; end
# Attribute for field ch
sig { returns(T.nilable(Ch)) }
def ch; end
# Attribute for field cl
sig { returns(T.nilable(Cl)) }
def cl; end
# Attribute for field cm
sig { returns(T.nilable(Cm)) }
def cm; end
# Attribute for field co
sig { returns(T.nilable(Co)) }
def co; end
# Attribute for field cr
sig { returns(T.nilable(Cr)) }
def cr; end
# Attribute for field cv
sig { returns(T.nilable(Cv)) }
def cv; end
# Attribute for field cy
sig { returns(T.nilable(Cy)) }
def cy; end
# Attribute for field cz
sig { returns(T.nilable(Cz)) }
def cz; end
# Attribute for field de
sig { returns(T.nilable(De)) }
def de; end
# Attribute for field dk
sig { returns(T.nilable(Dk)) }
def dk; end
# Attribute for field ec
sig { returns(T.nilable(Ec)) }
def ec; end
# Attribute for field ee
sig { returns(T.nilable(Ee)) }
def ee; end
# Attribute for field eg
sig { returns(T.nilable(Eg)) }
def eg; end
# Attribute for field es
sig { returns(T.nilable(Es)) }
def es; end
# Attribute for field et
sig { returns(T.nilable(Et)) }
def et; end
# Attribute for field fi
sig { returns(T.nilable(Fi)) }
def fi; end
# Attribute for field fr
sig { returns(T.nilable(Fr)) }
def fr; end
# Attribute for field gb
sig { returns(T.nilable(Gb)) }
def gb; end
# Attribute for field ge
sig { returns(T.nilable(Ge)) }
def ge; end
# Attribute for field gn
sig { returns(T.nilable(Gn)) }
def gn; end
# Attribute for field gr
sig { returns(T.nilable(Gr)) }
def gr; end
# Attribute for field hr
sig { returns(T.nilable(Hr)) }
def hr; end
# Attribute for field hu
sig { returns(T.nilable(Hu)) }
def hu; end
# Attribute for field id
sig { returns(T.nilable(Id)) }
def id; end
# Attribute for field ie
sig { returns(T.nilable(Ie)) }
def ie; end
# Attribute for field in
sig { returns(T.nilable(In)) }
def in; end
# Attribute for field is
sig { returns(T.nilable(Is)) }
def is; end
# Attribute for field it
sig { returns(T.nilable(It)) }
def it; end
# Attribute for field jp
sig { returns(T.nilable(Jp)) }
def jp; end
# Attribute for field ke
sig { returns(T.nilable(Ke)) }
def ke; end
# Attribute for field kg
sig { returns(T.nilable(Kg)) }
def kg; end
# Attribute for field kh
sig { returns(T.nilable(Kh)) }
def kh; end
# Attribute for field kr
sig { returns(T.nilable(Kr)) }
def kr; end
# Attribute for field kz
sig { returns(T.nilable(Kz)) }
def kz; end
# Attribute for field la
sig { returns(T.nilable(La)) }
def la; end
# Attribute for field lt
sig { returns(T.nilable(Lt)) }
def lt; end
# Attribute for field lu
sig { returns(T.nilable(Lu)) }
def lu; end
# Attribute for field lv
sig { returns(T.nilable(Lv)) }
def lv; end
# Attribute for field ma
sig { returns(T.nilable(Ma)) }
def ma; end
# Attribute for field md
sig { returns(T.nilable(Md)) }
def md; end
# Attribute for field me
sig { returns(T.nilable(Me)) }
def me; end
# Attribute for field mk
sig { returns(T.nilable(Mk)) }
def mk; end
# Attribute for field mr
sig { returns(T.nilable(Mr)) }
def mr; end
# Attribute for field mt
sig { returns(T.nilable(Mt)) }
def mt; end
# Attribute for field mx
sig { returns(T.nilable(Mx)) }
def mx; end
# Attribute for field my
sig { returns(T.nilable(My)) }
def my; end
# Attribute for field ng
sig { returns(T.nilable(Ng)) }
def ng; end
# Attribute for field nl
sig { returns(T.nilable(Nl)) }
def nl; end
# Attribute for field no
sig { returns(T.nilable(No)) }
def no; end
# Attribute for field np
sig { returns(T.nilable(Np)) }
def np; end
# Attribute for field nz
sig { returns(T.nilable(Nz)) }
def nz; end
# Attribute for field om
sig { returns(T.nilable(Om)) }
def om; end
# Attribute for field pe
sig { returns(T.nilable(Pe)) }
def pe; end
# Attribute for field ph
sig { returns(T.nilable(Ph)) }
def ph; end
# Attribute for field pl
sig { returns(T.nilable(Pl)) }
def pl; end
# Attribute for field pt
sig { returns(T.nilable(Pt)) }
def pt; end
# Attribute for field ro
sig { returns(T.nilable(Ro)) }
def ro; end
# Attribute for field rs
sig { returns(T.nilable(Rs)) }
def rs; end
# Attribute for field ru
sig { returns(T.nilable(Ru)) }
def ru; end
# Attribute for field sa
sig { returns(T.nilable(Sa)) }
def sa; end
# Attribute for field se
sig { returns(T.nilable(Se)) }
def se; end
# Attribute for field sg
sig { returns(T.nilable(Sg)) }
def sg; end
# Attribute for field si
sig { returns(T.nilable(Si)) }
def si; end
# Attribute for field sk
sig { returns(T.nilable(Sk)) }
def sk; end
# Attribute for field sn
sig { returns(T.nilable(Sn)) }
def sn; end
# Attribute for field sr
sig { returns(T.nilable(Sr)) }
def sr; end
# Attribute for field th
sig { returns(T.nilable(Th)) }
def th; end
# Attribute for field tj
sig { returns(T.nilable(Tj)) }
def tj; end
# Attribute for field tr
sig { returns(T.nilable(Tr)) }
def tr; end
# Attribute for field tz
sig { returns(T.nilable(Tz)) }
def tz; end
# Attribute for field ua
sig { returns(T.nilable(Ua)) }
def ua; end
# Attribute for field ug
sig { returns(T.nilable(Ug)) }
def ug; end
# Attribute for field us
sig { returns(T.nilable(Us)) }
def us; end
# Attribute for field uy
sig { returns(T.nilable(Uy)) }
def uy; end
# Attribute for field uz
sig { returns(T.nilable(Uz)) }
def uz; end
# Attribute for field vn
sig { returns(T.nilable(Vn)) }
def vn; end
# Attribute for field za
sig { returns(T.nilable(Za)) }
def za; end
# Attribute for field zm
sig { returns(T.nilable(Zm)) }
def zm; end
# Attribute for field zw
sig { returns(T.nilable(Zw)) }
def zw; end
end
# Time at which the registration becomes active. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def active_from; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
# Attribute for field country_options
sig { returns(CountryOptions) }
def country_options; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def expires_at; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`.
sig { returns(String) }
def status; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# The status of the Tax Registration.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class CountryOptions < Stripe::RequestParams
class Ae < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ae::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ae::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ae::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ae::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Al < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Al::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Al::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Al::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Al::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Am < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ao < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ao::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ao::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ao::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ao::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class At < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::At::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::At::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::At::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::At::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Au < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Au::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Au::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Au::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Au::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Aw < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Aw::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Aw::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Aw::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Aw::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Az < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ba < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ba::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ba::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ba::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ba::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Bb < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bb::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bb::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bb::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bb::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Bd < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bd::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bd::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bd::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bd::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Be < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Be::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Be::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Be::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Be::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Bf < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bf::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bf::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bf::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bf::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Bg < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bg::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bg::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bg::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bg::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Bh < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bh::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bh::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bh::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bh::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Bj < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Bs < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bs::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bs::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bs::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bs::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class By < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ca < Stripe::RequestParams
class ProvinceStandard < Stripe::RequestParams
# Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
sig { returns(String) }
def province; end
sig { params(_province: String).returns(String) }
def province=(_province); end
sig { params(province: String).void }
def initialize(province: nil); end
end
# Options for the provincial tax registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ca::ProvinceStandard))
}
def province_standard; end
sig {
params(_province_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ca::ProvinceStandard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ca::ProvinceStandard))
}
def province_standard=(_province_standard); end
# Type of registration to be created in Canada.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(province_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ca::ProvinceStandard), type: String).void
}
def initialize(province_standard: nil, type: nil); end
end
class Cd < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cd::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cd::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cd::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cd::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Ch < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ch::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ch::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ch::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ch::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Cl < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Cm < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Co < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Cr < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Cv < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Cy < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cy::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cy::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cy::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cy::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Cz < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cz::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cz::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cz::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cz::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class De < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::De::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::De::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::De::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::De::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Dk < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Dk::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Dk::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Dk::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Dk::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Ec < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ee < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ee::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ee::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ee::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ee::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Eg < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Es < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Es::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Es::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Es::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Es::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Et < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Et::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Et::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Et::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Et::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Fi < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Fi::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Fi::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Fi::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Fi::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Fr < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Fr::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Fr::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Fr::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Fr::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Gb < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gb::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gb::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gb::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gb::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Ge < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Gn < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gn::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gn::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gn::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gn::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Gr < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gr::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gr::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gr::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gr::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Hr < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Hr::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Hr::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Hr::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Hr::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Hu < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Hu::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Hu::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Hu::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Hu::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Id < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ie < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ie::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ie::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ie::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ie::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class In < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Is < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Is::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Is::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Is::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Is::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class It < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::It::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::It::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::It::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::It::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Jp < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Jp::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Jp::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Jp::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Jp::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Ke < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Kg < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Kh < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Kr < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Kz < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class La < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Lt < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lt::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lt::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lt::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lt::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Lu < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lu::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lu::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lu::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lu::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Lv < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lv::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lv::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lv::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lv::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Ma < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Md < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Me < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Me::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Me::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Me::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Me::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Mk < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mk::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mk::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mk::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mk::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Mr < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mr::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mr::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mr::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mr::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Mt < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mt::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mt::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mt::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mt::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Mx < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class My < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ng < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Nl < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Nl::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Nl::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Nl::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Nl::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class No < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::No::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::No::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::No::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::No::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Np < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Nz < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Nz::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Nz::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Nz::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Nz::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Om < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Om::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Om::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Om::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Om::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Pe < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ph < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Pl < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pl::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pl::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pl::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pl::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Pt < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pt::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pt::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pt::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pt::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Ro < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ro::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ro::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ro::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ro::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Rs < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Rs::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Rs::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Rs::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Rs::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Ru < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Sa < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Se < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Se::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Se::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Se::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Se::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Sg < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sg::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sg::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sg::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sg::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Si < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Si::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Si::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Si::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Si::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Sk < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sk::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sk::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sk::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sk::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Sn < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Sr < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sr::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sr::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sr::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sr::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Th < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Tj < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Tr < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Tz < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ua < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ug < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Us < Stripe::RequestParams
class LocalAmusementTax < Stripe::RequestParams
# A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), and `68081` (Schiller Park).
sig { returns(String) }
def jurisdiction; end
sig { params(_jurisdiction: String).returns(String) }
def jurisdiction=(_jurisdiction); end
sig { params(jurisdiction: String).void }
def initialize(jurisdiction: nil); end
end
class LocalLeaseTax < Stripe::RequestParams
# A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago).
sig { returns(String) }
def jurisdiction; end
sig { params(_jurisdiction: String).returns(String) }
def jurisdiction=(_jurisdiction); end
sig { params(jurisdiction: String).void }
def initialize(jurisdiction: nil); end
end
class StateSalesTax < Stripe::RequestParams
class Election < Stripe::RequestParams
# A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `003` (Allegheny County) and `60000` (Philadelphia City).
sig { returns(T.nilable(String)) }
def jurisdiction; end
sig { params(_jurisdiction: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction=(_jurisdiction); end
# The type of the election for the state sales tax registration.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(jurisdiction: T.nilable(String), type: String).void }
def initialize(jurisdiction: nil, type: nil); end
end
# Elections for the state sales tax registration.
sig {
returns(T::Array[::Stripe::Tax::Registration::CreateParams::CountryOptions::Us::StateSalesTax::Election])
}
def elections; end
sig {
params(_elections: T::Array[::Stripe::Tax::Registration::CreateParams::CountryOptions::Us::StateSalesTax::Election]).returns(T::Array[::Stripe::Tax::Registration::CreateParams::CountryOptions::Us::StateSalesTax::Election])
}
def elections=(_elections); end
sig {
params(elections: T::Array[::Stripe::Tax::Registration::CreateParams::CountryOptions::Us::StateSalesTax::Election]).void
}
def initialize(elections: nil); end
end
# Options for the local amusement tax registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Us::LocalAmusementTax))
}
def local_amusement_tax; end
sig {
params(_local_amusement_tax: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Us::LocalAmusementTax)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Us::LocalAmusementTax))
}
def local_amusement_tax=(_local_amusement_tax); end
# Options for the local lease tax registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Us::LocalLeaseTax))
}
def local_lease_tax; end
sig {
params(_local_lease_tax: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Us::LocalLeaseTax)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Us::LocalLeaseTax))
}
def local_lease_tax=(_local_lease_tax); end
# Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
sig { returns(String) }
def state; end
sig { params(_state: String).returns(String) }
def state=(_state); end
# Options for the state sales tax registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Us::StateSalesTax))
}
def state_sales_tax; end
sig {
params(_state_sales_tax: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Us::StateSalesTax)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Us::StateSalesTax))
}
def state_sales_tax=(_state_sales_tax); end
# Type of registration to be created in the US.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(local_amusement_tax: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Us::LocalAmusementTax), local_lease_tax: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Us::LocalLeaseTax), state: String, state_sales_tax: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Us::StateSalesTax), type: String).void
}
def initialize(
local_amusement_tax: nil,
local_lease_tax: nil,
state: nil,
state_sales_tax: nil,
type: nil
); end
end
class Uy < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Uy::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Uy::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Uy::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Uy::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Uz < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Vn < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Za < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Za::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Za::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Za::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Za::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Zm < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Zw < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Zw::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Zw::Standard)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Zw::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Zw::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
# Options for the registration in AE.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ae)) }
def ae; end
sig {
params(_ae: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ae)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ae))
}
def ae=(_ae); end
# Options for the registration in AL.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Al)) }
def al; end
sig {
params(_al: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Al)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Al))
}
def al=(_al); end
# Options for the registration in AM.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Am)) }
def am; end
sig {
params(_am: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Am)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Am))
}
def am=(_am); end
# Options for the registration in AO.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ao)) }
def ao; end
sig {
params(_ao: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ao)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ao))
}
def ao=(_ao); end
# Options for the registration in AT.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::At)) }
def at; end
sig {
params(_at: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::At)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::At))
}
def at=(_at); end
# Options for the registration in AU.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Au)) }
def au; end
sig {
params(_au: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Au)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Au))
}
def au=(_au); end
# Options for the registration in AW.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Aw)) }
def aw; end
sig {
params(_aw: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Aw)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Aw))
}
def aw=(_aw); end
# Options for the registration in AZ.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Az)) }
def az; end
sig {
params(_az: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Az)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Az))
}
def az=(_az); end
# Options for the registration in BA.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ba)) }
def ba; end
sig {
params(_ba: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ba)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ba))
}
def ba=(_ba); end
# Options for the registration in BB.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bb)) }
def bb; end
sig {
params(_bb: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bb)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bb))
}
def bb=(_bb); end
# Options for the registration in BD.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bd)) }
def bd; end
sig {
params(_bd: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bd)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bd))
}
def bd=(_bd); end
# Options for the registration in BE.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Be)) }
def be; end
sig {
params(_be: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Be)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Be))
}
def be=(_be); end
# Options for the registration in BF.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bf)) }
def bf; end
sig {
params(_bf: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bf)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bf))
}
def bf=(_bf); end
# Options for the registration in BG.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bg)) }
def bg; end
sig {
params(_bg: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bg)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bg))
}
def bg=(_bg); end
# Options for the registration in BH.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bh)) }
def bh; end
sig {
params(_bh: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bh)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bh))
}
def bh=(_bh); end
# Options for the registration in BJ.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bj)) }
def bj; end
sig {
params(_bj: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bj)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bj))
}
def bj=(_bj); end
# Options for the registration in BS.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bs)) }
def bs; end
sig {
params(_bs: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bs)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bs))
}
def bs=(_bs); end
# Options for the registration in BY.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::By)) }
def by; end
sig {
params(_by: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::By)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::By))
}
def by=(_by); end
# Options for the registration in CA.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ca)) }
def ca; end
sig {
params(_ca: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ca)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ca))
}
def ca=(_ca); end
# Options for the registration in CD.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cd)) }
def cd; end
sig {
params(_cd: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cd)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cd))
}
def cd=(_cd); end
# Options for the registration in CH.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ch)) }
def ch; end
sig {
params(_ch: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ch)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ch))
}
def ch=(_ch); end
# Options for the registration in CL.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cl)) }
def cl; end
sig {
params(_cl: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cl)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cl))
}
def cl=(_cl); end
# Options for the registration in CM.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cm)) }
def cm; end
sig {
params(_cm: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cm)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cm))
}
def cm=(_cm); end
# Options for the registration in CO.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Co)) }
def co; end
sig {
params(_co: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Co)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Co))
}
def co=(_co); end
# Options for the registration in CR.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cr)) }
def cr; end
sig {
params(_cr: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cr)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cr))
}
def cr=(_cr); end
# Options for the registration in CV.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cv)) }
def cv; end
sig {
params(_cv: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cv)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cv))
}
def cv=(_cv); end
# Options for the registration in CY.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cy)) }
def cy; end
sig {
params(_cy: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cy)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cy))
}
def cy=(_cy); end
# Options for the registration in CZ.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cz)) }
def cz; end
sig {
params(_cz: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cz)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cz))
}
def cz=(_cz); end
# Options for the registration in DE.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::De)) }
def de; end
sig {
params(_de: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::De)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::De))
}
def de=(_de); end
# Options for the registration in DK.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Dk)) }
def dk; end
sig {
params(_dk: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Dk)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Dk))
}
def dk=(_dk); end
# Options for the registration in EC.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ec)) }
def ec; end
sig {
params(_ec: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ec)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ec))
}
def ec=(_ec); end
# Options for the registration in EE.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ee)) }
def ee; end
sig {
params(_ee: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ee)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ee))
}
def ee=(_ee); end
# Options for the registration in EG.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Eg)) }
def eg; end
sig {
params(_eg: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Eg)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Eg))
}
def eg=(_eg); end
# Options for the registration in ES.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Es)) }
def es; end
sig {
params(_es: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Es)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Es))
}
def es=(_es); end
# Options for the registration in ET.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Et)) }
def et; end
sig {
params(_et: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Et)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Et))
}
def et=(_et); end
# Options for the registration in FI.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Fi)) }
def fi; end
sig {
params(_fi: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Fi)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Fi))
}
def fi=(_fi); end
# Options for the registration in FR.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Fr)) }
def fr; end
sig {
params(_fr: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Fr)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Fr))
}
def fr=(_fr); end
# Options for the registration in GB.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gb)) }
def gb; end
sig {
params(_gb: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gb)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gb))
}
def gb=(_gb); end
# Options for the registration in GE.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ge)) }
def ge; end
sig {
params(_ge: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ge)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ge))
}
def ge=(_ge); end
# Options for the registration in GN.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gn)) }
def gn; end
sig {
params(_gn: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gn)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gn))
}
def gn=(_gn); end
# Options for the registration in GR.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gr)) }
def gr; end
sig {
params(_gr: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gr)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gr))
}
def gr=(_gr); end
# Options for the registration in HR.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Hr)) }
def hr; end
sig {
params(_hr: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Hr)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Hr))
}
def hr=(_hr); end
# Options for the registration in HU.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Hu)) }
def hu; end
sig {
params(_hu: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Hu)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Hu))
}
def hu=(_hu); end
# Options for the registration in ID.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Id)) }
def id; end
sig {
params(_id: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Id)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Id))
}
def id=(_id); end
# Options for the registration in IE.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ie)) }
def ie; end
sig {
params(_ie: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ie)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ie))
}
def ie=(_ie); end
# Options for the registration in IN.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::In)) }
def in; end
sig {
params(_in: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::In)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::In))
}
def in=(_in); end
# Options for the registration in IS.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Is)) }
def is; end
sig {
params(_is: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Is)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Is))
}
def is=(_is); end
# Options for the registration in IT.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::It)) }
def it; end
sig {
params(_it: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::It)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::It))
}
def it=(_it); end
# Options for the registration in JP.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Jp)) }
def jp; end
sig {
params(_jp: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Jp)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Jp))
}
def jp=(_jp); end
# Options for the registration in KE.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ke)) }
def ke; end
sig {
params(_ke: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ke)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ke))
}
def ke=(_ke); end
# Options for the registration in KG.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Kg)) }
def kg; end
sig {
params(_kg: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Kg)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Kg))
}
def kg=(_kg); end
# Options for the registration in KH.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Kh)) }
def kh; end
sig {
params(_kh: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Kh)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Kh))
}
def kh=(_kh); end
# Options for the registration in KR.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Kr)) }
def kr; end
sig {
params(_kr: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Kr)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Kr))
}
def kr=(_kr); end
# Options for the registration in KZ.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Kz)) }
def kz; end
sig {
params(_kz: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Kz)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Kz))
}
def kz=(_kz); end
# Options for the registration in LA.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::La)) }
def la; end
sig {
params(_la: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::La)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::La))
}
def la=(_la); end
# Options for the registration in LT.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lt)) }
def lt; end
sig {
params(_lt: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lt)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lt))
}
def lt=(_lt); end
# Options for the registration in LU.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lu)) }
def lu; end
sig {
params(_lu: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lu)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lu))
}
def lu=(_lu); end
# Options for the registration in LV.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lv)) }
def lv; end
sig {
params(_lv: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lv)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lv))
}
def lv=(_lv); end
# Options for the registration in MA.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ma)) }
def ma; end
sig {
params(_ma: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ma)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ma))
}
def ma=(_ma); end
# Options for the registration in MD.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Md)) }
def md; end
sig {
params(_md: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Md)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Md))
}
def md=(_md); end
# Options for the registration in ME.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Me)) }
def me; end
sig {
params(_me: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Me)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Me))
}
def me=(_me); end
# Options for the registration in MK.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mk)) }
def mk; end
sig {
params(_mk: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mk)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mk))
}
def mk=(_mk); end
# Options for the registration in MR.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mr)) }
def mr; end
sig {
params(_mr: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mr)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mr))
}
def mr=(_mr); end
# Options for the registration in MT.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mt)) }
def mt; end
sig {
params(_mt: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mt)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mt))
}
def mt=(_mt); end
# Options for the registration in MX.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mx)) }
def mx; end
sig {
params(_mx: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mx)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mx))
}
def mx=(_mx); end
# Options for the registration in MY.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::My)) }
def my; end
sig {
params(_my: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::My)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::My))
}
def my=(_my); end
# Options for the registration in NG.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ng)) }
def ng; end
sig {
params(_ng: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ng)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ng))
}
def ng=(_ng); end
# Options for the registration in NL.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Nl)) }
def nl; end
sig {
params(_nl: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Nl)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Nl))
}
def nl=(_nl); end
# Options for the registration in NO.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::No)) }
def no; end
sig {
params(_no: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::No)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::No))
}
def no=(_no); end
# Options for the registration in NP.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Np)) }
def np; end
sig {
params(_np: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Np)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Np))
}
def np=(_np); end
# Options for the registration in NZ.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Nz)) }
def nz; end
sig {
params(_nz: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Nz)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Nz))
}
def nz=(_nz); end
# Options for the registration in OM.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Om)) }
def om; end
sig {
params(_om: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Om)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Om))
}
def om=(_om); end
# Options for the registration in PE.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pe)) }
def pe; end
sig {
params(_pe: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pe)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pe))
}
def pe=(_pe); end
# Options for the registration in PH.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ph)) }
def ph; end
sig {
params(_ph: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ph)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ph))
}
def ph=(_ph); end
# Options for the registration in PL.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pl)) }
def pl; end
sig {
params(_pl: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pl)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pl))
}
def pl=(_pl); end
# Options for the registration in PT.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pt)) }
def pt; end
sig {
params(_pt: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pt)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pt))
}
def pt=(_pt); end
# Options for the registration in RO.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ro)) }
def ro; end
sig {
params(_ro: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ro)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ro))
}
def ro=(_ro); end
# Options for the registration in RS.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Rs)) }
def rs; end
sig {
params(_rs: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Rs)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Rs))
}
def rs=(_rs); end
# Options for the registration in RU.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ru)) }
def ru; end
sig {
params(_ru: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ru)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ru))
}
def ru=(_ru); end
# Options for the registration in SA.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sa)) }
def sa; end
sig {
params(_sa: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sa)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sa))
}
def sa=(_sa); end
# Options for the registration in SE.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Se)) }
def se; end
sig {
params(_se: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Se)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Se))
}
def se=(_se); end
# Options for the registration in SG.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sg)) }
def sg; end
sig {
params(_sg: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sg)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sg))
}
def sg=(_sg); end
# Options for the registration in SI.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Si)) }
def si; end
sig {
params(_si: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Si)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Si))
}
def si=(_si); end
# Options for the registration in SK.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sk)) }
def sk; end
sig {
params(_sk: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sk)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sk))
}
def sk=(_sk); end
# Options for the registration in SN.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sn)) }
def sn; end
sig {
params(_sn: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sn)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sn))
}
def sn=(_sn); end
# Options for the registration in SR.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sr)) }
def sr; end
sig {
params(_sr: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sr)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sr))
}
def sr=(_sr); end
# Options for the registration in TH.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Th)) }
def th; end
sig {
params(_th: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Th)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Th))
}
def th=(_th); end
# Options for the registration in TJ.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Tj)) }
def tj; end
sig {
params(_tj: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Tj)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Tj))
}
def tj=(_tj); end
# Options for the registration in TR.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Tr)) }
def tr; end
sig {
params(_tr: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Tr)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Tr))
}
def tr=(_tr); end
# Options for the registration in TZ.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Tz)) }
def tz; end
sig {
params(_tz: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Tz)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Tz))
}
def tz=(_tz); end
# Options for the registration in UA.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ua)) }
def ua; end
sig {
params(_ua: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ua)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ua))
}
def ua=(_ua); end
# Options for the registration in UG.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ug)) }
def ug; end
sig {
params(_ug: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ug)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ug))
}
def ug=(_ug); end
# Options for the registration in US.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Us)) }
def us; end
sig {
params(_us: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Us)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Us))
}
def us=(_us); end
# Options for the registration in UY.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Uy)) }
def uy; end
sig {
params(_uy: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Uy)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Uy))
}
def uy=(_uy); end
# Options for the registration in UZ.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Uz)) }
def uz; end
sig {
params(_uz: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Uz)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Uz))
}
def uz=(_uz); end
# Options for the registration in VN.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Vn)) }
def vn; end
sig {
params(_vn: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Vn)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Vn))
}
def vn=(_vn); end
# Options for the registration in ZA.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Za)) }
def za; end
sig {
params(_za: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Za)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Za))
}
def za=(_za); end
# Options for the registration in ZM.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Zm)) }
def zm; end
sig {
params(_zm: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Zm)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Zm))
}
def zm=(_zm); end
# Options for the registration in ZW.
sig { returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Zw)) }
def zw; end
sig {
params(_zw: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Zw)).returns(T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Zw))
}
def zw=(_zw); end
sig {
params(ae: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ae), al: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Al), am: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Am), ao: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ao), at: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::At), au: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Au), aw: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Aw), az: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Az), ba: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ba), bb: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bb), bd: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bd), be: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Be), bf: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bf), bg: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bg), bh: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bh), bj: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bj), bs: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Bs), by: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::By), ca: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ca), cd: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cd), ch: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ch), cl: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cl), cm: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cm), co: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Co), cr: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cr), cv: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cv), cy: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cy), cz: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Cz), de: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::De), dk: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Dk), ec: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ec), ee: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ee), eg: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Eg), es: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Es), et: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Et), fi: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Fi), fr: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Fr), gb: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gb), ge: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ge), gn: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gn), gr: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Gr), hr: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Hr), hu: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Hu), id: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Id), ie: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ie), in_: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::In), is: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Is), it: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::It), jp: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Jp), ke: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ke), kg: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Kg), kh: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Kh), kr: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Kr), kz: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Kz), la: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::La), lt: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lt), lu: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lu), lv: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Lv), ma: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ma), md: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Md), me: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Me), mk: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mk), mr: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mr), mt: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mt), mx: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Mx), my: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::My), ng: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ng), nl: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Nl), no: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::No), np: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Np), nz: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Nz), om: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Om), pe: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pe), ph: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ph), pl: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pl), pt: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Pt), ro: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ro), rs: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Rs), ru: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ru), sa: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sa), se: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Se), sg: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sg), si: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Si), sk: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sk), sn: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sn), sr: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Sr), th: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Th), tj: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Tj), tr: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Tr), tz: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Tz), ua: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ua), ug: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Ug), us: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Us), uy: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Uy), uz: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Uz), vn: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Vn), za: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Za), zm: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Zm), zw: T.nilable(::Stripe::Tax::Registration::CreateParams::CountryOptions::Zw)).void
}
def initialize(
ae: nil,
al: nil,
am: nil,
ao: nil,
at: nil,
au: nil,
aw: nil,
az: nil,
ba: nil,
bb: nil,
bd: nil,
be: nil,
bf: nil,
bg: nil,
bh: nil,
bj: nil,
bs: nil,
by: nil,
ca: nil,
cd: nil,
ch: nil,
cl: nil,
cm: nil,
co: nil,
cr: nil,
cv: nil,
cy: nil,
cz: nil,
de: nil,
dk: nil,
ec: nil,
ee: nil,
eg: nil,
es: nil,
et: nil,
fi: nil,
fr: nil,
gb: nil,
ge: nil,
gn: nil,
gr: nil,
hr: nil,
hu: nil,
id: nil,
ie: nil,
in_: nil,
is: nil,
it: nil,
jp: nil,
ke: nil,
kg: nil,
kh: nil,
kr: nil,
kz: nil,
la: nil,
lt: nil,
lu: nil,
lv: nil,
ma: nil,
md: nil,
me: nil,
mk: nil,
mr: nil,
mt: nil,
mx: nil,
my: nil,
ng: nil,
nl: nil,
no: nil,
np: nil,
nz: nil,
om: nil,
pe: nil,
ph: nil,
pl: nil,
pt: nil,
ro: nil,
rs: nil,
ru: nil,
sa: nil,
se: nil,
sg: nil,
si: nil,
sk: nil,
sn: nil,
sr: nil,
th: nil,
tj: nil,
tr: nil,
tz: nil,
ua: nil,
ug: nil,
us: nil,
uy: nil,
uz: nil,
vn: nil,
za: nil,
zm: nil,
zw: nil
); end
end
# Time at which the Tax Registration becomes active. It can be either `now` to indicate the current time, or a future timestamp measured in seconds since the Unix epoch.
sig { returns(T.any(String, Integer)) }
def active_from; end
sig { params(_active_from: T.any(String, Integer)).returns(T.any(String, Integer)) }
def active_from=(_active_from); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Specific options for a registration in the specified `country`.
sig { returns(::Stripe::Tax::Registration::CreateParams::CountryOptions) }
def country_options; end
sig {
params(_country_options: ::Stripe::Tax::Registration::CreateParams::CountryOptions).returns(::Stripe::Tax::Registration::CreateParams::CountryOptions)
}
def country_options=(_country_options); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
sig {
params(active_from: T.any(String, Integer), country: String, country_options: ::Stripe::Tax::Registration::CreateParams::CountryOptions, expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer)).void
}
def initialize(
active_from: nil,
country: nil,
country_options: nil,
expand: nil,
expires_at: nil
); end
end
class UpdateParams < Stripe::RequestParams
# Time at which the registration becomes active. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch.
sig { returns(T.nilable(T.any(String, Integer))) }
def active_from; end
sig {
params(_active_from: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def active_from=(_active_from); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch.
sig { returns(T.nilable(T.any(String, T.any(String, Integer)))) }
def expires_at; end
sig {
params(_expires_at: T.nilable(T.any(String, T.any(String, Integer)))).returns(T.nilable(T.any(String, T.any(String, Integer))))
}
def expires_at=(_expires_at); end
sig {
params(active_from: T.nilable(T.any(String, Integer)), expand: T.nilable(T::Array[String]), expires_at: T.nilable(T.any(String, T.any(String, Integer)))).void
}
def initialize(active_from: nil, expand: nil, expires_at: nil); end
end
# Creates a new Tax Registration object.
sig {
params(params: T.any(::Stripe::Tax::Registration::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Registration)
}
def self.create(params = {}, opts = {}); end
# Returns a list of Tax Registration objects.
sig {
params(params: T.any(::Stripe::Tax::Registration::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates an existing Tax Registration object.
#
# A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.
sig {
params(id: String, params: T.any(::Stripe::Tax::Registration::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Registration)
}
def self.update(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Tax
# You can use Tax `Settings` to manage configurations used by Stripe Tax calculations.
#
# Related guide: [Using the Settings API](https://stripe.com/docs/tax/settings-api)
class Settings < SingletonAPIResource
class Defaults < Stripe::StripeObject
# The tax calculation provider this account uses. Defaults to `stripe` when not using a [third-party provider](/tax/third-party-apps).
sig { returns(String) }
def provider; end
# Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior.
sig { returns(T.nilable(String)) }
def tax_behavior; end
# Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices.
sig { returns(T.nilable(String)) }
def tax_code; end
end
class HeadOffice < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(Address) }
def address; end
end
class StatusDetails < Stripe::StripeObject
class Active < Stripe::StripeObject; end
class Pending < Stripe::StripeObject
# The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call.
sig { returns(T.nilable(T::Array[String])) }
def missing_fields; end
end
# Attribute for field active
sig { returns(T.nilable(Active)) }
def active; end
# Attribute for field pending
sig { returns(T.nilable(Pending)) }
def pending; end
end
# Attribute for field defaults
sig { returns(Defaults) }
def defaults; end
# The place where your business is located.
sig { returns(T.nilable(HeadOffice)) }
def head_office; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The status of the Tax `Settings`.
sig { returns(String) }
def status; end
# Attribute for field status_details
sig { returns(StatusDetails) }
def status_details; end
class UpdateParams < Stripe::RequestParams
class Defaults < Stripe::RequestParams
# Specifies the default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) to be used when the item's price has unspecified tax behavior. One of inclusive, exclusive, or inferred_by_currency. Once specified, it cannot be changed back to null.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
sig { params(tax_behavior: T.nilable(String), tax_code: T.nilable(String)).void }
def initialize(tax_behavior: nil, tax_code: nil); end
end
class HeadOffice < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The location of the business for tax purposes.
sig { returns(::Stripe::Tax::Settings::UpdateParams::HeadOffice::Address) }
def address; end
sig {
params(_address: ::Stripe::Tax::Settings::UpdateParams::HeadOffice::Address).returns(::Stripe::Tax::Settings::UpdateParams::HeadOffice::Address)
}
def address=(_address); end
sig { params(address: ::Stripe::Tax::Settings::UpdateParams::HeadOffice::Address).void }
def initialize(address: nil); end
end
# Default configuration to be used on Stripe Tax calculations.
sig { returns(T.nilable(::Stripe::Tax::Settings::UpdateParams::Defaults)) }
def defaults; end
sig {
params(_defaults: T.nilable(::Stripe::Tax::Settings::UpdateParams::Defaults)).returns(T.nilable(::Stripe::Tax::Settings::UpdateParams::Defaults))
}
def defaults=(_defaults); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The place where your business is located.
sig { returns(T.nilable(::Stripe::Tax::Settings::UpdateParams::HeadOffice)) }
def head_office; end
sig {
params(_head_office: T.nilable(::Stripe::Tax::Settings::UpdateParams::HeadOffice)).returns(T.nilable(::Stripe::Tax::Settings::UpdateParams::HeadOffice))
}
def head_office=(_head_office); end
sig {
params(defaults: T.nilable(::Stripe::Tax::Settings::UpdateParams::Defaults), expand: T.nilable(T::Array[String]), head_office: T.nilable(::Stripe::Tax::Settings::UpdateParams::HeadOffice)).void
}
def initialize(defaults: nil, expand: nil, head_office: nil); end
end
end
end
end
# typed: true
module Stripe
module Tax
# A Tax Transaction records the tax collected from or refunded to your customer.
#
# Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom#tax-transaction)
class Transaction < APIResource
class CustomerDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
sig { returns(T.nilable(String)) }
def state; end
end
class TaxId < Stripe::StripeObject
# The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
sig { returns(String) }
def type; end
# The value of the tax ID.
sig { returns(String) }
def value; end
end
# The customer's postal address (for example, home or business location).
sig { returns(T.nilable(Address)) }
def address; end
# The type of customer address provided.
sig { returns(T.nilable(String)) }
def address_source; end
# The customer's IP address (IPv4 or IPv6).
sig { returns(T.nilable(String)) }
def ip_address; end
# The customer's tax IDs (for example, EU VAT numbers).
sig { returns(T::Array[TaxId]) }
def tax_ids; end
# The taxability override used for taxation.
sig { returns(String) }
def taxability_override; end
end
class Reversal < Stripe::StripeObject
# The `id` of the reversed `Transaction` object.
sig { returns(T.nilable(String)) }
def original_transaction; end
end
class ShipFromDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(Address) }
def address; end
end
class ShippingCost < Stripe::StripeObject
class TaxBreakdown < Stripe::StripeObject
class Jurisdiction < Stripe::StripeObject
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
# A human-readable name for the jurisdiction imposing the tax.
sig { returns(String) }
def display_name; end
# Indicates the level of the jurisdiction imposing the tax.
sig { returns(String) }
def level; end
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.
sig { returns(T.nilable(String)) }
def state; end
end
class TaxRateDetails < Stripe::StripeObject
# A localized display name for tax type, intended to be human-readable. For example, "Local Sales and Use Tax", "Value-added tax (VAT)", or "Umsatzsteuer (USt.)".
sig { returns(String) }
def display_name; end
# The tax rate percentage as a string. For example, 8.5% is represented as "8.5".
sig { returns(String) }
def percentage_decimal; end
# The tax type, such as `vat` or `sales_tax`.
sig { returns(String) }
def tax_type; end
end
# The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
# Attribute for field jurisdiction
sig { returns(Jurisdiction) }
def jurisdiction; end
# Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address).
sig { returns(String) }
def sourcing; end
# Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax.
sig { returns(T.nilable(TaxRateDetails)) }
def tax_rate_details; end
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
sig { returns(String) }
def taxability_reason; end
# The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def taxable_amount; end
end
# The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
sig { returns(Integer) }
def amount; end
# The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount_tax; end
# The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object).
sig { returns(T.nilable(String)) }
def shipping_rate; end
# Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.
sig { returns(String) }
def tax_behavior; end
# Detailed account of taxes relevant to shipping cost. (It is not populated for the transaction resource object and will be removed in the next API version.)
sig { returns(T.nilable(T::Array[TaxBreakdown])) }
def tax_breakdown; end
# The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping.
sig { returns(String) }
def tax_code; end
end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.
sig { returns(T.nilable(String)) }
def customer; end
# Attribute for field customer_details
sig { returns(CustomerDetails) }
def customer_details; end
# Unique identifier for the transaction.
sig { returns(String) }
def id; end
# The tax collected or refunded, by line item.
sig { returns(T.nilable(Stripe::ListObject)) }
def line_items; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The Unix timestamp representing when the tax liability is assumed or reduced.
sig { returns(Integer) }
def posted_at; end
# A custom unique identifier, such as 'myOrder_123'.
sig { returns(String) }
def reference; end
# If `type=reversal`, contains information about what was reversed.
sig { returns(T.nilable(Reversal)) }
def reversal; end
# The details of the ship from location, such as the address.
sig { returns(T.nilable(ShipFromDetails)) }
def ship_from_details; end
# The shipping cost details for the transaction.
sig { returns(T.nilable(ShippingCost)) }
def shipping_cost; end
# Timestamp of date at which the tax rules and rates in effect applies for the calculation.
sig { returns(Integer) }
def tax_date; end
# If `reversal`, this transaction reverses an earlier transaction.
sig { returns(String) }
def type; end
class ListLineItemsParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateFromCalculationParams < Stripe::RequestParams
# Tax Calculation ID to be used as input when creating the transaction.
sig { returns(String) }
def calculation; end
sig { params(_calculation: String).returns(String) }
def calculation=(_calculation); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the `tax_date` and the current time, unless the `tax_date` is scheduled in advance. Defaults to the current time.
sig { returns(T.nilable(Integer)) }
def posted_at; end
sig { params(_posted_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def posted_at=(_posted_at); end
# A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(calculation: String, expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), posted_at: T.nilable(Integer), reference: String).void
}
def initialize(
calculation: nil,
expand: nil,
metadata: nil,
posted_at: nil,
reference: nil
); end
end
class CreateReversalParams < Stripe::RequestParams
class LineItem < Stripe::RequestParams
# The amount to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The amount of tax to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative.
sig { returns(Integer) }
def amount_tax; end
sig { params(_amount_tax: Integer).returns(Integer) }
def amount_tax=(_amount_tax); end
# 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The `id` of the line item to reverse in the original transaction.
sig { returns(String) }
def original_line_item; end
sig { params(_original_line_item: String).returns(String) }
def original_line_item=(_original_line_item); end
# The quantity reversed. Appears in [tax exports](https://stripe.com/docs/tax/reports), but does not affect the amount of tax reversed.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A custom identifier for this line item in the reversal transaction, such as 'L1-refund'.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(amount: Integer, amount_tax: Integer, metadata: T.nilable(T::Hash[String, String]), original_line_item: String, quantity: T.nilable(Integer), reference: String).void
}
def initialize(
amount: nil,
amount_tax: nil,
metadata: nil,
original_line_item: nil,
quantity: nil,
reference: nil
); end
end
class ShippingCost < Stripe::RequestParams
# The amount to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The amount of tax to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative.
sig { returns(Integer) }
def amount_tax; end
sig { params(_amount_tax: Integer).returns(Integer) }
def amount_tax=(_amount_tax); end
sig { params(amount: Integer, amount_tax: Integer).void }
def initialize(amount: nil, amount_tax: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes.
sig { returns(T.nilable(Integer)) }
def flat_amount; end
sig { params(_flat_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def flat_amount=(_flat_amount); end
# The line item amounts to reverse.
sig {
returns(T.nilable(T::Array[::Stripe::Tax::Transaction::CreateReversalParams::LineItem]))
}
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::Tax::Transaction::CreateReversalParams::LineItem])).returns(T.nilable(T::Array[::Stripe::Tax::Transaction::CreateReversalParams::LineItem]))
}
def line_items=(_line_items); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If `partial`, the provided line item or shipping cost amounts are reversed. If `full`, the original transaction is fully reversed.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
# The ID of the Transaction to partially or fully reverse.
sig { returns(String) }
def original_transaction; end
sig { params(_original_transaction: String).returns(String) }
def original_transaction=(_original_transaction); end
# A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://stripe.com/docs/tax/reports).
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
# The shipping cost to reverse.
sig { returns(T.nilable(::Stripe::Tax::Transaction::CreateReversalParams::ShippingCost)) }
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(::Stripe::Tax::Transaction::CreateReversalParams::ShippingCost)).returns(T.nilable(::Stripe::Tax::Transaction::CreateReversalParams::ShippingCost))
}
def shipping_cost=(_shipping_cost); end
sig {
params(expand: T.nilable(T::Array[String]), flat_amount: T.nilable(Integer), line_items: T.nilable(T::Array[::Stripe::Tax::Transaction::CreateReversalParams::LineItem]), metadata: T.nilable(T::Hash[String, String]), mode: String, original_transaction: String, reference: String, shipping_cost: T.nilable(::Stripe::Tax::Transaction::CreateReversalParams::ShippingCost)).void
}
def initialize(
expand: nil,
flat_amount: nil,
line_items: nil,
metadata: nil,
mode: nil,
original_transaction: nil,
reference: nil,
shipping_cost: nil
); end
end
# Creates a Tax Transaction from a calculation, if that calculation hasn't expired. Calculations expire after 90 days.
sig {
params(params: T.any(::Stripe::Tax::Transaction::CreateFromCalculationParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Transaction)
}
def self.create_from_calculation(params = {}, opts = {}); end
# Partially or fully reverses a previously created Transaction.
sig {
params(params: T.any(::Stripe::Tax::Transaction::CreateReversalParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Transaction)
}
def self.create_reversal(params = {}, opts = {}); end
# Retrieves the line items of a committed standalone transaction as a collection.
sig {
params(params: T.any(::Stripe::Tax::Transaction::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list_line_items(params = {}, opts = {}); end
# Retrieves the line items of a committed standalone transaction as a collection.
sig {
params(transaction: String, params: T.any(::Stripe::Tax::Transaction::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list_line_items(transaction, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
# [Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.
class TaxCode < APIResource
# A detailed description of which types of products the tax code represents.
sig { returns(String) }
def description; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# A short name for the tax code.
sig { returns(String) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# A list of [all tax codes available](https://stripe.com/docs/tax/tax-categories) to add to Products in order to allow specific tax calculations.
sig {
params(params: T.any(::Stripe::TaxCode::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account.
# Customer and account tax IDs get displayed on related invoices and credit notes.
#
# Related guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids)
class TaxId < APIResource
class Owner < Stripe::StripeObject
# The account being referenced when `type` is `account`.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def account; end
# The Connect Application being referenced when `type` is `application`.
sig { returns(T.nilable(T.any(String, Stripe::Application))) }
def application; end
# The customer being referenced when `type` is `customer`.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# The account being referenced when `type` is `customer`.
sig { returns(T.nilable(String)) }
def customer_account; end
# Type of owner referenced.
sig { returns(String) }
def type; end
end
class Verification < Stripe::StripeObject
# Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`.
sig { returns(String) }
def status; end
# Verified address.
sig { returns(T.nilable(String)) }
def verified_address; end
# Verified name.
sig { returns(T.nilable(String)) }
def verified_name; end
end
# Two-letter ISO code representing the country of the tax ID.
sig { returns(T.nilable(String)) }
def country; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# ID of the customer.
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
def customer; end
# ID of the account.
sig { returns(T.nilable(String)) }
def customer_account; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The account or customer the tax ID belongs to.
sig { returns(T.nilable(Owner)) }
def owner; end
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown`
sig { returns(String) }
def type; end
# Value of the tax ID.
sig { returns(String) }
def value; end
# Tax ID verification information.
sig { returns(T.nilable(Verification)) }
def verification; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams; end
class ListParams < Stripe::RequestParams
class Owner < Stripe::RequestParams
# Account the tax ID belongs to. Required when `type=account`
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Customer the tax ID belongs to. Required when `type=customer`
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# v2 Account the tax ID belongs to. Can be used in place of `customer` when `type=customer`
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Type of owner referenced.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(account: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), type: String).void
}
def initialize(account: nil, customer: nil, customer_account: nil, type: nil); end
end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.
sig { returns(T.nilable(::Stripe::TaxId::ListParams::Owner)) }
def owner; end
sig {
params(_owner: T.nilable(::Stripe::TaxId::ListParams::Owner)).returns(T.nilable(::Stripe::TaxId::ListParams::Owner))
}
def owner=(_owner); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), owner: T.nilable(::Stripe::TaxId::ListParams::Owner), starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
owner: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Owner < Stripe::RequestParams
# Account the tax ID belongs to. Required when `type=account`
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Customer the tax ID belongs to. Required when `type=customer`
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# v2 Account the tax ID belongs to. Can be used in place of `customer` when `type=customer`
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Type of owner referenced.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(account: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), type: String).void
}
def initialize(account: nil, customer: nil, customer_account: nil, type: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.
sig { returns(T.nilable(::Stripe::TaxId::CreateParams::Owner)) }
def owner; end
sig {
params(_owner: T.nilable(::Stripe::TaxId::CreateParams::Owner)).returns(T.nilable(::Stripe::TaxId::CreateParams::Owner))
}
def owner=(_owner); end
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Value of the tax ID.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig {
params(expand: T.nilable(T::Array[String]), owner: T.nilable(::Stripe::TaxId::CreateParams::Owner), type: String, value: String).void
}
def initialize(expand: nil, owner: nil, type: nil, value: nil); end
end
# Creates a new account or customer tax_id object.
sig {
params(params: T.any(::Stripe::TaxId::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TaxId)
}
def self.create(params = {}, opts = {}); end
# Deletes an existing account or customer tax_id object.
sig {
params(id: String, params: T.any(::Stripe::TaxId::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TaxId)
}
def self.delete(id, params = {}, opts = {}); end
# Deletes an existing account or customer tax_id object.
sig {
params(params: T.any(::Stripe::TaxId::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TaxId)
}
def delete(params = {}, opts = {}); end
# Returns a list of tax IDs.
sig {
params(params: T.any(::Stripe::TaxId::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# Tax rates can be applied to [invoices](https://docs.stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://docs.stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://docs.stripe.com/payments/checkout/use-manual-tax-rates) to collect tax.
#
# Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates)
class TaxRate < APIResource
class FlatAmount < Stripe::StripeObject
# Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
sig { returns(Integer) }
def amount; end
# Three-letter ISO currency code, in lowercase.
sig { returns(String) }
def currency; end
end
# Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
sig { returns(T::Boolean) }
def active; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
sig { returns(T.nilable(String)) }
def description; end
# The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
sig { returns(String) }
def display_name; end
# Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true,
# this percentage reflects the rate actually used to calculate tax based on the product's taxability
# and whether the user is registered to collect taxes in the corresponding jurisdiction.
sig { returns(T.nilable(Float)) }
def effective_percentage; end
# The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.
sig { returns(T.nilable(FlatAmount)) }
def flat_amount; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# This specifies if the tax rate is inclusive or exclusive.
sig { returns(T::Boolean) }
def inclusive; end
# The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
sig { returns(T.nilable(String)) }
def jurisdiction; end
# The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates.
sig { returns(T.nilable(String)) }
def jurisdiction_level; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
sig { returns(Float) }
def percentage; end
# Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.
sig { returns(T.nilable(String)) }
def rate_type; end
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.
sig { returns(T.nilable(String)) }
def state; end
# The high-level tax type, such as `vat` or `sales_tax`.
sig { returns(T.nilable(String)) }
def tax_type; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Optional flag to filter by tax rates that are either active or inactive (archived).
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Optional range for filtering created date.
sig { returns(T.nilable(T.any(::Stripe::TaxRate::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::TaxRate::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::TaxRate::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Optional flag to filter by tax rates that are inclusive (or those that are not inclusive).
sig { returns(T.nilable(T::Boolean)) }
def inclusive; end
sig { params(_inclusive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def inclusive=(_inclusive); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::TaxRate::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), inclusive: T.nilable(T::Boolean), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
active: nil,
created: nil,
ending_before: nil,
expand: nil,
inclusive: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The display name of the tax rate, which will be shown to users.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# This specifies if the tax rate is inclusive or exclusive.
sig { returns(T::Boolean) }
def inclusive; end
sig { params(_inclusive: T::Boolean).returns(T::Boolean) }
def inclusive=(_inclusive); end
# The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
sig { returns(T.nilable(String)) }
def jurisdiction; end
sig { params(_jurisdiction: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction=(_jurisdiction); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# This represents the tax rate percent out of 100.
sig { returns(Float) }
def percentage; end
sig { params(_percentage: Float).returns(Float) }
def percentage=(_percentage); end
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# The high-level tax type, such as `vat` or `sales_tax`.
sig { returns(T.nilable(String)) }
def tax_type; end
sig { params(_tax_type: T.nilable(String)).returns(T.nilable(String)) }
def tax_type=(_tax_type); end
sig {
params(active: T.nilable(T::Boolean), country: T.nilable(String), description: T.nilable(String), display_name: String, expand: T.nilable(T::Array[String]), inclusive: T::Boolean, jurisdiction: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), percentage: Float, state: T.nilable(String), tax_type: T.nilable(String)).void
}
def initialize(
active: nil,
country: nil,
description: nil,
display_name: nil,
expand: nil,
inclusive: nil,
jurisdiction: nil,
metadata: nil,
percentage: nil,
state: nil,
tax_type: nil
); end
end
class UpdateParams < Stripe::RequestParams
# Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The display name of the tax rate, which will be shown to users.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
sig { returns(T.nilable(String)) }
def jurisdiction; end
sig { params(_jurisdiction: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction=(_jurisdiction); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# The high-level tax type, such as `vat` or `sales_tax`.
sig { returns(T.nilable(String)) }
def tax_type; end
sig { params(_tax_type: T.nilable(String)).returns(T.nilable(String)) }
def tax_type=(_tax_type); end
sig {
params(active: T.nilable(T::Boolean), country: T.nilable(String), description: T.nilable(String), display_name: T.nilable(String), expand: T.nilable(T::Array[String]), jurisdiction: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), state: T.nilable(String), tax_type: T.nilable(String)).void
}
def initialize(
active: nil,
country: nil,
description: nil,
display_name: nil,
expand: nil,
jurisdiction: nil,
metadata: nil,
state: nil,
tax_type: nil
); end
end
# Creates a new tax rate.
sig {
params(params: T.any(::Stripe::TaxRate::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TaxRate)
}
def self.create(params = {}, opts = {}); end
# Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.
sig {
params(params: T.any(::Stripe::TaxRate::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates an existing tax rate.
sig {
params(tax_rate: String, params: T.any(::Stripe::TaxRate::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TaxRate)
}
def self.update(tax_rate, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
module Terminal
# A Configurations object represents how features should be configured for terminal readers.
# For information about how to use it, see the [Terminal configurations documentation](https://docs.stripe.com/terminal/fleet/configurations-overview).
class Configuration < APIResource
class BbposWisepad3 < Stripe::StripeObject
# A File ID representing an image to display on the reader
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def splashscreen; end
end
class BbposWiseposE < Stripe::StripeObject
# A File ID representing an image to display on the reader
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def splashscreen; end
end
class Offline < Stripe::StripeObject
# Determines whether to allow transactions to be collected while reader is offline. Defaults to false.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
end
class ReaderSecurity < Stripe::StripeObject
# Passcode used to access a reader's admin menu.
sig { returns(String) }
def admin_menu_passcode; end
end
class RebootWindow < Stripe::StripeObject
# Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.
sig { returns(Integer) }
def end_hour; end
# Integer between 0 to 23 that represents the start hour of the reboot time window.
sig { returns(Integer) }
def start_hour; end
end
class StripeS700 < Stripe::StripeObject
# A File ID representing an image to display on the reader
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def splashscreen; end
end
class Tipping < Stripe::StripeObject
class Aed < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Aud < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Bgn < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Cad < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Chf < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Czk < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Dkk < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Eur < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Gbp < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Hkd < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Huf < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Jpy < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Mxn < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Myr < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Nok < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Nzd < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Pln < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Ron < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Sek < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Sgd < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
class Usd < Stripe::StripeObject
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
end
# Attribute for field aed
sig { returns(T.nilable(Aed)) }
def aed; end
# Attribute for field aud
sig { returns(T.nilable(Aud)) }
def aud; end
# Attribute for field bgn
sig { returns(T.nilable(Bgn)) }
def bgn; end
# Attribute for field cad
sig { returns(T.nilable(Cad)) }
def cad; end
# Attribute for field chf
sig { returns(T.nilable(Chf)) }
def chf; end
# Attribute for field czk
sig { returns(T.nilable(Czk)) }
def czk; end
# Attribute for field dkk
sig { returns(T.nilable(Dkk)) }
def dkk; end
# Attribute for field eur
sig { returns(T.nilable(Eur)) }
def eur; end
# Attribute for field gbp
sig { returns(T.nilable(Gbp)) }
def gbp; end
# Attribute for field hkd
sig { returns(T.nilable(Hkd)) }
def hkd; end
# Attribute for field huf
sig { returns(T.nilable(Huf)) }
def huf; end
# Attribute for field jpy
sig { returns(T.nilable(Jpy)) }
def jpy; end
# Attribute for field mxn
sig { returns(T.nilable(Mxn)) }
def mxn; end
# Attribute for field myr
sig { returns(T.nilable(Myr)) }
def myr; end
# Attribute for field nok
sig { returns(T.nilable(Nok)) }
def nok; end
# Attribute for field nzd
sig { returns(T.nilable(Nzd)) }
def nzd; end
# Attribute for field pln
sig { returns(T.nilable(Pln)) }
def pln; end
# Attribute for field ron
sig { returns(T.nilable(Ron)) }
def ron; end
# Attribute for field sek
sig { returns(T.nilable(Sek)) }
def sek; end
# Attribute for field sgd
sig { returns(T.nilable(Sgd)) }
def sgd; end
# Attribute for field usd
sig { returns(T.nilable(Usd)) }
def usd; end
end
class VerifoneP400 < Stripe::StripeObject
# A File ID representing an image to display on the reader
sig { returns(T.nilable(T.any(String, Stripe::File))) }
def splashscreen; end
end
class Wifi < Stripe::StripeObject
class EnterpriseEapPeap < Stripe::StripeObject
# A File ID representing a PEM file containing the server certificate
sig { returns(T.nilable(String)) }
def ca_certificate_file; end
# Password for connecting to the WiFi network
sig { returns(String) }
def password; end
# Name of the WiFi network
sig { returns(String) }
def ssid; end
# Username for connecting to the WiFi network
sig { returns(String) }
def username; end
end
class EnterpriseEapTls < Stripe::StripeObject
# A File ID representing a PEM file containing the server certificate
sig { returns(T.nilable(String)) }
def ca_certificate_file; end
# A File ID representing a PEM file containing the client certificate
sig { returns(String) }
def client_certificate_file; end
# A File ID representing a PEM file containing the client RSA private key
sig { returns(String) }
def private_key_file; end
# Password for the private key file
sig { returns(T.nilable(String)) }
def private_key_file_password; end
# Name of the WiFi network
sig { returns(String) }
def ssid; end
end
class PersonalPsk < Stripe::StripeObject
# Password for connecting to the WiFi network
sig { returns(String) }
def password; end
# Name of the WiFi network
sig { returns(String) }
def ssid; end
end
# Attribute for field enterprise_eap_peap
sig { returns(T.nilable(EnterpriseEapPeap)) }
def enterprise_eap_peap; end
# Attribute for field enterprise_eap_tls
sig { returns(T.nilable(EnterpriseEapTls)) }
def enterprise_eap_tls; end
# Attribute for field personal_psk
sig { returns(T.nilable(PersonalPsk)) }
def personal_psk; end
# Security type of the WiFi network. The hash with the corresponding name contains the credentials for this security type.
sig { returns(String) }
def type; end
end
# Attribute for field bbpos_wisepad3
sig { returns(T.nilable(BbposWisepad3)) }
def bbpos_wisepad3; end
# Attribute for field bbpos_wisepos_e
sig { returns(T.nilable(BbposWiseposE)) }
def bbpos_wisepos_e; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Whether this Configuration is the default for your account
sig { returns(T.nilable(T::Boolean)) }
def is_account_default; end
# 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) }
def livemode; end
# String indicating the name of the Configuration object, set by the user
sig { returns(T.nilable(String)) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Attribute for field offline
sig { returns(T.nilable(Offline)) }
def offline; end
# Attribute for field reader_security
sig { returns(T.nilable(ReaderSecurity)) }
def reader_security; end
# Attribute for field reboot_window
sig { returns(T.nilable(RebootWindow)) }
def reboot_window; end
# Attribute for field stripe_s700
sig { returns(T.nilable(StripeS700)) }
def stripe_s700; end
# Attribute for field tipping
sig { returns(T.nilable(Tipping)) }
def tipping; end
# Attribute for field verifone_p400
sig { returns(T.nilable(VerifoneP400)) }
def verifone_p400; end
# Attribute for field wifi
sig { returns(T.nilable(Wifi)) }
def wifi; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams; end
class UpdateParams < Stripe::RequestParams
class BbposWisepad3 < Stripe::RequestParams
# A File ID representing an image you would like displayed on the reader.
sig { returns(T.nilable(String)) }
def splashscreen; end
sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) }
def splashscreen=(_splashscreen); end
sig { params(splashscreen: T.nilable(String)).void }
def initialize(splashscreen: nil); end
end
class BbposWiseposE < Stripe::RequestParams
# A File ID representing an image to display on the reader
sig { returns(T.nilable(String)) }
def splashscreen; end
sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) }
def splashscreen=(_splashscreen); end
sig { params(splashscreen: T.nilable(String)).void }
def initialize(splashscreen: nil); end
end
class Offline < Stripe::RequestParams
# Determines whether to allow transactions to be collected while reader is offline. Defaults to false.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class ReaderSecurity < Stripe::RequestParams
# Passcode used to access a reader's admin menu.
sig { returns(T.nilable(String)) }
def admin_menu_passcode; end
sig { params(_admin_menu_passcode: T.nilable(String)).returns(T.nilable(String)) }
def admin_menu_passcode=(_admin_menu_passcode); end
sig { params(admin_menu_passcode: T.nilable(String)).void }
def initialize(admin_menu_passcode: nil); end
end
class RebootWindow < Stripe::RequestParams
# Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.
sig { returns(Integer) }
def end_hour; end
sig { params(_end_hour: Integer).returns(Integer) }
def end_hour=(_end_hour); end
# Integer between 0 to 23 that represents the start hour of the reboot time window.
sig { returns(Integer) }
def start_hour; end
sig { params(_start_hour: Integer).returns(Integer) }
def start_hour=(_start_hour); end
sig { params(end_hour: Integer, start_hour: Integer).void }
def initialize(end_hour: nil, start_hour: nil); end
end
class StripeS700 < Stripe::RequestParams
# A File ID representing an image you would like displayed on the reader.
sig { returns(T.nilable(String)) }
def splashscreen; end
sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) }
def splashscreen=(_splashscreen); end
sig { params(splashscreen: T.nilable(String)).void }
def initialize(splashscreen: nil); end
end
class Tipping < Stripe::RequestParams
class Aed < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Aud < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Bgn < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Cad < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Chf < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Czk < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Dkk < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Eur < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Gbp < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Hkd < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Huf < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Jpy < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Mxn < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Myr < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Nok < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Nzd < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Pln < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Ron < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Sek < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Sgd < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Usd < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
# Tipping configuration for AED
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Aed)) }
def aed; end
sig {
params(_aed: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Aed)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Aed))
}
def aed=(_aed); end
# Tipping configuration for AUD
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Aud)) }
def aud; end
sig {
params(_aud: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Aud)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Aud))
}
def aud=(_aud); end
# Tipping configuration for BGN
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Bgn)) }
def bgn; end
sig {
params(_bgn: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Bgn)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Bgn))
}
def bgn=(_bgn); end
# Tipping configuration for CAD
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Cad)) }
def cad; end
sig {
params(_cad: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Cad)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Cad))
}
def cad=(_cad); end
# Tipping configuration for CHF
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Chf)) }
def chf; end
sig {
params(_chf: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Chf)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Chf))
}
def chf=(_chf); end
# Tipping configuration for CZK
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Czk)) }
def czk; end
sig {
params(_czk: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Czk)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Czk))
}
def czk=(_czk); end
# Tipping configuration for DKK
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Dkk)) }
def dkk; end
sig {
params(_dkk: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Dkk)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Dkk))
}
def dkk=(_dkk); end
# Tipping configuration for EUR
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Eur)) }
def eur; end
sig {
params(_eur: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Eur)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Eur))
}
def eur=(_eur); end
# Tipping configuration for GBP
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Gbp)) }
def gbp; end
sig {
params(_gbp: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Gbp)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Gbp))
}
def gbp=(_gbp); end
# Tipping configuration for HKD
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Hkd)) }
def hkd; end
sig {
params(_hkd: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Hkd)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Hkd))
}
def hkd=(_hkd); end
# Tipping configuration for HUF
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Huf)) }
def huf; end
sig {
params(_huf: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Huf)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Huf))
}
def huf=(_huf); end
# Tipping configuration for JPY
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Jpy)) }
def jpy; end
sig {
params(_jpy: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Jpy)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Jpy))
}
def jpy=(_jpy); end
# Tipping configuration for MXN
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Mxn)) }
def mxn; end
sig {
params(_mxn: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Mxn)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Mxn))
}
def mxn=(_mxn); end
# Tipping configuration for MYR
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Myr)) }
def myr; end
sig {
params(_myr: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Myr)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Myr))
}
def myr=(_myr); end
# Tipping configuration for NOK
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Nok)) }
def nok; end
sig {
params(_nok: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Nok)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Nok))
}
def nok=(_nok); end
# Tipping configuration for NZD
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Nzd)) }
def nzd; end
sig {
params(_nzd: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Nzd)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Nzd))
}
def nzd=(_nzd); end
# Tipping configuration for PLN
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Pln)) }
def pln; end
sig {
params(_pln: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Pln)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Pln))
}
def pln=(_pln); end
# Tipping configuration for RON
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Ron)) }
def ron; end
sig {
params(_ron: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Ron)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Ron))
}
def ron=(_ron); end
# Tipping configuration for SEK
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Sek)) }
def sek; end
sig {
params(_sek: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Sek)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Sek))
}
def sek=(_sek); end
# Tipping configuration for SGD
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Sgd)) }
def sgd; end
sig {
params(_sgd: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Sgd)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Sgd))
}
def sgd=(_sgd); end
# Tipping configuration for USD
sig { returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Usd)) }
def usd; end
sig {
params(_usd: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Usd)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Usd))
}
def usd=(_usd); end
sig {
params(aed: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Aed), aud: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Aud), bgn: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Bgn), cad: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Cad), chf: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Chf), czk: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Czk), dkk: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Dkk), eur: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Eur), gbp: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Gbp), hkd: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Hkd), huf: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Huf), jpy: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Jpy), mxn: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Mxn), myr: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Myr), nok: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Nok), nzd: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Nzd), pln: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Pln), ron: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Ron), sek: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Sek), sgd: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Sgd), usd: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Tipping::Usd)).void
}
def initialize(
aed: nil,
aud: nil,
bgn: nil,
cad: nil,
chf: nil,
czk: nil,
dkk: nil,
eur: nil,
gbp: nil,
hkd: nil,
huf: nil,
jpy: nil,
mxn: nil,
myr: nil,
nok: nil,
nzd: nil,
pln: nil,
ron: nil,
sek: nil,
sgd: nil,
usd: nil
); end
end
class VerifoneP400 < Stripe::RequestParams
# A File ID representing an image you would like displayed on the reader.
sig { returns(T.nilable(String)) }
def splashscreen; end
sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) }
def splashscreen=(_splashscreen); end
sig { params(splashscreen: T.nilable(String)).void }
def initialize(splashscreen: nil); end
end
class Wifi < Stripe::RequestParams
class EnterpriseEapPeap < Stripe::RequestParams
# A File ID representing a PEM file containing the server certificate
sig { returns(T.nilable(String)) }
def ca_certificate_file; end
sig { params(_ca_certificate_file: T.nilable(String)).returns(T.nilable(String)) }
def ca_certificate_file=(_ca_certificate_file); end
# Password for connecting to the WiFi network
sig { returns(String) }
def password; end
sig { params(_password: String).returns(String) }
def password=(_password); end
# Name of the WiFi network
sig { returns(String) }
def ssid; end
sig { params(_ssid: String).returns(String) }
def ssid=(_ssid); end
# Username for connecting to the WiFi network
sig { returns(String) }
def username; end
sig { params(_username: String).returns(String) }
def username=(_username); end
sig {
params(ca_certificate_file: T.nilable(String), password: String, ssid: String, username: String).void
}
def initialize(ca_certificate_file: nil, password: nil, ssid: nil, username: nil); end
end
class EnterpriseEapTls < Stripe::RequestParams
# A File ID representing a PEM file containing the server certificate
sig { returns(T.nilable(String)) }
def ca_certificate_file; end
sig { params(_ca_certificate_file: T.nilable(String)).returns(T.nilable(String)) }
def ca_certificate_file=(_ca_certificate_file); end
# A File ID representing a PEM file containing the client certificate
sig { returns(String) }
def client_certificate_file; end
sig { params(_client_certificate_file: String).returns(String) }
def client_certificate_file=(_client_certificate_file); end
# A File ID representing a PEM file containing the client RSA private key
sig { returns(String) }
def private_key_file; end
sig { params(_private_key_file: String).returns(String) }
def private_key_file=(_private_key_file); end
# Password for the private key file
sig { returns(T.nilable(String)) }
def private_key_file_password; end
sig { params(_private_key_file_password: T.nilable(String)).returns(T.nilable(String)) }
def private_key_file_password=(_private_key_file_password); end
# Name of the WiFi network
sig { returns(String) }
def ssid; end
sig { params(_ssid: String).returns(String) }
def ssid=(_ssid); end
sig {
params(ca_certificate_file: T.nilable(String), client_certificate_file: String, private_key_file: String, private_key_file_password: T.nilable(String), ssid: String).void
}
def initialize(
ca_certificate_file: nil,
client_certificate_file: nil,
private_key_file: nil,
private_key_file_password: nil,
ssid: nil
); end
end
class PersonalPsk < Stripe::RequestParams
# Password for connecting to the WiFi network
sig { returns(String) }
def password; end
sig { params(_password: String).returns(String) }
def password=(_password); end
# Name of the WiFi network
sig { returns(String) }
def ssid; end
sig { params(_ssid: String).returns(String) }
def ssid=(_ssid); end
sig { params(password: String, ssid: String).void }
def initialize(password: nil, ssid: nil); end
end
# Credentials for a WPA-Enterprise WiFi network using the EAP-PEAP authentication method.
sig {
returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Wifi::EnterpriseEapPeap))
}
def enterprise_eap_peap; end
sig {
params(_enterprise_eap_peap: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Wifi::EnterpriseEapPeap)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Wifi::EnterpriseEapPeap))
}
def enterprise_eap_peap=(_enterprise_eap_peap); end
# Credentials for a WPA-Enterprise WiFi network using the EAP-TLS authentication method.
sig {
returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Wifi::EnterpriseEapTls))
}
def enterprise_eap_tls; end
sig {
params(_enterprise_eap_tls: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Wifi::EnterpriseEapTls)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Wifi::EnterpriseEapTls))
}
def enterprise_eap_tls=(_enterprise_eap_tls); end
# Credentials for a WPA-Personal WiFi network.
sig {
returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Wifi::PersonalPsk))
}
def personal_psk; end
sig {
params(_personal_psk: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Wifi::PersonalPsk)).returns(T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Wifi::PersonalPsk))
}
def personal_psk=(_personal_psk); end
# Security type of the WiFi network. Fill out the hash with the corresponding name to provide the set of credentials for this security type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(enterprise_eap_peap: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Wifi::EnterpriseEapPeap), enterprise_eap_tls: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Wifi::EnterpriseEapTls), personal_psk: T.nilable(::Stripe::Terminal::Configuration::UpdateParams::Wifi::PersonalPsk), type: String).void
}
def initialize(
enterprise_eap_peap: nil,
enterprise_eap_tls: nil,
personal_psk: nil,
type: nil
); end
end
# An object containing device type specific settings for BBPOS WisePad 3 readers
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::BbposWisepad3)))
}
def bbpos_wisepad3; end
sig {
params(_bbpos_wisepad3: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::BbposWisepad3))).returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::BbposWisepad3)))
}
def bbpos_wisepad3=(_bbpos_wisepad3); end
# An object containing device type specific settings for BBPOS WisePOS E readers
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::BbposWiseposE)))
}
def bbpos_wisepos_e; end
sig {
params(_bbpos_wisepos_e: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::BbposWiseposE))).returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::BbposWiseposE)))
}
def bbpos_wisepos_e=(_bbpos_wisepos_e); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Name of the configuration
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Configurations for collecting transactions offline.
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::Offline)))
}
def offline; end
sig {
params(_offline: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::Offline))).returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::Offline)))
}
def offline=(_offline); end
# Configurations for reader security settings.
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::ReaderSecurity)))
}
def reader_security; end
sig {
params(_reader_security: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::ReaderSecurity))).returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::ReaderSecurity)))
}
def reader_security=(_reader_security); end
# Reboot time settings for readers that support customized reboot time configuration.
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::RebootWindow)))
}
def reboot_window; end
sig {
params(_reboot_window: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::RebootWindow))).returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::RebootWindow)))
}
def reboot_window=(_reboot_window); end
# An object containing device type specific settings for Stripe S700 readers
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::StripeS700)))
}
def stripe_s700; end
sig {
params(_stripe_s700: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::StripeS700))).returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::StripeS700)))
}
def stripe_s700=(_stripe_s700); end
# Tipping configurations for readers supporting on-reader tips
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::Tipping)))
}
def tipping; end
sig {
params(_tipping: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::Tipping))).returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::Tipping)))
}
def tipping=(_tipping); end
# An object containing device type specific settings for Verifone P400 readers
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::VerifoneP400)))
}
def verifone_p400; end
sig {
params(_verifone_p400: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::VerifoneP400))).returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::VerifoneP400)))
}
def verifone_p400=(_verifone_p400); end
# Configurations for connecting to a WiFi network.
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::Wifi)))
}
def wifi; end
sig {
params(_wifi: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::Wifi))).returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::Wifi)))
}
def wifi=(_wifi); end
sig {
params(bbpos_wisepad3: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::BbposWisepad3)), bbpos_wisepos_e: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::BbposWiseposE)), expand: T.nilable(T::Array[String]), name: T.nilable(String), offline: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::Offline)), reader_security: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::ReaderSecurity)), reboot_window: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::RebootWindow)), stripe_s700: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::StripeS700)), tipping: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::Tipping)), verifone_p400: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::VerifoneP400)), wifi: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::UpdateParams::Wifi))).void
}
def initialize(
bbpos_wisepad3: nil,
bbpos_wisepos_e: nil,
expand: nil,
name: nil,
offline: nil,
reader_security: nil,
reboot_window: nil,
stripe_s700: nil,
tipping: nil,
verifone_p400: nil,
wifi: nil
); end
end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# if present, only return the account default or non-default configurations.
sig { returns(T.nilable(T::Boolean)) }
def is_account_default; end
sig { params(_is_account_default: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def is_account_default=(_is_account_default); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), is_account_default: T.nilable(T::Boolean), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
is_account_default: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class BbposWisepad3 < Stripe::RequestParams
# A File ID representing an image you would like displayed on the reader.
sig { returns(T.nilable(String)) }
def splashscreen; end
sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) }
def splashscreen=(_splashscreen); end
sig { params(splashscreen: T.nilable(String)).void }
def initialize(splashscreen: nil); end
end
class BbposWiseposE < Stripe::RequestParams
# A File ID representing an image to display on the reader
sig { returns(T.nilable(String)) }
def splashscreen; end
sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) }
def splashscreen=(_splashscreen); end
sig { params(splashscreen: T.nilable(String)).void }
def initialize(splashscreen: nil); end
end
class Offline < Stripe::RequestParams
# Determines whether to allow transactions to be collected while reader is offline. Defaults to false.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class ReaderSecurity < Stripe::RequestParams
# Passcode used to access a reader's admin menu.
sig { returns(T.nilable(String)) }
def admin_menu_passcode; end
sig { params(_admin_menu_passcode: T.nilable(String)).returns(T.nilable(String)) }
def admin_menu_passcode=(_admin_menu_passcode); end
sig { params(admin_menu_passcode: T.nilable(String)).void }
def initialize(admin_menu_passcode: nil); end
end
class RebootWindow < Stripe::RequestParams
# Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.
sig { returns(Integer) }
def end_hour; end
sig { params(_end_hour: Integer).returns(Integer) }
def end_hour=(_end_hour); end
# Integer between 0 to 23 that represents the start hour of the reboot time window.
sig { returns(Integer) }
def start_hour; end
sig { params(_start_hour: Integer).returns(Integer) }
def start_hour=(_start_hour); end
sig { params(end_hour: Integer, start_hour: Integer).void }
def initialize(end_hour: nil, start_hour: nil); end
end
class StripeS700 < Stripe::RequestParams
# A File ID representing an image you would like displayed on the reader.
sig { returns(T.nilable(String)) }
def splashscreen; end
sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) }
def splashscreen=(_splashscreen); end
sig { params(splashscreen: T.nilable(String)).void }
def initialize(splashscreen: nil); end
end
class Tipping < Stripe::RequestParams
class Aed < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Aud < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Bgn < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Cad < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Chf < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Czk < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Dkk < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Eur < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Gbp < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Hkd < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Huf < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Jpy < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Mxn < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Myr < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Nok < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Nzd < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Pln < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Ron < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Sek < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Sgd < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Usd < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
# Tipping configuration for AED
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Aed)) }
def aed; end
sig {
params(_aed: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Aed)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Aed))
}
def aed=(_aed); end
# Tipping configuration for AUD
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Aud)) }
def aud; end
sig {
params(_aud: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Aud)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Aud))
}
def aud=(_aud); end
# Tipping configuration for BGN
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Bgn)) }
def bgn; end
sig {
params(_bgn: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Bgn)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Bgn))
}
def bgn=(_bgn); end
# Tipping configuration for CAD
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Cad)) }
def cad; end
sig {
params(_cad: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Cad)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Cad))
}
def cad=(_cad); end
# Tipping configuration for CHF
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Chf)) }
def chf; end
sig {
params(_chf: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Chf)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Chf))
}
def chf=(_chf); end
# Tipping configuration for CZK
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Czk)) }
def czk; end
sig {
params(_czk: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Czk)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Czk))
}
def czk=(_czk); end
# Tipping configuration for DKK
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Dkk)) }
def dkk; end
sig {
params(_dkk: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Dkk)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Dkk))
}
def dkk=(_dkk); end
# Tipping configuration for EUR
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Eur)) }
def eur; end
sig {
params(_eur: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Eur)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Eur))
}
def eur=(_eur); end
# Tipping configuration for GBP
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Gbp)) }
def gbp; end
sig {
params(_gbp: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Gbp)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Gbp))
}
def gbp=(_gbp); end
# Tipping configuration for HKD
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Hkd)) }
def hkd; end
sig {
params(_hkd: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Hkd)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Hkd))
}
def hkd=(_hkd); end
# Tipping configuration for HUF
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Huf)) }
def huf; end
sig {
params(_huf: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Huf)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Huf))
}
def huf=(_huf); end
# Tipping configuration for JPY
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Jpy)) }
def jpy; end
sig {
params(_jpy: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Jpy)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Jpy))
}
def jpy=(_jpy); end
# Tipping configuration for MXN
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Mxn)) }
def mxn; end
sig {
params(_mxn: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Mxn)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Mxn))
}
def mxn=(_mxn); end
# Tipping configuration for MYR
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Myr)) }
def myr; end
sig {
params(_myr: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Myr)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Myr))
}
def myr=(_myr); end
# Tipping configuration for NOK
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Nok)) }
def nok; end
sig {
params(_nok: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Nok)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Nok))
}
def nok=(_nok); end
# Tipping configuration for NZD
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Nzd)) }
def nzd; end
sig {
params(_nzd: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Nzd)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Nzd))
}
def nzd=(_nzd); end
# Tipping configuration for PLN
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Pln)) }
def pln; end
sig {
params(_pln: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Pln)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Pln))
}
def pln=(_pln); end
# Tipping configuration for RON
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Ron)) }
def ron; end
sig {
params(_ron: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Ron)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Ron))
}
def ron=(_ron); end
# Tipping configuration for SEK
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Sek)) }
def sek; end
sig {
params(_sek: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Sek)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Sek))
}
def sek=(_sek); end
# Tipping configuration for SGD
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Sgd)) }
def sgd; end
sig {
params(_sgd: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Sgd)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Sgd))
}
def sgd=(_sgd); end
# Tipping configuration for USD
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Usd)) }
def usd; end
sig {
params(_usd: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Usd)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Usd))
}
def usd=(_usd); end
sig {
params(aed: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Aed), aud: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Aud), bgn: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Bgn), cad: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Cad), chf: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Chf), czk: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Czk), dkk: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Dkk), eur: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Eur), gbp: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Gbp), hkd: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Hkd), huf: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Huf), jpy: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Jpy), mxn: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Mxn), myr: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Myr), nok: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Nok), nzd: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Nzd), pln: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Pln), ron: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Ron), sek: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Sek), sgd: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Sgd), usd: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Tipping::Usd)).void
}
def initialize(
aed: nil,
aud: nil,
bgn: nil,
cad: nil,
chf: nil,
czk: nil,
dkk: nil,
eur: nil,
gbp: nil,
hkd: nil,
huf: nil,
jpy: nil,
mxn: nil,
myr: nil,
nok: nil,
nzd: nil,
pln: nil,
ron: nil,
sek: nil,
sgd: nil,
usd: nil
); end
end
class VerifoneP400 < Stripe::RequestParams
# A File ID representing an image you would like displayed on the reader.
sig { returns(T.nilable(String)) }
def splashscreen; end
sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) }
def splashscreen=(_splashscreen); end
sig { params(splashscreen: T.nilable(String)).void }
def initialize(splashscreen: nil); end
end
class Wifi < Stripe::RequestParams
class EnterpriseEapPeap < Stripe::RequestParams
# A File ID representing a PEM file containing the server certificate
sig { returns(T.nilable(String)) }
def ca_certificate_file; end
sig { params(_ca_certificate_file: T.nilable(String)).returns(T.nilable(String)) }
def ca_certificate_file=(_ca_certificate_file); end
# Password for connecting to the WiFi network
sig { returns(String) }
def password; end
sig { params(_password: String).returns(String) }
def password=(_password); end
# Name of the WiFi network
sig { returns(String) }
def ssid; end
sig { params(_ssid: String).returns(String) }
def ssid=(_ssid); end
# Username for connecting to the WiFi network
sig { returns(String) }
def username; end
sig { params(_username: String).returns(String) }
def username=(_username); end
sig {
params(ca_certificate_file: T.nilable(String), password: String, ssid: String, username: String).void
}
def initialize(ca_certificate_file: nil, password: nil, ssid: nil, username: nil); end
end
class EnterpriseEapTls < Stripe::RequestParams
# A File ID representing a PEM file containing the server certificate
sig { returns(T.nilable(String)) }
def ca_certificate_file; end
sig { params(_ca_certificate_file: T.nilable(String)).returns(T.nilable(String)) }
def ca_certificate_file=(_ca_certificate_file); end
# A File ID representing a PEM file containing the client certificate
sig { returns(String) }
def client_certificate_file; end
sig { params(_client_certificate_file: String).returns(String) }
def client_certificate_file=(_client_certificate_file); end
# A File ID representing a PEM file containing the client RSA private key
sig { returns(String) }
def private_key_file; end
sig { params(_private_key_file: String).returns(String) }
def private_key_file=(_private_key_file); end
# Password for the private key file
sig { returns(T.nilable(String)) }
def private_key_file_password; end
sig { params(_private_key_file_password: T.nilable(String)).returns(T.nilable(String)) }
def private_key_file_password=(_private_key_file_password); end
# Name of the WiFi network
sig { returns(String) }
def ssid; end
sig { params(_ssid: String).returns(String) }
def ssid=(_ssid); end
sig {
params(ca_certificate_file: T.nilable(String), client_certificate_file: String, private_key_file: String, private_key_file_password: T.nilable(String), ssid: String).void
}
def initialize(
ca_certificate_file: nil,
client_certificate_file: nil,
private_key_file: nil,
private_key_file_password: nil,
ssid: nil
); end
end
class PersonalPsk < Stripe::RequestParams
# Password for connecting to the WiFi network
sig { returns(String) }
def password; end
sig { params(_password: String).returns(String) }
def password=(_password); end
# Name of the WiFi network
sig { returns(String) }
def ssid; end
sig { params(_ssid: String).returns(String) }
def ssid=(_ssid); end
sig { params(password: String, ssid: String).void }
def initialize(password: nil, ssid: nil); end
end
# Credentials for a WPA-Enterprise WiFi network using the EAP-PEAP authentication method.
sig {
returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Wifi::EnterpriseEapPeap))
}
def enterprise_eap_peap; end
sig {
params(_enterprise_eap_peap: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Wifi::EnterpriseEapPeap)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Wifi::EnterpriseEapPeap))
}
def enterprise_eap_peap=(_enterprise_eap_peap); end
# Credentials for a WPA-Enterprise WiFi network using the EAP-TLS authentication method.
sig {
returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Wifi::EnterpriseEapTls))
}
def enterprise_eap_tls; end
sig {
params(_enterprise_eap_tls: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Wifi::EnterpriseEapTls)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Wifi::EnterpriseEapTls))
}
def enterprise_eap_tls=(_enterprise_eap_tls); end
# Credentials for a WPA-Personal WiFi network.
sig {
returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Wifi::PersonalPsk))
}
def personal_psk; end
sig {
params(_personal_psk: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Wifi::PersonalPsk)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::Wifi::PersonalPsk))
}
def personal_psk=(_personal_psk); end
# Security type of the WiFi network. Fill out the hash with the corresponding name to provide the set of credentials for this security type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(enterprise_eap_peap: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Wifi::EnterpriseEapPeap), enterprise_eap_tls: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Wifi::EnterpriseEapTls), personal_psk: T.nilable(::Stripe::Terminal::Configuration::CreateParams::Wifi::PersonalPsk), type: String).void
}
def initialize(
enterprise_eap_peap: nil,
enterprise_eap_tls: nil,
personal_psk: nil,
type: nil
); end
end
# An object containing device type specific settings for BBPOS WisePad 3 readers
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::BbposWisepad3)) }
def bbpos_wisepad3; end
sig {
params(_bbpos_wisepad3: T.nilable(::Stripe::Terminal::Configuration::CreateParams::BbposWisepad3)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::BbposWisepad3))
}
def bbpos_wisepad3=(_bbpos_wisepad3); end
# An object containing device type specific settings for BBPOS WisePOS E readers
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::BbposWiseposE)) }
def bbpos_wisepos_e; end
sig {
params(_bbpos_wisepos_e: T.nilable(::Stripe::Terminal::Configuration::CreateParams::BbposWiseposE)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::BbposWiseposE))
}
def bbpos_wisepos_e=(_bbpos_wisepos_e); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Name of the configuration
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Configurations for collecting transactions offline.
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::CreateParams::Offline)))
}
def offline; end
sig {
params(_offline: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::CreateParams::Offline))).returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::CreateParams::Offline)))
}
def offline=(_offline); end
# Configurations for reader security settings.
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::CreateParams::ReaderSecurity)))
}
def reader_security; end
sig {
params(_reader_security: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::CreateParams::ReaderSecurity))).returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::CreateParams::ReaderSecurity)))
}
def reader_security=(_reader_security); end
# Reboot time settings for readers that support customized reboot time configuration.
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::RebootWindow)) }
def reboot_window; end
sig {
params(_reboot_window: T.nilable(::Stripe::Terminal::Configuration::CreateParams::RebootWindow)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::RebootWindow))
}
def reboot_window=(_reboot_window); end
# An object containing device type specific settings for Stripe S700 readers
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::StripeS700)) }
def stripe_s700; end
sig {
params(_stripe_s700: T.nilable(::Stripe::Terminal::Configuration::CreateParams::StripeS700)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::StripeS700))
}
def stripe_s700=(_stripe_s700); end
# Tipping configurations for readers supporting on-reader tips
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::CreateParams::Tipping)))
}
def tipping; end
sig {
params(_tipping: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::CreateParams::Tipping))).returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::CreateParams::Tipping)))
}
def tipping=(_tipping); end
# An object containing device type specific settings for Verifone P400 readers
sig { returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::VerifoneP400)) }
def verifone_p400; end
sig {
params(_verifone_p400: T.nilable(::Stripe::Terminal::Configuration::CreateParams::VerifoneP400)).returns(T.nilable(::Stripe::Terminal::Configuration::CreateParams::VerifoneP400))
}
def verifone_p400=(_verifone_p400); end
# Configurations for connecting to a WiFi network.
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::CreateParams::Wifi)))
}
def wifi; end
sig {
params(_wifi: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::CreateParams::Wifi))).returns(T.nilable(T.any(String, ::Stripe::Terminal::Configuration::CreateParams::Wifi)))
}
def wifi=(_wifi); end
sig {
params(bbpos_wisepad3: T.nilable(::Stripe::Terminal::Configuration::CreateParams::BbposWisepad3), bbpos_wisepos_e: T.nilable(::Stripe::Terminal::Configuration::CreateParams::BbposWiseposE), expand: T.nilable(T::Array[String]), name: T.nilable(String), offline: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::CreateParams::Offline)), reader_security: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::CreateParams::ReaderSecurity)), reboot_window: T.nilable(::Stripe::Terminal::Configuration::CreateParams::RebootWindow), stripe_s700: T.nilable(::Stripe::Terminal::Configuration::CreateParams::StripeS700), tipping: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::CreateParams::Tipping)), verifone_p400: T.nilable(::Stripe::Terminal::Configuration::CreateParams::VerifoneP400), wifi: T.nilable(T.any(String, ::Stripe::Terminal::Configuration::CreateParams::Wifi))).void
}
def initialize(
bbpos_wisepad3: nil,
bbpos_wisepos_e: nil,
expand: nil,
name: nil,
offline: nil,
reader_security: nil,
reboot_window: nil,
stripe_s700: nil,
tipping: nil,
verifone_p400: nil,
wifi: nil
); end
end
# Creates a new Configuration object.
sig {
params(params: T.any(::Stripe::Terminal::Configuration::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Configuration)
}
def self.create(params = {}, opts = {}); end
# Deletes a Configuration object.
sig {
params(configuration: String, params: T.any(::Stripe::Terminal::Configuration::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Configuration)
}
def self.delete(configuration, params = {}, opts = {}); end
# Deletes a Configuration object.
sig {
params(params: T.any(::Stripe::Terminal::Configuration::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Configuration)
}
def delete(params = {}, opts = {}); end
# Returns a list of Configuration objects.
sig {
params(params: T.any(::Stripe::Terminal::Configuration::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates a new Configuration object.
sig {
params(configuration: String, params: T.any(::Stripe::Terminal::Configuration::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Configuration)
}
def self.update(configuration, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Terminal
# A Connection Token is used by the Stripe Terminal SDK to connect to a reader.
#
# Related guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)
class ConnectionToken < APIResource
# The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).
sig { returns(T.nilable(String)) }
def location; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Your application should pass this token to the Stripe Terminal SDK.
sig { returns(String) }
def secret; end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).
sig { returns(T.nilable(String)) }
def location; end
sig { params(_location: T.nilable(String)).returns(T.nilable(String)) }
def location=(_location); end
sig { params(expand: T.nilable(T::Array[String]), location: T.nilable(String)).void }
def initialize(expand: nil, location: nil); end
end
# To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.
sig {
params(params: T.any(::Stripe::Terminal::ConnectionToken::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::ConnectionToken)
}
def self.create(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Terminal
# A Location represents a grouping of readers.
#
# Related guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)
class Location < APIResource
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
class AddressKana < Stripe::StripeObject
# City/Ward.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Block/Building number.
sig { returns(T.nilable(String)) }
def line1; end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
# Town/cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
class AddressKanji < Stripe::StripeObject
# City/Ward.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Block/Building number.
sig { returns(T.nilable(String)) }
def line1; end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
# Town/cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
# Attribute for field address
sig { returns(Address) }
def address; end
# Attribute for field address_kana
sig { returns(T.nilable(AddressKana)) }
def address_kana; end
# Attribute for field address_kanji
sig { returns(T.nilable(AddressKanji)) }
def address_kanji; end
# The ID of a configuration that will be used to customize all readers in this location.
sig { returns(T.nilable(String)) }
def configuration_overrides; end
# The display name of the location.
sig { returns(String) }
def display_name; end
# The Kana variation of the display name of the location.
sig { returns(T.nilable(String)) }
def display_name_kana; end
# The Kanji variation of the display name of the location.
sig { returns(T.nilable(String)) }
def display_name_kanji; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The phone number of the location.
sig { returns(T.nilable(String)) }
def phone; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams; end
class UpdateParams < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
# The full address of the location. You can't change the location's `country`. If you need to modify the `country` field, create a new `Location` object and re-register any existing readers to that location.
sig { returns(T.nilable(::Stripe::Terminal::Location::UpdateParams::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::Terminal::Location::UpdateParams::Address)).returns(T.nilable(::Stripe::Terminal::Location::UpdateParams::Address))
}
def address=(_address); end
# The Kana variation of the full address of the location (Japan only).
sig { returns(T.nilable(::Stripe::Terminal::Location::UpdateParams::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::Terminal::Location::UpdateParams::AddressKana)).returns(T.nilable(::Stripe::Terminal::Location::UpdateParams::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the full address of the location (Japan only).
sig { returns(T.nilable(::Stripe::Terminal::Location::UpdateParams::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::Terminal::Location::UpdateParams::AddressKanji)).returns(T.nilable(::Stripe::Terminal::Location::UpdateParams::AddressKanji))
}
def address_kanji=(_address_kanji); end
# The ID of a configuration that will be used to customize all readers in this location.
sig { returns(T.nilable(String)) }
def configuration_overrides; end
sig { params(_configuration_overrides: T.nilable(String)).returns(T.nilable(String)) }
def configuration_overrides=(_configuration_overrides); end
# A name for the location.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# The Kana variation of the name for the location (Japan only).
sig { returns(T.nilable(String)) }
def display_name_kana; end
sig { params(_display_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def display_name_kana=(_display_name_kana); end
# The Kanji variation of the name for the location (Japan only).
sig { returns(T.nilable(String)) }
def display_name_kanji; end
sig { params(_display_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def display_name_kanji=(_display_name_kanji); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The phone number for the location.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::Terminal::Location::UpdateParams::Address), address_kana: T.nilable(::Stripe::Terminal::Location::UpdateParams::AddressKana), address_kanji: T.nilable(::Stripe::Terminal::Location::UpdateParams::AddressKanji), configuration_overrides: T.nilable(String), display_name: T.nilable(String), display_name_kana: T.nilable(String), display_name_kanji: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), phone: T.nilable(String)).void
}
def initialize(
address: nil,
address_kana: nil,
address_kanji: nil,
configuration_overrides: nil,
display_name: nil,
display_name_kana: nil,
display_name_kanji: nil,
expand: nil,
metadata: nil,
phone: nil
); end
end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateParams < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
# The full address of the location.
sig { returns(T.nilable(::Stripe::Terminal::Location::CreateParams::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::Terminal::Location::CreateParams::Address)).returns(T.nilable(::Stripe::Terminal::Location::CreateParams::Address))
}
def address=(_address); end
# The Kana variation of the full address of the location (Japan only).
sig { returns(T.nilable(::Stripe::Terminal::Location::CreateParams::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::Terminal::Location::CreateParams::AddressKana)).returns(T.nilable(::Stripe::Terminal::Location::CreateParams::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the full address of the location (Japan only).
sig { returns(T.nilable(::Stripe::Terminal::Location::CreateParams::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::Terminal::Location::CreateParams::AddressKanji)).returns(T.nilable(::Stripe::Terminal::Location::CreateParams::AddressKanji))
}
def address_kanji=(_address_kanji); end
# The ID of a configuration that will be used to customize all readers in this location.
sig { returns(T.nilable(String)) }
def configuration_overrides; end
sig { params(_configuration_overrides: T.nilable(String)).returns(T.nilable(String)) }
def configuration_overrides=(_configuration_overrides); end
# A name for the location. Maximum length is 1000 characters.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# The Kana variation of the name for the location (Japan only). Maximum length is 1000 characters.
sig { returns(T.nilable(String)) }
def display_name_kana; end
sig { params(_display_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def display_name_kana=(_display_name_kana); end
# The Kanji variation of the name for the location (Japan only). Maximum length is 1000 characters.
sig { returns(T.nilable(String)) }
def display_name_kanji; end
sig { params(_display_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def display_name_kanji=(_display_name_kanji); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The phone number for the location.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::Terminal::Location::CreateParams::Address), address_kana: T.nilable(::Stripe::Terminal::Location::CreateParams::AddressKana), address_kanji: T.nilable(::Stripe::Terminal::Location::CreateParams::AddressKanji), configuration_overrides: T.nilable(String), display_name: T.nilable(String), display_name_kana: T.nilable(String), display_name_kanji: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), phone: T.nilable(String)).void
}
def initialize(
address: nil,
address_kana: nil,
address_kanji: nil,
configuration_overrides: nil,
display_name: nil,
display_name_kana: nil,
display_name_kanji: nil,
expand: nil,
metadata: nil,
phone: nil
); end
end
# Creates a new Location object.
# For further details, including which address fields are required in each country, see the [Manage locations](https://docs.stripe.com/docs/terminal/fleet/locations) guide.
sig {
params(params: T.any(::Stripe::Terminal::Location::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Location)
}
def self.create(params = {}, opts = {}); end
# Deletes a Location object.
sig {
params(location: String, params: T.any(::Stripe::Terminal::Location::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Location)
}
def self.delete(location, params = {}, opts = {}); end
# Deletes a Location object.
sig {
params(params: T.any(::Stripe::Terminal::Location::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Location)
}
def delete(params = {}, opts = {}); end
# Returns a list of Location objects.
sig {
params(params: T.any(::Stripe::Terminal::Location::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(location: String, params: T.any(::Stripe::Terminal::Location::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Location)
}
def self.update(location, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Terminal
# Returns redirect links used for onboarding onto Tap to Pay on iPhone.
class OnboardingLink < APIResource
class LinkOptions < Stripe::StripeObject
class AppleTermsAndConditions < Stripe::StripeObject
# Whether the link should also support users relinking their Apple account.
sig { returns(T.nilable(T::Boolean)) }
def allow_relinking; end
# The business name of the merchant accepting Apple's Terms and Conditions.
sig { returns(String) }
def merchant_display_name; end
end
# The options associated with the Apple Terms and Conditions link type.
sig { returns(T.nilable(AppleTermsAndConditions)) }
def apple_terms_and_conditions; end
end
# Link type options associated with the current onboarding link object.
sig { returns(LinkOptions) }
def link_options; end
# The type of link being generated.
sig { returns(String) }
def link_type; end
# Attribute for field object
sig { returns(String) }
def object; end
# Stripe account ID to generate the link for.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
# The link passed back to the user for their onboarding.
sig { returns(String) }
def redirect_url; end
class CreateParams < Stripe::RequestParams
class LinkOptions < Stripe::RequestParams
class AppleTermsAndConditions < Stripe::RequestParams
# Whether the link should also support users relinking their Apple account.
sig { returns(T.nilable(T::Boolean)) }
def allow_relinking; end
sig { params(_allow_relinking: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def allow_relinking=(_allow_relinking); end
# The business name of the merchant accepting Apple's Terms and Conditions.
sig { returns(String) }
def merchant_display_name; end
sig { params(_merchant_display_name: String).returns(String) }
def merchant_display_name=(_merchant_display_name); end
sig {
params(allow_relinking: T.nilable(T::Boolean), merchant_display_name: String).void
}
def initialize(allow_relinking: nil, merchant_display_name: nil); end
end
# The options associated with the Apple Terms and Conditions link type.
sig {
returns(T.nilable(::Stripe::Terminal::OnboardingLink::CreateParams::LinkOptions::AppleTermsAndConditions))
}
def apple_terms_and_conditions; end
sig {
params(_apple_terms_and_conditions: T.nilable(::Stripe::Terminal::OnboardingLink::CreateParams::LinkOptions::AppleTermsAndConditions)).returns(T.nilable(::Stripe::Terminal::OnboardingLink::CreateParams::LinkOptions::AppleTermsAndConditions))
}
def apple_terms_and_conditions=(_apple_terms_and_conditions); end
sig {
params(apple_terms_and_conditions: T.nilable(::Stripe::Terminal::OnboardingLink::CreateParams::LinkOptions::AppleTermsAndConditions)).void
}
def initialize(apple_terms_and_conditions: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Specific fields needed to generate the desired link type.
sig { returns(::Stripe::Terminal::OnboardingLink::CreateParams::LinkOptions) }
def link_options; end
sig {
params(_link_options: ::Stripe::Terminal::OnboardingLink::CreateParams::LinkOptions).returns(::Stripe::Terminal::OnboardingLink::CreateParams::LinkOptions)
}
def link_options=(_link_options); end
# The type of link being generated.
sig { returns(String) }
def link_type; end
sig { params(_link_type: String).returns(String) }
def link_type=(_link_type); end
# Stripe account ID to generate the link for.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
sig {
params(expand: T.nilable(T::Array[String]), link_options: ::Stripe::Terminal::OnboardingLink::CreateParams::LinkOptions, link_type: String, on_behalf_of: T.nilable(String)).void
}
def initialize(expand: nil, link_options: nil, link_type: nil, on_behalf_of: nil); end
end
# Creates a new OnboardingLink object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.
sig {
params(params: T.any(::Stripe::Terminal::OnboardingLink::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::OnboardingLink)
}
def self.create(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Terminal
# Returns data collected by Terminal readers. This data is only stored for 24 hours.
class ReaderCollectedData < APIResource
class Magstripe < Stripe::StripeObject
# The raw magstripe data collected by the reader.
sig { returns(T.nilable(String)) }
def data; end
end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# The magstripe data collected by the reader.
sig { returns(T.nilable(Magstripe)) }
def magstripe; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The type of data collected by the reader.
sig { returns(String) }
def type; end
end
end
end
# typed: true
module Stripe
module Terminal
# A Reader represents a physical device for accepting payment details.
#
# Related guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader)
class Reader < APIResource
class Action < Stripe::StripeObject
class CollectInputs < Stripe::StripeObject
class Input < Stripe::StripeObject
class CustomText < Stripe::StripeObject
# Customize the default description for this input
sig { returns(T.nilable(String)) }
def description; end
# Customize the default label for this input's skip button
sig { returns(T.nilable(String)) }
def skip_button; end
# Customize the default label for this input's submit button
sig { returns(T.nilable(String)) }
def submit_button; end
# Customize the default title for this input
sig { returns(T.nilable(String)) }
def title; end
end
class Email < Stripe::StripeObject
# The collected email address
sig { returns(T.nilable(String)) }
def value; end
end
class Numeric < Stripe::StripeObject
# The collected number
sig { returns(T.nilable(String)) }
def value; end
end
class Phone < Stripe::StripeObject
# The collected phone number
sig { returns(T.nilable(String)) }
def value; end
end
class Selection < Stripe::StripeObject
class Choice < Stripe::StripeObject
# The id to be selected
sig { returns(T.nilable(String)) }
def id; end
# The button style for the choice
sig { returns(T.nilable(String)) }
def style; end
# The text to be selected
sig { returns(String) }
def text; end
end
# List of possible choices to be selected
sig { returns(T::Array[Choice]) }
def choices; end
# The id of the selected choice
sig { returns(T.nilable(String)) }
def id; end
# The text of the selected choice
sig { returns(T.nilable(String)) }
def text; end
end
class Signature < Stripe::StripeObject
# The File ID of a collected signature image
sig { returns(T.nilable(String)) }
def value; end
end
class Text < Stripe::StripeObject
# The collected text value
sig { returns(T.nilable(String)) }
def value; end
end
class Toggle < Stripe::StripeObject
# The toggle's default value
sig { returns(T.nilable(String)) }
def default_value; end
# The toggle's description text
sig { returns(T.nilable(String)) }
def description; end
# The toggle's title text
sig { returns(T.nilable(String)) }
def title; end
# The toggle's collected value
sig { returns(T.nilable(String)) }
def value; end
end
# Default text of input being collected.
sig { returns(T.nilable(CustomText)) }
def custom_text; end
# Information about a email being collected using a reader
sig { returns(T.nilable(Email)) }
def email; end
# Information about a number being collected using a reader
sig { returns(T.nilable(Numeric)) }
def numeric; end
# Information about a phone number being collected using a reader
sig { returns(T.nilable(Phone)) }
def phone; end
# Indicate that this input is required, disabling the skip button.
sig { returns(T.nilable(T::Boolean)) }
def required; end
# Information about a selection being collected using a reader
sig { returns(T.nilable(Selection)) }
def selection; end
# Information about a signature being collected using a reader
sig { returns(T.nilable(Signature)) }
def signature; end
# Indicate that this input was skipped by the user.
sig { returns(T.nilable(T::Boolean)) }
def skipped; end
# Information about text being collected using a reader
sig { returns(T.nilable(Text)) }
def text; end
# List of toggles being collected. Values are present if collection is complete.
sig { returns(T.nilable(T::Array[Toggle])) }
def toggles; end
# Type of input being collected.
sig { returns(String) }
def type; end
end
# List of inputs to be collected.
sig { returns(T::Array[Input]) }
def inputs; end
# 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])) }
def metadata; end
end
class CollectPaymentMethod < Stripe::StripeObject
class CollectConfig < Stripe::StripeObject
class Tipping < Stripe::StripeObject
# Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).
sig { returns(T.nilable(Integer)) }
def amount_eligible; end
end
# Enable customer-initiated cancellation when processing this payment.
sig { returns(T.nilable(T::Boolean)) }
def enable_customer_cancellation; end
# Override showing a tipping selection screen on this transaction.
sig { returns(T.nilable(T::Boolean)) }
def skip_tipping; end
# Represents a per-transaction tipping configuration
sig { returns(T.nilable(Tipping)) }
def tipping; end
end
# Account the payment intent belongs to.
sig { returns(T.nilable(String)) }
def account; end
# Represents a per-transaction override of a reader configuration
sig { returns(T.nilable(CollectConfig)) }
def collect_config; end
# Most recent PaymentIntent processed by the reader.
sig { returns(T.any(String, Stripe::PaymentIntent)) }
def payment_intent; end
# 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).
sig { returns(T.nilable(Stripe::PaymentMethod)) }
def payment_method; end
end
class ConfirmPaymentIntent < Stripe::StripeObject
class ConfirmConfig < Stripe::StripeObject
# If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.
sig { returns(T.nilable(String)) }
def return_url; end
end
# Account the payment intent belongs to.
sig { returns(T.nilable(String)) }
def account; end
# Represents a per-transaction override of a reader configuration
sig { returns(T.nilable(ConfirmConfig)) }
def confirm_config; end
# Most recent PaymentIntent processed by the reader.
sig { returns(T.any(String, Stripe::PaymentIntent)) }
def payment_intent; end
end
class ProcessPaymentIntent < Stripe::StripeObject
class ProcessConfig < Stripe::StripeObject
class Tipping < Stripe::StripeObject
# Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).
sig { returns(T.nilable(Integer)) }
def amount_eligible; end
end
# Enable customer-initiated cancellation when processing this payment.
sig { returns(T.nilable(T::Boolean)) }
def enable_customer_cancellation; end
# If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.
sig { returns(T.nilable(String)) }
def return_url; end
# Override showing a tipping selection screen on this transaction.
sig { returns(T.nilable(T::Boolean)) }
def skip_tipping; end
# Represents a per-transaction tipping configuration
sig { returns(T.nilable(Tipping)) }
def tipping; end
end
# Account the payment intent belongs to.
sig { returns(T.nilable(String)) }
def account; end
# Most recent PaymentIntent processed by the reader.
sig { returns(T.any(String, Stripe::PaymentIntent)) }
def payment_intent; end
# Represents a per-transaction override of a reader configuration
sig { returns(T.nilable(ProcessConfig)) }
def process_config; end
end
class ProcessSetupIntent < Stripe::StripeObject
class ProcessConfig < Stripe::StripeObject
# Enable customer-initiated cancellation when processing this SetupIntent.
sig { returns(T.nilable(T::Boolean)) }
def enable_customer_cancellation; end
end
# ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
sig { returns(T.nilable(String)) }
def generated_card; end
# Represents a per-setup override of a reader configuration
sig { returns(T.nilable(ProcessConfig)) }
def process_config; end
# Most recent SetupIntent processed by the reader.
sig { returns(T.any(String, Stripe::SetupIntent)) }
def setup_intent; end
end
class RefundPayment < Stripe::StripeObject
class RefundPaymentConfig < Stripe::StripeObject
# Enable customer-initiated cancellation when refunding this payment.
sig { returns(T.nilable(T::Boolean)) }
def enable_customer_cancellation; end
end
# Account the payment intent belongs to.
sig { returns(T.nilable(String)) }
def account; end
# The amount being refunded.
sig { returns(T.nilable(Integer)) }
def amount; end
# Charge that is being refunded.
sig { returns(T.nilable(T.any(String, Stripe::Charge))) }
def charge; end
# 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])) }
def metadata; end
# Payment intent that is being refunded.
sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
def payment_intent; end
# The reason for the refund.
sig { returns(T.nilable(String)) }
def reason; end
# Unique identifier for the refund object.
sig { returns(T.nilable(T.any(String, Stripe::Refund))) }
def refund; end
# Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.
sig { returns(T.nilable(T::Boolean)) }
def refund_application_fee; end
# Represents a per-transaction override of a reader configuration
sig { returns(T.nilable(RefundPaymentConfig)) }
def refund_payment_config; end
# Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.
sig { returns(T.nilable(T::Boolean)) }
def reverse_transfer; end
end
class SetReaderDisplay < Stripe::StripeObject
class Cart < Stripe::StripeObject
class LineItem < Stripe::StripeObject
# The amount of the line item. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
# Description of the line item.
sig { returns(String) }
def description; end
# The quantity of the line item.
sig { returns(Integer) }
def quantity; end
end
# 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) }
def currency; end
# List of line items in the cart.
sig { returns(T::Array[LineItem]) }
def line_items; end
# Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(Integer)) }
def tax; end
# Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def total; end
end
# Cart object to be displayed by the reader.
sig { returns(T.nilable(Cart)) }
def cart; end
# Type of information to be displayed by the reader.
sig { returns(String) }
def type; end
end
# Represents a reader action to collect customer inputs
sig { returns(T.nilable(CollectInputs)) }
def collect_inputs; end
# Represents a reader action to collect a payment method
sig { returns(T.nilable(CollectPaymentMethod)) }
def collect_payment_method; end
# Represents a reader action to confirm a payment
sig { returns(T.nilable(ConfirmPaymentIntent)) }
def confirm_payment_intent; end
# Failure code, only set if status is `failed`.
sig { returns(T.nilable(String)) }
def failure_code; end
# Detailed failure message, only set if status is `failed`.
sig { returns(T.nilable(String)) }
def failure_message; end
# Represents a reader action to process a payment intent
sig { returns(T.nilable(ProcessPaymentIntent)) }
def process_payment_intent; end
# Represents a reader action to process a setup intent
sig { returns(T.nilable(ProcessSetupIntent)) }
def process_setup_intent; end
# Represents a reader action to refund a payment
sig { returns(T.nilable(RefundPayment)) }
def refund_payment; end
# Represents a reader action to set the reader display
sig { returns(T.nilable(SetReaderDisplay)) }
def set_reader_display; end
# Status of the action performed by the reader.
sig { returns(String) }
def status; end
# Type of action performed by the reader.
sig { returns(String) }
def type; end
end
# The most recent action performed by the reader.
sig { returns(T.nilable(Action)) }
def action; end
# The current software version of the reader.
sig { returns(T.nilable(String)) }
def device_sw_version; end
# Device type of the reader.
sig { returns(String) }
def device_type; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The local IP address of the reader.
sig { returns(T.nilable(String)) }
def ip_address; end
# Custom label given to the reader for easier identification.
sig { returns(String) }
def label; end
# 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) }
def livemode; end
# The location identifier of the reader.
sig { returns(T.nilable(T.any(String, Stripe::Terminal::Location))) }
def location; end
# 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::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Serial number of the reader.
sig { returns(String) }
def serial_number; end
# The networking status of the reader. We do not recommend using this field in flows that may block taking payments.
sig { returns(T.nilable(String)) }
def status; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams; end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The new label of the reader.
sig { returns(T.nilable(String)) }
def label; end
sig { params(_label: T.nilable(String)).returns(T.nilable(String)) }
def label=(_label); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), label: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, label: nil, metadata: nil); end
end
class ListParams < Stripe::RequestParams
# Filters readers by device type
sig { returns(T.nilable(String)) }
def device_type; end
sig { params(_device_type: T.nilable(String)).returns(T.nilable(String)) }
def device_type=(_device_type); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A location ID to filter the response list to only readers at the specific location
sig { returns(T.nilable(String)) }
def location; end
sig { params(_location: T.nilable(String)).returns(T.nilable(String)) }
def location=(_location); end
# Filters readers by serial number
sig { returns(T.nilable(String)) }
def serial_number; end
sig { params(_serial_number: T.nilable(String)).returns(T.nilable(String)) }
def serial_number=(_serial_number); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# A status filter to filter readers to only offline or online readers
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(device_type: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), location: T.nilable(String), serial_number: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
device_type: nil,
ending_before: nil,
expand: nil,
limit: nil,
location: nil,
serial_number: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Custom label given to the reader for easier identification. If no label is specified, the registration code will be used.
sig { returns(T.nilable(String)) }
def label; end
sig { params(_label: T.nilable(String)).returns(T.nilable(String)) }
def label=(_label); end
# The location to assign the reader to.
sig { returns(T.nilable(String)) }
def location; end
sig { params(_location: T.nilable(String)).returns(T.nilable(String)) }
def location=(_location); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# A code generated by the reader used for registering to an account.
sig { returns(String) }
def registration_code; end
sig { params(_registration_code: String).returns(String) }
def registration_code=(_registration_code); end
sig {
params(expand: T.nilable(T::Array[String]), label: T.nilable(String), location: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), registration_code: String).void
}
def initialize(
expand: nil,
label: nil,
location: nil,
metadata: nil,
registration_code: nil
); end
end
class CancelActionParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class CollectInputsParams < Stripe::RequestParams
class Input < Stripe::RequestParams
class CustomText < Stripe::RequestParams
# The description which will be displayed when collecting this input
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The skip button text
sig { returns(T.nilable(String)) }
def skip_button; end
sig { params(_skip_button: T.nilable(String)).returns(T.nilable(String)) }
def skip_button=(_skip_button); end
# The submit button text
sig { returns(T.nilable(String)) }
def submit_button; end
sig { params(_submit_button: T.nilable(String)).returns(T.nilable(String)) }
def submit_button=(_submit_button); end
# The title which will be displayed when collecting this input
sig { returns(String) }
def title; end
sig { params(_title: String).returns(String) }
def title=(_title); end
sig {
params(description: T.nilable(String), skip_button: T.nilable(String), submit_button: T.nilable(String), title: String).void
}
def initialize(description: nil, skip_button: nil, submit_button: nil, title: nil); end
end
class Selection < Stripe::RequestParams
class Choice < Stripe::RequestParams
# The unique identifier for this choice
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
# The style of the button which will be shown for this choice
sig { returns(T.nilable(String)) }
def style; end
sig { params(_style: T.nilable(String)).returns(T.nilable(String)) }
def style=(_style); end
# The text which will be shown on the button for this choice
sig { returns(String) }
def text; end
sig { params(_text: String).returns(String) }
def text=(_text); end
sig { params(id: String, style: T.nilable(String), text: String).void }
def initialize(id: nil, style: nil, text: nil); end
end
# List of choices for the `selection` input
sig {
returns(T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input::Selection::Choice])
}
def choices; end
sig {
params(_choices: T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input::Selection::Choice]).returns(T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input::Selection::Choice])
}
def choices=(_choices); end
sig {
params(choices: T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input::Selection::Choice]).void
}
def initialize(choices: nil); end
end
class Toggle < Stripe::RequestParams
# The default value of the toggle
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The description which will be displayed for the toggle
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The title which will be displayed for the toggle
sig { returns(T.nilable(String)) }
def title; end
sig { params(_title: T.nilable(String)).returns(T.nilable(String)) }
def title=(_title); end
sig {
params(default_value: T.nilable(String), description: T.nilable(String), title: T.nilable(String)).void
}
def initialize(default_value: nil, description: nil, title: nil); end
end
# Customize the text which will be displayed while collecting this input
sig { returns(::Stripe::Terminal::Reader::CollectInputsParams::Input::CustomText) }
def custom_text; end
sig {
params(_custom_text: ::Stripe::Terminal::Reader::CollectInputsParams::Input::CustomText).returns(::Stripe::Terminal::Reader::CollectInputsParams::Input::CustomText)
}
def custom_text=(_custom_text); end
# Indicate that this input is required, disabling the skip button
sig { returns(T.nilable(T::Boolean)) }
def required; end
sig { params(_required: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def required=(_required); end
# Options for the `selection` input
sig {
returns(T.nilable(::Stripe::Terminal::Reader::CollectInputsParams::Input::Selection))
}
def selection; end
sig {
params(_selection: T.nilable(::Stripe::Terminal::Reader::CollectInputsParams::Input::Selection)).returns(T.nilable(::Stripe::Terminal::Reader::CollectInputsParams::Input::Selection))
}
def selection=(_selection); end
# List of toggles to be displayed and customization for the toggles
sig {
returns(T.nilable(T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input::Toggle]))
}
def toggles; end
sig {
params(_toggles: T.nilable(T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input::Toggle])).returns(T.nilable(T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input::Toggle]))
}
def toggles=(_toggles); end
# The type of input to collect
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(custom_text: ::Stripe::Terminal::Reader::CollectInputsParams::Input::CustomText, required: T.nilable(T::Boolean), selection: T.nilable(::Stripe::Terminal::Reader::CollectInputsParams::Input::Selection), toggles: T.nilable(T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input::Toggle]), type: String).void
}
def initialize(
custom_text: nil,
required: nil,
selection: nil,
toggles: nil,
type: nil
); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# List of inputs to be collected using the Reader
sig { returns(T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input]) }
def inputs; end
sig {
params(_inputs: T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input]).returns(T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input])
}
def inputs=(_inputs); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), inputs: T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input], metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(expand: nil, inputs: nil, metadata: nil); end
end
class CollectPaymentMethodParams < Stripe::RequestParams
class CollectConfig < Stripe::RequestParams
class Tipping < Stripe::RequestParams
# Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).
sig { returns(T.nilable(Integer)) }
def amount_eligible; end
sig { params(_amount_eligible: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_eligible=(_amount_eligible); end
sig { params(amount_eligible: T.nilable(Integer)).void }
def initialize(amount_eligible: nil); end
end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# Enables cancel button on transaction screens.
sig { returns(T.nilable(T::Boolean)) }
def enable_customer_cancellation; end
sig {
params(_enable_customer_cancellation: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def enable_customer_cancellation=(_enable_customer_cancellation); end
# Override showing a tipping selection screen on this transaction.
sig { returns(T.nilable(T::Boolean)) }
def skip_tipping; end
sig { params(_skip_tipping: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def skip_tipping=(_skip_tipping); end
# Tipping configuration for this transaction.
sig {
returns(T.nilable(::Stripe::Terminal::Reader::CollectPaymentMethodParams::CollectConfig::Tipping))
}
def tipping; end
sig {
params(_tipping: T.nilable(::Stripe::Terminal::Reader::CollectPaymentMethodParams::CollectConfig::Tipping)).returns(T.nilable(::Stripe::Terminal::Reader::CollectPaymentMethodParams::CollectConfig::Tipping))
}
def tipping=(_tipping); end
sig {
params(allow_redisplay: T.nilable(String), enable_customer_cancellation: T.nilable(T::Boolean), skip_tipping: T.nilable(T::Boolean), tipping: T.nilable(::Stripe::Terminal::Reader::CollectPaymentMethodParams::CollectConfig::Tipping)).void
}
def initialize(
allow_redisplay: nil,
enable_customer_cancellation: nil,
skip_tipping: nil,
tipping: nil
); end
end
# Configuration overrides.
sig {
returns(T.nilable(::Stripe::Terminal::Reader::CollectPaymentMethodParams::CollectConfig))
}
def collect_config; end
sig {
params(_collect_config: T.nilable(::Stripe::Terminal::Reader::CollectPaymentMethodParams::CollectConfig)).returns(T.nilable(::Stripe::Terminal::Reader::CollectPaymentMethodParams::CollectConfig))
}
def collect_config=(_collect_config); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# PaymentIntent ID.
sig { returns(String) }
def payment_intent; end
sig { params(_payment_intent: String).returns(String) }
def payment_intent=(_payment_intent); end
sig {
params(collect_config: T.nilable(::Stripe::Terminal::Reader::CollectPaymentMethodParams::CollectConfig), expand: T.nilable(T::Array[String]), payment_intent: String).void
}
def initialize(collect_config: nil, expand: nil, payment_intent: nil); end
end
class ConfirmPaymentIntentParams < Stripe::RequestParams
class ConfirmConfig < Stripe::RequestParams
# The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig { params(return_url: T.nilable(String)).void }
def initialize(return_url: nil); end
end
# Configuration overrides.
sig {
returns(T.nilable(::Stripe::Terminal::Reader::ConfirmPaymentIntentParams::ConfirmConfig))
}
def confirm_config; end
sig {
params(_confirm_config: T.nilable(::Stripe::Terminal::Reader::ConfirmPaymentIntentParams::ConfirmConfig)).returns(T.nilable(::Stripe::Terminal::Reader::ConfirmPaymentIntentParams::ConfirmConfig))
}
def confirm_config=(_confirm_config); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# PaymentIntent ID.
sig { returns(String) }
def payment_intent; end
sig { params(_payment_intent: String).returns(String) }
def payment_intent=(_payment_intent); end
sig {
params(confirm_config: T.nilable(::Stripe::Terminal::Reader::ConfirmPaymentIntentParams::ConfirmConfig), expand: T.nilable(T::Array[String]), payment_intent: String).void
}
def initialize(confirm_config: nil, expand: nil, payment_intent: nil); end
end
class ProcessPaymentIntentParams < Stripe::RequestParams
class ProcessConfig < Stripe::RequestParams
class Tipping < Stripe::RequestParams
# Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).
sig { returns(T.nilable(Integer)) }
def amount_eligible; end
sig { params(_amount_eligible: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_eligible=(_amount_eligible); end
sig { params(amount_eligible: T.nilable(Integer)).void }
def initialize(amount_eligible: nil); end
end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# Enables cancel button on transaction screens.
sig { returns(T.nilable(T::Boolean)) }
def enable_customer_cancellation; end
sig {
params(_enable_customer_cancellation: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def enable_customer_cancellation=(_enable_customer_cancellation); end
# The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# Override showing a tipping selection screen on this transaction.
sig { returns(T.nilable(T::Boolean)) }
def skip_tipping; end
sig { params(_skip_tipping: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def skip_tipping=(_skip_tipping); end
# Tipping configuration for this transaction.
sig {
returns(T.nilable(::Stripe::Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig::Tipping))
}
def tipping; end
sig {
params(_tipping: T.nilable(::Stripe::Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig::Tipping)).returns(T.nilable(::Stripe::Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig::Tipping))
}
def tipping=(_tipping); end
sig {
params(allow_redisplay: T.nilable(String), enable_customer_cancellation: T.nilable(T::Boolean), return_url: T.nilable(String), skip_tipping: T.nilable(T::Boolean), tipping: T.nilable(::Stripe::Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig::Tipping)).void
}
def initialize(
allow_redisplay: nil,
enable_customer_cancellation: nil,
return_url: nil,
skip_tipping: nil,
tipping: nil
); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# PaymentIntent ID
sig { returns(String) }
def payment_intent; end
sig { params(_payment_intent: String).returns(String) }
def payment_intent=(_payment_intent); end
# Configuration overrides
sig {
returns(T.nilable(::Stripe::Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig))
}
def process_config; end
sig {
params(_process_config: T.nilable(::Stripe::Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig)).returns(T.nilable(::Stripe::Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig))
}
def process_config=(_process_config); end
sig {
params(expand: T.nilable(T::Array[String]), payment_intent: String, process_config: T.nilable(::Stripe::Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig)).void
}
def initialize(expand: nil, payment_intent: nil, process_config: nil); end
end
class ProcessSetupIntentParams < Stripe::RequestParams
class ProcessConfig < Stripe::RequestParams
# Enables cancel button on transaction screens.
sig { returns(T.nilable(T::Boolean)) }
def enable_customer_cancellation; end
sig {
params(_enable_customer_cancellation: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def enable_customer_cancellation=(_enable_customer_cancellation); end
sig { params(enable_customer_cancellation: T.nilable(T::Boolean)).void }
def initialize(enable_customer_cancellation: nil); end
end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
sig { returns(String) }
def allow_redisplay; end
sig { params(_allow_redisplay: String).returns(String) }
def allow_redisplay=(_allow_redisplay); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Configuration overrides
sig {
returns(T.nilable(::Stripe::Terminal::Reader::ProcessSetupIntentParams::ProcessConfig))
}
def process_config; end
sig {
params(_process_config: T.nilable(::Stripe::Terminal::Reader::ProcessSetupIntentParams::ProcessConfig)).returns(T.nilable(::Stripe::Terminal::Reader::ProcessSetupIntentParams::ProcessConfig))
}
def process_config=(_process_config); end
# SetupIntent ID
sig { returns(String) }
def setup_intent; end
sig { params(_setup_intent: String).returns(String) }
def setup_intent=(_setup_intent); end
sig {
params(allow_redisplay: String, expand: T.nilable(T::Array[String]), process_config: T.nilable(::Stripe::Terminal::Reader::ProcessSetupIntentParams::ProcessConfig), setup_intent: String).void
}
def initialize(
allow_redisplay: nil,
expand: nil,
process_config: nil,
setup_intent: nil
); end
end
class RefundPaymentParams < Stripe::RequestParams
class RefundPaymentConfig < Stripe::RequestParams
# Enables cancel button on transaction screens.
sig { returns(T.nilable(T::Boolean)) }
def enable_customer_cancellation; end
sig {
params(_enable_customer_cancellation: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def enable_customer_cancellation=(_enable_customer_cancellation); end
sig { params(enable_customer_cancellation: T.nilable(T::Boolean)).void }
def initialize(enable_customer_cancellation: nil); end
end
# A positive integer in __cents__ representing how much of this charge to refund.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# ID of the Charge to refund.
sig { returns(T.nilable(String)) }
def charge; end
sig { params(_charge: T.nilable(String)).returns(T.nilable(String)) }
def charge=(_charge); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# ID of the PaymentIntent to refund.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.
sig { returns(T.nilable(T::Boolean)) }
def refund_application_fee; end
sig {
params(_refund_application_fee: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def refund_application_fee=(_refund_application_fee); end
# Configuration overrides
sig {
returns(T.nilable(::Stripe::Terminal::Reader::RefundPaymentParams::RefundPaymentConfig))
}
def refund_payment_config; end
sig {
params(_refund_payment_config: T.nilable(::Stripe::Terminal::Reader::RefundPaymentParams::RefundPaymentConfig)).returns(T.nilable(::Stripe::Terminal::Reader::RefundPaymentParams::RefundPaymentConfig))
}
def refund_payment_config=(_refund_payment_config); end
# Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.
sig { returns(T.nilable(T::Boolean)) }
def reverse_transfer; end
sig { params(_reverse_transfer: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def reverse_transfer=(_reverse_transfer); end
sig {
params(amount: T.nilable(Integer), charge: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), payment_intent: T.nilable(String), refund_application_fee: T.nilable(T::Boolean), refund_payment_config: T.nilable(::Stripe::Terminal::Reader::RefundPaymentParams::RefundPaymentConfig), reverse_transfer: T.nilable(T::Boolean)).void
}
def initialize(
amount: nil,
charge: nil,
expand: nil,
metadata: nil,
payment_intent: nil,
refund_application_fee: nil,
refund_payment_config: nil,
reverse_transfer: nil
); end
end
class SetReaderDisplayParams < Stripe::RequestParams
class Cart < Stripe::RequestParams
class LineItem < Stripe::RequestParams
# The price of the item in cents.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The description or name of the item.
sig { returns(String) }
def description; end
sig { params(_description: String).returns(String) }
def description=(_description); end
# The quantity of the line item being purchased.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
sig { params(amount: Integer, description: String, quantity: Integer).void }
def initialize(amount: nil, description: nil, quantity: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Array of line items that were purchased.
sig {
returns(T::Array[::Stripe::Terminal::Reader::SetReaderDisplayParams::Cart::LineItem])
}
def line_items; end
sig {
params(_line_items: T::Array[::Stripe::Terminal::Reader::SetReaderDisplayParams::Cart::LineItem]).returns(T::Array[::Stripe::Terminal::Reader::SetReaderDisplayParams::Cart::LineItem])
}
def line_items=(_line_items); end
# The amount of tax in cents.
sig { returns(T.nilable(Integer)) }
def tax; end
sig { params(_tax: T.nilable(Integer)).returns(T.nilable(Integer)) }
def tax=(_tax); end
# Total balance of cart due in cents.
sig { returns(Integer) }
def total; end
sig { params(_total: Integer).returns(Integer) }
def total=(_total); end
sig {
params(currency: String, line_items: T::Array[::Stripe::Terminal::Reader::SetReaderDisplayParams::Cart::LineItem], tax: T.nilable(Integer), total: Integer).void
}
def initialize(currency: nil, line_items: nil, tax: nil, total: nil); end
end
# Cart
sig { returns(T.nilable(::Stripe::Terminal::Reader::SetReaderDisplayParams::Cart)) }
def cart; end
sig {
params(_cart: T.nilable(::Stripe::Terminal::Reader::SetReaderDisplayParams::Cart)).returns(T.nilable(::Stripe::Terminal::Reader::SetReaderDisplayParams::Cart))
}
def cart=(_cart); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Type
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(cart: T.nilable(::Stripe::Terminal::Reader::SetReaderDisplayParams::Cart), expand: T.nilable(T::Array[String]), type: String).void
}
def initialize(cart: nil, expand: nil, type: nil); end
end
class PresentPaymentMethodParams < Stripe::RequestParams
class Card < Stripe::RequestParams
# Card security code.
sig { returns(T.nilable(String)) }
def cvc; end
sig { params(_cvc: T.nilable(String)).returns(T.nilable(String)) }
def cvc=(_cvc); end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
sig { params(_exp_month: Integer).returns(Integer) }
def exp_month=(_exp_month); end
# Two- or four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
sig { params(_exp_year: Integer).returns(Integer) }
def exp_year=(_exp_year); end
# The card number, as a string without any separators.
sig { returns(String) }
def number; end
sig { params(_number: String).returns(String) }
def number=(_number); end
sig {
params(cvc: T.nilable(String), exp_month: Integer, exp_year: Integer, number: String).void
}
def initialize(cvc: nil, exp_month: nil, exp_year: nil, number: nil); end
end
class CardPresent < Stripe::RequestParams
# The card number, as a string without any separators.
sig { returns(T.nilable(String)) }
def number; end
sig { params(_number: T.nilable(String)).returns(T.nilable(String)) }
def number=(_number); end
sig { params(number: T.nilable(String)).void }
def initialize(number: nil); end
end
class InteracPresent < Stripe::RequestParams
# Card Number
sig { returns(T.nilable(String)) }
def number; end
sig { params(_number: T.nilable(String)).returns(T.nilable(String)) }
def number=(_number); end
sig { params(number: T.nilable(String)).void }
def initialize(number: nil); end
end
# Simulated on-reader tip amount.
sig { returns(T.nilable(Integer)) }
def amount_tip; end
sig { params(_amount_tip: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_tip=(_amount_tip); end
# Simulated data for the card payment method.
sig { returns(T.nilable(::Stripe::Terminal::Reader::PresentPaymentMethodParams::Card)) }
def card; end
sig {
params(_card: T.nilable(::Stripe::Terminal::Reader::PresentPaymentMethodParams::Card)).returns(T.nilable(::Stripe::Terminal::Reader::PresentPaymentMethodParams::Card))
}
def card=(_card); end
# Simulated data for the card_present payment method.
sig {
returns(T.nilable(::Stripe::Terminal::Reader::PresentPaymentMethodParams::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::Terminal::Reader::PresentPaymentMethodParams::CardPresent)).returns(T.nilable(::Stripe::Terminal::Reader::PresentPaymentMethodParams::CardPresent))
}
def card_present=(_card_present); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Simulated data for the interac_present payment method.
sig {
returns(T.nilable(::Stripe::Terminal::Reader::PresentPaymentMethodParams::InteracPresent))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::Terminal::Reader::PresentPaymentMethodParams::InteracPresent)).returns(T.nilable(::Stripe::Terminal::Reader::PresentPaymentMethodParams::InteracPresent))
}
def interac_present=(_interac_present); end
# Simulated payment type.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(amount_tip: T.nilable(Integer), card: T.nilable(::Stripe::Terminal::Reader::PresentPaymentMethodParams::Card), card_present: T.nilable(::Stripe::Terminal::Reader::PresentPaymentMethodParams::CardPresent), expand: T.nilable(T::Array[String]), interac_present: T.nilable(::Stripe::Terminal::Reader::PresentPaymentMethodParams::InteracPresent), type: T.nilable(String)).void
}
def initialize(
amount_tip: nil,
card: nil,
card_present: nil,
expand: nil,
interac_present: nil,
type: nil
); end
end
class SucceedInputCollectionParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# This parameter defines the skip behavior for input collection.
sig { returns(T.nilable(String)) }
def skip_non_required_inputs; end
sig { params(_skip_non_required_inputs: T.nilable(String)).returns(T.nilable(String)) }
def skip_non_required_inputs=(_skip_non_required_inputs); end
sig {
params(expand: T.nilable(T::Array[String]), skip_non_required_inputs: T.nilable(String)).void
}
def initialize(expand: nil, skip_non_required_inputs: nil); end
end
class TimeoutInputCollectionParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Cancels the current reader action.
sig {
params(params: T.any(::Stripe::Terminal::Reader::CancelActionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def cancel_action(params = {}, opts = {}); end
# Cancels the current reader action.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::Reader::CancelActionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def self.cancel_action(reader, params = {}, opts = {}); end
# Initiates an input collection flow on a Reader.
sig {
params(params: T.any(::Stripe::Terminal::Reader::CollectInputsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def collect_inputs(params = {}, opts = {}); end
# Initiates an input collection flow on a Reader.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::Reader::CollectInputsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def self.collect_inputs(reader, params = {}, opts = {}); end
# Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
sig {
params(params: T.any(::Stripe::Terminal::Reader::CollectPaymentMethodParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def collect_payment_method(params = {}, opts = {}); end
# Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::Reader::CollectPaymentMethodParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def self.collect_payment_method(reader, params = {}, opts = {}); end
# Finalizes a payment on a Reader.
sig {
params(params: T.any(::Stripe::Terminal::Reader::ConfirmPaymentIntentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def confirm_payment_intent(params = {}, opts = {}); end
# Finalizes a payment on a Reader.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::Reader::ConfirmPaymentIntentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def self.confirm_payment_intent(reader, params = {}, opts = {}); end
# Creates a new Reader object.
sig {
params(params: T.any(::Stripe::Terminal::Reader::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def self.create(params = {}, opts = {}); end
# Deletes a Reader object.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::Reader::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def self.delete(reader, params = {}, opts = {}); end
# Deletes a Reader object.
sig {
params(params: T.any(::Stripe::Terminal::Reader::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def delete(params = {}, opts = {}); end
# Returns a list of Reader objects.
sig {
params(params: T.any(::Stripe::Terminal::Reader::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Initiates a payment flow on a Reader.
sig {
params(params: T.any(::Stripe::Terminal::Reader::ProcessPaymentIntentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def process_payment_intent(params = {}, opts = {}); end
# Initiates a payment flow on a Reader.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::Reader::ProcessPaymentIntentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def self.process_payment_intent(reader, params = {}, opts = {}); end
# Initiates a setup intent flow on a Reader.
sig {
params(params: T.any(::Stripe::Terminal::Reader::ProcessSetupIntentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def process_setup_intent(params = {}, opts = {}); end
# Initiates a setup intent flow on a Reader.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::Reader::ProcessSetupIntentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def self.process_setup_intent(reader, params = {}, opts = {}); end
# Initiates a refund on a Reader
sig {
params(params: T.any(::Stripe::Terminal::Reader::RefundPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def refund_payment(params = {}, opts = {}); end
# Initiates a refund on a Reader
sig {
params(reader: String, params: T.any(::Stripe::Terminal::Reader::RefundPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def self.refund_payment(reader, params = {}, opts = {}); end
# Sets reader display to show cart details.
sig {
params(params: T.any(::Stripe::Terminal::Reader::SetReaderDisplayParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def set_reader_display(params = {}, opts = {}); end
# Sets reader display to show cart details.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::Reader::SetReaderDisplayParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def self.set_reader_display(reader, params = {}, opts = {}); end
# Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::Reader::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def self.update(reader, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module TestHelpers
# A test clock enables deterministic control over objects in testmode. With a test clock, you can create
# objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,
# you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.
class TestClock < APIResource
class StatusDetails < Stripe::StripeObject
class Advancing < Stripe::StripeObject
# The `frozen_time` that the Test Clock is advancing towards.
sig { returns(Integer) }
def target_frozen_time; end
end
# Attribute for field advancing
sig { returns(T.nilable(Advancing)) }
def advancing; end
end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Time at which this clock is scheduled to auto delete.
sig { returns(Integer) }
def deletes_after; end
# Time at which all objects belonging to this clock are frozen.
sig { returns(Integer) }
def frozen_time; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# The custom name supplied at creation.
sig { returns(T.nilable(String)) }
def name; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The status of the Test Clock.
sig { returns(String) }
def status; end
# Attribute for field status_details
sig { returns(StatusDetails) }
def status_details; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The initial frozen time for this test clock.
sig { returns(Integer) }
def frozen_time; end
sig { params(_frozen_time: Integer).returns(Integer) }
def frozen_time=(_frozen_time); end
# The name for this test clock.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(expand: T.nilable(T::Array[String]), frozen_time: Integer, name: T.nilable(String)).void
}
def initialize(expand: nil, frozen_time: nil, name: nil); end
end
class AdvanceParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future.
sig { returns(Integer) }
def frozen_time; end
sig { params(_frozen_time: Integer).returns(Integer) }
def frozen_time=(_frozen_time); end
sig { params(expand: T.nilable(T::Array[String]), frozen_time: Integer).void }
def initialize(expand: nil, frozen_time: nil); end
end
# Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.
sig {
params(params: T.any(::Stripe::TestHelpers::TestClock::AdvanceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TestHelpers::TestClock)
}
def advance(params = {}, opts = {}); end
# Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.
sig {
params(test_clock: String, params: T.any(::Stripe::TestHelpers::TestClock::AdvanceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TestHelpers::TestClock)
}
def self.advance(test_clock, params = {}, opts = {}); end
# Creates a new test clock that can be attached to new customers and quotes.
sig {
params(params: T.any(::Stripe::TestHelpers::TestClock::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TestHelpers::TestClock)
}
def self.create(params = {}, opts = {}); end
# Deletes a test clock.
sig {
params(test_clock: String, params: T.any(::Stripe::TestHelpers::TestClock::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TestHelpers::TestClock)
}
def self.delete(test_clock, params = {}, opts = {}); end
# Deletes a test clock.
sig {
params(params: T.any(::Stripe::TestHelpers::TestClock::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TestHelpers::TestClock)
}
def delete(params = {}, opts = {}); end
# Returns a list of your test clocks.
sig {
params(params: T.any(::Stripe::TestHelpers::TestClock::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
# Tokenization is the process Stripe uses to collect sensitive card or bank
# account details, or personally identifiable information (PII), directly from
# your customers in a secure manner. A token representing this information is
# returned to your server to use. Use our
# [recommended payments integrations](https://stripe.com/docs/payments) to perform this process
# on the client-side. This guarantees that no sensitive card data touches your server,
# and allows your integration to operate in a PCI-compliant way.
#
# If you can't use client-side tokenization, you can also create tokens using
# the API with either your publishable or secret API key. If
# your integration uses this method, you're responsible for any PCI compliance
# that it might require, and you must keep your secret API key safe. Unlike with
# client-side tokenization, your customer's information isn't sent directly to
# Stripe, so we can't determine how it's handled or stored.
#
# You can't store or use tokens more than once. To store card or bank account
# information for later use, create [Customer](https://stripe.com/docs/api#customers)
# objects or [External accounts](https://docs.stripe.com/api#external_accounts).
# [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,
# performs best with integrations that use client-side tokenization.
class Token < APIResource
# These bank accounts are payment methods on `Customer` objects.
#
# On the other hand [External Accounts](/api#external_accounts) are transfer
# destinations on `Account` objects for connected accounts.
# They can be bank accounts or debit cards as well, and are documented in the links above.
#
# Related guide: [Bank debits and transfers](/payments/bank-debits-transfers)
sig { returns(T.nilable(Stripe::BankAccount)) }
def bank_account; end
# You can store multiple cards on a customer in order to charge the customer
# later. You can also store multiple debit cards on a recipient in order to
# transfer to those cards later.
#
# Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)
sig { returns(T.nilable(Stripe::Card)) }
def card; end
# IP address of the client that generates the token.
sig { returns(T.nilable(String)) }
def client_ip; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Type of the token: `account`, `bank_account`, `card`, or `pii`.
sig { returns(String) }
def type; end
# Determines if you have already used this token (you can only use tokens once).
sig { returns(T::Boolean) }
def used; end
class CreateParams < Stripe::RequestParams
class Account < Stripe::RequestParams
class Company < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class DirectorshipDeclaration < Stripe::RequestParams
# The Unix timestamp marking when the directorship declaration attestation was made.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the directorship declaration attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the directorship declaration attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class OwnershipDeclaration < Stripe::RequestParams
# The Unix timestamp marking when the beneficial owner attestation was made.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class RegistrationDate < Stripe::RequestParams
# The day of registration, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of registration, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of registration.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Verification < Stripe::RequestParams
class Document < Stripe::RequestParams
# The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# A document verifying the business.
sig {
returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::Token::CreateParams::Account::Company::Verification::Document)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::Verification::Document))
}
def document=(_document); end
sig {
params(document: T.nilable(::Stripe::Token::CreateParams::Account::Company::Verification::Document)).void
}
def initialize(document: nil); end
end
# The company's primary address.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::Token::CreateParams::Account::Company::Address)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::Address))
}
def address=(_address); end
# The Kana variation of the company's primary address (Japan only).
sig { returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::Token::CreateParams::Account::Company::AddressKana)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the company's primary address (Japan only).
sig { returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::Token::CreateParams::Account::Company::AddressKanji)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::AddressKanji))
}
def address_kanji=(_address_kanji); end
# Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.
sig { returns(T.nilable(T::Boolean)) }
def directors_provided; end
sig { params(_directors_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def directors_provided=(_directors_provided); end
# This hash is used to attest that the directors information provided to Stripe is both current and correct.
sig {
returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::DirectorshipDeclaration))
}
def directorship_declaration; end
sig {
params(_directorship_declaration: T.nilable(::Stripe::Token::CreateParams::Account::Company::DirectorshipDeclaration)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::DirectorshipDeclaration))
}
def directorship_declaration=(_directorship_declaration); end
# Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](/api/persons) for accounts with a `relationship.executive` requirement.
sig { returns(T.nilable(T::Boolean)) }
def executives_provided; end
sig { params(_executives_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executives_provided=(_executives_provided); end
# The export license ID number of the company, also referred as Import Export Code (India only).
sig { returns(T.nilable(String)) }
def export_license_id; end
sig { params(_export_license_id: T.nilable(String)).returns(T.nilable(String)) }
def export_license_id=(_export_license_id); end
# The purpose code to use for export transactions (India only).
sig { returns(T.nilable(String)) }
def export_purpose_code; end
sig { params(_export_purpose_code: T.nilable(String)).returns(T.nilable(String)) }
def export_purpose_code=(_export_purpose_code); end
# The company's legal name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The Kana variation of the company's legal name (Japan only).
sig { returns(T.nilable(String)) }
def name_kana; end
sig { params(_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def name_kana=(_name_kana); end
# The Kanji variation of the company's legal name (Japan only).
sig { returns(T.nilable(String)) }
def name_kanji; end
sig { params(_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def name_kanji=(_name_kanji); end
# Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](/api/persons) for accounts with a `relationship.owner` requirement.
sig { returns(T.nilable(T::Boolean)) }
def owners_provided; end
sig { params(_owners_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owners_provided=(_owners_provided); end
# This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
sig {
returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::OwnershipDeclaration))
}
def ownership_declaration; end
sig {
params(_ownership_declaration: T.nilable(::Stripe::Token::CreateParams::Account::Company::OwnershipDeclaration)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::OwnershipDeclaration))
}
def ownership_declaration=(_ownership_declaration); end
# Whether the user described by the data in the token has been shown the Ownership Declaration and indicated that it is correct.
sig { returns(T.nilable(T::Boolean)) }
def ownership_declaration_shown_and_signed; end
sig {
params(_ownership_declaration_shown_and_signed: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def ownership_declaration_shown_and_signed=(_ownership_declaration_shown_and_signed); end
# This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.
sig { returns(T.nilable(T.any(String, String))) }
def ownership_exemption_reason; end
sig {
params(_ownership_exemption_reason: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def ownership_exemption_reason=(_ownership_exemption_reason); end
# The company's phone number (used for verification).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# When the business was incorporated or registered.
sig {
returns(T.nilable(T.any(String, ::Stripe::Token::CreateParams::Account::Company::RegistrationDate)))
}
def registration_date; end
sig {
params(_registration_date: T.nilable(T.any(String, ::Stripe::Token::CreateParams::Account::Company::RegistrationDate))).returns(T.nilable(T.any(String, ::Stripe::Token::CreateParams::Account::Company::RegistrationDate)))
}
def registration_date=(_registration_date); end
# The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).
sig { returns(T.nilable(String)) }
def registration_number; end
sig { params(_registration_number: T.nilable(String)).returns(T.nilable(String)) }
def registration_number=(_registration_number); end
# The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
sig { returns(T.nilable(T.any(String, String))) }
def structure; end
sig {
params(_structure: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def structure=(_structure); end
# The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
# The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
sig { returns(T.nilable(String)) }
def tax_id_registrar; end
sig { params(_tax_id_registrar: T.nilable(String)).returns(T.nilable(String)) }
def tax_id_registrar=(_tax_id_registrar); end
# The VAT number of the company.
sig { returns(T.nilable(String)) }
def vat_id; end
sig { params(_vat_id: T.nilable(String)).returns(T.nilable(String)) }
def vat_id=(_vat_id); end
# Information on the verification state of the company.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::Verification)) }
def verification; end
sig {
params(_verification: T.nilable(::Stripe::Token::CreateParams::Account::Company::Verification)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::Verification))
}
def verification=(_verification); end
sig {
params(address: T.nilable(::Stripe::Token::CreateParams::Account::Company::Address), address_kana: T.nilable(::Stripe::Token::CreateParams::Account::Company::AddressKana), address_kanji: T.nilable(::Stripe::Token::CreateParams::Account::Company::AddressKanji), directors_provided: T.nilable(T::Boolean), directorship_declaration: T.nilable(::Stripe::Token::CreateParams::Account::Company::DirectorshipDeclaration), executives_provided: T.nilable(T::Boolean), export_license_id: T.nilable(String), export_purpose_code: T.nilable(String), name: T.nilable(String), name_kana: T.nilable(String), name_kanji: T.nilable(String), owners_provided: T.nilable(T::Boolean), ownership_declaration: T.nilable(::Stripe::Token::CreateParams::Account::Company::OwnershipDeclaration), ownership_declaration_shown_and_signed: T.nilable(T::Boolean), ownership_exemption_reason: T.nilable(T.any(String, String)), phone: T.nilable(String), registration_date: T.nilable(T.any(String, ::Stripe::Token::CreateParams::Account::Company::RegistrationDate)), registration_number: T.nilable(String), structure: T.nilable(T.any(String, String)), tax_id: T.nilable(String), tax_id_registrar: T.nilable(String), vat_id: T.nilable(String), verification: T.nilable(::Stripe::Token::CreateParams::Account::Company::Verification)).void
}
def initialize(
address: nil,
address_kana: nil,
address_kanji: nil,
directors_provided: nil,
directorship_declaration: nil,
executives_provided: nil,
export_license_id: nil,
export_purpose_code: nil,
name: nil,
name_kana: nil,
name_kanji: nil,
owners_provided: nil,
ownership_declaration: nil,
ownership_declaration_shown_and_signed: nil,
ownership_exemption_reason: nil,
phone: nil,
registration_date: nil,
registration_number: nil,
structure: nil,
tax_id: nil,
tax_id_registrar: nil,
vat_id: nil,
verification: nil
); end
end
class Individual < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class RegisteredAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Relationship < Stripe::RequestParams
# Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
sig { returns(T.nilable(T::Boolean)) }
def director; end
sig { params(_director: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def director=(_director); end
# Whether the person has significant responsibility to control, manage, or direct the organization.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
sig { params(_executive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executive=(_executive); end
# Whether the person is an owner of the account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
sig { params(_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owner=(_owner); end
# The percent owned by the person of the account's legal entity.
sig { returns(T.nilable(T.any(String, Float))) }
def percent_ownership; end
sig {
params(_percent_ownership: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def percent_ownership=(_percent_ownership); end
# The person's title (e.g., CEO, Support Engineer).
sig { returns(T.nilable(String)) }
def title; end
sig { params(_title: T.nilable(String)).returns(T.nilable(String)) }
def title=(_title); end
sig {
params(director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), percent_ownership: T.nilable(T.any(String, Float)), title: T.nilable(String)).void
}
def initialize(
director: nil,
executive: nil,
owner: nil,
percent_ownership: nil,
title: nil
); end
end
class Verification < Stripe::RequestParams
class AdditionalDocument < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
class Document < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig {
returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification::AdditionalDocument))
}
def additional_document; end
sig {
params(_additional_document: T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification::AdditionalDocument)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification::AdditionalDocument))
}
def additional_document=(_additional_document); end
# An identifying document, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification::Document)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification::Document))
}
def document=(_document); end
sig {
params(additional_document: T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification::AdditionalDocument), document: T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification::Document)).void
}
def initialize(additional_document: nil, document: nil); end
end
# The individual's primary address.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::Token::CreateParams::Account::Individual::Address)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::Address))
}
def address=(_address); end
# The Kana variation of the individual's primary address (Japan only).
sig {
returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::AddressKana))
}
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::Token::CreateParams::Account::Individual::AddressKana)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the individual's primary address (Japan only).
sig {
returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::AddressKanji))
}
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::Token::CreateParams::Account::Individual::AddressKanji)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::AddressKanji))
}
def address_kanji=(_address_kanji); end
# The individual's date of birth.
sig {
returns(T.nilable(T.any(String, ::Stripe::Token::CreateParams::Account::Individual::Dob)))
}
def dob; end
sig {
params(_dob: T.nilable(T.any(String, ::Stripe::Token::CreateParams::Account::Individual::Dob))).returns(T.nilable(T.any(String, ::Stripe::Token::CreateParams::Account::Individual::Dob)))
}
def dob=(_dob); end
# The individual's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The individual's first name.
sig { returns(T.nilable(String)) }
def first_name; end
sig { params(_first_name: T.nilable(String)).returns(T.nilable(String)) }
def first_name=(_first_name); end
# The Kana variation of the individual's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kana; end
sig { params(_first_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kana=(_first_name_kana); end
# The Kanji variation of the individual's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kanji; end
sig { params(_first_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kanji=(_first_name_kanji); end
# A list of alternate names or aliases that the individual is known by.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def full_name_aliases; end
sig {
params(_full_name_aliases: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def full_name_aliases=(_full_name_aliases); end
# The individual's gender
sig { returns(T.nilable(String)) }
def gender; end
sig { params(_gender: T.nilable(String)).returns(T.nilable(String)) }
def gender=(_gender); end
# The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number; end
sig { params(_id_number: T.nilable(String)).returns(T.nilable(String)) }
def id_number=(_id_number); end
# The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number_secondary; end
sig { params(_id_number_secondary: T.nilable(String)).returns(T.nilable(String)) }
def id_number_secondary=(_id_number_secondary); end
# The individual's last name.
sig { returns(T.nilable(String)) }
def last_name; end
sig { params(_last_name: T.nilable(String)).returns(T.nilable(String)) }
def last_name=(_last_name); end
# The Kana variation of the individual's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kana; end
sig { params(_last_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kana=(_last_name_kana); end
# The Kanji variation of the individual's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kanji; end
sig { params(_last_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kanji=(_last_name_kanji); end
# The individual's maiden name.
sig { returns(T.nilable(String)) }
def maiden_name; end
sig { params(_maiden_name: T.nilable(String)).returns(T.nilable(String)) }
def maiden_name=(_maiden_name); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The individual's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
sig { returns(T.nilable(String)) }
def political_exposure; end
sig { params(_political_exposure: T.nilable(String)).returns(T.nilable(String)) }
def political_exposure=(_political_exposure); end
# The individual's registered address.
sig {
returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::RegisteredAddress))
}
def registered_address; end
sig {
params(_registered_address: T.nilable(::Stripe::Token::CreateParams::Account::Individual::RegisteredAddress)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::RegisteredAddress))
}
def registered_address=(_registered_address); end
# Describes the person’s relationship to the account.
sig {
returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::Relationship))
}
def relationship; end
sig {
params(_relationship: T.nilable(::Stripe::Token::CreateParams::Account::Individual::Relationship)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::Relationship))
}
def relationship=(_relationship); end
# The last four digits of the individual's Social Security Number (U.S. only).
sig { returns(T.nilable(String)) }
def ssn_last_4; end
sig { params(_ssn_last_4: T.nilable(String)).returns(T.nilable(String)) }
def ssn_last_4=(_ssn_last_4); end
# The individual's verification document information.
sig {
returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification))
}
def verification; end
sig {
params(_verification: T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification))
}
def verification=(_verification); end
sig {
params(address: T.nilable(::Stripe::Token::CreateParams::Account::Individual::Address), address_kana: T.nilable(::Stripe::Token::CreateParams::Account::Individual::AddressKana), address_kanji: T.nilable(::Stripe::Token::CreateParams::Account::Individual::AddressKanji), dob: T.nilable(T.any(String, ::Stripe::Token::CreateParams::Account::Individual::Dob)), email: T.nilable(String), first_name: T.nilable(String), first_name_kana: T.nilable(String), first_name_kanji: T.nilable(String), full_name_aliases: T.nilable(T.any(String, T::Array[String])), gender: T.nilable(String), id_number: T.nilable(String), id_number_secondary: T.nilable(String), last_name: T.nilable(String), last_name_kana: T.nilable(String), last_name_kanji: T.nilable(String), maiden_name: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), phone: T.nilable(String), political_exposure: T.nilable(String), registered_address: T.nilable(::Stripe::Token::CreateParams::Account::Individual::RegisteredAddress), relationship: T.nilable(::Stripe::Token::CreateParams::Account::Individual::Relationship), ssn_last_4: T.nilable(String), verification: T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification)).void
}
def initialize(
address: nil,
address_kana: nil,
address_kanji: nil,
dob: nil,
email: nil,
first_name: nil,
first_name_kana: nil,
first_name_kanji: nil,
full_name_aliases: nil,
gender: nil,
id_number: nil,
id_number_secondary: nil,
last_name: nil,
last_name_kana: nil,
last_name_kanji: nil,
maiden_name: nil,
metadata: nil,
phone: nil,
political_exposure: nil,
registered_address: nil,
relationship: nil,
ssn_last_4: nil,
verification: nil
); end
end
# The business type.
sig { returns(T.nilable(String)) }
def business_type; end
sig { params(_business_type: T.nilable(String)).returns(T.nilable(String)) }
def business_type=(_business_type); end
# Information about the company or business.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Account::Company)) }
def company; end
sig {
params(_company: T.nilable(::Stripe::Token::CreateParams::Account::Company)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Company))
}
def company=(_company); end
# Information about the person represented by the account.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual)) }
def individual; end
sig {
params(_individual: T.nilable(::Stripe::Token::CreateParams::Account::Individual)).returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual))
}
def individual=(_individual); end
# Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.
sig { returns(T.nilable(T::Boolean)) }
def tos_shown_and_accepted; end
sig {
params(_tos_shown_and_accepted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def tos_shown_and_accepted=(_tos_shown_and_accepted); end
sig {
params(business_type: T.nilable(String), company: T.nilable(::Stripe::Token::CreateParams::Account::Company), individual: T.nilable(::Stripe::Token::CreateParams::Account::Individual), tos_shown_and_accepted: T.nilable(T::Boolean)).void
}
def initialize(
business_type: nil,
company: nil,
individual: nil,
tos_shown_and_accepted: nil
); end
end
class BankAccount < Stripe::RequestParams
# The name of the person or business that owns the bank account. This field is required when attaching the bank account to a `Customer` object.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The account number for the bank account, in string form. Must be a checking account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The country in which the bank account is located.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](https://stripe.com/docs/payouts)
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The ID of a Payment Method with a `type` of `us_bank_account`. The Payment Method's bank account information will be copied and returned as a Bank Account Token. This parameter is exclusive with respect to all other parameters in the `bank_account` hash. You must include the top-level `customer` parameter if the Payment Method is attached to a `Customer` object. If the Payment Method is not attached to a `Customer` object, it will be consumed and cannot be used again. You may not use Payment Methods which were created by a Setup Intent with `attach_to_self=true`.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_name: T.nilable(String), account_holder_type: T.nilable(String), account_number: String, account_type: T.nilable(String), country: String, currency: T.nilable(String), payment_method: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_name: nil,
account_holder_type: nil,
account_number: nil,
account_type: nil,
country: nil,
currency: nil,
payment_method: nil,
routing_number: nil
); end
end
class Card < Stripe::RequestParams
class Networks < Stripe::RequestParams
# The customer's preferred card network for co-branded cards. Supports `cartes_bancaires`, `mastercard`, or `visa`. Selection of a network that does not apply to the card will be stored as `invalid_preference` on the card.
sig { returns(T.nilable(String)) }
def preferred; end
sig { params(_preferred: T.nilable(String)).returns(T.nilable(String)) }
def preferred=(_preferred); end
sig { params(preferred: T.nilable(String)).void }
def initialize(preferred: nil); end
end
# City / District / Suburb / Town / Village.
sig { returns(T.nilable(String)) }
def address_city; end
sig { params(_address_city: T.nilable(String)).returns(T.nilable(String)) }
def address_city=(_address_city); end
# Billing address country, if provided.
sig { returns(T.nilable(String)) }
def address_country; end
sig { params(_address_country: T.nilable(String)).returns(T.nilable(String)) }
def address_country=(_address_country); end
# Address line 1 (Street address / PO Box / Company name).
sig { returns(T.nilable(String)) }
def address_line1; end
sig { params(_address_line1: T.nilable(String)).returns(T.nilable(String)) }
def address_line1=(_address_line1); end
# Address line 2 (Apartment / Suite / Unit / Building).
sig { returns(T.nilable(String)) }
def address_line2; end
sig { params(_address_line2: T.nilable(String)).returns(T.nilable(String)) }
def address_line2=(_address_line2); end
# State / County / Province / Region.
sig { returns(T.nilable(String)) }
def address_state; end
sig { params(_address_state: T.nilable(String)).returns(T.nilable(String)) }
def address_state=(_address_state); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def address_zip; end
sig { params(_address_zip: T.nilable(String)).returns(T.nilable(String)) }
def address_zip=(_address_zip); end
# Required in order to add the card to an account; in all other cases, this parameter is not used. When added to an account, the card (which must be a debit card) can be used as a transfer destination for funds in this currency.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Card security code. Highly recommended to always include this value.
sig { returns(T.nilable(String)) }
def cvc; end
sig { params(_cvc: T.nilable(String)).returns(T.nilable(String)) }
def cvc=(_cvc); end
# Two-digit number representing the card's expiration month.
sig { returns(String) }
def exp_month; end
sig { params(_exp_month: String).returns(String) }
def exp_month=(_exp_month); end
# Two- or four-digit number representing the card's expiration year.
sig { returns(String) }
def exp_year; end
sig { params(_exp_year: String).returns(String) }
def exp_year=(_exp_year); end
# Cardholder's full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Contains information about card networks used to process the payment.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Card::Networks)) }
def networks; end
sig {
params(_networks: T.nilable(::Stripe::Token::CreateParams::Card::Networks)).returns(T.nilable(::Stripe::Token::CreateParams::Card::Networks))
}
def networks=(_networks); end
# The card number, as a string without any separators.
sig { returns(String) }
def number; end
sig { params(_number: String).returns(String) }
def number=(_number); end
sig {
params(address_city: T.nilable(String), address_country: T.nilable(String), address_line1: T.nilable(String), address_line2: T.nilable(String), address_state: T.nilable(String), address_zip: T.nilable(String), currency: T.nilable(String), cvc: T.nilable(String), exp_month: String, exp_year: String, name: T.nilable(String), networks: T.nilable(::Stripe::Token::CreateParams::Card::Networks), number: String).void
}
def initialize(
address_city: nil,
address_country: nil,
address_line1: nil,
address_line2: nil,
address_state: nil,
address_zip: nil,
currency: nil,
cvc: nil,
exp_month: nil,
exp_year: nil,
name: nil,
networks: nil,
number: nil
); end
end
class CvcUpdate < Stripe::RequestParams
# The CVC value, in string form.
sig { returns(String) }
def cvc; end
sig { params(_cvc: String).returns(String) }
def cvc=(_cvc); end
sig { params(cvc: String).void }
def initialize(cvc: nil); end
end
class Person < Stripe::RequestParams
class AdditionalTosAcceptances < Stripe::RequestParams
class Account < Stripe::RequestParams
# The Unix timestamp marking when the account representative accepted the service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Details on the legal guardian's acceptance of the main Stripe service agreement.
sig {
returns(T.nilable(::Stripe::Token::CreateParams::Person::AdditionalTosAcceptances::Account))
}
def account; end
sig {
params(_account: T.nilable(::Stripe::Token::CreateParams::Person::AdditionalTosAcceptances::Account)).returns(T.nilable(::Stripe::Token::CreateParams::Person::AdditionalTosAcceptances::Account))
}
def account=(_account); end
sig {
params(account: T.nilable(::Stripe::Token::CreateParams::Person::AdditionalTosAcceptances::Account)).void
}
def initialize(account: nil); end
end
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Documents < Stripe::RequestParams
class CompanyAuthorization < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class Passport < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class Visa < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
# One or more documents that demonstrate proof that this person is authorized to represent the company.
sig {
returns(T.nilable(::Stripe::Token::CreateParams::Person::Documents::CompanyAuthorization))
}
def company_authorization; end
sig {
params(_company_authorization: T.nilable(::Stripe::Token::CreateParams::Person::Documents::CompanyAuthorization)).returns(T.nilable(::Stripe::Token::CreateParams::Person::Documents::CompanyAuthorization))
}
def company_authorization=(_company_authorization); end
# One or more documents showing the person's passport page with photo and personal data.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::Documents::Passport)) }
def passport; end
sig {
params(_passport: T.nilable(::Stripe::Token::CreateParams::Person::Documents::Passport)).returns(T.nilable(::Stripe::Token::CreateParams::Person::Documents::Passport))
}
def passport=(_passport); end
# One or more documents showing the person's visa required for living in the country where they are residing.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::Documents::Visa)) }
def visa; end
sig {
params(_visa: T.nilable(::Stripe::Token::CreateParams::Person::Documents::Visa)).returns(T.nilable(::Stripe::Token::CreateParams::Person::Documents::Visa))
}
def visa=(_visa); end
sig {
params(company_authorization: T.nilable(::Stripe::Token::CreateParams::Person::Documents::CompanyAuthorization), passport: T.nilable(::Stripe::Token::CreateParams::Person::Documents::Passport), visa: T.nilable(::Stripe::Token::CreateParams::Person::Documents::Visa)).void
}
def initialize(company_authorization: nil, passport: nil, visa: nil); end
end
class RegisteredAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Relationship < Stripe::RequestParams
# Whether the person is the authorizer of the account's representative.
sig { returns(T.nilable(T::Boolean)) }
def authorizer; end
sig { params(_authorizer: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def authorizer=(_authorizer); end
# Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
sig { returns(T.nilable(T::Boolean)) }
def director; end
sig { params(_director: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def director=(_director); end
# Whether the person has significant responsibility to control, manage, or direct the organization.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
sig { params(_executive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executive=(_executive); end
# Whether the person is the legal guardian of the account's representative.
sig { returns(T.nilable(T::Boolean)) }
def legal_guardian; end
sig { params(_legal_guardian: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def legal_guardian=(_legal_guardian); end
# Whether the person is an owner of the account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
sig { params(_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owner=(_owner); end
# The percent owned by the person of the account's legal entity.
sig { returns(T.nilable(T.any(String, Float))) }
def percent_ownership; end
sig {
params(_percent_ownership: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def percent_ownership=(_percent_ownership); end
# Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
sig { returns(T.nilable(T::Boolean)) }
def representative; end
sig { params(_representative: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def representative=(_representative); end
# The person's title (e.g., CEO, Support Engineer).
sig { returns(T.nilable(String)) }
def title; end
sig { params(_title: T.nilable(String)).returns(T.nilable(String)) }
def title=(_title); end
sig {
params(authorizer: T.nilable(T::Boolean), director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), legal_guardian: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), percent_ownership: T.nilable(T.any(String, Float)), representative: T.nilable(T::Boolean), title: T.nilable(String)).void
}
def initialize(
authorizer: nil,
director: nil,
executive: nil,
legal_guardian: nil,
owner: nil,
percent_ownership: nil,
representative: nil,
title: nil
); end
end
class UsCfpbData < Stripe::RequestParams
class EthnicityDetails < Stripe::RequestParams
# The persons ethnicity
sig { returns(T.nilable(T::Array[String])) }
def ethnicity; end
sig {
params(_ethnicity: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def ethnicity=(_ethnicity); end
# Please specify your origin, when other is selected.
sig { returns(T.nilable(String)) }
def ethnicity_other; end
sig { params(_ethnicity_other: T.nilable(String)).returns(T.nilable(String)) }
def ethnicity_other=(_ethnicity_other); end
sig {
params(ethnicity: T.nilable(T::Array[String]), ethnicity_other: T.nilable(String)).void
}
def initialize(ethnicity: nil, ethnicity_other: nil); end
end
class RaceDetails < Stripe::RequestParams
# The persons race.
sig { returns(T.nilable(T::Array[String])) }
def race; end
sig { params(_race: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def race=(_race); end
# Please specify your race, when other is selected.
sig { returns(T.nilable(String)) }
def race_other; end
sig { params(_race_other: T.nilable(String)).returns(T.nilable(String)) }
def race_other=(_race_other); end
sig { params(race: T.nilable(T::Array[String]), race_other: T.nilable(String)).void }
def initialize(race: nil, race_other: nil); end
end
# The persons ethnicity details
sig {
returns(T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData::EthnicityDetails))
}
def ethnicity_details; end
sig {
params(_ethnicity_details: T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData::EthnicityDetails)).returns(T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData::EthnicityDetails))
}
def ethnicity_details=(_ethnicity_details); end
# The persons race details
sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData::RaceDetails)) }
def race_details; end
sig {
params(_race_details: T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData::RaceDetails)).returns(T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData::RaceDetails))
}
def race_details=(_race_details); end
# The persons self-identified gender
sig { returns(T.nilable(String)) }
def self_identified_gender; end
sig { params(_self_identified_gender: T.nilable(String)).returns(T.nilable(String)) }
def self_identified_gender=(_self_identified_gender); end
sig {
params(ethnicity_details: T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData::EthnicityDetails), race_details: T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData::RaceDetails), self_identified_gender: T.nilable(String)).void
}
def initialize(
ethnicity_details: nil,
race_details: nil,
self_identified_gender: nil
); end
end
class Verification < Stripe::RequestParams
class AdditionalDocument < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
class Document < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig {
returns(T.nilable(::Stripe::Token::CreateParams::Person::Verification::AdditionalDocument))
}
def additional_document; end
sig {
params(_additional_document: T.nilable(::Stripe::Token::CreateParams::Person::Verification::AdditionalDocument)).returns(T.nilable(::Stripe::Token::CreateParams::Person::Verification::AdditionalDocument))
}
def additional_document=(_additional_document); end
# An identifying document, either a passport or local ID card.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::Verification::Document)) }
def document; end
sig {
params(_document: T.nilable(::Stripe::Token::CreateParams::Person::Verification::Document)).returns(T.nilable(::Stripe::Token::CreateParams::Person::Verification::Document))
}
def document=(_document); end
sig {
params(additional_document: T.nilable(::Stripe::Token::CreateParams::Person::Verification::AdditionalDocument), document: T.nilable(::Stripe::Token::CreateParams::Person::Verification::Document)).void
}
def initialize(additional_document: nil, document: nil); end
end
# Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::AdditionalTosAcceptances)) }
def additional_tos_acceptances; end
sig {
params(_additional_tos_acceptances: T.nilable(::Stripe::Token::CreateParams::Person::AdditionalTosAcceptances)).returns(T.nilable(::Stripe::Token::CreateParams::Person::AdditionalTosAcceptances))
}
def additional_tos_acceptances=(_additional_tos_acceptances); end
# The person's address.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::Token::CreateParams::Person::Address)).returns(T.nilable(::Stripe::Token::CreateParams::Person::Address))
}
def address=(_address); end
# The Kana variation of the person's address (Japan only).
sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::Token::CreateParams::Person::AddressKana)).returns(T.nilable(::Stripe::Token::CreateParams::Person::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the person's address (Japan only).
sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::Token::CreateParams::Person::AddressKanji)).returns(T.nilable(::Stripe::Token::CreateParams::Person::AddressKanji))
}
def address_kanji=(_address_kanji); end
# The person's date of birth.
sig { returns(T.nilable(T.any(String, ::Stripe::Token::CreateParams::Person::Dob))) }
def dob; end
sig {
params(_dob: T.nilable(T.any(String, ::Stripe::Token::CreateParams::Person::Dob))).returns(T.nilable(T.any(String, ::Stripe::Token::CreateParams::Person::Dob)))
}
def dob=(_dob); end
# Documents that may be submitted to satisfy various informational requests.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::Documents)) }
def documents; end
sig {
params(_documents: T.nilable(::Stripe::Token::CreateParams::Person::Documents)).returns(T.nilable(::Stripe::Token::CreateParams::Person::Documents))
}
def documents=(_documents); end
# The person's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The person's first name.
sig { returns(T.nilable(String)) }
def first_name; end
sig { params(_first_name: T.nilable(String)).returns(T.nilable(String)) }
def first_name=(_first_name); end
# The Kana variation of the person's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kana; end
sig { params(_first_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kana=(_first_name_kana); end
# The Kanji variation of the person's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kanji; end
sig { params(_first_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kanji=(_first_name_kanji); end
# A list of alternate names or aliases that the person is known by.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def full_name_aliases; end
sig {
params(_full_name_aliases: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def full_name_aliases=(_full_name_aliases); end
# The person's gender (International regulations require either "male" or "female").
sig { returns(T.nilable(String)) }
def gender; end
sig { params(_gender: T.nilable(String)).returns(T.nilable(String)) }
def gender=(_gender); end
# The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number; end
sig { params(_id_number: T.nilable(String)).returns(T.nilable(String)) }
def id_number=(_id_number); end
# The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number_secondary; end
sig { params(_id_number_secondary: T.nilable(String)).returns(T.nilable(String)) }
def id_number_secondary=(_id_number_secondary); end
# The person's last name.
sig { returns(T.nilable(String)) }
def last_name; end
sig { params(_last_name: T.nilable(String)).returns(T.nilable(String)) }
def last_name=(_last_name); end
# The Kana variation of the person's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kana; end
sig { params(_last_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kana=(_last_name_kana); end
# The Kanji variation of the person's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kanji; end
sig { params(_last_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kanji=(_last_name_kanji); end
# The person's maiden name.
sig { returns(T.nilable(String)) }
def maiden_name; end
sig { params(_maiden_name: T.nilable(String)).returns(T.nilable(String)) }
def maiden_name=(_maiden_name); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable.
sig { returns(T.nilable(String)) }
def nationality; end
sig { params(_nationality: T.nilable(String)).returns(T.nilable(String)) }
def nationality=(_nationality); end
# The person's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
sig { returns(T.nilable(String)) }
def political_exposure; end
sig { params(_political_exposure: T.nilable(String)).returns(T.nilable(String)) }
def political_exposure=(_political_exposure); end
# The person's registered address.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::RegisteredAddress)) }
def registered_address; end
sig {
params(_registered_address: T.nilable(::Stripe::Token::CreateParams::Person::RegisteredAddress)).returns(T.nilable(::Stripe::Token::CreateParams::Person::RegisteredAddress))
}
def registered_address=(_registered_address); end
# The relationship that this person has with the account's legal entity.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::Relationship)) }
def relationship; end
sig {
params(_relationship: T.nilable(::Stripe::Token::CreateParams::Person::Relationship)).returns(T.nilable(::Stripe::Token::CreateParams::Person::Relationship))
}
def relationship=(_relationship); end
# The last four digits of the person's Social Security number (U.S. only).
sig { returns(T.nilable(String)) }
def ssn_last_4; end
sig { params(_ssn_last_4: T.nilable(String)).returns(T.nilable(String)) }
def ssn_last_4=(_ssn_last_4); end
# Demographic data related to the person.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData)) }
def us_cfpb_data; end
sig {
params(_us_cfpb_data: T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData)).returns(T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData))
}
def us_cfpb_data=(_us_cfpb_data); end
# The person's verification status.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::Verification)) }
def verification; end
sig {
params(_verification: T.nilable(::Stripe::Token::CreateParams::Person::Verification)).returns(T.nilable(::Stripe::Token::CreateParams::Person::Verification))
}
def verification=(_verification); end
sig {
params(additional_tos_acceptances: T.nilable(::Stripe::Token::CreateParams::Person::AdditionalTosAcceptances), address: T.nilable(::Stripe::Token::CreateParams::Person::Address), address_kana: T.nilable(::Stripe::Token::CreateParams::Person::AddressKana), address_kanji: T.nilable(::Stripe::Token::CreateParams::Person::AddressKanji), dob: T.nilable(T.any(String, ::Stripe::Token::CreateParams::Person::Dob)), documents: T.nilable(::Stripe::Token::CreateParams::Person::Documents), email: T.nilable(String), first_name: T.nilable(String), first_name_kana: T.nilable(String), first_name_kanji: T.nilable(String), full_name_aliases: T.nilable(T.any(String, T::Array[String])), gender: T.nilable(String), id_number: T.nilable(String), id_number_secondary: T.nilable(String), last_name: T.nilable(String), last_name_kana: T.nilable(String), last_name_kanji: T.nilable(String), maiden_name: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), nationality: T.nilable(String), phone: T.nilable(String), political_exposure: T.nilable(String), registered_address: T.nilable(::Stripe::Token::CreateParams::Person::RegisteredAddress), relationship: T.nilable(::Stripe::Token::CreateParams::Person::Relationship), ssn_last_4: T.nilable(String), us_cfpb_data: T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData), verification: T.nilable(::Stripe::Token::CreateParams::Person::Verification)).void
}
def initialize(
additional_tos_acceptances: nil,
address: nil,
address_kana: nil,
address_kanji: nil,
dob: nil,
documents: nil,
email: nil,
first_name: nil,
first_name_kana: nil,
first_name_kanji: nil,
full_name_aliases: nil,
gender: nil,
id_number: nil,
id_number_secondary: nil,
last_name: nil,
last_name_kana: nil,
last_name_kanji: nil,
maiden_name: nil,
metadata: nil,
nationality: nil,
phone: nil,
political_exposure: nil,
registered_address: nil,
relationship: nil,
ssn_last_4: nil,
us_cfpb_data: nil,
verification: nil
); end
end
class Pii < Stripe::RequestParams
# The `id_number` for the PII, in string form.
sig { returns(T.nilable(String)) }
def id_number; end
sig { params(_id_number: T.nilable(String)).returns(T.nilable(String)) }
def id_number=(_id_number); end
sig { params(id_number: T.nilable(String)).void }
def initialize(id_number: nil); end
end
# Information for the account this token represents.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Account)) }
def account; end
sig {
params(_account: T.nilable(::Stripe::Token::CreateParams::Account)).returns(T.nilable(::Stripe::Token::CreateParams::Account))
}
def account=(_account); end
# The bank account this token will represent.
sig { returns(T.nilable(::Stripe::Token::CreateParams::BankAccount)) }
def bank_account; end
sig {
params(_bank_account: T.nilable(::Stripe::Token::CreateParams::BankAccount)).returns(T.nilable(::Stripe::Token::CreateParams::BankAccount))
}
def bank_account=(_bank_account); end
# The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user's credit card details, with the options described below.
sig { returns(T.nilable(T.any(::Stripe::Token::CreateParams::Card, String))) }
def card; end
sig {
params(_card: T.nilable(T.any(::Stripe::Token::CreateParams::Card, String))).returns(T.nilable(T.any(::Stripe::Token::CreateParams::Card, String)))
}
def card=(_card); end
# Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). Learn more about [cloning saved payment methods](https://stripe.com/docs/connect/cloning-saved-payment-methods).
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The updated CVC value this token represents.
sig { returns(T.nilable(::Stripe::Token::CreateParams::CvcUpdate)) }
def cvc_update; end
sig {
params(_cvc_update: T.nilable(::Stripe::Token::CreateParams::CvcUpdate)).returns(T.nilable(::Stripe::Token::CreateParams::CvcUpdate))
}
def cvc_update=(_cvc_update); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Information for the person this token represents.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Person)) }
def person; end
sig {
params(_person: T.nilable(::Stripe::Token::CreateParams::Person)).returns(T.nilable(::Stripe::Token::CreateParams::Person))
}
def person=(_person); end
# The PII this token represents.
sig { returns(T.nilable(::Stripe::Token::CreateParams::Pii)) }
def pii; end
sig {
params(_pii: T.nilable(::Stripe::Token::CreateParams::Pii)).returns(T.nilable(::Stripe::Token::CreateParams::Pii))
}
def pii=(_pii); end
sig {
params(account: T.nilable(::Stripe::Token::CreateParams::Account), bank_account: T.nilable(::Stripe::Token::CreateParams::BankAccount), card: T.nilable(T.any(::Stripe::Token::CreateParams::Card, String)), customer: T.nilable(String), cvc_update: T.nilable(::Stripe::Token::CreateParams::CvcUpdate), expand: T.nilable(T::Array[String]), person: T.nilable(::Stripe::Token::CreateParams::Person), pii: T.nilable(::Stripe::Token::CreateParams::Pii)).void
}
def initialize(
account: nil,
bank_account: nil,
card: nil,
customer: nil,
cvc_update: nil,
expand: nil,
person: nil,
pii: nil
); end
end
# Creates a single-use token that represents a bank account's details.
# You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://docs.stripe.com/api#accounts) where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts.
sig {
params(params: T.any(::Stripe::Token::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Token)
}
def self.create(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# To top up your Stripe balance, you create a top-up object. You can retrieve
# individual top-ups, as well as list all top-ups. Top-ups are identified by a
# unique, random ID.
#
# Related guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups)
class Topup < APIResource
# Amount transferred.
sig { returns(Integer) }
def amount; end
# ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.
sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
def balance_transaction; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.
sig { returns(T.nilable(Integer)) }
def expected_availability_date; end
# Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes).
sig { returns(T.nilable(String)) }
def failure_code; end
# Message to user further explaining reason for top-up failure if available.
sig { returns(T.nilable(String)) }
def failure_message; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The source field is deprecated. It might not always be present in the API response.
sig { returns(T.nilable(Stripe::Source)) }
def source; end
# Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
# The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.
sig { returns(String) }
def status; end
# A string that identifies this top-up as part of a group.
sig { returns(T.nilable(String)) }
def transfer_group; end
class ListParams < Stripe::RequestParams
class Amount < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# A positive integer representing how much to transfer.
sig { returns(T.nilable(T.any(::Stripe::Topup::ListParams::Amount, Integer))) }
def amount; end
sig {
params(_amount: T.nilable(T.any(::Stripe::Topup::ListParams::Amount, Integer))).returns(T.nilable(T.any(::Stripe::Topup::ListParams::Amount, Integer)))
}
def amount=(_amount); end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
sig { returns(T.nilable(T.any(::Stripe::Topup::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Topup::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Topup::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(amount: T.nilable(T.any(::Stripe::Topup::ListParams::Amount, Integer)), created: T.nilable(T.any(::Stripe::Topup::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
amount: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
# A positive integer representing how much to transfer.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)).
sig { returns(T.nilable(String)) }
def source; end
sig { params(_source: T.nilable(String)).returns(T.nilable(String)) }
def source=(_source); end
# Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# A string that identifies this top-up as part of a group.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(amount: Integer, currency: String, description: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), source: T.nilable(String), statement_descriptor: T.nilable(String), transfer_group: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
expand: nil,
metadata: nil,
source: nil,
statement_descriptor: nil,
transfer_group: nil
); end
end
class UpdateParams < Stripe::RequestParams
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(description: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(description: nil, expand: nil, metadata: nil); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Cancels a top-up. Only pending top-ups can be canceled.
sig {
params(params: T.any(::Stripe::Topup::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Topup)
}
def cancel(params = {}, opts = {}); end
# Cancels a top-up. Only pending top-ups can be canceled.
sig {
params(topup: String, params: T.any(::Stripe::Topup::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Topup)
}
def self.cancel(topup, params = {}, opts = {}); end
# Top up the balance of an account
sig {
params(params: T.any(::Stripe::Topup::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Topup)
}
def self.create(params = {}, opts = {}); end
# Returns a list of top-ups.
sig {
params(params: T.any(::Stripe::Topup::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates the metadata of a top-up. Other top-up details are not editable by design.
sig {
params(topup: String, params: T.any(::Stripe::Topup::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Topup)
}
def self.update(topup, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
# A `Transfer` object is created when you move funds between Stripe accounts as
# part of Connect.
#
# Before April 6, 2017, transfers also represented movement of funds from a
# Stripe account to a card or bank account. This behavior has since been split
# out into a [Payout](https://stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more
# information, read about the
# [transfer/payout split](https://stripe.com/docs/transfer-payout-split).
#
# Related guide: [Creating separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers)
class Transfer < APIResource
# Amount in cents (or local equivalent) to be transferred.
sig { returns(Integer) }
def amount; end
# Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).
sig { returns(Integer) }
def amount_reversed; end
# Balance transaction that describes the impact of this transfer on your account balance.
sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
def balance_transaction; end
# Time that this record of the transfer was first created.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# ID of the Stripe account the transfer was sent to.
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
def destination; end
# If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.
sig { returns(T.nilable(T.any(String, Stripe::Charge))) }
def destination_payment; end
# The FX Quote used for the transfer.
sig { returns(T.nilable(String)) }
def fx_quote; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# A list of reversals that have been applied to the transfer.
sig { returns(Stripe::ListObject) }
def reversals; end
# Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.
sig { returns(T::Boolean) }
def reversed; end
# ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.
sig { returns(T.nilable(T.any(String, Stripe::Charge))) }
def source_transaction; end
# The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.
sig { returns(T.nilable(String)) }
def source_type; end
# A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
sig { returns(T.nilable(String)) }
def transfer_group; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return transfers that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::Transfer::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Transfer::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Transfer::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return transfers for the destination specified by this account ID.
sig { returns(T.nilable(String)) }
def destination; end
sig { params(_destination: T.nilable(String)).returns(T.nilable(String)) }
def destination=(_destination); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return transfers with the specified transfer group.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(created: T.nilable(T.any(::Stripe::Transfer::ListParams::Created, Integer)), destination: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), transfer_group: T.nilable(String)).void
}
def initialize(
created: nil,
destination: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
transfer_group: nil
); end
end
class CreateParams < Stripe::RequestParams
# A positive integer in cents (or local equivalent) representing how much to transfer.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies).
sig { returns(String) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The ID of a connected Stripe account. See the Connect documentation for details.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FX rate in the quote is validated and used to convert the transfer amount to the destination currency.
sig { returns(T.nilable(String)) }
def fx_quote; end
sig { params(_fx_quote: T.nilable(String)).returns(T.nilable(String)) }
def fx_quote=(_fx_quote); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details.
sig { returns(T.nilable(String)) }
def source_transaction; end
sig { params(_source_transaction: T.nilable(String)).returns(T.nilable(String)) }
def source_transaction=(_source_transaction); end
# The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`.
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
# A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(amount: T.nilable(Integer), currency: String, description: T.nilable(String), destination: String, expand: T.nilable(T::Array[String]), fx_quote: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), source_transaction: T.nilable(String), source_type: T.nilable(String), transfer_group: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
destination: nil,
expand: nil,
fx_quote: nil,
metadata: nil,
source_transaction: nil,
source_type: nil,
transfer_group: nil
); end
end
class UpdateParams < Stripe::RequestParams
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(description: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(description: nil, expand: nil, metadata: nil); end
end
# To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://docs.stripe.com/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.
sig {
params(params: T.any(::Stripe::Transfer::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Transfer)
}
def self.create(params = {}, opts = {}); end
# Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.
sig {
params(params: T.any(::Stripe::Transfer::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
#
# This request accepts only metadata as an argument.
sig {
params(transfer: String, params: T.any(::Stripe::Transfer::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Transfer)
}
def self.update(transfer, params = {}, opts = {}); end
end
end
# typed: 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://docs.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/separate-charges-and-transfers#transfer-options)
# transfer only if the destination account has enough balance to cover the
# reversal.
#
# Related guide: [Reverse transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers)
class Reversal < APIResource
# Amount, in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
# Balance transaction that describes the impact on your account balance.
sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
def balance_transaction; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# Linked payment refund for the transfer reversal.
sig { returns(T.nilable(T.any(String, Stripe::Refund))) }
def destination_payment_refund; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# ID of the refund responsible for the transfer reversal.
sig { returns(T.nilable(T.any(String, Stripe::Refund))) }
def source_refund; end
# ID of the transfer that was reversed.
sig { returns(T.any(String, Stripe::Transfer)) }
def transfer; end
end
end
# typed: true
module Stripe
module Treasury
# You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
class CreditReversal < APIResource
class StatusTransitions < Stripe::StripeObject
# Timestamp describing when the CreditReversal changed status to `posted`
sig { returns(T.nilable(Integer)) }
def posted_at; end
end
# Amount (in cents) transferred.
sig { returns(Integer) }
def amount; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# The FinancialAccount to reverse funds from.
sig { returns(String) }
def financial_account; end
# A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
sig { returns(T.nilable(String)) }
def hosted_regulatory_receipt_url; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# The rails used to reverse the funds.
sig { returns(String) }
def network; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The ReceivedCredit being reversed.
sig { returns(String) }
def received_credit; end
# Status of the CreditReversal
sig { returns(String) }
def status; end
# Attribute for field status_transitions
sig { returns(StatusTransitions) }
def status_transitions; end
# The Transaction associated with this object.
sig { returns(T.nilable(T.any(String, Stripe::Treasury::Transaction))) }
def transaction; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Returns objects associated with this FinancialAccount.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return CreditReversals for the ReceivedCredit ID.
sig { returns(T.nilable(String)) }
def received_credit; end
sig { params(_received_credit: T.nilable(String)).returns(T.nilable(String)) }
def received_credit=(_received_credit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return CreditReversals for a given status.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), received_credit: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
received_credit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ReceivedCredit to reverse.
sig { returns(String) }
def received_credit; end
sig { params(_received_credit: String).returns(String) }
def received_credit=(_received_credit); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), received_credit: String).void
}
def initialize(expand: nil, metadata: nil, received_credit: nil); end
end
# Reverses a ReceivedCredit and creates a CreditReversal object.
sig {
params(params: T.any(::Stripe::Treasury::CreditReversal::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::CreditReversal)
}
def self.create(params = {}, opts = {}); end
# Returns a list of CreditReversals.
sig {
params(params: T.any(::Stripe::Treasury::CreditReversal::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
# You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
class DebitReversal < APIResource
class LinkedFlows < Stripe::StripeObject
# Set if there is an Issuing dispute associated with the DebitReversal.
sig { returns(T.nilable(String)) }
def issuing_dispute; end
end
class StatusTransitions < Stripe::StripeObject
# Timestamp describing when the DebitReversal changed status to `completed`.
sig { returns(T.nilable(Integer)) }
def completed_at; end
end
# Amount (in cents) transferred.
sig { returns(Integer) }
def amount; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# The FinancialAccount to reverse funds from.
sig { returns(T.nilable(String)) }
def financial_account; end
# A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
sig { returns(T.nilable(String)) }
def hosted_regulatory_receipt_url; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Other flows linked to a DebitReversal.
sig { returns(T.nilable(LinkedFlows)) }
def linked_flows; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# The rails used to reverse the funds.
sig { returns(String) }
def network; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The ReceivedDebit being reversed.
sig { returns(String) }
def received_debit; end
# Status of the DebitReversal
sig { returns(String) }
def status; end
# Attribute for field status_transitions
sig { returns(StatusTransitions) }
def status_transitions; end
# The Transaction associated with this object.
sig { returns(T.nilable(T.any(String, Stripe::Treasury::Transaction))) }
def transaction; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Returns objects associated with this FinancialAccount.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return DebitReversals for the ReceivedDebit ID.
sig { returns(T.nilable(String)) }
def received_debit; end
sig { params(_received_debit: T.nilable(String)).returns(T.nilable(String)) }
def received_debit=(_received_debit); end
# Only return DebitReversals for a given resolution.
sig { returns(T.nilable(String)) }
def resolution; end
sig { params(_resolution: T.nilable(String)).returns(T.nilable(String)) }
def resolution=(_resolution); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return DebitReversals for a given status.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), received_debit: T.nilable(String), resolution: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
received_debit: nil,
resolution: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ReceivedDebit to reverse.
sig { returns(String) }
def received_debit; end
sig { params(_received_debit: String).returns(String) }
def received_debit=(_received_debit); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), received_debit: String).void
}
def initialize(expand: nil, metadata: nil, received_debit: nil); end
end
# Reverses a ReceivedDebit and creates a DebitReversal object.
sig {
params(params: T.any(::Stripe::Treasury::DebitReversal::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::DebitReversal)
}
def self.create(params = {}, opts = {}); end
# Returns a list of DebitReversals.
sig {
params(params: T.any(::Stripe::Treasury::DebitReversal::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
# Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance.
# FinancialAccounts serve as the source and destination of Treasury's money movement APIs.
class FinancialAccount < APIResource
class Balance < Stripe::StripeObject
# Funds the user can spend right now.
sig { returns(T::Hash[String, Integer]) }
def cash; end
# Funds not spendable yet, but will become available at a later time.
sig { returns(T::Hash[String, Integer]) }
def inbound_pending; end
# Funds in the account, but not spendable because they are being held for pending outbound flows.
sig { returns(T::Hash[String, Integer]) }
def outbound_pending; end
end
class FinancialAddress < Stripe::StripeObject
class Aba < Stripe::StripeObject
# The name of the person or business that owns the bank account.
sig { returns(String) }
def account_holder_name; end
# The account number.
sig { returns(T.nilable(String)) }
def account_number; end
# The last four characters of the account number.
sig { returns(String) }
def account_number_last4; end
# Name of the bank.
sig { returns(String) }
def bank_name; end
# Routing number for the account.
sig { returns(String) }
def routing_number; end
end
# ABA Records contain U.S. bank account details per the ABA format.
sig { returns(T.nilable(Aba)) }
def aba; end
# The list of networks that the address supports
sig { returns(T.nilable(T::Array[String])) }
def supported_networks; end
# The type of financial address
sig { returns(String) }
def type; end
end
class PlatformRestrictions < Stripe::StripeObject
# Restricts all inbound money movement.
sig { returns(T.nilable(String)) }
def inbound_flows; end
# Restricts all outbound money movement.
sig { returns(T.nilable(String)) }
def outbound_flows; end
end
class StatusDetails < Stripe::StripeObject
class Closed < Stripe::StripeObject
# The array that contains reasons for a FinancialAccount closure.
sig { returns(T::Array[String]) }
def reasons; end
end
# Details related to the closure of this FinancialAccount
sig { returns(T.nilable(Closed)) }
def closed; end
end
# The array of paths to active Features in the Features hash.
sig { returns(T.nilable(T::Array[String])) }
def active_features; end
# Balance information for the FinancialAccount
sig { returns(Balance) }
def balance; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
sig { returns(T.nilable(String)) }
def display_name; end
# Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.
# Stripe or the platform can control Features via the requested field.
sig { returns(T.nilable(Stripe::Treasury::FinancialAccountFeatures)) }
def features; end
# The set of credentials that resolve to a FinancialAccount.
sig { returns(T::Array[FinancialAddress]) }
def financial_addresses; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Attribute for field is_default
sig { returns(T.nilable(T::Boolean)) }
def is_default; end
# 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) }
def livemode; end
# 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])) }
def metadata; end
# The nickname for the FinancialAccount.
sig { returns(T.nilable(String)) }
def nickname; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The array of paths to pending Features in the Features hash.
sig { returns(T.nilable(T::Array[String])) }
def pending_features; end
# The set of functionalities that the platform can restrict on the FinancialAccount.
sig { returns(T.nilable(PlatformRestrictions)) }
def platform_restrictions; end
# The array of paths to restricted Features in the Features hash.
sig { returns(T.nilable(T::Array[String])) }
def restricted_features; end
# Status of this FinancialAccount.
sig { returns(String) }
def status; end
# Attribute for field status_details
sig { returns(StatusDetails) }
def status_details; end
# The currencies the FinancialAccount can hold a balance in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
sig { returns(T::Array[String]) }
def supported_currencies; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return FinancialAccounts that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Treasury::FinancialAccount::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Treasury::FinancialAccount::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Treasury::FinancialAccount::ListParams::Created, Integer)))
}
def created=(_created); end
# An object ID cursor for use in pagination.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit ranging from 1 to 100 (defaults to 10).
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# An object ID cursor for use in pagination.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return FinancialAccounts that have the given status: `open` or `closed`
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(created: T.nilable(T.any(::Stripe::Treasury::FinancialAccount::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class Features < Stripe::RequestParams
class CardIssuing < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class DepositInsurance < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class FinancialAddresses < Stripe::RequestParams
class Aba < Stripe::RequestParams
# Requested bank partner
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(bank: T.nilable(String), requested: T::Boolean).void }
def initialize(bank: nil, requested: nil); end
end
# Adds an ABA FinancialAddress to the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::FinancialAddresses::Aba))
}
def aba; end
sig {
params(_aba: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::FinancialAddresses::Aba)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::FinancialAddresses::Aba))
}
def aba=(_aba); end
sig {
params(aba: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::FinancialAddresses::Aba)).void
}
def initialize(aba: nil); end
end
class InboundTransfers < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH Debits via the InboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::InboundTransfers::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::InboundTransfers::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::InboundTransfers::Ach))
}
def ach=(_ach); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::InboundTransfers::Ach)).void
}
def initialize(ach: nil); end
end
class IntraStripeFlows < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class OutboundPayments < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class UsDomesticWire < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH transfers via the OutboundPayments API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundPayments::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundPayments::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundPayments::Ach))
}
def ach=(_ach); end
# Enables US domestic wire transfers via the OutboundPayments API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundPayments::UsDomesticWire))
}
def us_domestic_wire; end
sig {
params(_us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundPayments::UsDomesticWire)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundPayments::UsDomesticWire))
}
def us_domestic_wire=(_us_domestic_wire); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundPayments::Ach), us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundPayments::UsDomesticWire)).void
}
def initialize(ach: nil, us_domestic_wire: nil); end
end
class OutboundTransfers < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class UsDomesticWire < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH transfers via the OutboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundTransfers::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundTransfers::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundTransfers::Ach))
}
def ach=(_ach); end
# Enables US domestic wire transfers via the OutboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundTransfers::UsDomesticWire))
}
def us_domestic_wire; end
sig {
params(_us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundTransfers::UsDomesticWire)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundTransfers::UsDomesticWire))
}
def us_domestic_wire=(_us_domestic_wire); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundTransfers::Ach), us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundTransfers::UsDomesticWire)).void
}
def initialize(ach: nil, us_domestic_wire: nil); end
end
# Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::CardIssuing))
}
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::CardIssuing)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::CardIssuing))
}
def card_issuing=(_card_issuing); end
# Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::DepositInsurance))
}
def deposit_insurance; end
sig {
params(_deposit_insurance: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::DepositInsurance)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::DepositInsurance))
}
def deposit_insurance=(_deposit_insurance); end
# Contains Features that add FinancialAddresses to the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::FinancialAddresses))
}
def financial_addresses; end
sig {
params(_financial_addresses: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::FinancialAddresses)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::FinancialAddresses))
}
def financial_addresses=(_financial_addresses); end
# Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::InboundTransfers))
}
def inbound_transfers; end
sig {
params(_inbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::InboundTransfers)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::InboundTransfers))
}
def inbound_transfers=(_inbound_transfers); end
# Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::IntraStripeFlows))
}
def intra_stripe_flows; end
sig {
params(_intra_stripe_flows: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::IntraStripeFlows)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::IntraStripeFlows))
}
def intra_stripe_flows=(_intra_stripe_flows); end
# Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundPayments))
}
def outbound_payments; end
sig {
params(_outbound_payments: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundPayments)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundPayments))
}
def outbound_payments=(_outbound_payments); end
# Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundTransfers))
}
def outbound_transfers; end
sig {
params(_outbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundTransfers)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundTransfers))
}
def outbound_transfers=(_outbound_transfers); end
sig {
params(card_issuing: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::CardIssuing), deposit_insurance: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::DepositInsurance), financial_addresses: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::FinancialAddresses), inbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::InboundTransfers), intra_stripe_flows: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::IntraStripeFlows), outbound_payments: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundPayments), outbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features::OutboundTransfers)).void
}
def initialize(
card_issuing: nil,
deposit_insurance: nil,
financial_addresses: nil,
inbound_transfers: nil,
intra_stripe_flows: nil,
outbound_payments: nil,
outbound_transfers: nil
); end
end
class PlatformRestrictions < Stripe::RequestParams
# Restricts all inbound money movement.
sig { returns(T.nilable(String)) }
def inbound_flows; end
sig { params(_inbound_flows: T.nilable(String)).returns(T.nilable(String)) }
def inbound_flows=(_inbound_flows); end
# Restricts all outbound money movement.
sig { returns(T.nilable(String)) }
def outbound_flows; end
sig { params(_outbound_flows: T.nilable(String)).returns(T.nilable(String)) }
def outbound_flows=(_outbound_flows); end
sig { params(inbound_flows: T.nilable(String), outbound_flows: T.nilable(String)).void }
def initialize(inbound_flows: nil, outbound_flows: nil); end
end
# The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field.
sig { returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features)) }
def features; end
sig {
params(_features: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features))
}
def features=(_features); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The nickname for the FinancialAccount.
sig { returns(T.nilable(String)) }
def nickname; end
sig { params(_nickname: T.nilable(String)).returns(T.nilable(String)) }
def nickname=(_nickname); end
# The set of functionalities that the platform can restrict on the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::PlatformRestrictions))
}
def platform_restrictions; end
sig {
params(_platform_restrictions: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::PlatformRestrictions)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::PlatformRestrictions))
}
def platform_restrictions=(_platform_restrictions); end
# The currencies the FinancialAccount can hold a balance in.
sig { returns(T::Array[String]) }
def supported_currencies; end
sig { params(_supported_currencies: T::Array[String]).returns(T::Array[String]) }
def supported_currencies=(_supported_currencies); end
sig {
params(display_name: T.nilable(String), expand: T.nilable(T::Array[String]), features: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::Features), metadata: T.nilable(T::Hash[String, String]), nickname: T.nilable(String), platform_restrictions: T.nilable(::Stripe::Treasury::FinancialAccount::CreateParams::PlatformRestrictions), supported_currencies: T::Array[String]).void
}
def initialize(
display_name: nil,
expand: nil,
features: nil,
metadata: nil,
nickname: nil,
platform_restrictions: nil,
supported_currencies: nil
); end
end
class UpdateParams < Stripe::RequestParams
class Features < Stripe::RequestParams
class CardIssuing < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class DepositInsurance < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class FinancialAddresses < Stripe::RequestParams
class Aba < Stripe::RequestParams
# Requested bank partner
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(bank: T.nilable(String), requested: T::Boolean).void }
def initialize(bank: nil, requested: nil); end
end
# Adds an ABA FinancialAddress to the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::FinancialAddresses::Aba))
}
def aba; end
sig {
params(_aba: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::FinancialAddresses::Aba)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::FinancialAddresses::Aba))
}
def aba=(_aba); end
sig {
params(aba: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::FinancialAddresses::Aba)).void
}
def initialize(aba: nil); end
end
class InboundTransfers < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH Debits via the InboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::InboundTransfers::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::InboundTransfers::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::InboundTransfers::Ach))
}
def ach=(_ach); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::InboundTransfers::Ach)).void
}
def initialize(ach: nil); end
end
class IntraStripeFlows < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class OutboundPayments < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class UsDomesticWire < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH transfers via the OutboundPayments API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundPayments::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundPayments::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundPayments::Ach))
}
def ach=(_ach); end
# Enables US domestic wire transfers via the OutboundPayments API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundPayments::UsDomesticWire))
}
def us_domestic_wire; end
sig {
params(_us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundPayments::UsDomesticWire)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundPayments::UsDomesticWire))
}
def us_domestic_wire=(_us_domestic_wire); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundPayments::Ach), us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundPayments::UsDomesticWire)).void
}
def initialize(ach: nil, us_domestic_wire: nil); end
end
class OutboundTransfers < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class UsDomesticWire < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH transfers via the OutboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundTransfers::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundTransfers::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundTransfers::Ach))
}
def ach=(_ach); end
# Enables US domestic wire transfers via the OutboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundTransfers::UsDomesticWire))
}
def us_domestic_wire; end
sig {
params(_us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundTransfers::UsDomesticWire)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundTransfers::UsDomesticWire))
}
def us_domestic_wire=(_us_domestic_wire); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundTransfers::Ach), us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundTransfers::UsDomesticWire)).void
}
def initialize(ach: nil, us_domestic_wire: nil); end
end
# Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::CardIssuing))
}
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::CardIssuing)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::CardIssuing))
}
def card_issuing=(_card_issuing); end
# Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::DepositInsurance))
}
def deposit_insurance; end
sig {
params(_deposit_insurance: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::DepositInsurance)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::DepositInsurance))
}
def deposit_insurance=(_deposit_insurance); end
# Contains Features that add FinancialAddresses to the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::FinancialAddresses))
}
def financial_addresses; end
sig {
params(_financial_addresses: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::FinancialAddresses)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::FinancialAddresses))
}
def financial_addresses=(_financial_addresses); end
# Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::InboundTransfers))
}
def inbound_transfers; end
sig {
params(_inbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::InboundTransfers)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::InboundTransfers))
}
def inbound_transfers=(_inbound_transfers); end
# Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::IntraStripeFlows))
}
def intra_stripe_flows; end
sig {
params(_intra_stripe_flows: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::IntraStripeFlows)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::IntraStripeFlows))
}
def intra_stripe_flows=(_intra_stripe_flows); end
# Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundPayments))
}
def outbound_payments; end
sig {
params(_outbound_payments: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundPayments)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundPayments))
}
def outbound_payments=(_outbound_payments); end
# Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundTransfers))
}
def outbound_transfers; end
sig {
params(_outbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundTransfers)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundTransfers))
}
def outbound_transfers=(_outbound_transfers); end
sig {
params(card_issuing: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::CardIssuing), deposit_insurance: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::DepositInsurance), financial_addresses: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::FinancialAddresses), inbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::InboundTransfers), intra_stripe_flows: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::IntraStripeFlows), outbound_payments: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundPayments), outbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features::OutboundTransfers)).void
}
def initialize(
card_issuing: nil,
deposit_insurance: nil,
financial_addresses: nil,
inbound_transfers: nil,
intra_stripe_flows: nil,
outbound_payments: nil,
outbound_transfers: nil
); end
end
class ForwardingSettings < Stripe::RequestParams
# The financial_account id
sig { returns(T.nilable(String)) }
def financial_account; end
sig { params(_financial_account: T.nilable(String)).returns(T.nilable(String)) }
def financial_account=(_financial_account); end
# The payment_method or bank account id. This needs to be a verified bank account.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The type of the bank account provided. This can be either "financial_account" or "payment_method"
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(financial_account: T.nilable(String), payment_method: T.nilable(String), type: String).void
}
def initialize(financial_account: nil, payment_method: nil, type: nil); end
end
class PlatformRestrictions < Stripe::RequestParams
# Restricts all inbound money movement.
sig { returns(T.nilable(String)) }
def inbound_flows; end
sig { params(_inbound_flows: T.nilable(String)).returns(T.nilable(String)) }
def inbound_flows=(_inbound_flows); end
# Restricts all outbound money movement.
sig { returns(T.nilable(String)) }
def outbound_flows; end
sig { params(_outbound_flows: T.nilable(String)).returns(T.nilable(String)) }
def outbound_flows=(_outbound_flows); end
sig { params(inbound_flows: T.nilable(String), outbound_flows: T.nilable(String)).void }
def initialize(inbound_flows: nil, outbound_flows: nil); end
end
# The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated `status_details`. Stripe or the platform may control features via the requested field.
sig { returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features)) }
def features; end
sig {
params(_features: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features))
}
def features=(_features); end
# A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::ForwardingSettings))
}
def forwarding_settings; end
sig {
params(_forwarding_settings: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::ForwardingSettings)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::ForwardingSettings))
}
def forwarding_settings=(_forwarding_settings); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The nickname for the FinancialAccount.
sig { returns(T.nilable(String)) }
def nickname; end
sig { params(_nickname: T.nilable(String)).returns(T.nilable(String)) }
def nickname=(_nickname); end
# The set of functionalities that the platform can restrict on the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::PlatformRestrictions))
}
def platform_restrictions; end
sig {
params(_platform_restrictions: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::PlatformRestrictions)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::PlatformRestrictions))
}
def platform_restrictions=(_platform_restrictions); end
sig {
params(display_name: T.nilable(String), expand: T.nilable(T::Array[String]), features: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::Features), forwarding_settings: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::ForwardingSettings), metadata: T.nilable(T::Hash[String, String]), nickname: T.nilable(String), platform_restrictions: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateParams::PlatformRestrictions)).void
}
def initialize(
display_name: nil,
expand: nil,
features: nil,
forwarding_settings: nil,
metadata: nil,
nickname: nil,
platform_restrictions: nil
); end
end
class RetrieveFeaturesParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateFeaturesParams < Stripe::RequestParams
class CardIssuing < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class DepositInsurance < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class FinancialAddresses < Stripe::RequestParams
class Aba < Stripe::RequestParams
# Requested bank partner
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(bank: T.nilable(String), requested: T::Boolean).void }
def initialize(bank: nil, requested: nil); end
end
# Adds an ABA FinancialAddress to the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::FinancialAddresses::Aba))
}
def aba; end
sig {
params(_aba: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::FinancialAddresses::Aba)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::FinancialAddresses::Aba))
}
def aba=(_aba); end
sig {
params(aba: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::FinancialAddresses::Aba)).void
}
def initialize(aba: nil); end
end
class InboundTransfers < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH Debits via the InboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::InboundTransfers::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::InboundTransfers::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::InboundTransfers::Ach))
}
def ach=(_ach); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::InboundTransfers::Ach)).void
}
def initialize(ach: nil); end
end
class IntraStripeFlows < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class OutboundPayments < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class UsDomesticWire < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH transfers via the OutboundPayments API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundPayments::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundPayments::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundPayments::Ach))
}
def ach=(_ach); end
# Enables US domestic wire transfers via the OutboundPayments API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundPayments::UsDomesticWire))
}
def us_domestic_wire; end
sig {
params(_us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundPayments::UsDomesticWire)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundPayments::UsDomesticWire))
}
def us_domestic_wire=(_us_domestic_wire); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundPayments::Ach), us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundPayments::UsDomesticWire)).void
}
def initialize(ach: nil, us_domestic_wire: nil); end
end
class OutboundTransfers < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class UsDomesticWire < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH transfers via the OutboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundTransfers::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundTransfers::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundTransfers::Ach))
}
def ach=(_ach); end
# Enables US domestic wire transfers via the OutboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundTransfers::UsDomesticWire))
}
def us_domestic_wire; end
sig {
params(_us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundTransfers::UsDomesticWire)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundTransfers::UsDomesticWire))
}
def us_domestic_wire=(_us_domestic_wire); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundTransfers::Ach), us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundTransfers::UsDomesticWire)).void
}
def initialize(ach: nil, us_domestic_wire: nil); end
end
# Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::CardIssuing))
}
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::CardIssuing)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::CardIssuing))
}
def card_issuing=(_card_issuing); end
# Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::DepositInsurance))
}
def deposit_insurance; end
sig {
params(_deposit_insurance: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::DepositInsurance)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::DepositInsurance))
}
def deposit_insurance=(_deposit_insurance); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Contains Features that add FinancialAddresses to the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::FinancialAddresses))
}
def financial_addresses; end
sig {
params(_financial_addresses: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::FinancialAddresses)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::FinancialAddresses))
}
def financial_addresses=(_financial_addresses); end
# Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::InboundTransfers))
}
def inbound_transfers; end
sig {
params(_inbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::InboundTransfers)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::InboundTransfers))
}
def inbound_transfers=(_inbound_transfers); end
# Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::IntraStripeFlows))
}
def intra_stripe_flows; end
sig {
params(_intra_stripe_flows: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::IntraStripeFlows)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::IntraStripeFlows))
}
def intra_stripe_flows=(_intra_stripe_flows); end
# Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundPayments))
}
def outbound_payments; end
sig {
params(_outbound_payments: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundPayments)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundPayments))
}
def outbound_payments=(_outbound_payments); end
# Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundTransfers))
}
def outbound_transfers; end
sig {
params(_outbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundTransfers)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundTransfers))
}
def outbound_transfers=(_outbound_transfers); end
sig {
params(card_issuing: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::CardIssuing), deposit_insurance: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::DepositInsurance), expand: T.nilable(T::Array[String]), financial_addresses: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::FinancialAddresses), inbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::InboundTransfers), intra_stripe_flows: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::IntraStripeFlows), outbound_payments: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundPayments), outbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams::OutboundTransfers)).void
}
def initialize(
card_issuing: nil,
deposit_insurance: nil,
expand: nil,
financial_addresses: nil,
inbound_transfers: nil,
intra_stripe_flows: nil,
outbound_payments: nil,
outbound_transfers: nil
); end
end
class CloseParams < Stripe::RequestParams
class ForwardingSettings < Stripe::RequestParams
# The financial_account id
sig { returns(T.nilable(String)) }
def financial_account; end
sig { params(_financial_account: T.nilable(String)).returns(T.nilable(String)) }
def financial_account=(_financial_account); end
# The payment_method or bank account id. This needs to be a verified bank account.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The type of the bank account provided. This can be either "financial_account" or "payment_method"
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(financial_account: T.nilable(String), payment_method: T.nilable(String), type: String).void
}
def initialize(financial_account: nil, payment_method: nil, type: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccount::CloseParams::ForwardingSettings))
}
def forwarding_settings; end
sig {
params(_forwarding_settings: T.nilable(::Stripe::Treasury::FinancialAccount::CloseParams::ForwardingSettings)).returns(T.nilable(::Stripe::Treasury::FinancialAccount::CloseParams::ForwardingSettings))
}
def forwarding_settings=(_forwarding_settings); end
sig {
params(expand: T.nilable(T::Array[String]), forwarding_settings: T.nilable(::Stripe::Treasury::FinancialAccount::CloseParams::ForwardingSettings)).void
}
def initialize(expand: nil, forwarding_settings: nil); end
end
# Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.
sig {
params(params: T.any(::Stripe::Treasury::FinancialAccount::CloseParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::FinancialAccount)
}
def close(params = {}, opts = {}); end
# Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.
sig {
params(financial_account: String, params: T.any(::Stripe::Treasury::FinancialAccount::CloseParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::FinancialAccount)
}
def self.close(financial_account, params = {}, opts = {}); end
# Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.
sig {
params(params: T.any(::Stripe::Treasury::FinancialAccount::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::FinancialAccount)
}
def self.create(params = {}, opts = {}); end
# Returns a list of FinancialAccounts.
sig {
params(params: T.any(::Stripe::Treasury::FinancialAccount::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Retrieves Features information associated with the FinancialAccount.
sig {
params(params: T.any(::Stripe::Treasury::FinancialAccount::RetrieveFeaturesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::FinancialAccountFeatures)
}
def retrieve_features(params = {}, opts = {}); end
# Retrieves Features information associated with the FinancialAccount.
sig {
params(financial_account: String, params: T.any(::Stripe::Treasury::FinancialAccount::RetrieveFeaturesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::FinancialAccountFeatures)
}
def self.retrieve_features(financial_account, params = {}, opts = {}); end
# Updates the details of a FinancialAccount.
sig {
params(financial_account: String, params: T.any(::Stripe::Treasury::FinancialAccount::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::FinancialAccount)
}
def self.update(financial_account, params = {}, opts = {}); end
# Updates the Features associated with a FinancialAccount.
sig {
params(params: T.any(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::FinancialAccountFeatures)
}
def update_features(params = {}, opts = {}); end
# Updates the Features associated with a FinancialAccount.
sig {
params(financial_account: String, params: T.any(::Stripe::Treasury::FinancialAccount::UpdateFeaturesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::FinancialAccountFeatures)
}
def self.update_features(financial_account, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
# Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.
#
# Related guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)
class InboundTransfer < APIResource
class FailureDetails < Stripe::StripeObject
# Reason for the failure.
sig { returns(String) }
def code; end
end
class LinkedFlows < Stripe::StripeObject
# If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return.
sig { returns(T.nilable(String)) }
def received_debit; end
end
class OriginPaymentMethodDetails < Stripe::StripeObject
class BillingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(Address) }
def address; end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
end
class UsBankAccount < Stripe::StripeObject
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def mandate; end
# The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
sig { returns(String) }
def network; end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
end
# Attribute for field billing_details
sig { returns(BillingDetails) }
def billing_details; end
# The type of the payment method used in the InboundTransfer.
sig { returns(String) }
def type; end
# Attribute for field us_bank_account
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
end
class StatusTransitions < Stripe::StripeObject
# Timestamp describing when an InboundTransfer changed status to `canceled`.
sig { returns(T.nilable(Integer)) }
def canceled_at; end
# Timestamp describing when an InboundTransfer changed status to `failed`.
sig { returns(T.nilable(Integer)) }
def failed_at; end
# Timestamp describing when an InboundTransfer changed status to `succeeded`.
sig { returns(T.nilable(Integer)) }
def succeeded_at; end
end
# Amount (in cents) transferred.
sig { returns(Integer) }
def amount; end
# Returns `true` if the InboundTransfer is able to be canceled.
sig { returns(T::Boolean) }
def cancelable; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# Details about this InboundTransfer's failure. Only set when status is `failed`.
sig { returns(T.nilable(FailureDetails)) }
def failure_details; end
# The FinancialAccount that received the funds.
sig { returns(String) }
def financial_account; end
# A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
sig { returns(T.nilable(String)) }
def hosted_regulatory_receipt_url; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Attribute for field linked_flows
sig { returns(LinkedFlows) }
def linked_flows; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The origin payment method to be debited for an InboundTransfer.
sig { returns(T.nilable(String)) }
def origin_payment_method; end
# Details about the PaymentMethod for an InboundTransfer.
sig { returns(T.nilable(OriginPaymentMethodDetails)) }
def origin_payment_method_details; end
# Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state.
sig { returns(T.nilable(T::Boolean)) }
def returned; end
# Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`.
sig { returns(String) }
def statement_descriptor; end
# Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been "confirmed" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails.
sig { returns(String) }
def status; end
# Attribute for field status_transitions
sig { returns(StatusTransitions) }
def status_transitions; end
# The Transaction associated with this object.
sig { returns(T.nilable(T.any(String, Stripe::Treasury::Transaction))) }
def transaction; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Returns objects associated with this FinancialAccount.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
# Amount (in cents) to be transferred.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FinancialAccount to send funds to.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The origin payment method to be debited for the InboundTransfer.
sig { returns(String) }
def origin_payment_method; end
sig { params(_origin_payment_method: String).returns(String) }
def origin_payment_method=(_origin_payment_method); end
# The complete description that appears on your customers' statements. Maximum 10 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
sig {
params(amount: Integer, currency: String, description: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, metadata: T.nilable(T::Hash[String, String]), origin_payment_method: String, statement_descriptor: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
expand: nil,
financial_account: nil,
metadata: nil,
origin_payment_method: nil,
statement_descriptor: nil
); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class FailParams < Stripe::RequestParams
class FailureDetails < Stripe::RequestParams
# Reason for the failure.
sig { returns(T.nilable(String)) }
def code; end
sig { params(_code: T.nilable(String)).returns(T.nilable(String)) }
def code=(_code); end
sig { params(code: T.nilable(String)).void }
def initialize(code: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Details about a failed InboundTransfer.
sig { returns(T.nilable(::Stripe::Treasury::InboundTransfer::FailParams::FailureDetails)) }
def failure_details; end
sig {
params(_failure_details: T.nilable(::Stripe::Treasury::InboundTransfer::FailParams::FailureDetails)).returns(T.nilable(::Stripe::Treasury::InboundTransfer::FailParams::FailureDetails))
}
def failure_details=(_failure_details); end
sig {
params(expand: T.nilable(T::Array[String]), failure_details: T.nilable(::Stripe::Treasury::InboundTransfer::FailParams::FailureDetails)).void
}
def initialize(expand: nil, failure_details: nil); end
end
class ReturnInboundTransferParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class SucceedParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Cancels an InboundTransfer.
sig {
params(params: T.any(::Stripe::Treasury::InboundTransfer::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::InboundTransfer)
}
def cancel(params = {}, opts = {}); end
# Cancels an InboundTransfer.
sig {
params(inbound_transfer: String, params: T.any(::Stripe::Treasury::InboundTransfer::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::InboundTransfer)
}
def self.cancel(inbound_transfer, params = {}, opts = {}); end
# Creates an InboundTransfer.
sig {
params(params: T.any(::Stripe::Treasury::InboundTransfer::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::InboundTransfer)
}
def self.create(params = {}, opts = {}); end
# Returns a list of InboundTransfers sent from the specified FinancialAccount.
sig {
params(params: T.any(::Stripe::Treasury::InboundTransfer::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
# Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).
#
# Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.
#
# Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)
class OutboundPayment < APIResource
class DestinationPaymentMethodDetails < Stripe::StripeObject
class BillingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(Address) }
def address; end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
end
class FinancialAccount < Stripe::StripeObject
# Token of the FinancialAccount.
sig { returns(String) }
def id; end
# The rails used to send funds.
sig { returns(String) }
def network; end
end
class UsBankAccount < Stripe::StripeObject
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def mandate; end
# The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
sig { returns(String) }
def network; end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
end
# Attribute for field billing_details
sig { returns(BillingDetails) }
def billing_details; end
# Attribute for field financial_account
sig { returns(T.nilable(FinancialAccount)) }
def financial_account; end
# The type of the payment method used in the OutboundPayment.
sig { returns(String) }
def type; end
# Attribute for field us_bank_account
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
end
class EndUserDetails < Stripe::StripeObject
# IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked.
sig { returns(T.nilable(String)) }
def ip_address; end
# `true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.
sig { returns(T::Boolean) }
def present; end
end
class ReturnedDetails < Stripe::StripeObject
# Reason for the return.
sig { returns(String) }
def code; end
# The Transaction associated with this object.
sig { returns(T.any(String, Stripe::Treasury::Transaction)) }
def transaction; end
end
class StatusTransitions < Stripe::StripeObject
# Timestamp describing when an OutboundPayment changed status to `canceled`.
sig { returns(T.nilable(Integer)) }
def canceled_at; end
# Timestamp describing when an OutboundPayment changed status to `failed`.
sig { returns(T.nilable(Integer)) }
def failed_at; end
# Timestamp describing when an OutboundPayment changed status to `posted`.
sig { returns(T.nilable(Integer)) }
def posted_at; end
# Timestamp describing when an OutboundPayment changed status to `returned`.
sig { returns(T.nilable(Integer)) }
def returned_at; end
end
class TrackingDetails < Stripe::StripeObject
class Ach < Stripe::StripeObject
# ACH trace ID of the OutboundPayment for payments sent over the `ach` network.
sig { returns(String) }
def trace_id; end
end
class UsDomesticWire < Stripe::StripeObject
# CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def chips; end
# IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def imad; end
# OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def omad; end
end
# Attribute for field ach
sig { returns(T.nilable(Ach)) }
def ach; end
# The US bank account network used to send funds.
sig { returns(String) }
def type; end
# Attribute for field us_domestic_wire
sig { returns(T.nilable(UsDomesticWire)) }
def us_domestic_wire; end
end
# Amount (in cents) transferred.
sig { returns(Integer) }
def amount; end
# Returns `true` if the object can be canceled, and `false` otherwise.
sig { returns(T::Boolean) }
def cancelable; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent.
sig { returns(T.nilable(String)) }
def customer; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`.
sig { returns(T.nilable(String)) }
def destination_payment_method; end
# Details about the PaymentMethod for an OutboundPayment.
sig { returns(T.nilable(DestinationPaymentMethodDetails)) }
def destination_payment_method_details; end
# Details about the end user.
sig { returns(T.nilable(EndUserDetails)) }
def end_user_details; end
# The date when funds are expected to arrive in the destination account.
sig { returns(Integer) }
def expected_arrival_date; end
# The FinancialAccount that funds were pulled from.
sig { returns(String) }
def financial_account; end
# A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
sig { returns(T.nilable(String)) }
def hosted_regulatory_receipt_url; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Details about a returned OutboundPayment. Only set when the status is `returned`.
sig { returns(T.nilable(ReturnedDetails)) }
def returned_details; end
# The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).
sig { returns(String) }
def statement_descriptor; end
# Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`.
sig { returns(String) }
def status; end
# Attribute for field status_transitions
sig { returns(StatusTransitions) }
def status_transitions; end
# Details about network-specific tracking information if available.
sig { returns(T.nilable(TrackingDetails)) }
def tracking_details; end
# The Transaction associated with this object.
sig { returns(T.any(String, Stripe::Treasury::Transaction)) }
def transaction; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return OutboundPayments that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Treasury::OutboundPayment::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Treasury::OutboundPayment::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Treasury::OutboundPayment::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return OutboundPayments sent to this customer.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Returns objects associated with this FinancialAccount.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return OutboundPayments that have the given status: `processing`, `failed`, `posted`, `returned`, or `canceled`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(created: T.nilable(T.any(::Stripe::Treasury::OutboundPayment::ListParams::Created, Integer)), customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
created: nil,
customer: nil,
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class DestinationPaymentMethodData < Stripe::RequestParams
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodData::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodData::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodData::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodData::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil); end
end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig {
params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String))
}
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodData::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodData::BillingDetails)).returns(T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodData::BillingDetails))
}
def billing_details=(_billing_details); end
# Required if type is set to `financial_account`. The FinancialAccount ID to send funds to.
sig { returns(T.nilable(String)) }
def financial_account; end
sig { params(_financial_account: T.nilable(String)).returns(T.nilable(String)) }
def financial_account=(_financial_account); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Required hash if type is set to `us_bank_account`.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodData::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodData::UsBankAccount)).returns(T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodData::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
sig {
params(billing_details: T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodData::BillingDetails), financial_account: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), type: String, us_bank_account: T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodData::UsBankAccount)).void
}
def initialize(
billing_details: nil,
financial_account: nil,
metadata: nil,
type: nil,
us_bank_account: nil
); end
end
class DestinationPaymentMethodOptions < Stripe::RequestParams
class UsBankAccount < Stripe::RequestParams
# Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
sig { params(network: T.nilable(String)).void }
def initialize(network: nil); end
end
# Optional fields for `us_bank_account`.
sig {
returns(T.nilable(T.any(String, ::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
sig {
params(us_bank_account: T.nilable(T.any(String, ::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodOptions::UsBankAccount))).void
}
def initialize(us_bank_account: nil); end
end
class EndUserDetails < Stripe::RequestParams
# IP address of the user initiating the OutboundPayment. Must be supplied if `present` is set to `true`.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# `True` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.
sig { returns(T::Boolean) }
def present; end
sig { params(_present: T::Boolean).returns(T::Boolean) }
def present=(_present); end
sig { params(ip_address: T.nilable(String), present: T::Boolean).void }
def initialize(ip_address: nil, present: nil); end
end
# Amount (in cents) to be transferred.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the `destination_payment_method` passed in.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with `destination_payment_method_data`.
sig { returns(T.nilable(String)) }
def destination_payment_method; end
sig { params(_destination_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def destination_payment_method=(_destination_payment_method); end
# Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with `destination_payment_method`.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodData))
}
def destination_payment_method_data; end
sig {
params(_destination_payment_method_data: T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodData)).returns(T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodData))
}
def destination_payment_method_data=(_destination_payment_method_data); end
# Payment method-specific configuration for this OutboundPayment.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodOptions))
}
def destination_payment_method_options; end
sig {
params(_destination_payment_method_options: T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodOptions)).returns(T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodOptions))
}
def destination_payment_method_options=(_destination_payment_method_options); end
# End user details.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::EndUserDetails))
}
def end_user_details; end
sig {
params(_end_user_details: T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::EndUserDetails)).returns(T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::EndUserDetails))
}
def end_user_details=(_end_user_details); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FinancialAccount to pull funds from.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. The default value is "payment".
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
sig {
params(amount: Integer, currency: String, customer: T.nilable(String), description: T.nilable(String), destination_payment_method: T.nilable(String), destination_payment_method_data: T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodData), destination_payment_method_options: T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodOptions), end_user_details: T.nilable(::Stripe::Treasury::OutboundPayment::CreateParams::EndUserDetails), expand: T.nilable(T::Array[String]), financial_account: String, metadata: T.nilable(T::Hash[String, String]), statement_descriptor: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
customer: nil,
description: nil,
destination_payment_method: nil,
destination_payment_method_data: nil,
destination_payment_method_options: nil,
end_user_details: nil,
expand: nil,
financial_account: nil,
metadata: nil,
statement_descriptor: nil
); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class TrackingDetails < Stripe::RequestParams
class Ach < Stripe::RequestParams
# ACH trace ID for funds sent over the `ach` network.
sig { returns(String) }
def trace_id; end
sig { params(_trace_id: String).returns(String) }
def trace_id=(_trace_id); end
sig { params(trace_id: String).void }
def initialize(trace_id: nil); end
end
class UsDomesticWire < Stripe::RequestParams
# CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def chips; end
sig { params(_chips: T.nilable(String)).returns(T.nilable(String)) }
def chips=(_chips); end
# IMAD for funds sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def imad; end
sig { params(_imad: T.nilable(String)).returns(T.nilable(String)) }
def imad=(_imad); end
# OMAD for funds sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def omad; end
sig { params(_omad: T.nilable(String)).returns(T.nilable(String)) }
def omad=(_omad); end
sig {
params(chips: T.nilable(String), imad: T.nilable(String), omad: T.nilable(String)).void
}
def initialize(chips: nil, imad: nil, omad: nil); end
end
# ACH network tracking details.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundPayment::UpdateParams::TrackingDetails::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::OutboundPayment::UpdateParams::TrackingDetails::Ach)).returns(T.nilable(::Stripe::Treasury::OutboundPayment::UpdateParams::TrackingDetails::Ach))
}
def ach=(_ach); end
# The US bank account network used to send funds.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# US domestic wire network tracking details.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundPayment::UpdateParams::TrackingDetails::UsDomesticWire))
}
def us_domestic_wire; end
sig {
params(_us_domestic_wire: T.nilable(::Stripe::Treasury::OutboundPayment::UpdateParams::TrackingDetails::UsDomesticWire)).returns(T.nilable(::Stripe::Treasury::OutboundPayment::UpdateParams::TrackingDetails::UsDomesticWire))
}
def us_domestic_wire=(_us_domestic_wire); end
sig {
params(ach: T.nilable(::Stripe::Treasury::OutboundPayment::UpdateParams::TrackingDetails::Ach), type: String, us_domestic_wire: T.nilable(::Stripe::Treasury::OutboundPayment::UpdateParams::TrackingDetails::UsDomesticWire)).void
}
def initialize(ach: nil, type: nil, us_domestic_wire: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Details about network-specific tracking information.
sig { returns(::Stripe::Treasury::OutboundPayment::UpdateParams::TrackingDetails) }
def tracking_details; end
sig {
params(_tracking_details: ::Stripe::Treasury::OutboundPayment::UpdateParams::TrackingDetails).returns(::Stripe::Treasury::OutboundPayment::UpdateParams::TrackingDetails)
}
def tracking_details=(_tracking_details); end
sig {
params(expand: T.nilable(T::Array[String]), tracking_details: ::Stripe::Treasury::OutboundPayment::UpdateParams::TrackingDetails).void
}
def initialize(expand: nil, tracking_details: nil); end
end
class FailParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class PostParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ReturnOutboundPaymentParams < Stripe::RequestParams
class ReturnedDetails < Stripe::RequestParams
# The return code to be set on the OutboundPayment object.
sig { returns(T.nilable(String)) }
def code; end
sig { params(_code: T.nilable(String)).returns(T.nilable(String)) }
def code=(_code); end
sig { params(code: T.nilable(String)).void }
def initialize(code: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Optional hash to set the return code.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundPayment::ReturnOutboundPaymentParams::ReturnedDetails))
}
def returned_details; end
sig {
params(_returned_details: T.nilable(::Stripe::Treasury::OutboundPayment::ReturnOutboundPaymentParams::ReturnedDetails)).returns(T.nilable(::Stripe::Treasury::OutboundPayment::ReturnOutboundPaymentParams::ReturnedDetails))
}
def returned_details=(_returned_details); end
sig {
params(expand: T.nilable(T::Array[String]), returned_details: T.nilable(::Stripe::Treasury::OutboundPayment::ReturnOutboundPaymentParams::ReturnedDetails)).void
}
def initialize(expand: nil, returned_details: nil); end
end
# Cancel an OutboundPayment.
sig {
params(params: T.any(::Stripe::Treasury::OutboundPayment::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundPayment)
}
def cancel(params = {}, opts = {}); end
# Cancel an OutboundPayment.
sig {
params(id: String, params: T.any(::Stripe::Treasury::OutboundPayment::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundPayment)
}
def self.cancel(id, params = {}, opts = {}); end
# Creates an OutboundPayment.
sig {
params(params: T.any(::Stripe::Treasury::OutboundPayment::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundPayment)
}
def self.create(params = {}, opts = {}); end
# Returns a list of OutboundPayments sent from the specified FinancialAccount.
sig {
params(params: T.any(::Stripe::Treasury::OutboundPayment::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
# Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
#
# Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.
#
# Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)
class OutboundTransfer < APIResource
class DestinationPaymentMethodDetails < Stripe::StripeObject
class BillingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(Address) }
def address; end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
end
class FinancialAccount < Stripe::StripeObject
# Token of the FinancialAccount.
sig { returns(String) }
def id; end
# The rails used to send funds.
sig { returns(String) }
def network; end
end
class UsBankAccount < Stripe::StripeObject
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
# Name of the bank associated with the bank account.
sig { returns(T.nilable(String)) }
def bank_name; end
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sig { returns(T.nilable(String)) }
def fingerprint; end
# Last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# ID of the mandate used to make this payment.
sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
def mandate; end
# The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
sig { returns(String) }
def network; end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
end
# Attribute for field billing_details
sig { returns(BillingDetails) }
def billing_details; end
# Attribute for field financial_account
sig { returns(T.nilable(FinancialAccount)) }
def financial_account; end
# The type of the payment method used in the OutboundTransfer.
sig { returns(String) }
def type; end
# Attribute for field us_bank_account
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
end
class NetworkDetails < Stripe::StripeObject
class Ach < Stripe::StripeObject
# ACH Addenda record
sig { returns(T.nilable(String)) }
def addenda; end
end
# Details about an ACH transaction.
sig { returns(T.nilable(Ach)) }
def ach; end
# The type of flow that originated the OutboundTransfer.
sig { returns(String) }
def type; end
end
class ReturnedDetails < Stripe::StripeObject
# Reason for the return.
sig { returns(String) }
def code; end
# The Transaction associated with this object.
sig { returns(T.any(String, Stripe::Treasury::Transaction)) }
def transaction; end
end
class StatusTransitions < Stripe::StripeObject
# Timestamp describing when an OutboundTransfer changed status to `canceled`
sig { returns(T.nilable(Integer)) }
def canceled_at; end
# Timestamp describing when an OutboundTransfer changed status to `failed`
sig { returns(T.nilable(Integer)) }
def failed_at; end
# Timestamp describing when an OutboundTransfer changed status to `posted`
sig { returns(T.nilable(Integer)) }
def posted_at; end
# Timestamp describing when an OutboundTransfer changed status to `returned`
sig { returns(T.nilable(Integer)) }
def returned_at; end
end
class TrackingDetails < Stripe::StripeObject
class Ach < Stripe::StripeObject
# ACH trace ID of the OutboundTransfer for transfers sent over the `ach` network.
sig { returns(String) }
def trace_id; end
end
class UsDomesticWire < Stripe::StripeObject
# CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def chips; end
# IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def imad; end
# OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def omad; end
end
# Attribute for field ach
sig { returns(T.nilable(Ach)) }
def ach; end
# The US bank account network used to send funds.
sig { returns(String) }
def type; end
# Attribute for field us_domestic_wire
sig { returns(T.nilable(UsDomesticWire)) }
def us_domestic_wire; end
end
# Amount (in cents) transferred.
sig { returns(Integer) }
def amount; end
# Returns `true` if the object can be canceled, and `false` otherwise.
sig { returns(T::Boolean) }
def cancelable; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# The PaymentMethod used as the payment instrument for an OutboundTransfer.
sig { returns(T.nilable(String)) }
def destination_payment_method; end
# Attribute for field destination_payment_method_details
sig { returns(DestinationPaymentMethodDetails) }
def destination_payment_method_details; end
# The date when funds are expected to arrive in the destination account.
sig { returns(Integer) }
def expected_arrival_date; end
# The FinancialAccount that funds were pulled from.
sig { returns(String) }
def financial_account; end
# A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
sig { returns(T.nilable(String)) }
def hosted_regulatory_receipt_url; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# Details about the network used for the OutboundTransfer.
sig { returns(T.nilable(NetworkDetails)) }
def network_details; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Details about a returned OutboundTransfer. Only set when the status is `returned`.
sig { returns(T.nilable(ReturnedDetails)) }
def returned_details; end
# Information about the OutboundTransfer to be sent to the recipient account.
sig { returns(String) }
def statement_descriptor; end
# Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`.
sig { returns(String) }
def status; end
# Attribute for field status_transitions
sig { returns(StatusTransitions) }
def status_transitions; end
# Details about network-specific tracking information if available.
sig { returns(T.nilable(TrackingDetails)) }
def tracking_details; end
# The Transaction associated with this object.
sig { returns(T.any(String, Stripe::Treasury::Transaction)) }
def transaction; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Returns objects associated with this FinancialAccount.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class DestinationPaymentMethodData < Stripe::RequestParams
# Required if type is set to `financial_account`. The FinancialAccount ID to send funds to.
sig { returns(T.nilable(String)) }
def financial_account; end
sig { params(_financial_account: T.nilable(String)).returns(T.nilable(String)) }
def financial_account=(_financial_account); end
# The type of the destination.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(financial_account: T.nilable(String), type: String).void }
def initialize(financial_account: nil, type: nil); end
end
class DestinationPaymentMethodOptions < Stripe::RequestParams
class UsBankAccount < Stripe::RequestParams
# Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
sig { params(network: T.nilable(String)).void }
def initialize(network: nil); end
end
# Optional fields for `us_bank_account`.
sig {
returns(T.nilable(T.any(String, ::Stripe::Treasury::OutboundTransfer::CreateParams::DestinationPaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::Treasury::OutboundTransfer::CreateParams::DestinationPaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::Treasury::OutboundTransfer::CreateParams::DestinationPaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
sig {
params(us_bank_account: T.nilable(T.any(String, ::Stripe::Treasury::OutboundTransfer::CreateParams::DestinationPaymentMethodOptions::UsBankAccount))).void
}
def initialize(us_bank_account: nil); end
end
class NetworkDetails < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Addenda record data associated with this OutboundTransfer.
sig { returns(T.nilable(String)) }
def addenda; end
sig { params(_addenda: T.nilable(String)).returns(T.nilable(String)) }
def addenda=(_addenda); end
sig { params(addenda: T.nilable(String)).void }
def initialize(addenda: nil); end
end
# Optional fields for `ach`.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundTransfer::CreateParams::NetworkDetails::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::OutboundTransfer::CreateParams::NetworkDetails::Ach)).returns(T.nilable(::Stripe::Treasury::OutboundTransfer::CreateParams::NetworkDetails::Ach))
}
def ach=(_ach); end
# The type of flow that originated the OutboundTransfer.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(ach: T.nilable(::Stripe::Treasury::OutboundTransfer::CreateParams::NetworkDetails::Ach), type: String).void
}
def initialize(ach: nil, type: nil); end
end
# Amount (in cents) to be transferred.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The PaymentMethod to use as the payment instrument for the OutboundTransfer.
sig { returns(T.nilable(String)) }
def destination_payment_method; end
sig { params(_destination_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def destination_payment_method=(_destination_payment_method); end
# Hash used to generate the PaymentMethod to be used for this OutboundTransfer. Exclusive with `destination_payment_method`.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundTransfer::CreateParams::DestinationPaymentMethodData))
}
def destination_payment_method_data; end
sig {
params(_destination_payment_method_data: T.nilable(::Stripe::Treasury::OutboundTransfer::CreateParams::DestinationPaymentMethodData)).returns(T.nilable(::Stripe::Treasury::OutboundTransfer::CreateParams::DestinationPaymentMethodData))
}
def destination_payment_method_data=(_destination_payment_method_data); end
# Hash describing payment method configuration details.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundTransfer::CreateParams::DestinationPaymentMethodOptions))
}
def destination_payment_method_options; end
sig {
params(_destination_payment_method_options: T.nilable(::Stripe::Treasury::OutboundTransfer::CreateParams::DestinationPaymentMethodOptions)).returns(T.nilable(::Stripe::Treasury::OutboundTransfer::CreateParams::DestinationPaymentMethodOptions))
}
def destination_payment_method_options=(_destination_payment_method_options); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FinancialAccount to pull funds from.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Details about the network used for the OutboundTransfer.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundTransfer::CreateParams::NetworkDetails))
}
def network_details; end
sig {
params(_network_details: T.nilable(::Stripe::Treasury::OutboundTransfer::CreateParams::NetworkDetails)).returns(T.nilable(::Stripe::Treasury::OutboundTransfer::CreateParams::NetworkDetails))
}
def network_details=(_network_details); end
# Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer".
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
sig {
params(amount: Integer, currency: String, description: T.nilable(String), destination_payment_method: T.nilable(String), destination_payment_method_data: T.nilable(::Stripe::Treasury::OutboundTransfer::CreateParams::DestinationPaymentMethodData), destination_payment_method_options: T.nilable(::Stripe::Treasury::OutboundTransfer::CreateParams::DestinationPaymentMethodOptions), expand: T.nilable(T::Array[String]), financial_account: String, metadata: T.nilable(T::Hash[String, String]), network_details: T.nilable(::Stripe::Treasury::OutboundTransfer::CreateParams::NetworkDetails), statement_descriptor: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
destination_payment_method: nil,
destination_payment_method_data: nil,
destination_payment_method_options: nil,
expand: nil,
financial_account: nil,
metadata: nil,
network_details: nil,
statement_descriptor: nil
); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class TrackingDetails < Stripe::RequestParams
class Ach < Stripe::RequestParams
# ACH trace ID for funds sent over the `ach` network.
sig { returns(String) }
def trace_id; end
sig { params(_trace_id: String).returns(String) }
def trace_id=(_trace_id); end
sig { params(trace_id: String).void }
def initialize(trace_id: nil); end
end
class UsDomesticWire < Stripe::RequestParams
# CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def chips; end
sig { params(_chips: T.nilable(String)).returns(T.nilable(String)) }
def chips=(_chips); end
# IMAD for funds sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def imad; end
sig { params(_imad: T.nilable(String)).returns(T.nilable(String)) }
def imad=(_imad); end
# OMAD for funds sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def omad; end
sig { params(_omad: T.nilable(String)).returns(T.nilable(String)) }
def omad=(_omad); end
sig {
params(chips: T.nilable(String), imad: T.nilable(String), omad: T.nilable(String)).void
}
def initialize(chips: nil, imad: nil, omad: nil); end
end
# ACH network tracking details.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundTransfer::UpdateParams::TrackingDetails::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::OutboundTransfer::UpdateParams::TrackingDetails::Ach)).returns(T.nilable(::Stripe::Treasury::OutboundTransfer::UpdateParams::TrackingDetails::Ach))
}
def ach=(_ach); end
# The US bank account network used to send funds.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# US domestic wire network tracking details.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundTransfer::UpdateParams::TrackingDetails::UsDomesticWire))
}
def us_domestic_wire; end
sig {
params(_us_domestic_wire: T.nilable(::Stripe::Treasury::OutboundTransfer::UpdateParams::TrackingDetails::UsDomesticWire)).returns(T.nilable(::Stripe::Treasury::OutboundTransfer::UpdateParams::TrackingDetails::UsDomesticWire))
}
def us_domestic_wire=(_us_domestic_wire); end
sig {
params(ach: T.nilable(::Stripe::Treasury::OutboundTransfer::UpdateParams::TrackingDetails::Ach), type: String, us_domestic_wire: T.nilable(::Stripe::Treasury::OutboundTransfer::UpdateParams::TrackingDetails::UsDomesticWire)).void
}
def initialize(ach: nil, type: nil, us_domestic_wire: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Details about network-specific tracking information.
sig { returns(::Stripe::Treasury::OutboundTransfer::UpdateParams::TrackingDetails) }
def tracking_details; end
sig {
params(_tracking_details: ::Stripe::Treasury::OutboundTransfer::UpdateParams::TrackingDetails).returns(::Stripe::Treasury::OutboundTransfer::UpdateParams::TrackingDetails)
}
def tracking_details=(_tracking_details); end
sig {
params(expand: T.nilable(T::Array[String]), tracking_details: ::Stripe::Treasury::OutboundTransfer::UpdateParams::TrackingDetails).void
}
def initialize(expand: nil, tracking_details: nil); end
end
class FailParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class PostParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ReturnOutboundTransferParams < Stripe::RequestParams
class ReturnedDetails < Stripe::RequestParams
# Reason for the return.
sig { returns(T.nilable(String)) }
def code; end
sig { params(_code: T.nilable(String)).returns(T.nilable(String)) }
def code=(_code); end
sig { params(code: T.nilable(String)).void }
def initialize(code: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Details about a returned OutboundTransfer.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundTransfer::ReturnOutboundTransferParams::ReturnedDetails))
}
def returned_details; end
sig {
params(_returned_details: T.nilable(::Stripe::Treasury::OutboundTransfer::ReturnOutboundTransferParams::ReturnedDetails)).returns(T.nilable(::Stripe::Treasury::OutboundTransfer::ReturnOutboundTransferParams::ReturnedDetails))
}
def returned_details=(_returned_details); end
sig {
params(expand: T.nilable(T::Array[String]), returned_details: T.nilable(::Stripe::Treasury::OutboundTransfer::ReturnOutboundTransferParams::ReturnedDetails)).void
}
def initialize(expand: nil, returned_details: nil); end
end
# An OutboundTransfer can be canceled if the funds have not yet been paid out.
sig {
params(params: T.any(::Stripe::Treasury::OutboundTransfer::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundTransfer)
}
def cancel(params = {}, opts = {}); end
# An OutboundTransfer can be canceled if the funds have not yet been paid out.
sig {
params(outbound_transfer: String, params: T.any(::Stripe::Treasury::OutboundTransfer::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundTransfer)
}
def self.cancel(outbound_transfer, params = {}, opts = {}); end
# Creates an OutboundTransfer.
sig {
params(params: T.any(::Stripe::Treasury::OutboundTransfer::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundTransfer)
}
def self.create(params = {}, opts = {}); end
# Returns a list of OutboundTransfers sent from the specified FinancialAccount.
sig {
params(params: T.any(::Stripe::Treasury::OutboundTransfer::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
# ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
class ReceivedCredit < APIResource
class InitiatingPaymentMethodDetails < Stripe::StripeObject
class BillingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(Address) }
def address; end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
end
class FinancialAccount < Stripe::StripeObject
# The FinancialAccount ID.
sig { returns(String) }
def id; end
# The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.
sig { returns(String) }
def network; end
end
class UsBankAccount < Stripe::StripeObject
# Bank name.
sig { returns(T.nilable(String)) }
def bank_name; end
# The last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# The routing number for the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
end
# Set when `type` is `balance`.
sig { returns(T.nilable(String)) }
def balance; end
# Attribute for field billing_details
sig { returns(BillingDetails) }
def billing_details; end
# Attribute for field financial_account
sig { returns(T.nilable(FinancialAccount)) }
def financial_account; end
# Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID.
sig { returns(T.nilable(String)) }
def issuing_card; end
# Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.
sig { returns(String) }
def type; end
# Attribute for field us_bank_account
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
end
class LinkedFlows < Stripe::StripeObject
class SourceFlowDetails < Stripe::StripeObject
# You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
sig { returns(T.nilable(Stripe::Treasury::CreditReversal)) }
def credit_reversal; end
# Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).
#
# Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.
#
# Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)
sig { returns(T.nilable(Stripe::Treasury::OutboundPayment)) }
def outbound_payment; end
# Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
#
# Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.
#
# Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)
sig { returns(T.nilable(Stripe::Treasury::OutboundTransfer)) }
def outbound_transfer; end
# 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](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
# and list all payouts. Payouts are made on [varying
# schedules](/docs/connect/manage-payout-schedule), depending on your country and
# industry.
#
# Related guide: [Receiving payouts](https://stripe.com/docs/payouts)
sig { returns(T.nilable(Stripe::Payout)) }
def payout; end
# The type of the source flow that originated the ReceivedCredit.
sig { returns(String) }
def type; end
end
# The CreditReversal created as a result of this ReceivedCredit being reversed.
sig { returns(T.nilable(String)) }
def credit_reversal; end
# Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.
sig { returns(T.nilable(String)) }
def issuing_authorization; end
# Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object.
sig { returns(T.nilable(String)) }
def issuing_transaction; end
# ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals.
sig { returns(T.nilable(String)) }
def source_flow; end
# The expandable object of the source flow.
sig { returns(T.nilable(SourceFlowDetails)) }
def source_flow_details; end
# The type of flow that originated the ReceivedCredit (for example, `outbound_payment`).
sig { returns(T.nilable(String)) }
def source_flow_type; end
end
class NetworkDetails < Stripe::StripeObject
class Ach < Stripe::StripeObject
# ACH Addenda record
sig { returns(T.nilable(String)) }
def addenda; end
end
# Details about an ACH transaction.
sig { returns(T.nilable(Ach)) }
def ach; end
# The type of flow that originated the ReceivedCredit.
sig { returns(String) }
def type; end
end
class ReversalDetails < Stripe::StripeObject
# Time before which a ReceivedCredit can be reversed.
sig { returns(T.nilable(Integer)) }
def deadline; end
# Set if a ReceivedCredit cannot be reversed.
sig { returns(T.nilable(String)) }
def restricted_reason; end
end
# Amount (in cents) transferred.
sig { returns(Integer) }
def amount; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(String) }
def description; end
# Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.
sig { returns(T.nilable(String)) }
def failure_code; end
# The FinancialAccount that received the funds.
sig { returns(T.nilable(String)) }
def financial_account; end
# A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
sig { returns(T.nilable(String)) }
def hosted_regulatory_receipt_url; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Attribute for field initiating_payment_method_details
sig { returns(InitiatingPaymentMethodDetails) }
def initiating_payment_method_details; end
# Attribute for field linked_flows
sig { returns(LinkedFlows) }
def linked_flows; end
# 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) }
def livemode; end
# The rails used to send the funds.
sig { returns(String) }
def network; end
# Details specific to the money movement rails.
sig { returns(T.nilable(NetworkDetails)) }
def network_details; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Details describing when a ReceivedCredit may be reversed.
sig { returns(T.nilable(ReversalDetails)) }
def reversal_details; end
# Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field.
sig { returns(String) }
def status; end
# The Transaction associated with this object.
sig { returns(T.nilable(T.any(String, Stripe::Treasury::Transaction))) }
def transaction; end
class ListParams < Stripe::RequestParams
class LinkedFlows < Stripe::RequestParams
# The source flow type.
sig { returns(String) }
def source_flow_type; end
sig { params(_source_flow_type: String).returns(String) }
def source_flow_type=(_source_flow_type); end
sig { params(source_flow_type: String).void }
def initialize(source_flow_type: nil); end
end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FinancialAccount that received the funds.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return ReceivedCredits described by the flow.
sig { returns(T.nilable(::Stripe::Treasury::ReceivedCredit::ListParams::LinkedFlows)) }
def linked_flows; end
sig {
params(_linked_flows: T.nilable(::Stripe::Treasury::ReceivedCredit::ListParams::LinkedFlows)).returns(T.nilable(::Stripe::Treasury::ReceivedCredit::ListParams::LinkedFlows))
}
def linked_flows=(_linked_flows); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return ReceivedCredits that have the given status: `succeeded` or `failed`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), linked_flows: T.nilable(::Stripe::Treasury::ReceivedCredit::ListParams::LinkedFlows), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
linked_flows: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class InitiatingPaymentMethodDetails < Stripe::RequestParams
class UsBankAccount < Stripe::RequestParams
# The bank account holder's name.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The bank account number.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# The bank account's routing number.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_name: T.nilable(String), account_number: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(account_holder_name: nil, account_number: nil, routing_number: nil); end
end
# The source type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Optional fields for `us_bank_account`.
sig {
returns(T.nilable(::Stripe::Treasury::ReceivedCredit::CreateParams::InitiatingPaymentMethodDetails::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::Treasury::ReceivedCredit::CreateParams::InitiatingPaymentMethodDetails::UsBankAccount)).returns(T.nilable(::Stripe::Treasury::ReceivedCredit::CreateParams::InitiatingPaymentMethodDetails::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
sig {
params(type: String, us_bank_account: T.nilable(::Stripe::Treasury::ReceivedCredit::CreateParams::InitiatingPaymentMethodDetails::UsBankAccount)).void
}
def initialize(type: nil, us_bank_account: nil); end
end
class NetworkDetails < Stripe::RequestParams
class Ach < Stripe::RequestParams
# ACH Addenda record
sig { returns(T.nilable(String)) }
def addenda; end
sig { params(_addenda: T.nilable(String)).returns(T.nilable(String)) }
def addenda=(_addenda); end
sig { params(addenda: T.nilable(String)).void }
def initialize(addenda: nil); end
end
# Optional fields for `ach`.
sig {
returns(T.nilable(::Stripe::Treasury::ReceivedCredit::CreateParams::NetworkDetails::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::ReceivedCredit::CreateParams::NetworkDetails::Ach)).returns(T.nilable(::Stripe::Treasury::ReceivedCredit::CreateParams::NetworkDetails::Ach))
}
def ach=(_ach); end
# The type of flow that originated the ReceivedCredit.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(ach: T.nilable(::Stripe::Treasury::ReceivedCredit::CreateParams::NetworkDetails::Ach), type: String).void
}
def initialize(ach: nil, type: nil); end
end
# Amount (in cents) to be transferred.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FinancialAccount to send funds to.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# Initiating payment method details for the object.
sig {
returns(T.nilable(::Stripe::Treasury::ReceivedCredit::CreateParams::InitiatingPaymentMethodDetails))
}
def initiating_payment_method_details; end
sig {
params(_initiating_payment_method_details: T.nilable(::Stripe::Treasury::ReceivedCredit::CreateParams::InitiatingPaymentMethodDetails)).returns(T.nilable(::Stripe::Treasury::ReceivedCredit::CreateParams::InitiatingPaymentMethodDetails))
}
def initiating_payment_method_details=(_initiating_payment_method_details); end
# Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
sig { returns(String) }
def network; end
sig { params(_network: String).returns(String) }
def network=(_network); end
# Details about the network used for the ReceivedCredit.
sig { returns(T.nilable(::Stripe::Treasury::ReceivedCredit::CreateParams::NetworkDetails)) }
def network_details; end
sig {
params(_network_details: T.nilable(::Stripe::Treasury::ReceivedCredit::CreateParams::NetworkDetails)).returns(T.nilable(::Stripe::Treasury::ReceivedCredit::CreateParams::NetworkDetails))
}
def network_details=(_network_details); end
sig {
params(amount: Integer, currency: String, description: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, initiating_payment_method_details: T.nilable(::Stripe::Treasury::ReceivedCredit::CreateParams::InitiatingPaymentMethodDetails), network: String, network_details: T.nilable(::Stripe::Treasury::ReceivedCredit::CreateParams::NetworkDetails)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
expand: nil,
financial_account: nil,
initiating_payment_method_details: nil,
network: nil,
network_details: nil
); end
end
# Returns a list of ReceivedCredits.
sig {
params(params: T.any(::Stripe::Treasury::ReceivedCredit::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
# ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount.
class ReceivedDebit < APIResource
class InitiatingPaymentMethodDetails < Stripe::StripeObject
class BillingDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Attribute for field address
sig { returns(Address) }
def address; end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
end
class FinancialAccount < Stripe::StripeObject
# The FinancialAccount ID.
sig { returns(String) }
def id; end
# The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.
sig { returns(String) }
def network; end
end
class UsBankAccount < Stripe::StripeObject
# Bank name.
sig { returns(T.nilable(String)) }
def bank_name; end
# The last four digits of the bank account number.
sig { returns(T.nilable(String)) }
def last4; end
# The routing number for the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
end
# Set when `type` is `balance`.
sig { returns(T.nilable(String)) }
def balance; end
# Attribute for field billing_details
sig { returns(BillingDetails) }
def billing_details; end
# Attribute for field financial_account
sig { returns(T.nilable(FinancialAccount)) }
def financial_account; end
# Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID.
sig { returns(T.nilable(String)) }
def issuing_card; end
# Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.
sig { returns(String) }
def type; end
# Attribute for field us_bank_account
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
end
class LinkedFlows < Stripe::StripeObject
# The DebitReversal created as a result of this ReceivedDebit being reversed.
sig { returns(T.nilable(String)) }
def debit_reversal; end
# Set if the ReceivedDebit is associated with an InboundTransfer's return of funds.
sig { returns(T.nilable(String)) }
def inbound_transfer; end
# Set if the ReceivedDebit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.
sig { returns(T.nilable(String)) }
def issuing_authorization; end
# Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object.
sig { returns(T.nilable(String)) }
def issuing_transaction; end
# Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object.
sig { returns(T.nilable(String)) }
def payout; end
# The ReceivedCredit that Capital withheld from
sig { returns(T.nilable(String)) }
def received_credit_capital_withholding; end
end
class NetworkDetails < Stripe::StripeObject
class Ach < Stripe::StripeObject
# ACH Addenda record
sig { returns(T.nilable(String)) }
def addenda; end
end
# Details about an ACH transaction.
sig { returns(T.nilable(Ach)) }
def ach; end
# The type of flow that originated the ReceivedDebit.
sig { returns(String) }
def type; end
end
class ReversalDetails < Stripe::StripeObject
# Time before which a ReceivedDebit can be reversed.
sig { returns(T.nilable(Integer)) }
def deadline; end
# Set if a ReceivedDebit can't be reversed.
sig { returns(T.nilable(String)) }
def restricted_reason; end
end
# Amount (in cents) transferred.
sig { returns(Integer) }
def amount; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(String) }
def description; end
# Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.
sig { returns(T.nilable(String)) }
def failure_code; end
# The FinancialAccount that funds were pulled from.
sig { returns(T.nilable(String)) }
def financial_account; end
# A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
sig { returns(T.nilable(String)) }
def hosted_regulatory_receipt_url; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Attribute for field initiating_payment_method_details
sig { returns(T.nilable(InitiatingPaymentMethodDetails)) }
def initiating_payment_method_details; end
# Attribute for field linked_flows
sig { returns(LinkedFlows) }
def linked_flows; end
# 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) }
def livemode; end
# The network used for the ReceivedDebit.
sig { returns(String) }
def network; end
# Details specific to the money movement rails.
sig { returns(T.nilable(NetworkDetails)) }
def network_details; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Details describing when a ReceivedDebit might be reversed.
sig { returns(T.nilable(ReversalDetails)) }
def reversal_details; end
# Status of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`.
sig { returns(String) }
def status; end
# The Transaction associated with this object.
sig { returns(T.nilable(T.any(String, Stripe::Treasury::Transaction))) }
def transaction; end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FinancialAccount that funds were pulled from.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return ReceivedDebits that have the given status: `succeeded` or `failed`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class InitiatingPaymentMethodDetails < Stripe::RequestParams
class UsBankAccount < Stripe::RequestParams
# The bank account holder's name.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The bank account number.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# The bank account's routing number.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_name: T.nilable(String), account_number: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(account_holder_name: nil, account_number: nil, routing_number: nil); end
end
# The source type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Optional fields for `us_bank_account`.
sig {
returns(T.nilable(::Stripe::Treasury::ReceivedDebit::CreateParams::InitiatingPaymentMethodDetails::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::Treasury::ReceivedDebit::CreateParams::InitiatingPaymentMethodDetails::UsBankAccount)).returns(T.nilable(::Stripe::Treasury::ReceivedDebit::CreateParams::InitiatingPaymentMethodDetails::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
sig {
params(type: String, us_bank_account: T.nilable(::Stripe::Treasury::ReceivedDebit::CreateParams::InitiatingPaymentMethodDetails::UsBankAccount)).void
}
def initialize(type: nil, us_bank_account: nil); end
end
class NetworkDetails < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Addenda record data associated with this ReceivedDebit.
sig { returns(T.nilable(String)) }
def addenda; end
sig { params(_addenda: T.nilable(String)).returns(T.nilable(String)) }
def addenda=(_addenda); end
sig { params(addenda: T.nilable(String)).void }
def initialize(addenda: nil); end
end
# Optional fields for `ach`.
sig {
returns(T.nilable(::Stripe::Treasury::ReceivedDebit::CreateParams::NetworkDetails::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::ReceivedDebit::CreateParams::NetworkDetails::Ach)).returns(T.nilable(::Stripe::Treasury::ReceivedDebit::CreateParams::NetworkDetails::Ach))
}
def ach=(_ach); end
# The type of flow that originated the ReceivedDebit.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(ach: T.nilable(::Stripe::Treasury::ReceivedDebit::CreateParams::NetworkDetails::Ach), type: String).void
}
def initialize(ach: nil, type: nil); end
end
# Amount (in cents) to be transferred.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FinancialAccount to pull funds from.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# Initiating payment method details for the object.
sig {
returns(T.nilable(::Stripe::Treasury::ReceivedDebit::CreateParams::InitiatingPaymentMethodDetails))
}
def initiating_payment_method_details; end
sig {
params(_initiating_payment_method_details: T.nilable(::Stripe::Treasury::ReceivedDebit::CreateParams::InitiatingPaymentMethodDetails)).returns(T.nilable(::Stripe::Treasury::ReceivedDebit::CreateParams::InitiatingPaymentMethodDetails))
}
def initiating_payment_method_details=(_initiating_payment_method_details); end
# Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
sig { returns(String) }
def network; end
sig { params(_network: String).returns(String) }
def network=(_network); end
# Details about the network used for the ReceivedDebit.
sig { returns(T.nilable(::Stripe::Treasury::ReceivedDebit::CreateParams::NetworkDetails)) }
def network_details; end
sig {
params(_network_details: T.nilable(::Stripe::Treasury::ReceivedDebit::CreateParams::NetworkDetails)).returns(T.nilable(::Stripe::Treasury::ReceivedDebit::CreateParams::NetworkDetails))
}
def network_details=(_network_details); end
sig {
params(amount: Integer, currency: String, description: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, initiating_payment_method_details: T.nilable(::Stripe::Treasury::ReceivedDebit::CreateParams::InitiatingPaymentMethodDetails), network: String, network_details: T.nilable(::Stripe::Treasury::ReceivedDebit::CreateParams::NetworkDetails)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
expand: nil,
financial_account: nil,
initiating_payment_method_details: nil,
network: nil,
network_details: nil
); end
end
# Returns a list of ReceivedDebits.
sig {
params(params: T.any(::Stripe::Treasury::ReceivedDebit::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
# TransactionEntries represent individual units of money movements within a single [Transaction](https://stripe.com/docs/api#transactions).
class TransactionEntry < APIResource
class BalanceImpact < Stripe::StripeObject
# The change made to funds the user can spend right now.
sig { returns(Integer) }
def cash; end
# The change made to funds that are not spendable yet, but will become available at a later time.
sig { returns(Integer) }
def inbound_pending; end
# The change made to funds in the account, but not spendable because they are being held for pending outbound flows.
sig { returns(Integer) }
def outbound_pending; end
end
class FlowDetails < Stripe::StripeObject
# You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
sig { returns(T.nilable(Stripe::Treasury::CreditReversal)) }
def credit_reversal; end
# You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
sig { returns(T.nilable(Stripe::Treasury::DebitReversal)) }
def debit_reversal; end
# Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.
#
# Related guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)
sig { returns(T.nilable(Stripe::Treasury::InboundTransfer)) }
def inbound_transfer; end
# 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)
sig { returns(T.nilable(Stripe::Issuing::Authorization)) }
def issuing_authorization; end
# Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).
#
# Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.
#
# Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)
sig { returns(T.nilable(Stripe::Treasury::OutboundPayment)) }
def outbound_payment; end
# Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
#
# Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.
#
# Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)
sig { returns(T.nilable(Stripe::Treasury::OutboundTransfer)) }
def outbound_transfer; end
# ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
sig { returns(T.nilable(Stripe::Treasury::ReceivedCredit)) }
def received_credit; end
# ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount.
sig { returns(T.nilable(Stripe::Treasury::ReceivedDebit)) }
def received_debit; end
# Type of the flow that created the Transaction. Set to the same value as `flow_type`.
sig { returns(String) }
def type; end
end
# Change to a FinancialAccount's balance
sig { returns(BalanceImpact) }
def balance_impact; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# When the TransactionEntry will impact the FinancialAccount's balance.
sig { returns(Integer) }
def effective_at; end
# The FinancialAccount associated with this object.
sig { returns(String) }
def financial_account; end
# Token of the flow associated with the TransactionEntry.
sig { returns(T.nilable(String)) }
def flow; end
# Details of the flow associated with the TransactionEntry.
sig { returns(T.nilable(FlowDetails)) }
def flow_details; end
# Type of the flow associated with the TransactionEntry.
sig { returns(String) }
def flow_type; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The Transaction associated with this object.
sig { returns(T.any(String, Stripe::Treasury::Transaction)) }
def transaction; end
# The specific money movement that generated the TransactionEntry.
sig { returns(String) }
def type; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class EffectiveAt < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return TransactionEntries that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Treasury::TransactionEntry::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Treasury::TransactionEntry::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Treasury::TransactionEntry::ListParams::Created, Integer)))
}
def created=(_created); end
# Attribute for param field effective_at
sig {
returns(T.nilable(T.any(::Stripe::Treasury::TransactionEntry::ListParams::EffectiveAt, Integer)))
}
def effective_at; end
sig {
params(_effective_at: T.nilable(T.any(::Stripe::Treasury::TransactionEntry::ListParams::EffectiveAt, Integer))).returns(T.nilable(T.any(::Stripe::Treasury::TransactionEntry::ListParams::EffectiveAt, Integer)))
}
def effective_at=(_effective_at); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Returns objects associated with this FinancialAccount.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The results are in reverse chronological order by `created` or `effective_at`. The default is `created`.
sig { returns(T.nilable(String)) }
def order_by; end
sig { params(_order_by: T.nilable(String)).returns(T.nilable(String)) }
def order_by=(_order_by); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return TransactionEntries associated with this Transaction.
sig { returns(T.nilable(String)) }
def transaction; end
sig { params(_transaction: T.nilable(String)).returns(T.nilable(String)) }
def transaction=(_transaction); end
sig {
params(created: T.nilable(T.any(::Stripe::Treasury::TransactionEntry::ListParams::Created, Integer)), effective_at: T.nilable(T.any(::Stripe::Treasury::TransactionEntry::ListParams::EffectiveAt, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), order_by: T.nilable(String), starting_after: T.nilable(String), transaction: T.nilable(String)).void
}
def initialize(
created: nil,
effective_at: nil,
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
order_by: nil,
starting_after: nil,
transaction: nil
); end
end
# Retrieves a list of TransactionEntry objects.
sig {
params(params: T.any(::Stripe::Treasury::TransactionEntry::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
# Transactions represent changes to a [FinancialAccount's](https://stripe.com/docs/api#financial_accounts) balance.
class Transaction < APIResource
class BalanceImpact < Stripe::StripeObject
# The change made to funds the user can spend right now.
sig { returns(Integer) }
def cash; end
# The change made to funds that are not spendable yet, but will become available at a later time.
sig { returns(Integer) }
def inbound_pending; end
# The change made to funds in the account, but not spendable because they are being held for pending outbound flows.
sig { returns(Integer) }
def outbound_pending; end
end
class FlowDetails < Stripe::StripeObject
# You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
sig { returns(T.nilable(Stripe::Treasury::CreditReversal)) }
def credit_reversal; end
# You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
sig { returns(T.nilable(Stripe::Treasury::DebitReversal)) }
def debit_reversal; end
# Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.
#
# Related guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)
sig { returns(T.nilable(Stripe::Treasury::InboundTransfer)) }
def inbound_transfer; end
# 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)
sig { returns(T.nilable(Stripe::Issuing::Authorization)) }
def issuing_authorization; end
# Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).
#
# Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.
#
# Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)
sig { returns(T.nilable(Stripe::Treasury::OutboundPayment)) }
def outbound_payment; end
# Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
#
# Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.
#
# Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)
sig { returns(T.nilable(Stripe::Treasury::OutboundTransfer)) }
def outbound_transfer; end
# ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
sig { returns(T.nilable(Stripe::Treasury::ReceivedCredit)) }
def received_credit; end
# ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount.
sig { returns(T.nilable(Stripe::Treasury::ReceivedDebit)) }
def received_debit; end
# Type of the flow that created the Transaction. Set to the same value as `flow_type`.
sig { returns(String) }
def type; end
end
class StatusTransitions < Stripe::StripeObject
# Timestamp describing when the Transaction changed status to `posted`.
sig { returns(T.nilable(Integer)) }
def posted_at; end
# Timestamp describing when the Transaction changed status to `void`.
sig { returns(T.nilable(Integer)) }
def void_at; end
end
# Amount (in cents) transferred.
sig { returns(Integer) }
def amount; end
# Change to a FinancialAccount's balance
sig { returns(BalanceImpact) }
def balance_impact; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# 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) }
def currency; end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(String) }
def description; end
# A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.
sig { returns(T.nilable(Stripe::ListObject)) }
def entries; end
# The FinancialAccount associated with this object.
sig { returns(String) }
def financial_account; end
# ID of the flow that created the Transaction.
sig { returns(T.nilable(String)) }
def flow; end
# Details of the flow that created the Transaction.
sig { returns(T.nilable(FlowDetails)) }
def flow_details; end
# Type of the flow that created the Transaction.
sig { returns(String) }
def flow_type; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# Status of the Transaction.
sig { returns(String) }
def status; end
# Attribute for field status_transitions
sig { returns(StatusTransitions) }
def status_transitions; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class StatusTransitions < Stripe::RequestParams
class PostedAt < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Returns Transactions with `posted_at` within the specified range.
sig {
returns(T.nilable(T.any(::Stripe::Treasury::Transaction::ListParams::StatusTransitions::PostedAt, Integer)))
}
def posted_at; end
sig {
params(_posted_at: T.nilable(T.any(::Stripe::Treasury::Transaction::ListParams::StatusTransitions::PostedAt, Integer))).returns(T.nilable(T.any(::Stripe::Treasury::Transaction::ListParams::StatusTransitions::PostedAt, Integer)))
}
def posted_at=(_posted_at); end
sig {
params(posted_at: T.nilable(T.any(::Stripe::Treasury::Transaction::ListParams::StatusTransitions::PostedAt, Integer))).void
}
def initialize(posted_at: nil); end
end
# Only return Transactions that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Treasury::Transaction::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Treasury::Transaction::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Treasury::Transaction::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Returns objects associated with this FinancialAccount.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The results are in reverse chronological order by `created` or `posted_at`. The default is `created`.
sig { returns(T.nilable(String)) }
def order_by; end
sig { params(_order_by: T.nilable(String)).returns(T.nilable(String)) }
def order_by=(_order_by); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return Transactions that have the given status: `open`, `posted`, or `void`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# A filter for the `status_transitions.posted_at` timestamp. When using this filter, `status=posted` and `order_by=posted_at` must also be specified.
sig { returns(T.nilable(::Stripe::Treasury::Transaction::ListParams::StatusTransitions)) }
def status_transitions; end
sig {
params(_status_transitions: T.nilable(::Stripe::Treasury::Transaction::ListParams::StatusTransitions)).returns(T.nilable(::Stripe::Treasury::Transaction::ListParams::StatusTransitions))
}
def status_transitions=(_status_transitions); end
sig {
params(created: T.nilable(T.any(::Stripe::Treasury::Transaction::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), order_by: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String), status_transitions: T.nilable(::Stripe::Treasury::Transaction::ListParams::StatusTransitions)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
order_by: nil,
starting_after: nil,
status: nil,
status_transitions: nil
); end
end
# Retrieves a list of Transaction objects.
sig {
params(params: T.any(::Stripe::Treasury::Transaction::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
# You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be
# notified about events that happen in your Stripe account or connected
# accounts.
#
# Most users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.
#
# Related guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure)
class WebhookEndpoint < APIResource
# The API version events are rendered as for this webhook endpoint.
sig { returns(T.nilable(String)) }
def api_version; end
# The ID of the associated Connect application.
sig { returns(T.nilable(String)) }
def application; end
# Time at which the object was created. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def created; end
# An optional description of what the webhook is used for.
sig { returns(T.nilable(String)) }
def description; end
# The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection.
sig { returns(T::Array[String]) }
def enabled_events; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# 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) }
def livemode; end
# 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::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation.
sig { returns(T.nilable(String)) }
def secret; end
# The status of the webhook. It can be `enabled` or `disabled`.
sig { returns(String) }
def status; end
# The URL of the webhook endpoint.
sig { returns(String) }
def url; end
# Always true for a deleted object
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
class DeleteParams < Stripe::RequestParams; end
class UpdateParams < Stripe::RequestParams
# An optional description of what the webhook is used for.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Disable the webhook endpoint if set to true.
sig { returns(T.nilable(T::Boolean)) }
def disabled; end
sig { params(_disabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def disabled=(_disabled); end
# The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection.
sig { returns(T.nilable(T::Array[String])) }
def enabled_events; end
sig {
params(_enabled_events: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def enabled_events=(_enabled_events); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The URL of the webhook endpoint.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(description: T.nilable(String), disabled: T.nilable(T::Boolean), enabled_events: T.nilable(T::Array[String]), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), url: T.nilable(String)).void
}
def initialize(
description: nil,
disabled: nil,
enabled_events: nil,
expand: nil,
metadata: nil,
url: nil
); end
end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateParams < Stripe::RequestParams
# Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version.
sig { returns(T.nilable(String)) }
def api_version; end
sig { params(_api_version: T.nilable(String)).returns(T.nilable(String)) }
def api_version=(_api_version); end
# Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def connect; end
sig { params(_connect: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def connect=(_connect); end
# An optional description of what the webhook is used for.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection.
sig { returns(T::Array[String]) }
def enabled_events; end
sig { params(_enabled_events: T::Array[String]).returns(T::Array[String]) }
def enabled_events=(_enabled_events); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The URL of the webhook endpoint.
sig { returns(String) }
def url; end
sig { params(_url: String).returns(String) }
def url=(_url); end
sig {
params(api_version: T.nilable(String), connect: T.nilable(T::Boolean), description: T.nilable(String), enabled_events: T::Array[String], expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), url: String).void
}
def initialize(
api_version: nil,
connect: nil,
description: nil,
enabled_events: nil,
expand: nil,
metadata: nil,
url: nil
); end
end
# A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the [webhooks settings](https://dashboard.stripe.com/account/webhooks) section of the Dashboard.
sig {
params(params: T.any(::Stripe::WebhookEndpoint::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::WebhookEndpoint)
}
def self.create(params = {}, opts = {}); end
# You can also delete webhook endpoints via the [webhook endpoint management](https://dashboard.stripe.com/account/webhooks) page of the Stripe dashboard.
sig {
params(webhook_endpoint: String, params: T.any(::Stripe::WebhookEndpoint::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::WebhookEndpoint)
}
def self.delete(webhook_endpoint, params = {}, opts = {}); end
# You can also delete webhook endpoints via the [webhook endpoint management](https://dashboard.stripe.com/account/webhooks) page of the Stripe dashboard.
sig {
params(params: T.any(::Stripe::WebhookEndpoint::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::WebhookEndpoint)
}
def delete(params = {}, opts = {}); end
# Returns a list of your webhook endpoints.
sig {
params(params: T.any(::Stripe::WebhookEndpoint::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def self.list(params = {}, opts = {}); end
# Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.
sig {
params(webhook_endpoint: String, params: T.any(::Stripe::WebhookEndpoint::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::WebhookEndpoint)
}
def self.update(webhook_endpoint, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
module V2
module Billing
class MeterEventAdjustment < APIResource
class Cancel < Stripe::StripeObject
# Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.
sig { returns(String) }
def identifier; end
end
# Specifies which event to cancel.
sig { returns(Cancel) }
def cancel; end
# The time the adjustment was created.
sig { returns(String) }
def created; end
# The name of the meter event. Corresponds with the `event_name` field on a meter.
sig { returns(String) }
def event_name; end
# The unique id of this meter event adjustment.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# Open Enum. The meter event adjustment’s status.
sig { returns(String) }
def status; end
# Open Enum. Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
sig { returns(String) }
def type; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
module Billing
class MeterEventSession < APIResource
# The authentication token for this session. Use this token when calling the
# high-throughput meter event API.
sig { returns(String) }
def authentication_token; end
# The creation time of this session.
sig { returns(String) }
def created; end
# The time at which this session will expire.
sig { returns(String) }
def expires_at; end
# The unique id of this auth session.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
module Billing
# Fix me empty_doc_string.
class MeterEvent < APIResource
# The creation time of this meter event.
sig { returns(String) }
def created; end
# The name of the meter event. Corresponds with the `event_name` field on a meter.
sig { returns(String) }
def event_name; end
# A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We’ll enforce uniqueness within a rolling 24 hour period.
sig { returns(String) }
def identifier; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# The payload of the event. This must contain the fields corresponding to a meter’s
# `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and
# `value_settings.event_payload_key` (default is `value`). Read more about the payload.
sig { returns(T::Hash[String, String]) }
def payload; end
# The time of the event. Must be within the past 35 calendar days or up to
# 5 minutes in the future. Defaults to current timestamp if not specified.
sig { returns(String) }
def timestamp; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
module Core
# AccountLinks are the means by which a Merchant grants an Account permission to access Stripe-hosted applications, such as Recipient Onboarding. This API is only available for users enrolled in the public preview for Accounts v2.
class AccountLink < APIResource
class UseCase < Stripe::StripeObject
class AccountOnboarding < Stripe::StripeObject
class CollectionOptions < Stripe::StripeObject
# Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don’t specify collection_options, the default value is currently_due.
sig { returns(T.nilable(String)) }
def fields; end
# Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
sig { returns(T.nilable(String)) }
def future_requirements; end
end
# Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
sig { returns(T.nilable(CollectionOptions)) }
def collection_options; end
# Open Enum. A v2/core/account can be configured to enable certain functionality. The configuration param targets the v2/core/account_link to collect information for the specified v2/core/account configuration/s.
sig { returns(T::Array[String]) }
def configurations; end
# The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink’s URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
sig { returns(String) }
def refresh_url; end
# The URL that the user will be redirected to upon completing the linked flow.
sig { returns(T.nilable(String)) }
def return_url; end
end
class AccountUpdate < Stripe::StripeObject
class CollectionOptions < Stripe::StripeObject
# Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don’t specify collection_options, the default value is currently_due.
sig { returns(T.nilable(String)) }
def fields; end
# Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
sig { returns(T.nilable(String)) }
def future_requirements; end
end
# Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
sig { returns(T.nilable(CollectionOptions)) }
def collection_options; end
# Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
sig { returns(T::Array[String]) }
def configurations; end
# The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink’s URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
sig { returns(String) }
def refresh_url; end
# The URL that the user will be redirected to upon completing the linked flow.
sig { returns(T.nilable(String)) }
def return_url; end
end
# Open Enum. The type of AccountLink the user is requesting.
sig { returns(String) }
def type; end
# Indicates that the AccountLink provided should onboard an account.
sig { returns(T.nilable(AccountOnboarding)) }
def account_onboarding; end
# Indicates that the AccountLink provided should update a previously onboarded account.
sig { returns(T.nilable(AccountUpdate)) }
def account_update; end
end
# The ID of the Account the link was created for.
sig { returns(String) }
def account; end
# The timestamp at which this AccountLink was created.
sig { returns(String) }
def created; end
# The timestamp at which this AccountLink will expire.
sig { returns(String) }
def expires_at; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# The URL for the AccountLink.
sig { returns(String) }
def url; end
# The use case of AccountLink the user is requesting.
sig { returns(UseCase) }
def use_case; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
module Core
# A V2 Account is a representation of a company or individual that a Stripe user does business with. Accounts contain the contact details, Legal Entity information, and configuration required to enable the Account for use across Stripe products.
class Account < APIResource
class Configuration < Stripe::StripeObject
class Customer < Stripe::StripeObject
class AutomaticIndirectTax < Stripe::StripeObject
class Location < Stripe::StripeObject
# The identified tax country of the customer.
sig { returns(T.nilable(String)) }
def country; end
# The identified tax state, county, province, or region of the customer.
sig { returns(T.nilable(String)) }
def state; end
end
# Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to reverse, invoice and receipt PDFs include the following text: “Reverse charge”.
sig { returns(T.nilable(String)) }
def exempt; end
# A recent IP address of the customer used for tax reporting and tax location inference.
sig { returns(T.nilable(String)) }
def ip_address; end
# The customer’s identified tax location - uses `location_source`. Will only be rendered if the `automatic_indirect_tax` feature is requested and `active`.
sig { returns(T.nilable(Location)) }
def location; end
# The data source used to identify the customer's tax location - defaults to 'identity_address'. Will only be used for automatic tax calculation on the customer's Invoices and Subscriptions.
sig { returns(T.nilable(String)) }
def location_source; end
end
class Billing < Stripe::StripeObject
class Invoice < Stripe::StripeObject
class CustomField < Stripe::StripeObject
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
# The value of the custom field. This may be up to 140 characters. When updating, pass an empty string to remove previously-defined values.
sig { returns(String) }
def value; end
end
class Rendering < Stripe::StripeObject
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of exclude_tax or include_inclusive_tax. include_inclusive_tax will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. exclude_tax will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(String)) }
def amount_tax_display; end
# ID of the invoice rendering template to use for future invoices.
sig { returns(T.nilable(String)) }
def template; end
end
# The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.
sig { returns(T::Array[CustomField]) }
def custom_fields; end
# Default footer to be displayed on invoices for this customer.
sig { returns(T.nilable(String)) }
def footer; end
# The sequence to be used on the customer's next invoice. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def next_sequence; end
# The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
sig { returns(T.nilable(String)) }
def prefix; end
# Default options for invoice PDF rendering for this customer.
sig { returns(T.nilable(Rendering)) }
def rendering; end
end
# ID of a payment method that’s attached to the customer, to be used as the customer’s default payment method for invoices and subscriptions.
sig { returns(T.nilable(String)) }
def default_payment_method; end
# Default settings used on invoices for this customer.
sig { returns(T.nilable(Invoice)) }
def invoice; end
end
class Capabilities < Stripe::StripeObject
class AutomaticIndirectTax < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
# Generates requirements for enabling automatic indirect tax calculation on this customer's invoices or subscriptions. Recommended to request this capability if planning to enable automatic tax calculation on this customer's invoices or subscriptions. Uses the `location_source` field.
sig { returns(T.nilable(AutomaticIndirectTax)) }
def automatic_indirect_tax; end
end
class Shipping < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
end
# Customer shipping address.
sig { returns(T.nilable(Address)) }
def address; end
# Customer name.
sig { returns(T.nilable(String)) }
def name; end
# Customer phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
end
# Represents the state of the configuration, and can be updated to deactivate or re-apply a configuration.
sig { returns(T::Boolean) }
def applied; end
# Automatic indirect tax settings to be used when automatic tax calculation is enabled on the customer's invoices, subscriptions, checkout sessions, or payment links. Surfaces if automatic tax calculation is possible given the current customer location information.
sig { returns(T.nilable(AutomaticIndirectTax)) }
def automatic_indirect_tax; end
# Billing settings - default settings used for this customer in Billing flows such as Invoices and Subscriptions.
sig { returns(T.nilable(Billing)) }
def billing; end
# Capabilities that have been requested on the Customer Configuration.
sig { returns(T.nilable(Capabilities)) }
def capabilities; end
# The customer's shipping information. Appears on invoices emailed to this customer.
sig { returns(T.nilable(Shipping)) }
def shipping; end
# ID of the test clock to attach to the customer. Can only be set on testmode Accounts, and when the Customer Configuration is first set on an Account.
sig { returns(T.nilable(String)) }
def test_clock; end
end
class Merchant < Stripe::StripeObject
class BacsDebitPayments < Stripe::StripeObject
# Display name for Bacs debit payments.
sig { returns(T.nilable(String)) }
def display_name; end
# Service user number for Bacs debit payments.
sig { returns(T.nilable(String)) }
def service_user_number; end
end
class Branding < Stripe::StripeObject
# ID of a [file upload](https://docs.stripe.com/api/persons/update#create_file): An icon for the merchant. Must be square and at least 128px x 128px.
sig { returns(T.nilable(String)) }
def icon; end
# ID of a [file upload](https://docs.stripe.com/api/persons/update#create_file): A logo for the merchant that will be used in Checkout instead of the icon and without the merchant's name next to it if provided. Must be at least 128px x 128px.
sig { returns(T.nilable(String)) }
def logo; end
# A CSS hex color value representing the primary branding color for the merchant.
sig { returns(T.nilable(String)) }
def primary_color; end
# A CSS hex color value representing the secondary branding color for the merchant.
sig { returns(T.nilable(String)) }
def secondary_color; end
end
class Capabilities < Stripe::StripeObject
class AchDebitPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class AcssDebitPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class AffirmPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class AfterpayClearpayPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class AlmaPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class AmazonPayPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class AuBecsDebitPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class BacsDebitPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class BancontactPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class BlikPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class BoletoPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class CardPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class CartesBancairesPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class CashappPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class EpsPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class FpxPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class GbBankTransferPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class GrabpayPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class IdealPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class JcbPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class JpBankTransferPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class KakaoPayPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class KlarnaPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class KonbiniPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class KrCardPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class LinkPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class MobilepayPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class MultibancoPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class MxBankTransferPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class NaverPayPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class OxxoPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class P24Payments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class PayByBankPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class PaycoPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class PaynowPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class PromptpayPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class RevolutPayPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class SamsungPayPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class SepaBankTransferPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class SepaDebitPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class StripeBalance < Stripe::StripeObject
class Payouts < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
# Allows the account to do payouts using their Stripe Balance (/v1/balance).
sig { returns(T.nilable(Payouts)) }
def payouts; end
end
class SwishPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class TwintPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class UsBankTransferPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class ZipPayments < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
# Allow the merchant to process ACH debit payments.
sig { returns(T.nilable(AchDebitPayments)) }
def ach_debit_payments; end
# Allow the merchant to process ACSS debit payments.
sig { returns(T.nilable(AcssDebitPayments)) }
def acss_debit_payments; end
# Allow the merchant to process Affirm payments.
sig { returns(T.nilable(AffirmPayments)) }
def affirm_payments; end
# Allow the merchant to process Afterpay/Clearpay payments.
sig { returns(T.nilable(AfterpayClearpayPayments)) }
def afterpay_clearpay_payments; end
# Allow the merchant to process Alma payments.
sig { returns(T.nilable(AlmaPayments)) }
def alma_payments; end
# Allow the merchant to process Amazon Pay payments.
sig { returns(T.nilable(AmazonPayPayments)) }
def amazon_pay_payments; end
# Allow the merchant to process Australian BECS Direct Debit payments.
sig { returns(T.nilable(AuBecsDebitPayments)) }
def au_becs_debit_payments; end
# Allow the merchant to process BACS Direct Debit payments.
sig { returns(T.nilable(BacsDebitPayments)) }
def bacs_debit_payments; end
# Allow the merchant to process Bancontact payments.
sig { returns(T.nilable(BancontactPayments)) }
def bancontact_payments; end
# Allow the merchant to process BLIK payments.
sig { returns(T.nilable(BlikPayments)) }
def blik_payments; end
# Allow the merchant to process Boleto payments.
sig { returns(T.nilable(BoletoPayments)) }
def boleto_payments; end
# Allow the merchant to collect card payments.
sig { returns(T.nilable(CardPayments)) }
def card_payments; end
# Allow the merchant to process Cartes Bancaires payments.
sig { returns(T.nilable(CartesBancairesPayments)) }
def cartes_bancaires_payments; end
# Allow the merchant to process Cash App payments.
sig { returns(T.nilable(CashappPayments)) }
def cashapp_payments; end
# Allow the merchant to process EPS payments.
sig { returns(T.nilable(EpsPayments)) }
def eps_payments; end
# Allow the merchant to process FPX payments.
sig { returns(T.nilable(FpxPayments)) }
def fpx_payments; end
# Allow the merchant to process UK bank transfer payments.
sig { returns(T.nilable(GbBankTransferPayments)) }
def gb_bank_transfer_payments; end
# Allow the merchant to process GrabPay payments.
sig { returns(T.nilable(GrabpayPayments)) }
def grabpay_payments; end
# Allow the merchant to process iDEAL payments.
sig { returns(T.nilable(IdealPayments)) }
def ideal_payments; end
# Allow the merchant to process JCB card payments.
sig { returns(T.nilable(JcbPayments)) }
def jcb_payments; end
# Allow the merchant to process Japanese bank transfer payments.
sig { returns(T.nilable(JpBankTransferPayments)) }
def jp_bank_transfer_payments; end
# Allow the merchant to process Kakao Pay payments.
sig { returns(T.nilable(KakaoPayPayments)) }
def kakao_pay_payments; end
# Allow the merchant to process Klarna payments.
sig { returns(T.nilable(KlarnaPayments)) }
def klarna_payments; end
# Allow the merchant to process Konbini convenience store payments.
sig { returns(T.nilable(KonbiniPayments)) }
def konbini_payments; end
# Allow the merchant to process Korean card payments.
sig { returns(T.nilable(KrCardPayments)) }
def kr_card_payments; end
# Allow the merchant to process Link payments.
sig { returns(T.nilable(LinkPayments)) }
def link_payments; end
# Allow the merchant to process MobilePay payments.
sig { returns(T.nilable(MobilepayPayments)) }
def mobilepay_payments; end
# Allow the merchant to process Multibanco payments.
sig { returns(T.nilable(MultibancoPayments)) }
def multibanco_payments; end
# Allow the merchant to process Mexican bank transfer payments.
sig { returns(T.nilable(MxBankTransferPayments)) }
def mx_bank_transfer_payments; end
# Allow the merchant to process Naver Pay payments.
sig { returns(T.nilable(NaverPayPayments)) }
def naver_pay_payments; end
# Allow the merchant to process OXXO payments.
sig { returns(T.nilable(OxxoPayments)) }
def oxxo_payments; end
# Allow the merchant to process Przelewy24 (P24) payments.
sig { returns(T.nilable(P24Payments)) }
def p24_payments; end
# Allow the merchant to process Pay by Bank payments.
sig { returns(T.nilable(PayByBankPayments)) }
def pay_by_bank_payments; end
# Allow the merchant to process PAYCO payments.
sig { returns(T.nilable(PaycoPayments)) }
def payco_payments; end
# Allow the merchant to process PayNow payments.
sig { returns(T.nilable(PaynowPayments)) }
def paynow_payments; end
# Allow the merchant to process PromptPay payments.
sig { returns(T.nilable(PromptpayPayments)) }
def promptpay_payments; end
# Allow the merchant to process Revolut Pay payments.
sig { returns(T.nilable(RevolutPayPayments)) }
def revolut_pay_payments; end
# Allow the merchant to process Samsung Pay payments.
sig { returns(T.nilable(SamsungPayPayments)) }
def samsung_pay_payments; end
# Allow the merchant to process SEPA bank transfer payments.
sig { returns(T.nilable(SepaBankTransferPayments)) }
def sepa_bank_transfer_payments; end
# Allow the merchant to process SEPA Direct Debit payments.
sig { returns(T.nilable(SepaDebitPayments)) }
def sepa_debit_payments; end
# Capabilities that enable the merchant to manage their Stripe Balance (/v1/balance).
sig { returns(T.nilable(StripeBalance)) }
def stripe_balance; end
# Allow the merchant to process Swish payments.
sig { returns(T.nilable(SwishPayments)) }
def swish_payments; end
# Allow the merchant to process TWINT payments.
sig { returns(T.nilable(TwintPayments)) }
def twint_payments; end
# Allow the merchant to process US bank transfer payments.
sig { returns(T.nilable(UsBankTransferPayments)) }
def us_bank_transfer_payments; end
# Allow the merchant to process Zip payments.
sig { returns(T.nilable(ZipPayments)) }
def zip_payments; end
end
class CardPayments < Stripe::StripeObject
class DeclineOn < Stripe::StripeObject
# Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.
sig { returns(T.nilable(T::Boolean)) }
def avs_failure; end
# Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.
sig { returns(T.nilable(T::Boolean)) }
def cvc_failure; end
end
# Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.
sig { returns(T.nilable(DeclineOn)) }
def decline_on; end
end
class SepaDebitPayments < Stripe::StripeObject
# Creditor ID for SEPA debit payments.
sig { returns(T.nilable(String)) }
def creditor_id; end
end
class StatementDescriptor < Stripe::StripeObject
# The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don’t set a statement_descriptor_prefix, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the statement_descriptor text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation.
sig { returns(T.nilable(String)) }
def descriptor; end
# Default text that appears on statements for card charges outside of Japan, prefixing any dynamic statement_descriptor_suffix specified on the charge. To maximize space for the dynamic part of the descriptor, keep this text short. If you don’t specify this value, statement_descriptor is used as the prefix. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation.
sig { returns(T.nilable(String)) }
def prefix; end
end
class Support < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
# A publicly available mailing address for sending support issues to.
sig { returns(T.nilable(Address)) }
def address; end
# A publicly available email address for sending support issues to.
sig { returns(T.nilable(String)) }
def email; end
# A publicly available phone number to call with support issues.
sig { returns(T.nilable(String)) }
def phone; end
# A publicly available website for handling support issues.
sig { returns(T.nilable(String)) }
def url; end
end
# Represents the state of the configuration, and can be updated to deactivate or re-apply a configuration.
sig { returns(T::Boolean) }
def applied; end
# Settings used for Bacs debit payments.
sig { returns(T.nilable(BacsDebitPayments)) }
def bacs_debit_payments; end
# Settings used to apply the merchant's branding to email receipts, invoices, Checkout, and other products.
sig { returns(T.nilable(Branding)) }
def branding; end
# Capabilities that have been requested on the Merchant Configuration.
sig { returns(T.nilable(Capabilities)) }
def capabilities; end
# Card payments settings.
sig { returns(T.nilable(CardPayments)) }
def card_payments; end
# The merchant category code for the merchant. MCCs are used to classify businesses based on the goods or services they provide.
sig { returns(T.nilable(String)) }
def mcc; end
# Settings used for SEPA debit payments.
sig { returns(T.nilable(SepaDebitPayments)) }
def sepa_debit_payments; end
# Statement descriptor.
sig { returns(T.nilable(StatementDescriptor)) }
def statement_descriptor; end
# Publicly available contact information for sending support issues to.
sig { returns(T.nilable(Support)) }
def support; end
end
class Recipient < Stripe::StripeObject
class Capabilities < Stripe::StripeObject
class BankAccounts < Stripe::StripeObject
class Local < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class Wire < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
# Enables this Account to receive OutboundPayments to linked bank accounts over local networks.
sig { returns(T.nilable(Local)) }
def local; end
# Enables this Account to receive OutboundPayments to linked bank accounts over wire.
sig { returns(T.nilable(Wire)) }
def wire; end
end
class Cards < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class StripeBalance < Stripe::StripeObject
class Payouts < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class StripeTransfers < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
# Allows the account to do payouts using their Stripe Balance (/v1/balance).
sig { returns(T.nilable(Payouts)) }
def payouts; end
# Allows the account to receive /v1/transfers into their Stripe Balance (/v1/balance).
sig { returns(T.nilable(StripeTransfers)) }
def stripe_transfers; end
end
# Capabilities that enable OutboundPayments to a bank account linked to this Account.
sig { returns(T.nilable(BankAccounts)) }
def bank_accounts; end
# Capability that enable OutboundPayments to a debit card linked to this Account.
sig { returns(T.nilable(Cards)) }
def cards; end
# Capabilities that enable the recipient to manage their Stripe Balance (/v1/balance).
sig { returns(T.nilable(StripeBalance)) }
def stripe_balance; end
end
class DefaultOutboundDestination < Stripe::StripeObject
# The payout method ID of the default outbound destination.
sig { returns(String) }
def id; end
# Closed Enum. The payout method type of the default outbound destination.
sig { returns(String) }
def type; end
end
# Represents the state of the configuration, and can be updated to deactivate or re-apply a configuration.
sig { returns(T::Boolean) }
def applied; end
# Capabilities that have been requested on the Recipient Configuration.
sig { returns(T.nilable(Capabilities)) }
def capabilities; end
# The payout method to be used as a default outbound destination. This will allow the PayoutMethod to be omitted on OutboundPayments made through the dashboard.
sig { returns(T.nilable(DefaultOutboundDestination)) }
def default_outbound_destination; end
end
class Storer < Stripe::StripeObject
class Capabilities < Stripe::StripeObject
class FinancialAddresses < Stripe::StripeObject
class BankAccounts < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
# Can provision a bank-account like financial address (VBAN) to credit/debit a FinancialAccount.
sig { returns(T.nilable(BankAccounts)) }
def bank_accounts; end
end
class HoldsCurrencies < Stripe::StripeObject
class Gbp < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
# Can hold storage-type funds on Stripe in GBP.
sig { returns(T.nilable(Gbp)) }
def gbp; end
end
class InboundTransfers < Stripe::StripeObject
class BankAccounts < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
# Can pull funds from an external bank account, owned by yourself, to a FinancialAccount.
sig { returns(T.nilable(BankAccounts)) }
def bank_accounts; end
end
class OutboundPayments < Stripe::StripeObject
class BankAccounts < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class Cards < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class FinancialAccounts < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
# Can send funds from a FinancialAccount to a bank account, owned by someone else.
sig { returns(T.nilable(BankAccounts)) }
def bank_accounts; end
# Can send funds from a FinancialAccount to a debit card, owned by someone else.
sig { returns(T.nilable(Cards)) }
def cards; end
# Can send funds from a FinancialAccount to another FinancialAccount, owned by someone else.
sig { returns(T.nilable(FinancialAccounts)) }
def financial_accounts; end
end
class OutboundTransfers < Stripe::StripeObject
class BankAccounts < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
class FinancialAccounts < Stripe::StripeObject
class StatusDetail < Stripe::StripeObject
# Machine-readable code explaining the reason for the Capability to be in its current status.
sig { returns(String) }
def code; end
# Machine-readable code explaining how to make the Capability active.
sig { returns(String) }
def resolution; end
end
# Whether the Capability has been requested.
sig { returns(T::Boolean) }
def requested; end
# The status of the Capability.
sig { returns(String) }
def status; end
# Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
sig { returns(T::Array[StatusDetail]) }
def status_details; end
end
# Can send funds from a FinancialAccount, to a bank account, owned by yourself.
sig { returns(T.nilable(BankAccounts)) }
def bank_accounts; end
# Can send funds from a FinancialAccount to another FinancialAccount, owned by yourself.
sig { returns(T.nilable(FinancialAccounts)) }
def financial_accounts; end
end
# Can provision a financial address to credit/debit a FinancialAccount.
sig { returns(T.nilable(FinancialAddresses)) }
def financial_addresses; end
# Can hold storage-type funds on Stripe.
sig { returns(T.nilable(HoldsCurrencies)) }
def holds_currencies; end
# Can pull funds from an external source, owned by yourself, to a FinancialAccount.
sig { returns(T.nilable(InboundTransfers)) }
def inbound_transfers; end
# Can send funds from a FinancialAccount to a destination owned by someone else.
sig { returns(T.nilable(OutboundPayments)) }
def outbound_payments; end
# Can send funds from a FinancialAccount to a destination owned by yourself.
sig { returns(T.nilable(OutboundTransfers)) }
def outbound_transfers; end
end
# Represents the state of the configuration, and can be updated to deactivate or re-apply a configuration.
sig { returns(T::Boolean) }
def applied; end
# Capabilities that have been requested on the Storer Configuration.
sig { returns(T.nilable(Capabilities)) }
def capabilities; end
end
# The Customer Configuration allows the Account to be used in inbound payment flows.
sig { returns(T.nilable(Customer)) }
def customer; end
# The Merchant configuration allows the Account to act as a connected account and collect payments facilitated by a Connect platform. You can add this configuration to your connected accounts only if you’ve completed onboarding as a Connect platform.
sig { returns(T.nilable(Merchant)) }
def merchant; end
# The Recipient Configuration allows the Account to receive funds.
sig { returns(T.nilable(Recipient)) }
def recipient; end
# The Storer Configuration allows the Account to store and move funds using stored-value FinancialAccounts.
sig { returns(T.nilable(Storer)) }
def storer; end
end
class Defaults < Stripe::StripeObject
class Responsibilities < Stripe::StripeObject
# A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this Account.
sig { returns(String) }
def fees_collector; end
# A value indicating who is responsible for losses when this Account can’t pay back negative balances from payments.
sig { returns(String) }
def losses_collector; end
end
# 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(T.nilable(String)) }
def currency; end
# The Account's preferred locales (languages), ordered by preference.
sig { returns(T.nilable(T::Array[String])) }
def locales; end
# Default responsibilities held by either Stripe or the platform.
sig { returns(T.nilable(Responsibilities)) }
def responsibilities; end
end
class Identity < Stripe::StripeObject
class Attestations < Stripe::StripeObject
class DirectorshipDeclaration < Stripe::StripeObject
# The time marking when the director attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def date; end
# The IP address from which the director attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
# The user agent of the browser from which the director attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
end
class OwnershipDeclaration < Stripe::StripeObject
# The time marking when the beneficial owner attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def date; end
# The IP address from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
# The user agent of the browser from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
end
class PersonsProvided < Stripe::StripeObject
# Whether the company’s directors have been provided. Set this Boolean to true after creating all the company’s directors with the [Persons API](https://docs.stripe.com/api/v2/core/accounts/createperson).
sig { returns(T.nilable(T::Boolean)) }
def directors; end
# Whether the company’s executives have been provided. Set this Boolean to true after creating all the company’s executives with the [Persons API](https://docs.stripe.com/api/v2/core/accounts/createperson).
sig { returns(T.nilable(T::Boolean)) }
def executives; end
# Whether the company’s owners have been provided. Set this Boolean to true after creating all the company’s owners with the [Persons API](https://docs.stripe.com/api/v2/core/accounts/createperson).
sig { returns(T.nilable(T::Boolean)) }
def owners; end
# Reason for why the company is exempt from providing ownership information.
sig { returns(T.nilable(String)) }
def ownership_exemption_reason; end
end
class TermsOfService < Stripe::StripeObject
class Account < Stripe::StripeObject
# The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def date; end
# The IP address from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def ip; end
# The user agent of the browser from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def user_agent; end
end
class Storer < Stripe::StripeObject
# The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def date; end
# The IP address from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def ip; end
# The user agent of the browser from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def user_agent; end
end
# Details on the Account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance).
sig { returns(T.nilable(Account)) }
def account; end
# Details on the Account's acceptance of Treasury-specific terms of service.
sig { returns(T.nilable(Storer)) }
def storer; end
end
# This hash is used to attest that the directors information provided to Stripe is both current and correct.
sig { returns(T.nilable(DirectorshipDeclaration)) }
def directorship_declaration; end
# This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
sig { returns(T.nilable(OwnershipDeclaration)) }
def ownership_declaration; end
# Attestation that all Persons with a specific Relationship value have been provided.
sig { returns(T.nilable(PersonsProvided)) }
def persons_provided; end
# Attestations of accepted terms of service agreements.
sig { returns(T.nilable(TermsOfService)) }
def terms_of_service; end
end
class BusinessDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
class AnnualRevenue < Stripe::StripeObject
# A non-negative integer representing the amount in the smallest currency unit.
sig { returns(T.nilable(Stripe::V2::Amount)) }
def amount; end
# The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
sig { returns(T.nilable(String)) }
def fiscal_year_end; end
end
class Documents < Stripe::StripeObject
class BankAccountOwnershipVerification < Stripe::StripeObject
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
end
class CompanyLicense < Stripe::StripeObject
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
end
class CompanyMemorandumOfAssociation < Stripe::StripeObject
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
end
class CompanyMinisterialDecree < Stripe::StripeObject
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
end
class CompanyRegistrationVerification < Stripe::StripeObject
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
end
class CompanyTaxIdVerification < Stripe::StripeObject
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
end
class PrimaryVerification < Stripe::StripeObject
class FrontBack < Stripe::StripeObject
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(String) }
def front; end
end
# The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens for the front and back of the verification document.
sig { returns(FrontBack) }
def front_back; end
# The format of the verification document. Currently supports `front_back` only.
sig { returns(String) }
def type; end
end
class ProofOfAddress < Stripe::StripeObject
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
end
class ProofOfRegistration < Stripe::StripeObject
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
end
class ProofOfUltimateBeneficialOwnership < Stripe::StripeObject
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
end
# One or more documents that support the Bank account ownership verification requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check.
sig { returns(T.nilable(BankAccountOwnershipVerification)) }
def bank_account_ownership_verification; end
# One or more documents that demonstrate proof of a company’s license to operate.
sig { returns(T.nilable(CompanyLicense)) }
def company_license; end
# One or more documents showing the company’s Memorandum of Association.
sig { returns(T.nilable(CompanyMemorandumOfAssociation)) }
def company_memorandum_of_association; end
# Certain countries only: One or more documents showing the ministerial decree legalizing the company’s establishment.
sig { returns(T.nilable(CompanyMinisterialDecree)) }
def company_ministerial_decree; end
# One or more documents that demonstrate proof of a company’s registration with the appropriate local authorities.
sig { returns(T.nilable(CompanyRegistrationVerification)) }
def company_registration_verification; end
# One or more documents that demonstrate proof of a company’s tax ID.
sig { returns(T.nilable(CompanyTaxIdVerification)) }
def company_tax_id_verification; end
# A document verifying the business.
sig { returns(T.nilable(PrimaryVerification)) }
def primary_verification; end
# One or more documents that demonstrate proof of address.
sig { returns(T.nilable(ProofOfAddress)) }
def proof_of_address; end
# One or more documents showing the company’s proof of registration with the national business registry.
sig { returns(T.nilable(ProofOfRegistration)) }
def proof_of_registration; end
# One or more documents that demonstrate proof of ultimate beneficial ownership.
sig { returns(T.nilable(ProofOfUltimateBeneficialOwnership)) }
def proof_of_ultimate_beneficial_ownership; end
end
class IdNumber < Stripe::StripeObject
# The registrar of the ID number (Only valid for DE ID number types).
sig { returns(T.nilable(String)) }
def registrar; end
# Open Enum. The ID number type of a business entity.
sig { returns(String) }
def type; end
end
class MonthlyEstimatedRevenue < Stripe::StripeObject
# A non-negative integer representing the amount in the smallest currency unit.
sig { returns(T.nilable(Stripe::V2::Amount)) }
def amount; end
end
class ScriptAddresses < Stripe::StripeObject
class Kana < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
class Kanji < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
# Kana Address.
sig { returns(T.nilable(Kana)) }
def kana; end
# Kanji Address.
sig { returns(T.nilable(Kanji)) }
def kanji; end
end
class ScriptNames < Stripe::StripeObject
class Kana < Stripe::StripeObject
# Registered name of the business.
sig { returns(T.nilable(String)) }
def registered_name; end
end
class Kanji < Stripe::StripeObject
# Registered name of the business.
sig { returns(T.nilable(String)) }
def registered_name; end
end
# Kana name.
sig { returns(T.nilable(Kana)) }
def kana; end
# Kanji name.
sig { returns(T.nilable(Kanji)) }
def kanji; end
end
# The company’s primary address.
sig { returns(T.nilable(Address)) }
def address; end
# The business gross annual revenue for its preceding fiscal year.
sig { returns(T.nilable(AnnualRevenue)) }
def annual_revenue; end
# Documents that may be submitted to satisfy various informational requests.
sig { returns(T.nilable(Documents)) }
def documents; end
# The company’s legal name.
sig { returns(T.nilable(String)) }
def doing_business_as; end
# An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
sig { returns(T.nilable(Integer)) }
def estimated_worker_count; end
# The provided ID numbers of a business entity.
sig { returns(T.nilable(T::Array[IdNumber])) }
def id_numbers; end
# An estimate of the monthly revenue of the business.
sig { returns(T.nilable(MonthlyEstimatedRevenue)) }
def monthly_estimated_revenue; end
# The company’s phone number (used for verification).
sig { returns(T.nilable(String)) }
def phone; end
# Internal-only description of the product sold or service provided by the business. It’s used by Stripe for risk and underwriting purposes.
sig { returns(T.nilable(String)) }
def product_description; end
# The business legal name.
sig { returns(T.nilable(String)) }
def registered_name; end
# The business registration address of the business entity in non latin script.
sig { returns(T.nilable(ScriptAddresses)) }
def script_addresses; end
# The business legal name in non latin script.
sig { returns(T.nilable(ScriptNames)) }
def script_names; end
# The category identifying the legal structure of the business.
sig { returns(T.nilable(String)) }
def structure; end
# The business's publicly available website.
sig { returns(T.nilable(String)) }
def url; end
end
class Individual < Stripe::StripeObject
class AdditionalAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# Purpose of additional address.
sig { returns(String) }
def purpose; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
class AdditionalName < Stripe::StripeObject
# The individual's full name.
sig { returns(T.nilable(String)) }
def full_name; end
# The individual's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
# The purpose or type of the additional name.
sig { returns(String) }
def purpose; end
# The individual's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
end
class AdditionalTermsOfService < Stripe::StripeObject
class Account < Stripe::StripeObject
# The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def date; end
# The IP address from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def ip; end
# The user agent of the browser from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def user_agent; end
end
# Stripe terms of service agreement.
sig { returns(T.nilable(Account)) }
def account; end
end
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
class DateOfBirth < Stripe::StripeObject
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
end
class Documents < Stripe::StripeObject
class CompanyAuthorization < Stripe::StripeObject
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
end
class Passport < Stripe::StripeObject
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
end
class PrimaryVerification < Stripe::StripeObject
class FrontBack < Stripe::StripeObject
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(String) }
def front; end
end
# The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens for the front and back of the verification document.
sig { returns(FrontBack) }
def front_back; end
# The format of the verification document. Currently supports `front_back` only.
sig { returns(String) }
def type; end
end
class SecondaryVerification < Stripe::StripeObject
class FrontBack < Stripe::StripeObject
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(String) }
def front; end
end
# The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens for the front and back of the verification document.
sig { returns(FrontBack) }
def front_back; end
# The format of the verification document. Currently supports `front_back` only.
sig { returns(String) }
def type; end
end
class Visa < Stripe::StripeObject
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
end
# One or more documents that demonstrate proof that this person is authorized to represent the company.
sig { returns(T.nilable(CompanyAuthorization)) }
def company_authorization; end
# One or more documents showing the person’s passport page with photo and personal data.
sig { returns(T.nilable(Passport)) }
def passport; end
# An identifying document showing the person's name, either a passport or local ID card.
sig { returns(T.nilable(PrimaryVerification)) }
def primary_verification; end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig { returns(T.nilable(SecondaryVerification)) }
def secondary_verification; end
# One or more documents showing the person’s visa required for living in the country where they are residing.
sig { returns(T.nilable(Visa)) }
def visa; end
end
class IdNumber < Stripe::StripeObject
# The ID number type of an individual.
sig { returns(String) }
def type; end
end
class Relationship < Stripe::StripeObject
# Whether the individual is an authorizer of the Account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def authorizer; end
# Whether the individual is a director of the Account’s legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
sig { returns(T.nilable(T::Boolean)) }
def director; end
# Whether the individual has significant responsibility to control, manage, or direct the organization.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
# Whether the individual is the legal guardian of the Account’s representative.
sig { returns(T.nilable(T::Boolean)) }
def legal_guardian; end
# Whether the individual is an owner of the Account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
# The percent owned by the individual of the Account’s legal entity.
sig { returns(T.nilable(String)) }
def percent_ownership; end
# Whether the individual is authorized as the primary representative of the Account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
sig { returns(T.nilable(T::Boolean)) }
def representative; end
# The individual's title (e.g., CEO, Support Engineer).
sig { returns(T.nilable(String)) }
def title; end
end
class ScriptAddresses < Stripe::StripeObject
class Kana < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
class Kanji < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
# Kana Address.
sig { returns(T.nilable(Kana)) }
def kana; end
# Kanji Address.
sig { returns(T.nilable(Kanji)) }
def kanji; end
end
class ScriptNames < Stripe::StripeObject
class Kana < Stripe::StripeObject
# The person's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
# The person's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
end
class Kanji < Stripe::StripeObject
# The person's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
# The person's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
end
# Persons name in kana script.
sig { returns(T.nilable(Kana)) }
def kana; end
# Persons name in kanji script.
sig { returns(T.nilable(Kanji)) }
def kanji; end
end
# The account ID which the individual belongs to.
sig { returns(String) }
def account; end
# Additional addresses associated with the individual.
sig { returns(T.nilable(T::Array[AdditionalAddress])) }
def additional_addresses; end
# Additional names (e.g. aliases) associated with the individual.
sig { returns(T.nilable(T::Array[AdditionalName])) }
def additional_names; end
# Terms of service acceptances.
sig { returns(T.nilable(AdditionalTermsOfService)) }
def additional_terms_of_service; end
# The individual's residential address.
sig { returns(T.nilable(Address)) }
def address; end
# Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(String) }
def created; end
# The individual's date of birth.
sig { returns(T.nilable(DateOfBirth)) }
def date_of_birth; end
# Documents that may be submitted to satisfy various informational requests.
sig { returns(T.nilable(Documents)) }
def documents; end
# The individual's email address.
sig { returns(T.nilable(String)) }
def email; end
# The individual's first name.
sig { returns(T.nilable(String)) }
def given_name; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# The identification numbers (e.g., SSN) associated with the individual.
sig { returns(T.nilable(T::Array[IdNumber])) }
def id_numbers; end
# The individual's gender (International regulations require either "male” or "female").
sig { returns(T.nilable(String)) }
def legal_gender; end
# Set of key-value pairs 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])) }
def metadata; end
# The countries where the individual is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(T::Array[String])) }
def nationalities; end
# String representing the object's type. Objects of the same type share the same value.
sig { returns(String) }
def object; end
# The individual's phone number.
sig { returns(T.nilable(String)) }
def phone; end
# Indicates if the individual or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
sig { returns(T.nilable(String)) }
def political_exposure; end
# The relationship that this individual has with the Account's identity.
sig { returns(T.nilable(Relationship)) }
def relationship; end
# The script addresses (e.g., non-Latin characters) associated with the individual.
sig { returns(T.nilable(ScriptAddresses)) }
def script_addresses; end
# The script names (e.g. non-Latin characters) associated with the individual.
sig { returns(T.nilable(ScriptNames)) }
def script_names; end
# The individual's last name.
sig { returns(T.nilable(String)) }
def surname; end
# Time at which the object was last updated.
sig { returns(String) }
def updated; end
end
# Attestations from the identity's key people, e.g. owners, executives, directors.
sig { returns(T.nilable(Attestations)) }
def attestations; end
# Information about the company or business.
sig { returns(T.nilable(BusinessDetails)) }
def business_details; end
# The country in which the account holder resides, or in which the business is legally established. This should be an [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.
sig { returns(T.nilable(String)) }
def country; end
# The entity type.
sig { returns(T.nilable(String)) }
def entity_type; end
# Information about the individual represented by the Account. This property is `null` unless `entity_type` is set to `individual`.
sig { returns(T.nilable(Individual)) }
def individual; end
end
class Requirements < Stripe::StripeObject
class Entry < Stripe::StripeObject
class Error < Stripe::StripeObject
# Machine-readable code describing the error.
sig { returns(String) }
def code; end
# Human-readable description of the error.
sig { returns(String) }
def description; end
end
class Impact < Stripe::StripeObject
class RestrictsCapability < Stripe::StripeObject
class Deadline < Stripe::StripeObject
# The current status of the requirement's impact.
sig { returns(String) }
def status; end
end
# The name of the Capability which will be restricted.
sig { returns(String) }
def capability; end
# The configuration which specifies the Capability which will be restricted.
sig { returns(String) }
def configuration; end
# Details about when in the account lifecycle the requirement must be collected by the avoid the Capability restriction.
sig { returns(Deadline) }
def deadline; end
end
# The Capabilities that will be restricted if the requirement is not collected and satisfactory to Stripe.
sig { returns(T.nilable(T::Array[RestrictsCapability])) }
def restricts_capabilities; end
end
class MinimumDeadline < Stripe::StripeObject
# The current status of the requirement's impact.
sig { returns(String) }
def status; end
end
class Reference < Stripe::StripeObject
# If `inquiry` is the type, the inquiry token.
sig { returns(T.nilable(String)) }
def inquiry; end
# If `resource` is the type, the resource token.
sig { returns(T.nilable(String)) }
def resource; end
# The type of the reference. An additional hash is included with a name matching the type. It contains additional information specific to the type.
sig { returns(String) }
def type; end
end
class RequestedReason < Stripe::StripeObject
# Machine-readable description of Stripe's reason for collecting the requirement.
sig { returns(String) }
def code; end
end
# Whether the responsibility is with the integrator or with Stripe (to review info, to wait for some condition, etc.) to action the requirement.
sig { returns(String) }
def awaiting_action_from; end
# Machine-readable string describing the requirement.
sig { returns(String) }
def description; end
# Descriptions of why the requirement must be collected, or why the collected information isn't satisfactory to Stripe.
sig { returns(T::Array[Error]) }
def errors; end
# A hash describing the impact of not collecting the requirement, or Stripe not being able to verify the collected information.
sig { returns(Impact) }
def impact; end
# The soonest point when the account will be impacted by not providing the requirement.
sig { returns(MinimumDeadline) }
def minimum_deadline; end
# A reference to the location of the requirement.
sig { returns(T.nilable(Reference)) }
def reference; end
# A list of reasons why Stripe is collecting the requirement.
sig { returns(T::Array[RequestedReason]) }
def requested_reasons; end
end
class Summary < Stripe::StripeObject
class MinimumDeadline < Stripe::StripeObject
# The current strictest status of all requirements on the Account.
sig { returns(String) }
def status; end
# The soonest RFC3339 date & time UTC value a requirement can impact the Account.
sig { returns(T.nilable(String)) }
def time; end
end
# The soonest date and time a requirement on the Account will become `past due`. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: `2022-09-18T13:22:18.123Z`.
sig { returns(T.nilable(MinimumDeadline)) }
def minimum_deadline; end
end
# A value indicating responsibility for collecting requirements on this account.
sig { returns(String) }
def collector; end
# A list of requirements for the Account.
sig { returns(T.nilable(T::Array[Entry])) }
def entries; end
# An object containing an overview of requirements for the Account.
sig { returns(T.nilable(Summary)) }
def summary; end
end
# Filter only accounts that have all of the configurations specified. If omitted, returns all accounts regardless of which configurations they have.
sig { returns(T::Array[String]) }
def applied_configurations; end
# An Account Configuration which allows the Account to take on a key persona across Stripe products.
sig { returns(T.nilable(Configuration)) }
def configuration; end
# The default contact email address for the Account. Required when configuring the account as a merchant or recipient.
sig { returns(T.nilable(String)) }
def contact_email; end
# Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(String) }
def created; end
# A value indicating the Stripe dashboard this Account has access to. This will depend on which configurations are enabled for this account.
sig { returns(T.nilable(String)) }
def dashboard; end
# Default values to be used on Account Configurations.
sig { returns(T.nilable(Defaults)) }
def defaults; end
# A descriptive name for the Account. This name will be surfaced in the Stripe Dashboard and on any invoices sent to the Account.
sig { returns(T.nilable(String)) }
def display_name; end
# Unique identifier for the Account.
sig { returns(String) }
def id; end
# Information about the company, individual, and business represented by the Account.
sig { returns(T.nilable(Identity)) }
def identity; end
# Set of key-value pairs 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# Information about the requirements for the Account, including what information needs to be collected, and by when.
sig { returns(T.nilable(Requirements)) }
def requirements; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
module Core
# Person retrieval response schema.
class AccountPerson < APIResource
class AdditionalAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# Purpose of additional address.
sig { returns(String) }
def purpose; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
class AdditionalName < Stripe::StripeObject
# The individual's full name.
sig { returns(T.nilable(String)) }
def full_name; end
# The individual's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
# The purpose or type of the additional name.
sig { returns(String) }
def purpose; end
# The individual's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
end
class AdditionalTermsOfService < Stripe::StripeObject
class Account < Stripe::StripeObject
# The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def date; end
# The IP address from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def ip; end
# The user agent of the browser from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def user_agent; end
end
# Stripe terms of service agreement.
sig { returns(T.nilable(Account)) }
def account; end
end
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
class DateOfBirth < Stripe::StripeObject
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
end
class Documents < Stripe::StripeObject
class CompanyAuthorization < Stripe::StripeObject
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
end
class Passport < Stripe::StripeObject
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
end
class PrimaryVerification < Stripe::StripeObject
class FrontBack < Stripe::StripeObject
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(String) }
def front; end
end
# The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens for the front and back of the verification document.
sig { returns(FrontBack) }
def front_back; end
# The format of the verification document. Currently supports `front_back` only.
sig { returns(String) }
def type; end
end
class SecondaryVerification < Stripe::StripeObject
class FrontBack < Stripe::StripeObject
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(String) }
def front; end
end
# The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens for the front and back of the verification document.
sig { returns(FrontBack) }
def front_back; end
# The format of the verification document. Currently supports `front_back` only.
sig { returns(String) }
def type; end
end
class Visa < Stripe::StripeObject
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
end
# One or more documents that demonstrate proof that this person is authorized to represent the company.
sig { returns(T.nilable(CompanyAuthorization)) }
def company_authorization; end
# One or more documents showing the person’s passport page with photo and personal data.
sig { returns(T.nilable(Passport)) }
def passport; end
# An identifying document showing the person's name, either a passport or local ID card.
sig { returns(T.nilable(PrimaryVerification)) }
def primary_verification; end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig { returns(T.nilable(SecondaryVerification)) }
def secondary_verification; end
# One or more documents showing the person’s visa required for living in the country where they are residing.
sig { returns(T.nilable(Visa)) }
def visa; end
end
class IdNumber < Stripe::StripeObject
# The ID number type of an individual.
sig { returns(String) }
def type; end
end
class Relationship < Stripe::StripeObject
# Whether the individual is an authorizer of the Account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def authorizer; end
# Whether the individual is a director of the Account’s legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
sig { returns(T.nilable(T::Boolean)) }
def director; end
# Whether the individual has significant responsibility to control, manage, or direct the organization.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
# Whether the individual is the legal guardian of the Account’s representative.
sig { returns(T.nilable(T::Boolean)) }
def legal_guardian; end
# Whether the individual is an owner of the Account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
# The percent owned by the individual of the Account’s legal entity.
sig { returns(T.nilable(String)) }
def percent_ownership; end
# Whether the individual is authorized as the primary representative of the Account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
sig { returns(T.nilable(T::Boolean)) }
def representative; end
# The individual's title (e.g., CEO, Support Engineer).
sig { returns(T.nilable(String)) }
def title; end
end
class ScriptAddresses < Stripe::StripeObject
class Kana < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
class Kanji < Stripe::StripeObject
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
end
# Kana Address.
sig { returns(T.nilable(Kana)) }
def kana; end
# Kanji Address.
sig { returns(T.nilable(Kanji)) }
def kanji; end
end
class ScriptNames < Stripe::StripeObject
class Kana < Stripe::StripeObject
# The person's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
# The person's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
end
class Kanji < Stripe::StripeObject
# The person's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
# The person's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
end
# Persons name in kana script.
sig { returns(T.nilable(Kana)) }
def kana; end
# Persons name in kanji script.
sig { returns(T.nilable(Kanji)) }
def kanji; end
end
# The account ID which the individual belongs to.
sig { returns(String) }
def account; end
# Additional addresses associated with the person.
sig { returns(T.nilable(T::Array[AdditionalAddress])) }
def additional_addresses; end
# Additional names (e.g. aliases) associated with the person.
sig { returns(T.nilable(T::Array[AdditionalName])) }
def additional_names; end
# Attestations of accepted terms of service agreements.
sig { returns(T.nilable(AdditionalTermsOfService)) }
def additional_terms_of_service; end
# The person's residential address.
sig { returns(T.nilable(Address)) }
def address; end
# Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(String) }
def created; end
# The person's date of birth.
sig { returns(T.nilable(DateOfBirth)) }
def date_of_birth; end
# Documents that may be submitted to satisfy various informational requests.
sig { returns(T.nilable(Documents)) }
def documents; end
# The person's email address.
sig { returns(T.nilable(String)) }
def email; end
# The person's first name.
sig { returns(T.nilable(String)) }
def given_name; end
# Unique identifier for the Person.
sig { returns(String) }
def id; end
# The identification numbers (e.g., SSN) associated with the person.
sig { returns(T.nilable(T::Array[IdNumber])) }
def id_numbers; end
# The person's gender (International regulations require either "male" or "female").
sig { returns(T.nilable(String)) }
def legal_gender; end
# Set of key-value pairs 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])) }
def metadata; end
# The countries where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(T::Array[String])) }
def nationalities; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# The person's phone number.
sig { returns(T.nilable(String)) }
def phone; end
# The person's political exposure.
sig { returns(T.nilable(String)) }
def political_exposure; end
# The relationship that this person has with the Account's business or legal entity.
sig { returns(T.nilable(Relationship)) }
def relationship; end
# The script addresses (e.g., non-Latin characters) associated with the person.
sig { returns(T.nilable(ScriptAddresses)) }
def script_addresses; end
# The script names (e.g. non-Latin characters) associated with the person.
sig { returns(T.nilable(ScriptNames)) }
def script_names; end
# The person's last name.
sig { returns(T.nilable(String)) }
def surname; end
# Time at which the object was last updated. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(String) }
def updated; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
# Set up an event destination to receive events from Stripe across multiple destination types, including [webhook endpoints](https://docs.stripe.com/webhooks) and [Amazon EventBridge](https://docs.stripe.com/event-destinations/eventbridge). Event destinations support receiving [thin events](https://docs.stripe.com/api/v2/events) and [snapshot events](https://docs.stripe.com/api/events).
class EventDestination < APIResource
class StatusDetails < Stripe::StripeObject
class Disabled < Stripe::StripeObject
# Reason event destination has been disabled.
sig { returns(String) }
def reason; end
end
# Details about why the event destination has been disabled.
sig { returns(T.nilable(Disabled)) }
def disabled; end
end
class AmazonEventbridge < Stripe::StripeObject
# The AWS account ID.
sig { returns(String) }
def aws_account_id; end
# The ARN of the AWS event source.
sig { returns(String) }
def aws_event_source_arn; end
# The state of the AWS event source.
sig { returns(String) }
def aws_event_source_status; end
end
class WebhookEndpoint < Stripe::StripeObject
# The signing secret of the webhook endpoint, only includable on creation.
sig { returns(T.nilable(String)) }
def signing_secret; end
# The URL of the webhook endpoint, includable.
sig { returns(T.nilable(String)) }
def url; end
end
# Time at which the object was created.
sig { returns(String) }
def created; end
# An optional description of what the event destination is used for.
sig { returns(String) }
def description; end
# The list of events to enable for this endpoint.
sig { returns(T::Array[String]) }
def enabled_events; end
# Payload type of events being subscribed to.
sig { returns(String) }
def event_payload; end
# Where events should be routed from.
sig { returns(T.nilable(T::Array[String])) }
def events_from; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Metadata.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
# Event destination name.
sig { returns(String) }
def name; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# If using the snapshot event payload, the API version events are rendered as.
sig { returns(T.nilable(String)) }
def snapshot_api_version; end
# Status. It can be set to either enabled or disabled.
sig { returns(String) }
def status; end
# Additional information about event destination status.
sig { returns(T.nilable(StatusDetails)) }
def status_details; end
# Event destination type.
sig { returns(String) }
def type; end
# Time at which the object was last updated.
sig { returns(String) }
def updated; end
# 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) }
def livemode; end
# Amazon EventBridge configuration.
sig { returns(T.nilable(AmazonEventbridge)) }
def amazon_eventbridge; end
# Webhook endpoint configuration.
sig { returns(T.nilable(WebhookEndpoint)) }
def webhook_endpoint; end
end
end
end
# typed: true
module Stripe
module V2
# Events are generated to keep you informed of activity in your business account. APIs in the /v2 namespace generate [thin events](https://docs.stripe.com/event-destinations#benefits-of-thin-events) which have small, unversioned payloads that include a reference to the ID of the object that has changed. The Events v2 API returns these new thin events. [Retrieve the event object](https://docs.stripe.com/event-destinations#fetch-data) for additional data about the event. Use the related object ID in the event payload to [fetch the API resource](https://docs.stripe.com/event-destinations#retrieve-the-object-associated-with-thin-events) of the object associated with the event. Comparatively, events generated by most API v1 include a versioned snapshot of an API object in their payload.
class Event < APIResource
class Reason < Stripe::StripeObject
class Request < Stripe::StripeObject
# ID of the API request that caused the event.
sig { returns(String) }
def id; end
# The idempotency key transmitted during the request.
sig { returns(String) }
def idempotency_key; end
end
# Event reason type.
sig { returns(String) }
def type; end
# Information on the API request that instigated the event.
sig { returns(T.nilable(Request)) }
def request; end
end
# Authentication context needed to fetch the event or related object.
sig { returns(T.nilable(String)) }
def context; end
# Time at which the object was created.
sig { returns(String) }
def created; end
# Unique identifier for the event.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# Reason for the event.
sig { returns(T.nilable(Reason)) }
def reason; end
# The type of the event.
sig { returns(String) }
def type; end
# 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) }
def livemode; end
end
end
end
# typed: true
module Stripe
module V2
module Core
module Vault
# Use the GBBankAccounts API to create and manage GB bank account objects
class GbBankAccount < APIResource
class ConfirmationOfPayee < Stripe::StripeObject
class Result < Stripe::StripeObject
class Matched < Stripe::StripeObject
# The business type given by the bank for this account, in case of a MATCH or PARTIAL_MATCH.
# Closed enum.
sig { returns(T.nilable(String)) }
def business_type; end
# The name given by the bank for this account, in case of a MATCH or PARTIAL_MATCH.
sig { returns(T.nilable(String)) }
def name; end
end
class Provided < Stripe::StripeObject
# The provided or Legal Entity business type to match against the CoP service. Closed enum.
sig { returns(String) }
def business_type; end
# The provided or Legal Entity name to match against the CoP service.
sig { returns(String) }
def name; end
end
# When the CoP result was created.
sig { returns(String) }
def created; end
# Whether or not the information of the bank account matches what you have provided. Closed enum.
sig { returns(String) }
def match_result; end
# The fields that CoP service matched against. Only has value if MATCH or PARTIAL_MATCH, empty otherwise.
sig { returns(Matched) }
def matched; end
# Human-readable message describing the match result.
sig { returns(String) }
def message; end
# The fields that are matched against what the network has on file.
sig { returns(Provided) }
def provided; end
end
# The result of the Confirmation of Payee check, once the check has been initiated. Closed enum.
sig { returns(Result) }
def result; end
# The current state of Confirmation of Payee on this bank account. Closed enum.
sig { returns(String) }
def status; end
end
# Whether this bank account object was archived. Bank account objects can be archived through
# the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects
# cannot be used as outbound destinations and will not appear in the outbound destination list.
sig { returns(T::Boolean) }
def archived; end
# Closed Enum. The type of the bank account (checking or savings).
sig { returns(String) }
def bank_account_type; end
# The name of the bank.
sig { returns(String) }
def bank_name; end
# Information around the status of Confirmation of Payee matching done on this bank account.
# Confirmation of Payee is a name matching service that must be done before making OutboundPayments in the UK.
sig { returns(ConfirmationOfPayee) }
def confirmation_of_payee; end
# Creation time.
sig { returns(String) }
def created; end
# The ID of the GBBankAccount object.
sig { returns(String) }
def id; end
# The last 4 digits of the account number or IBAN.
sig { returns(String) }
def last4; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# The Sort Code of the bank account.
sig { returns(String) }
def sort_code; end
# 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) }
def livemode; end
end
end
end
end
end
# typed: true
module Stripe
module V2
module Core
module Vault
# Use the USBankAccounts API to create and manage US bank accounts objects that you can use to receive funds. Note that these are not interchangeable with v1 Tokens.
class UsBankAccount < APIResource
# Whether this USBankAccount object was archived.
sig { returns(T::Boolean) }
def archived; end
# Closed Enum. The type of bank account (checking or savings).
sig { returns(String) }
def bank_account_type; end
# The name of the bank this bank account belongs to. This field is populated automatically by Stripe based on the routing number.
sig { returns(String) }
def bank_name; end
# Creation time of the object.
sig { returns(String) }
def created; end
# The fedwire routing number of the bank account.
sig { returns(T.nilable(String)) }
def fedwire_routing_number; end
# The ID of the USBankAccount object.
sig { returns(String) }
def id; end
# The last 4 digits of the account number.
sig { returns(String) }
def last4; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# The ACH routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
# 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) }
def livemode; end
end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
# Adjustments represent Stripe-initiated credits or debits to a user balance. They might be used to amend balances due to technical or operational error.
class Adjustment < APIResource
class AdjustedFlow < Stripe::StripeObject
# Closed Enum. If applicable, the type of flow linked to this Adjustment. The field matching this value will contain the ID of the flow.
sig { returns(String) }
def type; end
# If applicable, the ID of the Adjustment linked to this Adjustment.
sig { returns(T.nilable(String)) }
def adjustment; end
# If applicable, the ID of the InboundTransfer linked to this Adjustment.
sig { returns(T.nilable(String)) }
def inbound_transfer; end
# If applicable, the ID of the OutboundPayment linked to this Adjustment.
sig { returns(T.nilable(String)) }
def outbound_payment; end
# If applicable, the ID of the OutboundTransfer linked to this Adjustment.
sig { returns(T.nilable(String)) }
def outbound_transfer; end
# If applicable, the ID of the ReceivedCredit linked to this Adjustment.
sig { returns(T.nilable(String)) }
def received_credit; end
# If applicable, the ID of the ReceivedDebit linked to this Adjustment.
sig { returns(T.nilable(String)) }
def received_debit; end
end
# If applicable, contains information about the original flow linked to this Adjustment.
sig { returns(T.nilable(AdjustedFlow)) }
def adjusted_flow; end
# The amount of the Adjustment.
sig { returns(Stripe::V2::Amount) }
def amount; end
# Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(String) }
def created; end
# Description of the Adjustment and what it was used for.
sig { returns(T.nilable(String)) }
def description; end
# The FinancialAccount that this adjustment is for.
sig { returns(String) }
def financial_account; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# A link to the Stripe-hosted receipt that is provided when money movement is considered regulated under Stripe’s money transmission licenses. The receipt link remains active for 60 days from the Adjustment creation date. After this period, the link will expire and the receipt url value will be null.
sig { returns(T.nilable(String)) }
def receipt_url; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
# A FinancialAccount represents a balance and can be used as the source or destination for the money management (`/v2/money_management`) APIs.
class FinancialAccount < APIResource
class Balance < Stripe::StripeObject
# Balance that can be used for money movement.
sig { returns(T::Hash[String, Stripe::V2::Amount]) }
def available; end
# Balance of inbound funds that will later transition to the `available` balance.
sig { returns(T::Hash[String, Stripe::V2::Amount]) }
def inbound_pending; end
# Balance of funds that are being used for a pending outbound money movement.
sig { returns(T::Hash[String, Stripe::V2::Amount]) }
def outbound_pending; end
end
class Other < Stripe::StripeObject
# The type of the FinancialAccount, represented as a string. Upgrade your API version to see the type reflected in `financial_account.type`.
sig { returns(String) }
def type; end
end
class StatusDetails < Stripe::StripeObject
class Closed < Stripe::StripeObject
class ForwardingSettings < Stripe::StripeObject
# The address to send forwarded payments to.
sig { returns(T.nilable(String)) }
def payment_method; end
# The address to send forwarded payouts to.
sig { returns(T.nilable(String)) }
def payout_method; end
end
# Attribute for field forwarding_settings
sig { returns(T.nilable(ForwardingSettings)) }
def forwarding_settings; end
# Attribute for field reason
sig { returns(String) }
def reason; end
end
# Attribute for field closed
sig { returns(T.nilable(Closed)) }
def closed; end
end
class Storage < Stripe::StripeObject
# The currencies that this FinancialAccount can hold.
sig { returns(T::Array[String]) }
def holds_currencies; end
end
# Multi-currency balance of this FinancialAccount, split by availability state. Each balance is represented as a hash where the key is the three-letter ISO currency code, in lowercase, and the value is the amount for that currency.
sig { returns(Balance) }
def balance; end
# Open Enum. Two-letter country code that represents the country where the LegalEntity associated with the FinancialAccount is based in.
sig { returns(String) }
def country; end
# Time at which the object was created.
sig { returns(String) }
def created; end
# A descriptive name for the FinancialAccount, up to 50 characters long. This name will be used in the Stripe Dashboard and embedded components.
sig { returns(T.nilable(String)) }
def display_name; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# Metadata associated with the FinancialAccount.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# If this is a `other` FinancialAccount, this hash indicates what the actual type is. Upgrade your API version to see it reflected in `type`.
sig { returns(T.nilable(Other)) }
def other; end
# Closed Enum. An enum representing the status of the FinancialAccount. This indicates whether or not the FinancialAccount can be used for any money movement flows.
sig { returns(String) }
def status; end
# Attribute for field status_details
sig { returns(T.nilable(StatusDetails)) }
def status_details; end
# If this is a `storage` FinancialAccount, this hash includes details specific to `storage` FinancialAccounts.
sig { returns(T.nilable(Storage)) }
def storage; end
# Type of the FinancialAccount. An additional hash is included on the FinancialAccount with a name matching this value.
# It contains additional information specific to the FinancialAccount type.
sig { returns(String) }
def type; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
# A FinancialAddress contains information needed to transfer money to a Financial Account. A Financial Account can have more than one Financial Address.
class FinancialAddress < APIResource
class Credentials < Stripe::StripeObject
class GbBankAccount < Stripe::StripeObject
# The account holder name to be used during bank transference.
sig { returns(String) }
def account_holder_name; end
# The account number of the UK Bank Account.
sig { returns(T.nilable(String)) }
def account_number; end
# The last four digits of the UK Bank Account number. This will always be returned.
# To view the full account number when retrieving or listing FinancialAddresses, use the `include` request parameter.
sig { returns(String) }
def last4; end
# The sort code of the UK Bank Account.
sig { returns(String) }
def sort_code; end
end
class UsBankAccount < Stripe::StripeObject
# The account number of the US Bank Account.
sig { returns(T.nilable(String)) }
def account_number; end
# The name of the Bank.
sig { returns(T.nilable(String)) }
def bank_name; end
# The last four digits of the US Bank Account number. This will always be returned.
# To view the full account number when retrieving or listing FinancialAddresses, use the `include` request parameter.
sig { returns(String) }
def last4; end
# The routing number of the US Bank Account.
sig { returns(String) }
def routing_number; end
# The swift code of the bank or financial institution.
sig { returns(T.nilable(String)) }
def swift_code; end
end
# Open Enum. The type of Credentials that are provisioned for the FinancialAddress.
sig { returns(String) }
def type; end
# The credentials of the UK Bank Account for the FinancialAddress. This contains unique banking details such as the sort code, account number, etc. of a UK bank account.
sig { returns(T.nilable(GbBankAccount)) }
def gb_bank_account; end
# The credentials of the US Bank Account for the FinancialAddress. This contains unique banking details such as the routing number, account number, etc. of a US bank account.
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
end
# The creation timestamp of the FinancialAddress.
sig { returns(String) }
def created; end
# Object indicates the type of credentials that have been allocated and attached to the FinancialAddress.
# It contains all necessary banking details with which to perform money movements with the FinancialAddress.
# This field is only available for FinancialAddresses with an active status.
sig { returns(T.nilable(Credentials)) }
def credentials; end
# Open Enum. The currency the FinancialAddress supports.
sig { returns(String) }
def currency; end
# A ID of the FinancialAccount this FinancialAddress corresponds to.
sig { returns(String) }
def financial_account; end
# The ID of a FinancialAddress.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# Closed Enum. An enum representing the status of the FinancialAddress. This indicates whether or not the FinancialAddress can be used for any money movement flows.
sig { returns(String) }
def status; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
# An InboundTransfer object, representing a money movement from a
# user owned PaymentMethod to a FinancialAccount belonging to the same user.
class InboundTransfer < APIResource
class From < Stripe::StripeObject
class PaymentMethod < Stripe::StripeObject
# The type of object this destination represents. For a us bank account, we expect us_bank_account.
sig { returns(String) }
def type; end
# The destination US bank account identifier. eg "usba_***".
sig { returns(T.nilable(String)) }
def us_bank_account; end
end
# The amount in specified currency that was debited from the Payment Method.
sig { returns(Stripe::V2::Amount) }
def debited; end
# The Payment Method object used to create the InboundTransfer.
sig { returns(PaymentMethod) }
def payment_method; end
end
class To < Stripe::StripeObject
# The amount by which the FinancialAccount balance is credited.
sig { returns(Stripe::V2::Amount) }
def credited; end
# The FinancialAccount that funds will land in.
sig { returns(String) }
def financial_account; end
end
class TransferHistory < Stripe::StripeObject
class BankDebitFailed < Stripe::StripeObject
# Open Enum. The return reason for the failed InboundTransfer.
sig { returns(String) }
def failure_reason; end
end
class BankDebitReturned < Stripe::StripeObject
# Open Enum. The return reason for the returned InboundTransfer.
sig { returns(String) }
def return_reason; end
end
# Creation time of the HistoryEntry in RFC 3339 format and UTC.
sig { returns(String) }
def created; end
# Effective at time of the HistoryEntry in RFC 3339 format and UTC.
sig { returns(String) }
def effective_at; end
# A unique ID for the HistoryEntry.
sig { returns(String) }
def id; end
# Open Enum. The Level of the HistoryEntry.
sig { returns(String) }
def level; end
# Open Enum. The type of the HistoryEntry.
sig { returns(String) }
def type; end
# The history entry for a failed InboundTransfer.
sig { returns(T.nilable(BankDebitFailed)) }
def bank_debit_failed; end
# The history entry for a processing InboundTransfer.
sig { returns(T.nilable(T::Hash[String, T.untyped])) }
def bank_debit_processing; end
# The history entry for a queued InboundTransfer.
sig { returns(T.nilable(T::Hash[String, T.untyped])) }
def bank_debit_queued; end
# The history entry for a returned InboundTransfer.
sig { returns(T.nilable(BankDebitReturned)) }
def bank_debit_returned; end
# The history entry for a succeeded InboundTransfer.
sig { returns(T.nilable(T::Hash[String, T.untyped])) }
def bank_debit_succeeded; end
end
# The amount in specified currency that will land in the FinancialAccount balance.
sig { returns(Stripe::V2::Amount) }
def amount; end
# Creation time of the InboundTransfer. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(String) }
def created; end
# A freeform text field provided by user, containing metadata.
sig { returns(String) }
def description; end
# A nested object containing information about the origin of the InboundTransfer.
sig { returns(From) }
def from; end
# Unique identifier for the InboundTransfer.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.
sig { returns(T.nilable(String)) }
def receipt_url; end
# A nested object containing information about the destination of the InboundTransfer.
sig { returns(To) }
def to; end
# A list of history objects, representing changes in the state of the InboundTransfer.
sig { returns(T::Array[TransferHistory]) }
def transfer_history; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
# OutboundPaymentQuote represents a quote that provides fee and amount estimates for OutboundPayment.
class OutboundPaymentQuote < APIResource
class DeliveryOptions < Stripe::StripeObject
# Open Enum. Method for bank account.
sig { returns(T.nilable(String)) }
def bank_account; end
end
class EstimatedFee < Stripe::StripeObject
# The fee amount for corresponding fee type.
sig { returns(Stripe::V2::Amount) }
def amount; end
# The fee type.
sig { returns(String) }
def type; end
end
class From < Stripe::StripeObject
# The monetary amount debited from the sender, only set on responses.
sig { returns(Stripe::V2::Amount) }
def debited; end
# The FinancialAccount that funds were pulled from.
sig { returns(String) }
def financial_account; end
end
class FxQuote < Stripe::StripeObject
class Rates < Stripe::StripeObject
# The exchange rate going from_currency -> to_currency.
sig { returns(String) }
def exchange_rate; end
end
# The duration the exchange rate lock remains valid from creation time. Allowed value is five_minutes.
sig { returns(String) }
def lock_duration; end
# Time at which the rate lock will expire, measured in seconds since the Unix epoch.
sig { returns(String) }
def lock_expires_at; end
# Lock status of the quote. Transitions from active to expired once past the lock_expires_at timestamp. Value can be active or expired.
sig { returns(String) }
def lock_status; end
# Key pair: from currency Value: exchange rate going from_currency -> to_currency.
sig { returns(T::Hash[String, Rates]) }
def rates; end
# The currency that the transaction is exchanging to.
sig { returns(String) }
def to_currency; end
end
class To < Stripe::StripeObject
# The monetary amount being credited to the destination.
sig { returns(Stripe::V2::Amount) }
def credited; end
# The payout method which the OutboundPayment uses to send payout.
sig { returns(String) }
def payout_method; end
# To which account the OutboundPayment is sent.
sig { returns(String) }
def recipient; end
end
# The "presentment amount" for the OutboundPaymentQuote.
sig { returns(Stripe::V2::Amount) }
def amount; end
# Time at which the OutboundPaymentQuote was created.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(String) }
def created; end
# Delivery options to be used to send the OutboundPayment.
sig { returns(T.nilable(DeliveryOptions)) }
def delivery_options; end
# The estimated fees for the OutboundPaymentQuote.
sig { returns(T::Array[EstimatedFee]) }
def estimated_fees; end
# Details about the sender of an OutboundPaymentQuote.
sig { returns(From) }
def from; end
# The underlying FXQuote details for the OutboundPaymentQuote.
sig { returns(FxQuote) }
def fx_quote; end
# Unique identifier for the OutboundPaymentQuote.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# Details about the recipient of an OutboundPaymentQuote.
sig { returns(To) }
def to; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
# OutboundPayment represents a single money movement from one FinancialAccount you own to a payout method someone else owns.
class OutboundPayment < APIResource
class DeliveryOptions < Stripe::StripeObject
# Open Enum. Method for bank account.
sig { returns(T.nilable(String)) }
def bank_account; end
end
class From < Stripe::StripeObject
# The monetary amount debited from the sender, only set on responses.
sig { returns(Stripe::V2::Amount) }
def debited; end
# The FinancialAccount that funds were pulled from.
sig { returns(String) }
def financial_account; end
end
class RecipientNotification < Stripe::StripeObject
# Closed Enum. Configuration option to enable or disable notifications to recipients.
# Do not send notifications when setting is NONE. Default to account setting when setting is CONFIGURED or not set.
sig { returns(String) }
def setting; end
end
class StatusDetails < Stripe::StripeObject
class Failed < Stripe::StripeObject
# Open Enum. The `failed` status reason.
sig { returns(String) }
def reason; end
end
class Returned < Stripe::StripeObject
# Open Enum. The `returned` status reason.
sig { returns(String) }
def reason; end
end
# The `failed` status reason.
sig { returns(T.nilable(Failed)) }
def failed; end
# The `returned` status reason.
sig { returns(T.nilable(Returned)) }
def returned; end
end
class StatusTransitions < Stripe::StripeObject
# Timestamp describing when an OutboundPayment changed status to `canceled`.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def canceled_at; end
# Timestamp describing when an OutboundPayment changed status to `failed`.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def failed_at; end
# Timestamp describing when an OutboundPayment changed status to `posted`.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def posted_at; end
# Timestamp describing when an OutboundPayment changed status to `returned`.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def returned_at; end
end
class To < Stripe::StripeObject
# The monetary amount being credited to the destination.
sig { returns(Stripe::V2::Amount) }
def credited; end
# The payout method which the OutboundPayment uses to send payout.
sig { returns(String) }
def payout_method; end
# To which account the OutboundPayment is sent.
sig { returns(String) }
def recipient; end
end
class TraceId < Stripe::StripeObject
# Possible values are `pending`, `supported`, and `unsupported`. Initially set to `pending`, it changes to
# `supported` when the recipient bank provides a trace ID, or `unsupported` if the recipient bank doesn't support it.
# Note that this status may not align with the OutboundPayment or OutboundTransfer status and can remain `pending`
# even after the payment or transfer is posted.
sig { returns(String) }
def status; end
# The trace ID value if `trace_id.status` is `supported`, otherwise empty.
sig { returns(T.nilable(String)) }
def value; end
end
# The "presentment amount" for the OutboundPayment.
sig { returns(Stripe::V2::Amount) }
def amount; end
# Returns true if the OutboundPayment can be canceled, and false otherwise.
sig { returns(T::Boolean) }
def cancelable; end
# Time at which the OutboundPayment was created.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(String) }
def created; end
# Delivery options to be used to send the OutboundPayment.
sig { returns(T.nilable(DeliveryOptions)) }
def delivery_options; end
# An arbitrary string attached to the OutboundPayment. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# The date when funds are expected to arrive in the payout method. This field is not set if the payout method is in a `failed`, `canceled`, or `returned` state.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def expected_arrival_date; end
# The FinancialAccount that funds were pulled from.
sig { returns(From) }
def from; end
# Unique identifier for the OutboundPayment.
sig { returns(String) }
def id; end
# Set of key-value pairs 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# The quote for this OutboundPayment. Only required for countries with regulatory mandates to display fee estimates before OutboundPayment creation.
sig { returns(T.nilable(String)) }
def outbound_payment_quote; end
# A link to the Stripe-hosted receipt for this OutboundPayment. The receipt link remains active for 60 days from the OutboundPayment creation date. After this period, the link will expire and the receipt url value will be null.
sig { returns(T.nilable(String)) }
def receipt_url; end
# Details about the OutboundPayment notification settings for recipient.
sig { returns(RecipientNotification) }
def recipient_notification; end
# The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). It will default to `STRIPE` if not set on the account settings.
sig { returns(String) }
def statement_descriptor; end
# Closed Enum. Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`.
# An OutboundPayment is `processing` if it has been created and is processing.
# The status changes to `posted` once the OutboundPayment has been "confirmed" and funds have left the account, or to `failed` or `canceled`.
# If an OutboundPayment fails to arrive at its payout method, its status will change to `returned`.
sig { returns(String) }
def status; end
# Status details for an OutboundPayment in a `failed` or `returned` state.
sig { returns(T.nilable(StatusDetails)) }
def status_details; end
# Hash containing timestamps of when the object transitioned to a particular status.
sig { returns(T.nilable(StatusTransitions)) }
def status_transitions; end
# To which payout method the OutboundPayment was sent.
sig { returns(To) }
def to; end
# A unique identifier that can be used to track this OutboundPayment with recipient bank. Banks might call this a “reference number” or something similar.
sig { returns(TraceId) }
def trace_id; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
# Use the OutboundSetupIntent API to create and setup usable payout methods.
class OutboundSetupIntent < APIResource
class NextAction < Stripe::StripeObject
class ConfirmationOfPayee < Stripe::StripeObject
# The type of the credential.
sig { returns(String) }
def object; end
# The Confirmation of Payee status.
sig { returns(String) }
def status; end
end
# The type of next action.
sig { returns(String) }
def type; end
# Confirmation of Payee details.
sig { returns(T.nilable(ConfirmationOfPayee)) }
def confirmation_of_payee; end
end
# Created timestamp.
sig { returns(String) }
def created; end
# ID of the outbound setup intent.
sig { returns(String) }
def id; end
# Specifies which actions needs to be taken next to continue setup of the credential.
sig { returns(T.nilable(NextAction)) }
def next_action; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# Use the PayoutMethods API to list and interact with PayoutMethod objects.
sig { returns(Stripe::V2::MoneyManagement::PayoutMethod) }
def payout_method; end
# Closed Enum. Status of the outbound setup intent.
sig { returns(String) }
def status; end
# The intended money movement flow this payout method should be set up for, specified in params.
sig { returns(String) }
def usage_intent; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
# OutboundTransfer represents a single money movement from one FinancialAccount you own to a payout method you also own.
class OutboundTransfer < APIResource
class DeliveryOptions < Stripe::StripeObject
# Open Enum. Method for bank account.
sig { returns(T.nilable(String)) }
def bank_account; end
end
class From < Stripe::StripeObject
# The monetary amount debited from the sender, only set on responses.
sig { returns(Stripe::V2::Amount) }
def debited; end
# The FinancialAccount that funds were pulled from.
sig { returns(String) }
def financial_account; end
end
class StatusDetails < Stripe::StripeObject
class Failed < Stripe::StripeObject
# Open Enum. The `failed` status reason.
sig { returns(String) }
def reason; end
end
class Returned < Stripe::StripeObject
# Open Enum. The `returned` status reason.
sig { returns(String) }
def reason; end
end
# The `failed` status reason.
sig { returns(T.nilable(Failed)) }
def failed; end
# The `returned` status reason.
sig { returns(T.nilable(Returned)) }
def returned; end
end
class StatusTransitions < Stripe::StripeObject
# Timestamp describing when an OutboundTransfer changed status to `canceled`.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def canceled_at; end
# Timestamp describing when an OutboundTransfer changed status to `failed`.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def failed_at; end
# Timestamp describing when an OutboundTransfer changed status to `posted`.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def posted_at; end
# Timestamp describing when an OutboundTransfer changed status to `returned`.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def returned_at; end
end
class To < Stripe::StripeObject
# The monetary amount being credited to the destination.
sig { returns(Stripe::V2::Amount) }
def credited; end
# The payout method which the OutboundTransfer uses to send payout.
sig { returns(String) }
def payout_method; end
end
class TraceId < Stripe::StripeObject
# Possible values are `pending`, `supported`, and `unsupported`. Initially set to `pending`, it changes to
# `supported` when the recipient bank provides a trace ID, or `unsupported` if the recipient bank doesn't support it.
# Note that this status may not align with the OutboundPayment or OutboundTransfer status and can remain `pending`
# even after the payment or transfer is posted.
sig { returns(String) }
def status; end
# The trace ID value if `trace_id.status` is `supported`, otherwise empty.
sig { returns(T.nilable(String)) }
def value; end
end
# The "presentment amount" for the OutboundTransfer.
sig { returns(Stripe::V2::Amount) }
def amount; end
# Returns true if the OutboundTransfer can be canceled, and false otherwise.
sig { returns(T::Boolean) }
def cancelable; end
# Time at which the OutboundTransfer was created.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(String) }
def created; end
# Delivery options to be used to send the OutboundTransfer.
sig { returns(T.nilable(DeliveryOptions)) }
def delivery_options; end
# An arbitrary string attached to the OutboundTransfer. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
# The date when funds are expected to arrive in the payout method. This field is not set if the payout method is in a `failed`, `canceled`, or `returned` state.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def expected_arrival_date; end
# The FinancialAccount that funds were pulled from.
sig { returns(From) }
def from; end
# Unique identifier for the OutboundTransfer.
sig { returns(String) }
def id; end
# Set of key-value pairs 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])) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# A link to the Stripe-hosted receipt for this OutboundTransfer. The receipt link remains active for 60 days from the OutboundTransfer creation date. After this period, the link will expire and the receipt url value will be null.
sig { returns(T.nilable(String)) }
def receipt_url; end
# The description that appears on the receiving end for an OutboundTransfer (for example, bank statement for external bank transfer). It will default to `STRIPE` if not set on the account settings.
sig { returns(String) }
def statement_descriptor; end
# Closed Enum. Current status of the OutboundTransfer: `processing`, `failed`, `posted`, `returned`, `canceled`.
# An OutboundTransfer is `processing` if it has been created and is processing.
# The status changes to `posted` once the OutboundTransfer has been "confirmed" and funds have left the account, or to `failed` or `canceled`.
# If an OutboundTransfer fails to arrive at its payout method, its status will change to `returned`.
sig { returns(String) }
def status; end
# Status details for an OutboundTransfer in a `failed` or `returned` state.
sig { returns(T.nilable(StatusDetails)) }
def status_details; end
# Hash containing timestamps of when the object transitioned to a particular status.
sig { returns(T.nilable(StatusTransitions)) }
def status_transitions; end
# To which payout method the OutboundTransfer was sent.
sig { returns(To) }
def to; end
# A unique identifier that can be used to track this OutboundTransfer with recipient bank. Banks might call this a “reference number” or something similar.
sig { returns(TraceId) }
def trace_id; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
# Use the PayoutMethods API to list and interact with PayoutMethod objects.
class PayoutMethod < APIResource
class UsageStatus < Stripe::StripeObject
# Payments status - used when sending OutboundPayments (sending funds to recipients).
sig { returns(String) }
def payments; end
# Transfers status - used when making an OutboundTransfer (sending funds to yourself).
sig { returns(String) }
def transfers; end
end
class BankAccount < Stripe::StripeObject
# Whether this PayoutMethodBankAccount object was archived. PayoutMethodBankAccount objects can be archived through
# the /archive API, and they will not be automatically archived by Stripe. Archived PayoutMethodBankAccount objects
# cannot be used as payout methods and will not appear in the payout method list.
sig { returns(T::Boolean) }
def archived; end
# The type of bank account (checking or savings).
sig { returns(String) }
def bank_account_type; end
# The name of the bank this bank account is in. This field is populated automatically by Stripe.
sig { returns(String) }
def bank_name; end
# The country code of the bank account.
sig { returns(String) }
def country; end
# List of enabled flows for this bank account (wire or local).
sig { returns(T::Array[String]) }
def enabled_delivery_options; end
# The last 4 digits of the account number.
sig { returns(String) }
def last4; end
# The routing number of the bank account, if present.
sig { returns(T.nilable(String)) }
def routing_number; end
# The list of currencies supported by this bank account.
sig { returns(T::Array[String]) }
def supported_currencies; end
end
class Card < Stripe::StripeObject
# Whether the PayoutMethodCard object was archived. PayoutMethodCard objects can be archived through
# the /archive API, and they will not be automatically archived by Stripe. Archived PayoutMethodCard objects
# cannot be used as payout methods and will not appear in the payout method list.
sig { returns(T::Boolean) }
def archived; end
# The month the card expires.
sig { returns(String) }
def exp_month; end
# The year the card expires.
sig { returns(String) }
def exp_year; end
# The last 4 digits of the card number.
sig { returns(String) }
def last4; end
end
# A set of available payout speeds for this payout method.
sig { returns(T::Array[String]) }
def available_payout_speeds; end
# Created timestamp.
sig { returns(String) }
def created; end
# ID of the PayoutMethod object.
sig { returns(String) }
def id; end
# ID of the underlying active OutboundSetupIntent object, if any.
sig { returns(T.nilable(String)) }
def latest_outbound_setup_intent; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# Closed Enum. The type of payout method.
sig { returns(String) }
def type; end
# Indicates whether the payout method has met the necessary requirements for outbound money movement.
sig { returns(UsageStatus) }
def usage_status; end
# 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) }
def livemode; end
# The PayoutMethodBankAccount object details.
sig { returns(T.nilable(BankAccount)) }
def bank_account; end
# The PayoutMethodCard object details.
sig { returns(T.nilable(Card)) }
def card; end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
# The PayoutMethodsBankAccountSpec object.
class PayoutMethodsBankAccountSpec < SingletonAPIResource
class Countries < Stripe::StripeObject
class Field < Stripe::StripeObject
class LocalNameHuman < Stripe::StripeObject
# The default content of the localizable string.
sig { returns(String) }
def content; end
# A unique key representing the instance of this localizable string.
sig { returns(String) }
def localization_key; end
end
# The local name of the field.
sig { returns(String) }
def local_name; end
# The human readable local name of the field.
sig { returns(LocalNameHuman) }
def local_name_human; end
# The maximum length of the field.
sig { returns(Integer) }
def max_length; end
# THe minimum length of the field.
sig { returns(Integer) }
def min_length; end
# The placeholder value of the field.
sig { returns(String) }
def placeholder; end
# The stripe name of the field.
sig { returns(String) }
def stripe_name; end
# The validation regex of the field.
sig { returns(String) }
def validation_regex; end
end
# The list of fields for a country, along with associated information.
sig { returns(T::Array[Field]) }
def fields; end
end
# The list of specs by country.
sig { returns(T::Hash[String, Countries]) }
def countries; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
# Use ReceivedCredits API to retrieve information on when, where, and how funds are sent into your FinancialAccount.
class ReceivedCredit < APIResource
class StatusDetails < Stripe::StripeObject
class Failed < Stripe::StripeObject
# Open Enum. The `failed` status reason.
sig { returns(String) }
def reason; end
end
class Returned < Stripe::StripeObject
# Open Enum. The `returned` status reason.
sig { returns(String) }
def reason; end
end
# Hash that provides additional information regarding the reason behind a `failed` ReceivedCredit status. It is only present when the ReceivedCredit status is `failed`.
sig { returns(T.nilable(Failed)) }
def failed; end
# Hash that provides additional information regarding the reason behind a `returned` ReceivedCredit status. It is only present when the ReceivedCredit status is `returned`.
sig { returns(T.nilable(Returned)) }
def returned; end
end
class StatusTransitions < Stripe::StripeObject
# Timestamp describing when the ReceivedCredit was marked as `failed`.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def failed_at; end
# Timestamp describing when the ReceivedCredit changed status to `returned`.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def returned_at; end
# Timestamp describing when the ReceivedCredit was marked as `succeeded`.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def succeeded_at; end
end
class BalanceTransfer < Stripe::StripeObject
# The ID of the account that owns the source object originated the ReceivedCredit.
sig { returns(T.nilable(String)) }
def from_account; end
# Open Enum. The type of Stripe Money Movement that originated the ReceivedCredit.
sig { returns(String) }
def type; end
# The ID of the outbound payment object that originated the ReceivedCredit.
sig { returns(T.nilable(String)) }
def outbound_payment; end
# The ID of the outbound transfer object that originated the ReceivedCredit.
sig { returns(T.nilable(String)) }
def outbound_transfer; end
# The ID of the payout object that originated the ReceivedCredit.
sig { returns(T.nilable(String)) }
def payout_v1; end
end
class BankTransfer < Stripe::StripeObject
class GbBankAccount < Stripe::StripeObject
# The bank name the transfer was received from.
sig { returns(T.nilable(String)) }
def account_holder_name; end
# The bank name the transfer was received from.
sig { returns(T.nilable(String)) }
def bank_name; end
# The last 4 digits of the account number that originated the transfer.
sig { returns(T.nilable(String)) }
def last4; end
# Open Enum. The money transmission network used to send funds for this ReceivedCredit.
sig { returns(String) }
def network; end
# The sort code of the account that originated the transfer.
sig { returns(T.nilable(String)) }
def sort_code; end
end
class UsBankAccount < Stripe::StripeObject
# The bank name the transfer was received from.
sig { returns(T.nilable(String)) }
def bank_name; end
# The last 4 digits of the account number that originated the transfer.
sig { returns(T.nilable(String)) }
def last4; end
# Open Enum. The money transmission network used to send funds for this ReceivedCredit.
sig { returns(String) }
def network; end
# The routing number of the account that originated the transfer.
sig { returns(T.nilable(String)) }
def routing_number; end
end
# Financial Address on which funds for ReceivedCredit were received.
sig { returns(String) }
def financial_address; end
# Open Enum. Indicates the type of source via from which external funds originated.
sig { returns(String) }
def payment_method_type; end
# Freeform string set by originator of the external ReceivedCredit.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
# Hash containing the transaction bank details. Present if `payment_method_type` field value is `gb_bank_account`.
sig { returns(T.nilable(GbBankAccount)) }
def gb_bank_account; end
# Hash containing the transaction bank details. Present if `payment_method_type` field value is `us_bank_account`.
sig { returns(T.nilable(UsBankAccount)) }
def us_bank_account; end
end
# The amount and currency of the ReceivedCredit.
sig { returns(Stripe::V2::Amount) }
def amount; end
# Time at which the ReceivedCredit was created.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(String) }
def created; end
# Freeform string set by originator of the ReceivedCredit.
sig { returns(T.nilable(String)) }
def description; end
# Financial Account ID on which funds for ReceivedCredit were received.
sig { returns(String) }
def financial_account; end
# Unique identifier for the ReceivedCredit.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.
sig { returns(T.nilable(String)) }
def receipt_url; end
# Open Enum. The status of the ReceivedCredit.
sig { returns(String) }
def status; end
# This hash contains detailed information that elaborates on the specific status of the ReceivedCredit. e.g the reason behind a failure if the status is marked as `failed`.
sig { returns(T.nilable(StatusDetails)) }
def status_details; end
# Hash containing timestamps of when the object transitioned to a particular status.
sig { returns(T.nilable(StatusTransitions)) }
def status_transitions; end
# Open Enum. The type of flow that caused the ReceivedCredit.
sig { returns(String) }
def type; end
# 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) }
def livemode; end
# This object stores details about the originating Stripe transaction that resulted in the ReceivedCredit. Present if `type` field value is `balance_transfer`.
sig { returns(T.nilable(BalanceTransfer)) }
def balance_transfer; end
# This object stores details about the originating banking transaction that resulted in the ReceivedCredit. Present if `type` field value is `external_credit`.
sig { returns(T.nilable(BankTransfer)) }
def bank_transfer; end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
# ReceivedDebit resource
class ReceivedDebit < APIResource
class StatusDetails < Stripe::StripeObject
class Failed < Stripe::StripeObject
# Open Enum. The reason for the failure of the ReceivedDebit.
sig { returns(String) }
def reason; end
end
# Information that elaborates on the `failed` status of a ReceivedDebit.
# It is only present when the ReceivedDebit status is `failed`.
sig { returns(Failed) }
def failed; end
end
class StatusTransitions < Stripe::StripeObject
# The time when the ReceivedDebit was marked as `canceled`.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: `2022-09-18T13:22:18.123Z`.
sig { returns(T.nilable(String)) }
def canceled_at; end
# The time when the ReceivedDebit was marked as `failed`.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: `2022-09-18T13:22:18.123Z`.
sig { returns(T.nilable(String)) }
def failed_at; end
# The time when the ReceivedDebit was marked as `succeeded`.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: `2022-09-18T13:22:18.123Z`.
sig { returns(T.nilable(String)) }
def succeeded_at; end
end
class BankTransfer < Stripe::StripeObject
class UsBankAccount < Stripe::StripeObject
# The name of the bank the debit originated from.
sig { returns(T.nilable(String)) }
def bank_name; end
# Open Enum. The bank network the debit was originated on.
sig { returns(String) }
def network; end
# The routing number of the bank that originated the debit.
sig { returns(T.nilable(String)) }
def routing_number; end
end
# The Financial Address that was debited.
sig { returns(String) }
def financial_address; end
# Open Enum. The type of the payment method used to originate the debit.
sig { returns(String) }
def payment_method_type; end
# The statement descriptor set by the originator of the debit.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
# The payment method used to originate the debit.
sig { returns(UsBankAccount) }
def us_bank_account; end
end
# Amount and currency of the ReceivedDebit.
sig { returns(Stripe::V2::Amount) }
def amount; end
# The time at which the ReceivedDebit was created.
# Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: `2022-09-18T13:22:18.123Z`.
sig { returns(String) }
def created; end
# Freeform string sent by the originator of the ReceivedDebit.
sig { returns(T.nilable(String)) }
def description; end
# Financial Account on which funds for ReceivedDebit were debited.
sig { returns(String) }
def financial_account; end
# Unique identifier for the ReceivedDebit.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# A link to the Stripe-hosted receipt for this ReceivedDebit.
sig { returns(T.nilable(String)) }
def receipt_url; end
# Open Enum. The status of the ReceivedDebit.
sig { returns(String) }
def status; end
# Detailed information about the status of the ReceivedDebit.
sig { returns(T.nilable(StatusDetails)) }
def status_details; end
# The time at which the ReceivedDebit transitioned to a particular status.
sig { returns(T.nilable(StatusTransitions)) }
def status_transitions; end
# Open Enum. The type of the ReceivedDebit.
sig { returns(String) }
def type; end
# 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) }
def livemode; end
# This object stores details about the originating banking transaction that resulted in the ReceivedDebit. Present if `type` field value is `bank_transfer`.
sig { returns(T.nilable(BankTransfer)) }
def bank_transfer; end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
# TransactionEntries represent individual money movements across different states within a Transaction.
class TransactionEntry < APIResource
class BalanceImpact < Stripe::StripeObject
# Impact to the available balance.
sig { returns(Stripe::V2::Amount) }
def available; end
# Impact to the inbound_pending balance.
sig { returns(Stripe::V2::Amount) }
def inbound_pending; end
# Impact to the outbound_pending balance.
sig { returns(Stripe::V2::Amount) }
def outbound_pending; end
end
class TransactionDetails < Stripe::StripeObject
class Flow < Stripe::StripeObject
# Open Enum. Type of the flow that created the Transaction. The field matching this value will contain the ID of the flow.
sig { returns(String) }
def type; end
# If applicable, the ID of the Adjustment that created this Transaction.
sig { returns(T.nilable(String)) }
def adjustment; end
# In the future, this will be the ID of the currency conversion that created this Transaction. For now, this field is always null.
sig { returns(T.nilable(String)) }
def currency_conversion; end
# If applicable, the ID of the FeeTransaction that created this Transaction.
sig { returns(T.nilable(String)) }
def fee_transaction; end
# If applicable, the ID of the InboundTransfer that created this Transaction.
sig { returns(T.nilable(String)) }
def inbound_transfer; end
# If applicable, the ID of the OutboundPayment that created this Transaction.
sig { returns(T.nilable(String)) }
def outbound_payment; end
# If applicable, the ID of the OutboundTransfer that created this Transaction.
sig { returns(T.nilable(String)) }
def outbound_transfer; end
# If applicable, the ID of the ReceivedCredit that created this Transaction.
sig { returns(T.nilable(String)) }
def received_credit; end
# If applicable, the ID of the ReceivedDebit that created this Transaction.
sig { returns(T.nilable(String)) }
def received_debit; end
end
# Closed Enum for now, and will be turned into an Open Enum soon. A descriptive category used to classify the Transaction.
sig { returns(String) }
def category; end
# Indicates the FinancialAccount affected by this Transaction.
sig { returns(String) }
def financial_account; end
# Details about the Flow object that created the Transaction.
sig { returns(Flow) }
def flow; end
end
# The delta to the FinancialAccount's balance.
sig { returns(BalanceImpact) }
def balance_impact; end
# Time at which the object was created.
sig { returns(String) }
def created; end
# Time at which the entry impacted (or will impact if it's in the future) the FinancialAccount balance.
sig { returns(String) }
def effective_at; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# The Transaction that this TransactionEntry belongs to.
sig { returns(String) }
def transaction; end
# Details copied from the transaction that this TransactionEntry belongs to.
sig { returns(TransactionDetails) }
def transaction_details; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
# Use Transactions to view changes to your FinancialAccount balance over time. Every flow that moves money, such as OutboundPayments or ReceivedCredits, will have one or more Transactions that describes how the flow impacted your balance. Note that while the FinancialAccount balance will always be up to date, be aware that Transactions and TransactionEntries are created shortly after to reflect changes.
class Transaction < APIResource
class BalanceImpact < Stripe::StripeObject
# Impact to the available balance.
sig { returns(Stripe::V2::Amount) }
def available; end
# Impact to the inbound_pending balance.
sig { returns(Stripe::V2::Amount) }
def inbound_pending; end
# Impact to the outbound_pending balance.
sig { returns(Stripe::V2::Amount) }
def outbound_pending; end
end
class Flow < Stripe::StripeObject
# Open Enum. Type of the flow that created the Transaction. The field matching this value will contain the ID of the flow.
sig { returns(String) }
def type; end
# If applicable, the ID of the Adjustment that created this Transaction.
sig { returns(T.nilable(String)) }
def adjustment; end
# In the future, this will be the ID of the currency conversion that created this Transaction. For now, this field is always null.
sig { returns(T.nilable(String)) }
def currency_conversion; end
# If applicable, the ID of the FeeTransaction that created this Transaction.
sig { returns(T.nilable(String)) }
def fee_transaction; end
# If applicable, the ID of the InboundTransfer that created this Transaction.
sig { returns(T.nilable(String)) }
def inbound_transfer; end
# If applicable, the ID of the OutboundPayment that created this Transaction.
sig { returns(T.nilable(String)) }
def outbound_payment; end
# If applicable, the ID of the OutboundTransfer that created this Transaction.
sig { returns(T.nilable(String)) }
def outbound_transfer; end
# If applicable, the ID of the ReceivedCredit that created this Transaction.
sig { returns(T.nilable(String)) }
def received_credit; end
# If applicable, the ID of the ReceivedDebit that created this Transaction.
sig { returns(T.nilable(String)) }
def received_debit; end
end
class StatusTransitions < Stripe::StripeObject
# The time at which the Transaction became posted. Only present if status == posted.
sig { returns(T.nilable(String)) }
def posted_at; end
# The time at which the Transaction became void. Only present if status == void.
sig { returns(T.nilable(String)) }
def void_at; end
end
# The amount of the Transaction.
sig { returns(Stripe::V2::Amount) }
def amount; end
# The delta to the FinancialAccount's balance. The balance_impact for the Transaction is equal to sum of its
# TransactionEntries that have `effective_at`s in the past.
sig { returns(BalanceImpact) }
def balance_impact; end
# Open Enum. A descriptive category used to classify the Transaction.
sig { returns(String) }
def category; end
# Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(String) }
def created; end
# Indicates the FinancialAccount affected by this Transaction.
sig { returns(String) }
def financial_account; end
# Details about the Flow object that created the Transaction.
sig { returns(Flow) }
def flow; end
# Unique identifier for the object.
sig { returns(String) }
def id; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# Closed Enum. Current status of the Transaction.
# A Transaction is `pending` if either `balance_impact.inbound_pending` or `balance_impact.outbound_pending` is non-zero.
# A Transaction is `posted` if only `balance_impact.available` is non-zero.
# A Transaction is `void` if there is no balance impact.
# `posted` and `void` are terminal states, and no additional entries will be added to the Transaction.
sig { returns(String) }
def status; end
# Timestamps for when the Transaction transitioned to a particular status.
sig { returns(StatusTransitions) }
def status_transitions; end
# 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) }
def livemode; end
end
end
end
end
# typed: true
module Stripe
module V2
module Payments
# OffSessionPayment resource.
class OffSessionPayment < APIResource
class RetryDetails < Stripe::StripeObject
# Number of authorization attempts so far.
sig { returns(Integer) }
def attempts; end
# Indicates the strategy for how you want Stripe to retry the payment.
sig { returns(String) }
def retry_strategy; end
end
class TransferData < Stripe::StripeObject
# The amount transferred to the destination account. This transfer will occur
# automatically after the payment succeeds. If no amount is specified, by default
# the entire payment amount is transferred to the destination account. The amount
# must be less than or equal to the
# [amount_requested](https://docs.corp.stripe.com/api/v2/off-session-payments/object?api-version=2025-05-28.preview#v2_off_session_payment_object-amount_requested),
# and must be a positive integer representing how much to transfer in the smallest
# currency unit (e.g., 100 cents to charge $1.00).
sig { returns(T.nilable(Integer)) }
def amount; end
# The account (if any) that the payment is attributed to for tax reporting, and
# where funds from the payment are transferred to after payment success.
sig { returns(String) }
def destination; end
end
# The “presentment amount” to be collected from the customer.
sig { returns(Stripe::V2::Amount) }
def amount_requested; end
# The frequency of the underlying payment.
sig { returns(String) }
def cadence; end
# ID of the owning compartment.
sig { returns(String) }
def compartment_id; end
# Creation time of the OffSessionPayment. Represented as a RFC 3339 date & time UTC
# value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(String) }
def created; end
# ID of the Customer to which this OffSessionPayment belongs.
sig { returns(String) }
def customer; end
# The reason why the OffSessionPayment failed.
sig { returns(T.nilable(String)) }
def failure_reason; end
# Unique identifier for the object..
sig { returns(String) }
def id; end
# The payment error encountered in the previous attempt to authorize the payment.
sig { returns(T.nilable(String)) }
def last_authorization_attempt_error; end
# Payment attempt record for the latest attempt, if one exists.
sig { returns(T.nilable(String)) }
def latest_payment_attempt_record; end
# 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) }
def livemode; end
# Set of [key-value pairs](https://docs.corp.stripe.com/api/metadata) that you can
# attach to an object. This can be useful for storing additional information about
# the object in a structured format. Learn more about
# [storing information in metadata](https://docs.corp.stripe.com/payments/payment-intents#storing-information-in-metadata).
sig { returns(T::Hash[String, String]) }
def metadata; end
# String representing the object's type. Objects of the same type share the same value of the object field.
sig { returns(String) }
def object; end
# The account (if any) for which the funds of the OffSessionPayment are intended.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
# ID of the payment method used in this OffSessionPayment.
sig { returns(String) }
def payment_method; end
# Payment record associated with the OffSessionPayment.
sig { returns(T.nilable(String)) }
def payment_record; end
# Details about the OffSessionPayment retries.
sig { returns(RetryDetails) }
def retry_details; end
# Text that appears on the customer’s statement as the statement descriptor for a
# non-card charge. This value overrides the account’s default statement descriptor.
# For information about requirements, including the 22-character limit, see the
# [Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor; end
# Provides information about a card charge. Concatenated to the account’s
# [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
# to form the complete statement descriptor that appears on the customer’s statement.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
# Status of this OffSessionPayment, one of `pending`, `pending_retry`, `processing`,
# `failed`, `canceled`, `requires_capture`, or `succeeded`.
sig { returns(String) }
def status; end
# Test clock that can be used to advance the retry attempts in a sandbox.
sig { returns(T.nilable(String)) }
def test_clock; end
# The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for [connected accounts](https://docs.corp.stripe.com/payments/connected-accounts).
sig { returns(T.nilable(TransferData)) }
def transfer_data; end
end
end
end
end
# typed: true
module Stripe
class V1Services < StripeService
attr_reader :accounts
attr_reader :account_links
attr_reader :account_notices
attr_reader :account_sessions
attr_reader :apple_pay_domains
attr_reader :application_fees
attr_reader :apps
attr_reader :balance
attr_reader :balance_settings
attr_reader :balance_transactions
attr_reader :billing
attr_reader :billing_portal
attr_reader :capital
attr_reader :charges
attr_reader :checkout
attr_reader :climate
attr_reader :confirmation_tokens
attr_reader :country_specs
attr_reader :coupons
attr_reader :credit_notes
attr_reader :customers
attr_reader :customer_sessions
attr_reader :disputes
attr_reader :entitlements
attr_reader :ephemeral_keys
attr_reader :events
attr_reader :exchange_rates
attr_reader :external_accounts
attr_reader :files
attr_reader :file_links
attr_reader :financial_connections
attr_reader :forwarding
attr_reader :fx_quotes
attr_reader :identity
attr_reader :invoices
attr_reader :invoice_items
attr_reader :invoice_payments
attr_reader :invoice_rendering_templates
attr_reader :issuing
attr_reader :mandates
attr_reader :margins
attr_reader :orders
attr_reader :payment_attempt_records
attr_reader :payment_intents
attr_reader :payment_links
attr_reader :payment_methods
attr_reader :payment_method_configurations
attr_reader :payment_method_domains
attr_reader :payment_records
attr_reader :payouts
attr_reader :plans
attr_reader :prices
attr_reader :privacy
attr_reader :products
attr_reader :promotion_codes
attr_reader :quotes
attr_reader :radar
attr_reader :refunds
attr_reader :reporting
attr_reader :reviews
attr_reader :setup_attempts
attr_reader :setup_intents
attr_reader :shipping_rates
attr_reader :sigma
attr_reader :sources
attr_reader :subscriptions
attr_reader :subscription_items
attr_reader :subscription_schedules
attr_reader :tax
attr_reader :tax_codes
attr_reader :tax_ids
attr_reader :tax_rates
attr_reader :terminal
attr_reader :test_helpers
attr_reader :tokens
attr_reader :topups
attr_reader :transfers
attr_reader :treasury
attr_reader :webhook_endpoints
end
end
# typed: true
module Stripe
class AccountService < StripeService
attr_reader :capabilities
attr_reader :external_accounts
attr_reader :login_links
attr_reader :persons
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class BankAccount < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The account number for the bank account, in string form. Must be a checking account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The country in which the bank account is located.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts)
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(object: String, account_holder_name: T.nilable(String), account_holder_type: T.nilable(String), account_number: String, country: String, currency: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
object: nil,
account_holder_name: nil,
account_holder_type: nil,
account_number: nil,
country: nil,
currency: nil,
routing_number: nil
); end
end
class BusinessProfile < Stripe::RequestParams
class AnnualRevenue < Stripe::RequestParams
# A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
sig { returns(String) }
def fiscal_year_end; end
sig { params(_fiscal_year_end: String).returns(String) }
def fiscal_year_end=(_fiscal_year_end); end
sig { params(amount: Integer, currency: String, fiscal_year_end: String).void }
def initialize(amount: nil, currency: nil, fiscal_year_end: nil); end
end
class MonthlyEstimatedRevenue < Stripe::RequestParams
# A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
sig { params(amount: Integer, currency: String).void }
def initialize(amount: nil, currency: nil); end
end
class SupportAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The applicant's gross annual revenue for its preceding fiscal year.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::BusinessProfile::AnnualRevenue))
}
def annual_revenue; end
sig {
params(_annual_revenue: T.nilable(::Stripe::AccountService::UpdateParams::BusinessProfile::AnnualRevenue)).returns(T.nilable(::Stripe::AccountService::UpdateParams::BusinessProfile::AnnualRevenue))
}
def annual_revenue=(_annual_revenue); end
# An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
sig { returns(T.nilable(Integer)) }
def estimated_worker_count; end
sig { params(_estimated_worker_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def estimated_worker_count=(_estimated_worker_count); end
# [The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
sig { returns(T.nilable(String)) }
def mcc; end
sig { params(_mcc: T.nilable(String)).returns(T.nilable(String)) }
def mcc=(_mcc); end
# Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business.
sig { returns(T.nilable(T::Array[String])) }
def minority_owned_business_designation; end
sig {
params(_minority_owned_business_designation: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def minority_owned_business_designation=(_minority_owned_business_designation); end
# An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::BusinessProfile::MonthlyEstimatedRevenue))
}
def monthly_estimated_revenue; end
sig {
params(_monthly_estimated_revenue: T.nilable(::Stripe::AccountService::UpdateParams::BusinessProfile::MonthlyEstimatedRevenue)).returns(T.nilable(::Stripe::AccountService::UpdateParams::BusinessProfile::MonthlyEstimatedRevenue))
}
def monthly_estimated_revenue=(_monthly_estimated_revenue); end
# The customer-facing business name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# A publicly available mailing address for sending support issues to.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::BusinessProfile::SupportAddress))
}
def support_address; end
sig {
params(_support_address: T.nilable(::Stripe::AccountService::UpdateParams::BusinessProfile::SupportAddress)).returns(T.nilable(::Stripe::AccountService::UpdateParams::BusinessProfile::SupportAddress))
}
def support_address=(_support_address); end
# A publicly available email address for sending support issues to.
sig { returns(T.nilable(String)) }
def support_email; end
sig { params(_support_email: T.nilable(String)).returns(T.nilable(String)) }
def support_email=(_support_email); end
# A publicly available phone number to call with support issues.
sig { returns(T.nilable(String)) }
def support_phone; end
sig { params(_support_phone: T.nilable(String)).returns(T.nilable(String)) }
def support_phone=(_support_phone); end
# A publicly available website for handling support issues.
sig { returns(T.nilable(String)) }
def support_url; end
sig { params(_support_url: T.nilable(String)).returns(T.nilable(String)) }
def support_url=(_support_url); end
# The business's publicly available website.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(annual_revenue: T.nilable(::Stripe::AccountService::UpdateParams::BusinessProfile::AnnualRevenue), estimated_worker_count: T.nilable(Integer), mcc: T.nilable(String), minority_owned_business_designation: T.nilable(T::Array[String]), monthly_estimated_revenue: T.nilable(::Stripe::AccountService::UpdateParams::BusinessProfile::MonthlyEstimatedRevenue), name: T.nilable(String), product_description: T.nilable(String), support_address: T.nilable(::Stripe::AccountService::UpdateParams::BusinessProfile::SupportAddress), support_email: T.nilable(String), support_phone: T.nilable(String), support_url: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
annual_revenue: nil,
estimated_worker_count: nil,
mcc: nil,
minority_owned_business_designation: nil,
monthly_estimated_revenue: nil,
name: nil,
product_description: nil,
support_address: nil,
support_email: nil,
support_phone: nil,
support_url: nil,
url: nil
); end
end
class Capabilities < Stripe::RequestParams
class AcssDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AffirmPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AfterpayClearpayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AlmaPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AmazonPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AuBecsDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AutomaticIndirectTax < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BacsDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BancontactPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BilliePayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BlikPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BoletoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CardIssuing < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CardPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CartesBancairesPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CashappPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CryptoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class EpsPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class FpxPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GbBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GiropayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GopayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GrabpayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IdBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IdBankTransferPaymentsBca < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IdealPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IndiaInternationalPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class JcbPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class JpBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KakaoPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KlarnaPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KonbiniPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KrCardPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class LegacyPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class LinkPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MbWayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MobilepayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MultibancoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MxBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class NaverPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class NzBankAccountBecsDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class OxxoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class P24Payments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PayByBankPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaycoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaynowPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaypalPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaypayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaytoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PixPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PromptpayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class QrisPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class RechnungPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class RevolutPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SamsungPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SatispayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SepaBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SepaDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class ShopeepayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SofortPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class StripeBalancePayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SwishPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TaxReportingUs1099K < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TaxReportingUs1099Misc < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class Transfers < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class Treasury < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TreasuryEvolve < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TreasuryFifthThird < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TreasuryGoldmanSachs < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TwintPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class UsBankAccountAchPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class UsBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class ZipPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
# The acss_debit_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AcssDebitPayments))
}
def acss_debit_payments; end
sig {
params(_acss_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AcssDebitPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AcssDebitPayments))
}
def acss_debit_payments=(_acss_debit_payments); end
# The affirm_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AffirmPayments))
}
def affirm_payments; end
sig {
params(_affirm_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AffirmPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AffirmPayments))
}
def affirm_payments=(_affirm_payments); end
# The afterpay_clearpay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AfterpayClearpayPayments))
}
def afterpay_clearpay_payments; end
sig {
params(_afterpay_clearpay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AfterpayClearpayPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AfterpayClearpayPayments))
}
def afterpay_clearpay_payments=(_afterpay_clearpay_payments); end
# The alma_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AlmaPayments))
}
def alma_payments; end
sig {
params(_alma_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AlmaPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AlmaPayments))
}
def alma_payments=(_alma_payments); end
# The amazon_pay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AmazonPayPayments))
}
def amazon_pay_payments; end
sig {
params(_amazon_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AmazonPayPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AmazonPayPayments))
}
def amazon_pay_payments=(_amazon_pay_payments); end
# The au_becs_debit_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AuBecsDebitPayments))
}
def au_becs_debit_payments; end
sig {
params(_au_becs_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AuBecsDebitPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AuBecsDebitPayments))
}
def au_becs_debit_payments=(_au_becs_debit_payments); end
# The automatic_indirect_tax capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AutomaticIndirectTax))
}
def automatic_indirect_tax; end
sig {
params(_automatic_indirect_tax: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AutomaticIndirectTax)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AutomaticIndirectTax))
}
def automatic_indirect_tax=(_automatic_indirect_tax); end
# The bacs_debit_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BacsDebitPayments))
}
def bacs_debit_payments; end
sig {
params(_bacs_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BacsDebitPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BacsDebitPayments))
}
def bacs_debit_payments=(_bacs_debit_payments); end
# The bancontact_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BancontactPayments))
}
def bancontact_payments; end
sig {
params(_bancontact_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BancontactPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BancontactPayments))
}
def bancontact_payments=(_bancontact_payments); end
# The bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BankTransferPayments))
}
def bank_transfer_payments; end
sig {
params(_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BankTransferPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BankTransferPayments))
}
def bank_transfer_payments=(_bank_transfer_payments); end
# The billie_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BilliePayments))
}
def billie_payments; end
sig {
params(_billie_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BilliePayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BilliePayments))
}
def billie_payments=(_billie_payments); end
# The blik_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BlikPayments))
}
def blik_payments; end
sig {
params(_blik_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BlikPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BlikPayments))
}
def blik_payments=(_blik_payments); end
# The boleto_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BoletoPayments))
}
def boleto_payments; end
sig {
params(_boleto_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BoletoPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BoletoPayments))
}
def boleto_payments=(_boleto_payments); end
# The card_issuing capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CardIssuing))
}
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CardIssuing)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CardIssuing))
}
def card_issuing=(_card_issuing); end
# The card_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CardPayments))
}
def card_payments; end
sig {
params(_card_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CardPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CardPayments))
}
def card_payments=(_card_payments); end
# The cartes_bancaires_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CartesBancairesPayments))
}
def cartes_bancaires_payments; end
sig {
params(_cartes_bancaires_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CartesBancairesPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CartesBancairesPayments))
}
def cartes_bancaires_payments=(_cartes_bancaires_payments); end
# The cashapp_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CashappPayments))
}
def cashapp_payments; end
sig {
params(_cashapp_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CashappPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CashappPayments))
}
def cashapp_payments=(_cashapp_payments); end
# The crypto_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CryptoPayments))
}
def crypto_payments; end
sig {
params(_crypto_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CryptoPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CryptoPayments))
}
def crypto_payments=(_crypto_payments); end
# The eps_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::EpsPayments))
}
def eps_payments; end
sig {
params(_eps_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::EpsPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::EpsPayments))
}
def eps_payments=(_eps_payments); end
# The fpx_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::FpxPayments))
}
def fpx_payments; end
sig {
params(_fpx_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::FpxPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::FpxPayments))
}
def fpx_payments=(_fpx_payments); end
# The gb_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GbBankTransferPayments))
}
def gb_bank_transfer_payments; end
sig {
params(_gb_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GbBankTransferPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GbBankTransferPayments))
}
def gb_bank_transfer_payments=(_gb_bank_transfer_payments); end
# The giropay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GiropayPayments))
}
def giropay_payments; end
sig {
params(_giropay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GiropayPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GiropayPayments))
}
def giropay_payments=(_giropay_payments); end
# The gopay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GopayPayments))
}
def gopay_payments; end
sig {
params(_gopay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GopayPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GopayPayments))
}
def gopay_payments=(_gopay_payments); end
# The grabpay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GrabpayPayments))
}
def grabpay_payments; end
sig {
params(_grabpay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GrabpayPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GrabpayPayments))
}
def grabpay_payments=(_grabpay_payments); end
# The id_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IdBankTransferPayments))
}
def id_bank_transfer_payments; end
sig {
params(_id_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IdBankTransferPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IdBankTransferPayments))
}
def id_bank_transfer_payments=(_id_bank_transfer_payments); end
# The id_bank_transfer_payments_bca capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IdBankTransferPaymentsBca))
}
def id_bank_transfer_payments_bca; end
sig {
params(_id_bank_transfer_payments_bca: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IdBankTransferPaymentsBca)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IdBankTransferPaymentsBca))
}
def id_bank_transfer_payments_bca=(_id_bank_transfer_payments_bca); end
# The ideal_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IdealPayments))
}
def ideal_payments; end
sig {
params(_ideal_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IdealPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IdealPayments))
}
def ideal_payments=(_ideal_payments); end
# The india_international_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IndiaInternationalPayments))
}
def india_international_payments; end
sig {
params(_india_international_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IndiaInternationalPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IndiaInternationalPayments))
}
def india_international_payments=(_india_international_payments); end
# The jcb_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::JcbPayments))
}
def jcb_payments; end
sig {
params(_jcb_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::JcbPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::JcbPayments))
}
def jcb_payments=(_jcb_payments); end
# The jp_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::JpBankTransferPayments))
}
def jp_bank_transfer_payments; end
sig {
params(_jp_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::JpBankTransferPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::JpBankTransferPayments))
}
def jp_bank_transfer_payments=(_jp_bank_transfer_payments); end
# The kakao_pay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KakaoPayPayments))
}
def kakao_pay_payments; end
sig {
params(_kakao_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KakaoPayPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KakaoPayPayments))
}
def kakao_pay_payments=(_kakao_pay_payments); end
# The klarna_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KlarnaPayments))
}
def klarna_payments; end
sig {
params(_klarna_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KlarnaPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KlarnaPayments))
}
def klarna_payments=(_klarna_payments); end
# The konbini_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KonbiniPayments))
}
def konbini_payments; end
sig {
params(_konbini_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KonbiniPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KonbiniPayments))
}
def konbini_payments=(_konbini_payments); end
# The kr_card_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KrCardPayments))
}
def kr_card_payments; end
sig {
params(_kr_card_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KrCardPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KrCardPayments))
}
def kr_card_payments=(_kr_card_payments); end
# The legacy_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::LegacyPayments))
}
def legacy_payments; end
sig {
params(_legacy_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::LegacyPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::LegacyPayments))
}
def legacy_payments=(_legacy_payments); end
# The link_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::LinkPayments))
}
def link_payments; end
sig {
params(_link_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::LinkPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::LinkPayments))
}
def link_payments=(_link_payments); end
# The mb_way_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MbWayPayments))
}
def mb_way_payments; end
sig {
params(_mb_way_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MbWayPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MbWayPayments))
}
def mb_way_payments=(_mb_way_payments); end
# The mobilepay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MobilepayPayments))
}
def mobilepay_payments; end
sig {
params(_mobilepay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MobilepayPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MobilepayPayments))
}
def mobilepay_payments=(_mobilepay_payments); end
# The multibanco_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MultibancoPayments))
}
def multibanco_payments; end
sig {
params(_multibanco_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MultibancoPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MultibancoPayments))
}
def multibanco_payments=(_multibanco_payments); end
# The mx_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MxBankTransferPayments))
}
def mx_bank_transfer_payments; end
sig {
params(_mx_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MxBankTransferPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MxBankTransferPayments))
}
def mx_bank_transfer_payments=(_mx_bank_transfer_payments); end
# The naver_pay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::NaverPayPayments))
}
def naver_pay_payments; end
sig {
params(_naver_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::NaverPayPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::NaverPayPayments))
}
def naver_pay_payments=(_naver_pay_payments); end
# The nz_bank_account_becs_debit_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::NzBankAccountBecsDebitPayments))
}
def nz_bank_account_becs_debit_payments; end
sig {
params(_nz_bank_account_becs_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::NzBankAccountBecsDebitPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::NzBankAccountBecsDebitPayments))
}
def nz_bank_account_becs_debit_payments=(_nz_bank_account_becs_debit_payments); end
# The oxxo_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::OxxoPayments))
}
def oxxo_payments; end
sig {
params(_oxxo_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::OxxoPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::OxxoPayments))
}
def oxxo_payments=(_oxxo_payments); end
# The p24_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::P24Payments))
}
def p24_payments; end
sig {
params(_p24_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::P24Payments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::P24Payments))
}
def p24_payments=(_p24_payments); end
# The pay_by_bank_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PayByBankPayments))
}
def pay_by_bank_payments; end
sig {
params(_pay_by_bank_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PayByBankPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PayByBankPayments))
}
def pay_by_bank_payments=(_pay_by_bank_payments); end
# The payco_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaycoPayments))
}
def payco_payments; end
sig {
params(_payco_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaycoPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaycoPayments))
}
def payco_payments=(_payco_payments); end
# The paynow_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaynowPayments))
}
def paynow_payments; end
sig {
params(_paynow_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaynowPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaynowPayments))
}
def paynow_payments=(_paynow_payments); end
# The paypal_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaypalPayments))
}
def paypal_payments; end
sig {
params(_paypal_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaypalPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaypalPayments))
}
def paypal_payments=(_paypal_payments); end
# The paypay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaypayPayments))
}
def paypay_payments; end
sig {
params(_paypay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaypayPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaypayPayments))
}
def paypay_payments=(_paypay_payments); end
# The payto_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaytoPayments))
}
def payto_payments; end
sig {
params(_payto_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaytoPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaytoPayments))
}
def payto_payments=(_payto_payments); end
# The pix_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PixPayments))
}
def pix_payments; end
sig {
params(_pix_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PixPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PixPayments))
}
def pix_payments=(_pix_payments); end
# The promptpay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PromptpayPayments))
}
def promptpay_payments; end
sig {
params(_promptpay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PromptpayPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PromptpayPayments))
}
def promptpay_payments=(_promptpay_payments); end
# The qris_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::QrisPayments))
}
def qris_payments; end
sig {
params(_qris_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::QrisPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::QrisPayments))
}
def qris_payments=(_qris_payments); end
# The rechnung_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::RechnungPayments))
}
def rechnung_payments; end
sig {
params(_rechnung_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::RechnungPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::RechnungPayments))
}
def rechnung_payments=(_rechnung_payments); end
# The revolut_pay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::RevolutPayPayments))
}
def revolut_pay_payments; end
sig {
params(_revolut_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::RevolutPayPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::RevolutPayPayments))
}
def revolut_pay_payments=(_revolut_pay_payments); end
# The samsung_pay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SamsungPayPayments))
}
def samsung_pay_payments; end
sig {
params(_samsung_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SamsungPayPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SamsungPayPayments))
}
def samsung_pay_payments=(_samsung_pay_payments); end
# The satispay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SatispayPayments))
}
def satispay_payments; end
sig {
params(_satispay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SatispayPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SatispayPayments))
}
def satispay_payments=(_satispay_payments); end
# The sepa_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SepaBankTransferPayments))
}
def sepa_bank_transfer_payments; end
sig {
params(_sepa_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SepaBankTransferPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SepaBankTransferPayments))
}
def sepa_bank_transfer_payments=(_sepa_bank_transfer_payments); end
# The sepa_debit_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SepaDebitPayments))
}
def sepa_debit_payments; end
sig {
params(_sepa_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SepaDebitPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SepaDebitPayments))
}
def sepa_debit_payments=(_sepa_debit_payments); end
# The shopeepay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::ShopeepayPayments))
}
def shopeepay_payments; end
sig {
params(_shopeepay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::ShopeepayPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::ShopeepayPayments))
}
def shopeepay_payments=(_shopeepay_payments); end
# The sofort_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SofortPayments))
}
def sofort_payments; end
sig {
params(_sofort_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SofortPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SofortPayments))
}
def sofort_payments=(_sofort_payments); end
# The stripe_balance_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::StripeBalancePayments))
}
def stripe_balance_payments; end
sig {
params(_stripe_balance_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::StripeBalancePayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::StripeBalancePayments))
}
def stripe_balance_payments=(_stripe_balance_payments); end
# The swish_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SwishPayments))
}
def swish_payments; end
sig {
params(_swish_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SwishPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SwishPayments))
}
def swish_payments=(_swish_payments); end
# The tax_reporting_us_1099_k capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TaxReportingUs1099K))
}
def tax_reporting_us_1099_k; end
sig {
params(_tax_reporting_us_1099_k: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TaxReportingUs1099K)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TaxReportingUs1099K))
}
def tax_reporting_us_1099_k=(_tax_reporting_us_1099_k); end
# The tax_reporting_us_1099_misc capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TaxReportingUs1099Misc))
}
def tax_reporting_us_1099_misc; end
sig {
params(_tax_reporting_us_1099_misc: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TaxReportingUs1099Misc)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TaxReportingUs1099Misc))
}
def tax_reporting_us_1099_misc=(_tax_reporting_us_1099_misc); end
# The transfers capability.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::Transfers)) }
def transfers; end
sig {
params(_transfers: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::Transfers)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::Transfers))
}
def transfers=(_transfers); end
# The treasury capability.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::Treasury)) }
def treasury; end
sig {
params(_treasury: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::Treasury)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::Treasury))
}
def treasury=(_treasury); end
# The treasury_evolve capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TreasuryEvolve))
}
def treasury_evolve; end
sig {
params(_treasury_evolve: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TreasuryEvolve)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TreasuryEvolve))
}
def treasury_evolve=(_treasury_evolve); end
# The treasury_fifth_third capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TreasuryFifthThird))
}
def treasury_fifth_third; end
sig {
params(_treasury_fifth_third: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TreasuryFifthThird)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TreasuryFifthThird))
}
def treasury_fifth_third=(_treasury_fifth_third); end
# The treasury_goldman_sachs capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TreasuryGoldmanSachs))
}
def treasury_goldman_sachs; end
sig {
params(_treasury_goldman_sachs: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TreasuryGoldmanSachs)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TreasuryGoldmanSachs))
}
def treasury_goldman_sachs=(_treasury_goldman_sachs); end
# The twint_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TwintPayments))
}
def twint_payments; end
sig {
params(_twint_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TwintPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TwintPayments))
}
def twint_payments=(_twint_payments); end
# The us_bank_account_ach_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::UsBankAccountAchPayments))
}
def us_bank_account_ach_payments; end
sig {
params(_us_bank_account_ach_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::UsBankAccountAchPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::UsBankAccountAchPayments))
}
def us_bank_account_ach_payments=(_us_bank_account_ach_payments); end
# The us_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::UsBankTransferPayments))
}
def us_bank_transfer_payments; end
sig {
params(_us_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::UsBankTransferPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::UsBankTransferPayments))
}
def us_bank_transfer_payments=(_us_bank_transfer_payments); end
# The zip_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::ZipPayments))
}
def zip_payments; end
sig {
params(_zip_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::ZipPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::ZipPayments))
}
def zip_payments=(_zip_payments); end
sig {
params(acss_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AcssDebitPayments), affirm_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AffirmPayments), afterpay_clearpay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AfterpayClearpayPayments), alma_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AlmaPayments), amazon_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AmazonPayPayments), au_becs_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AuBecsDebitPayments), automatic_indirect_tax: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AutomaticIndirectTax), bacs_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BacsDebitPayments), bancontact_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BancontactPayments), bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BankTransferPayments), billie_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BilliePayments), blik_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BlikPayments), boleto_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BoletoPayments), card_issuing: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CardIssuing), card_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CardPayments), cartes_bancaires_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CartesBancairesPayments), cashapp_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CashappPayments), crypto_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CryptoPayments), eps_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::EpsPayments), fpx_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::FpxPayments), gb_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GbBankTransferPayments), giropay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GiropayPayments), gopay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GopayPayments), grabpay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GrabpayPayments), id_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IdBankTransferPayments), id_bank_transfer_payments_bca: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IdBankTransferPaymentsBca), ideal_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IdealPayments), india_international_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IndiaInternationalPayments), jcb_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::JcbPayments), jp_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::JpBankTransferPayments), kakao_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KakaoPayPayments), klarna_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KlarnaPayments), konbini_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KonbiniPayments), kr_card_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KrCardPayments), legacy_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::LegacyPayments), link_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::LinkPayments), mb_way_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MbWayPayments), mobilepay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MobilepayPayments), multibanco_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MultibancoPayments), mx_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MxBankTransferPayments), naver_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::NaverPayPayments), nz_bank_account_becs_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::NzBankAccountBecsDebitPayments), oxxo_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::OxxoPayments), p24_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::P24Payments), pay_by_bank_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PayByBankPayments), payco_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaycoPayments), paynow_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaynowPayments), paypal_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaypalPayments), paypay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaypayPayments), payto_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaytoPayments), pix_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PixPayments), promptpay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PromptpayPayments), qris_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::QrisPayments), rechnung_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::RechnungPayments), revolut_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::RevolutPayPayments), samsung_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SamsungPayPayments), satispay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SatispayPayments), sepa_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SepaBankTransferPayments), sepa_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SepaDebitPayments), shopeepay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::ShopeepayPayments), sofort_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SofortPayments), stripe_balance_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::StripeBalancePayments), swish_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SwishPayments), tax_reporting_us_1099_k: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TaxReportingUs1099K), tax_reporting_us_1099_misc: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TaxReportingUs1099Misc), transfers: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::Transfers), treasury: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::Treasury), treasury_evolve: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TreasuryEvolve), treasury_fifth_third: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TreasuryFifthThird), treasury_goldman_sachs: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TreasuryGoldmanSachs), twint_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TwintPayments), us_bank_account_ach_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::UsBankAccountAchPayments), us_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::UsBankTransferPayments), zip_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::ZipPayments)).void
}
def initialize(
acss_debit_payments: nil,
affirm_payments: nil,
afterpay_clearpay_payments: nil,
alma_payments: nil,
amazon_pay_payments: nil,
au_becs_debit_payments: nil,
automatic_indirect_tax: nil,
bacs_debit_payments: nil,
bancontact_payments: nil,
bank_transfer_payments: nil,
billie_payments: nil,
blik_payments: nil,
boleto_payments: nil,
card_issuing: nil,
card_payments: nil,
cartes_bancaires_payments: nil,
cashapp_payments: nil,
crypto_payments: nil,
eps_payments: nil,
fpx_payments: nil,
gb_bank_transfer_payments: nil,
giropay_payments: nil,
gopay_payments: nil,
grabpay_payments: nil,
id_bank_transfer_payments: nil,
id_bank_transfer_payments_bca: nil,
ideal_payments: nil,
india_international_payments: nil,
jcb_payments: nil,
jp_bank_transfer_payments: nil,
kakao_pay_payments: nil,
klarna_payments: nil,
konbini_payments: nil,
kr_card_payments: nil,
legacy_payments: nil,
link_payments: nil,
mb_way_payments: nil,
mobilepay_payments: nil,
multibanco_payments: nil,
mx_bank_transfer_payments: nil,
naver_pay_payments: nil,
nz_bank_account_becs_debit_payments: nil,
oxxo_payments: nil,
p24_payments: nil,
pay_by_bank_payments: nil,
payco_payments: nil,
paynow_payments: nil,
paypal_payments: nil,
paypay_payments: nil,
payto_payments: nil,
pix_payments: nil,
promptpay_payments: nil,
qris_payments: nil,
rechnung_payments: nil,
revolut_pay_payments: nil,
samsung_pay_payments: nil,
satispay_payments: nil,
sepa_bank_transfer_payments: nil,
sepa_debit_payments: nil,
shopeepay_payments: nil,
sofort_payments: nil,
stripe_balance_payments: nil,
swish_payments: nil,
tax_reporting_us_1099_k: nil,
tax_reporting_us_1099_misc: nil,
transfers: nil,
treasury: nil,
treasury_evolve: nil,
treasury_fifth_third: nil,
treasury_goldman_sachs: nil,
twint_payments: nil,
us_bank_account_ach_payments: nil,
us_bank_transfer_payments: nil,
zip_payments: nil
); end
end
class Card < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# Attribute for param field address_city
sig { returns(T.nilable(String)) }
def address_city; end
sig { params(_address_city: T.nilable(String)).returns(T.nilable(String)) }
def address_city=(_address_city); end
# Attribute for param field address_country
sig { returns(T.nilable(String)) }
def address_country; end
sig { params(_address_country: T.nilable(String)).returns(T.nilable(String)) }
def address_country=(_address_country); end
# Attribute for param field address_line1
sig { returns(T.nilable(String)) }
def address_line1; end
sig { params(_address_line1: T.nilable(String)).returns(T.nilable(String)) }
def address_line1=(_address_line1); end
# Attribute for param field address_line2
sig { returns(T.nilable(String)) }
def address_line2; end
sig { params(_address_line2: T.nilable(String)).returns(T.nilable(String)) }
def address_line2=(_address_line2); end
# Attribute for param field address_state
sig { returns(T.nilable(String)) }
def address_state; end
sig { params(_address_state: T.nilable(String)).returns(T.nilable(String)) }
def address_state=(_address_state); end
# Attribute for param field address_zip
sig { returns(T.nilable(String)) }
def address_zip; end
sig { params(_address_zip: T.nilable(String)).returns(T.nilable(String)) }
def address_zip=(_address_zip); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Attribute for param field cvc
sig { returns(T.nilable(String)) }
def cvc; end
sig { params(_cvc: T.nilable(String)).returns(T.nilable(String)) }
def cvc=(_cvc); end
# Attribute for param field exp_month
sig { returns(Integer) }
def exp_month; end
sig { params(_exp_month: Integer).returns(Integer) }
def exp_month=(_exp_month); end
# Attribute for param field exp_year
sig { returns(Integer) }
def exp_year; end
sig { params(_exp_year: Integer).returns(Integer) }
def exp_year=(_exp_year); end
# Attribute for param field name
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Attribute for param field number
sig { returns(String) }
def number; end
sig { params(_number: String).returns(String) }
def number=(_number); end
# 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Attribute for param field default_for_currency
sig { returns(T.nilable(T::Boolean)) }
def default_for_currency; end
sig { params(_default_for_currency: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def default_for_currency=(_default_for_currency); end
sig {
params(object: String, address_city: T.nilable(String), address_country: T.nilable(String), address_line1: T.nilable(String), address_line2: T.nilable(String), address_state: T.nilable(String), address_zip: T.nilable(String), currency: T.nilable(String), cvc: T.nilable(String), exp_month: Integer, exp_year: Integer, name: T.nilable(String), number: String, metadata: T.nilable(T::Hash[String, String]), default_for_currency: T.nilable(T::Boolean)).void
}
def initialize(
object: nil,
address_city: nil,
address_country: nil,
address_line1: nil,
address_line2: nil,
address_state: nil,
address_zip: nil,
currency: nil,
cvc: nil,
exp_month: nil,
exp_year: nil,
name: nil,
number: nil,
metadata: nil,
default_for_currency: nil
); end
end
class CardToken < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Attribute for param field token
sig { returns(String) }
def token; end
sig { params(_token: String).returns(String) }
def token=(_token); end
sig { params(object: String, currency: T.nilable(String), token: String).void }
def initialize(object: nil, currency: nil, token: nil); end
end
class Company < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class DirectorshipDeclaration < Stripe::RequestParams
# The Unix timestamp marking when the directorship declaration attestation was made.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the directorship declaration attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the directorship declaration attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class OwnershipDeclaration < Stripe::RequestParams
# The Unix timestamp marking when the beneficial owner attestation was made.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class RegistrationDate < Stripe::RequestParams
# The day of registration, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of registration, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of registration.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Verification < Stripe::RequestParams
class Document < Stripe::RequestParams
# The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# A document verifying the business.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Company::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::AccountService::UpdateParams::Company::Verification::Document)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Company::Verification::Document))
}
def document=(_document); end
sig {
params(document: T.nilable(::Stripe::AccountService::UpdateParams::Company::Verification::Document)).void
}
def initialize(document: nil); end
end
# The company's primary address.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Company::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::AccountService::UpdateParams::Company::Address)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Company::Address))
}
def address=(_address); end
# The Kana variation of the company's primary address (Japan only).
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Company::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::AccountService::UpdateParams::Company::AddressKana)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Company::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the company's primary address (Japan only).
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Company::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::AccountService::UpdateParams::Company::AddressKanji)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Company::AddressKanji))
}
def address_kanji=(_address_kanji); end
# Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.
sig { returns(T.nilable(T::Boolean)) }
def directors_provided; end
sig { params(_directors_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def directors_provided=(_directors_provided); end
# This hash is used to attest that the directors information provided to Stripe is both current and correct.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Company::DirectorshipDeclaration))
}
def directorship_declaration; end
sig {
params(_directorship_declaration: T.nilable(::Stripe::AccountService::UpdateParams::Company::DirectorshipDeclaration)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Company::DirectorshipDeclaration))
}
def directorship_declaration=(_directorship_declaration); end
# Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](/api/persons) for accounts with a `relationship.executive` requirement.
sig { returns(T.nilable(T::Boolean)) }
def executives_provided; end
sig { params(_executives_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executives_provided=(_executives_provided); end
# The export license ID number of the company, also referred as Import Export Code (India only).
sig { returns(T.nilable(String)) }
def export_license_id; end
sig { params(_export_license_id: T.nilable(String)).returns(T.nilable(String)) }
def export_license_id=(_export_license_id); end
# The purpose code to use for export transactions (India only).
sig { returns(T.nilable(String)) }
def export_purpose_code; end
sig { params(_export_purpose_code: T.nilable(String)).returns(T.nilable(String)) }
def export_purpose_code=(_export_purpose_code); end
# The company's legal name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The Kana variation of the company's legal name (Japan only).
sig { returns(T.nilable(String)) }
def name_kana; end
sig { params(_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def name_kana=(_name_kana); end
# The Kanji variation of the company's legal name (Japan only).
sig { returns(T.nilable(String)) }
def name_kanji; end
sig { params(_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def name_kanji=(_name_kanji); end
# Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](/api/persons) for accounts with a `relationship.owner` requirement.
sig { returns(T.nilable(T::Boolean)) }
def owners_provided; end
sig { params(_owners_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owners_provided=(_owners_provided); end
# This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Company::OwnershipDeclaration))
}
def ownership_declaration; end
sig {
params(_ownership_declaration: T.nilable(::Stripe::AccountService::UpdateParams::Company::OwnershipDeclaration)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Company::OwnershipDeclaration))
}
def ownership_declaration=(_ownership_declaration); end
# This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.
sig { returns(T.nilable(T.any(String, String))) }
def ownership_exemption_reason; end
sig {
params(_ownership_exemption_reason: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def ownership_exemption_reason=(_ownership_exemption_reason); end
# The company's phone number (used for verification).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Attribute for param field registration_date
sig {
returns(T.nilable(T.any(String, ::Stripe::AccountService::UpdateParams::Company::RegistrationDate)))
}
def registration_date; end
sig {
params(_registration_date: T.nilable(T.any(String, ::Stripe::AccountService::UpdateParams::Company::RegistrationDate))).returns(T.nilable(T.any(String, ::Stripe::AccountService::UpdateParams::Company::RegistrationDate)))
}
def registration_date=(_registration_date); end
# The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).
sig { returns(T.nilable(String)) }
def registration_number; end
sig { params(_registration_number: T.nilable(String)).returns(T.nilable(String)) }
def registration_number=(_registration_number); end
# The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
sig { returns(T.nilable(T.any(String, String))) }
def structure; end
sig {
params(_structure: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def structure=(_structure); end
# The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
# The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
sig { returns(T.nilable(String)) }
def tax_id_registrar; end
sig { params(_tax_id_registrar: T.nilable(String)).returns(T.nilable(String)) }
def tax_id_registrar=(_tax_id_registrar); end
# The VAT number of the company.
sig { returns(T.nilable(String)) }
def vat_id; end
sig { params(_vat_id: T.nilable(String)).returns(T.nilable(String)) }
def vat_id=(_vat_id); end
# Information on the verification state of the company.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Company::Verification)) }
def verification; end
sig {
params(_verification: T.nilable(::Stripe::AccountService::UpdateParams::Company::Verification)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Company::Verification))
}
def verification=(_verification); end
sig {
params(address: T.nilable(::Stripe::AccountService::UpdateParams::Company::Address), address_kana: T.nilable(::Stripe::AccountService::UpdateParams::Company::AddressKana), address_kanji: T.nilable(::Stripe::AccountService::UpdateParams::Company::AddressKanji), directors_provided: T.nilable(T::Boolean), directorship_declaration: T.nilable(::Stripe::AccountService::UpdateParams::Company::DirectorshipDeclaration), executives_provided: T.nilable(T::Boolean), export_license_id: T.nilable(String), export_purpose_code: T.nilable(String), name: T.nilable(String), name_kana: T.nilable(String), name_kanji: T.nilable(String), owners_provided: T.nilable(T::Boolean), ownership_declaration: T.nilable(::Stripe::AccountService::UpdateParams::Company::OwnershipDeclaration), ownership_exemption_reason: T.nilable(T.any(String, String)), phone: T.nilable(String), registration_date: T.nilable(T.any(String, ::Stripe::AccountService::UpdateParams::Company::RegistrationDate)), registration_number: T.nilable(String), structure: T.nilable(T.any(String, String)), tax_id: T.nilable(String), tax_id_registrar: T.nilable(String), vat_id: T.nilable(String), verification: T.nilable(::Stripe::AccountService::UpdateParams::Company::Verification)).void
}
def initialize(
address: nil,
address_kana: nil,
address_kanji: nil,
directors_provided: nil,
directorship_declaration: nil,
executives_provided: nil,
export_license_id: nil,
export_purpose_code: nil,
name: nil,
name_kana: nil,
name_kanji: nil,
owners_provided: nil,
ownership_declaration: nil,
ownership_exemption_reason: nil,
phone: nil,
registration_date: nil,
registration_number: nil,
structure: nil,
tax_id: nil,
tax_id_registrar: nil,
vat_id: nil,
verification: nil
); end
end
class Documents < Stripe::RequestParams
class BankAccountOwnershipVerification < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyLicense < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyMemorandumOfAssociation < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyMinisterialDecree < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyRegistrationVerification < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyTaxIdVerification < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class ProofOfAddress < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class ProofOfRegistration < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class ProofOfUltimateBeneficialOwnership < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
# One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::BankAccountOwnershipVerification))
}
def bank_account_ownership_verification; end
sig {
params(_bank_account_ownership_verification: T.nilable(::Stripe::AccountService::UpdateParams::Documents::BankAccountOwnershipVerification)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::BankAccountOwnershipVerification))
}
def bank_account_ownership_verification=(_bank_account_ownership_verification); end
# One or more documents that demonstrate proof of a company's license to operate.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyLicense))
}
def company_license; end
sig {
params(_company_license: T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyLicense)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyLicense))
}
def company_license=(_company_license); end
# One or more documents showing the company's Memorandum of Association.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyMemorandumOfAssociation))
}
def company_memorandum_of_association; end
sig {
params(_company_memorandum_of_association: T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyMemorandumOfAssociation)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyMemorandumOfAssociation))
}
def company_memorandum_of_association=(_company_memorandum_of_association); end
# (Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyMinisterialDecree))
}
def company_ministerial_decree; end
sig {
params(_company_ministerial_decree: T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyMinisterialDecree)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyMinisterialDecree))
}
def company_ministerial_decree=(_company_ministerial_decree); end
# One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyRegistrationVerification))
}
def company_registration_verification; end
sig {
params(_company_registration_verification: T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyRegistrationVerification)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyRegistrationVerification))
}
def company_registration_verification=(_company_registration_verification); end
# One or more documents that demonstrate proof of a company's tax ID.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyTaxIdVerification))
}
def company_tax_id_verification; end
sig {
params(_company_tax_id_verification: T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyTaxIdVerification)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyTaxIdVerification))
}
def company_tax_id_verification=(_company_tax_id_verification); end
# One or more documents that demonstrate proof of address.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::ProofOfAddress))
}
def proof_of_address; end
sig {
params(_proof_of_address: T.nilable(::Stripe::AccountService::UpdateParams::Documents::ProofOfAddress)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::ProofOfAddress))
}
def proof_of_address=(_proof_of_address); end
# One or more documents showing the company’s proof of registration with the national business registry.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::ProofOfRegistration))
}
def proof_of_registration; end
sig {
params(_proof_of_registration: T.nilable(::Stripe::AccountService::UpdateParams::Documents::ProofOfRegistration)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::ProofOfRegistration))
}
def proof_of_registration=(_proof_of_registration); end
# One or more documents that demonstrate proof of ultimate beneficial ownership.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::ProofOfUltimateBeneficialOwnership))
}
def proof_of_ultimate_beneficial_ownership; end
sig {
params(_proof_of_ultimate_beneficial_ownership: T.nilable(::Stripe::AccountService::UpdateParams::Documents::ProofOfUltimateBeneficialOwnership)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents::ProofOfUltimateBeneficialOwnership))
}
def proof_of_ultimate_beneficial_ownership=(_proof_of_ultimate_beneficial_ownership); end
sig {
params(bank_account_ownership_verification: T.nilable(::Stripe::AccountService::UpdateParams::Documents::BankAccountOwnershipVerification), company_license: T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyLicense), company_memorandum_of_association: T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyMemorandumOfAssociation), company_ministerial_decree: T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyMinisterialDecree), company_registration_verification: T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyRegistrationVerification), company_tax_id_verification: T.nilable(::Stripe::AccountService::UpdateParams::Documents::CompanyTaxIdVerification), proof_of_address: T.nilable(::Stripe::AccountService::UpdateParams::Documents::ProofOfAddress), proof_of_registration: T.nilable(::Stripe::AccountService::UpdateParams::Documents::ProofOfRegistration), proof_of_ultimate_beneficial_ownership: T.nilable(::Stripe::AccountService::UpdateParams::Documents::ProofOfUltimateBeneficialOwnership)).void
}
def initialize(
bank_account_ownership_verification: nil,
company_license: nil,
company_memorandum_of_association: nil,
company_ministerial_decree: nil,
company_registration_verification: nil,
company_tax_id_verification: nil,
proof_of_address: nil,
proof_of_registration: nil,
proof_of_ultimate_beneficial_ownership: nil
); end
end
class Groups < Stripe::RequestParams
# The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details.
sig { returns(T.nilable(String)) }
def payments_pricing; end
sig { params(_payments_pricing: T.nilable(String)).returns(T.nilable(String)) }
def payments_pricing=(_payments_pricing); end
sig { params(payments_pricing: T.nilable(String)).void }
def initialize(payments_pricing: nil); end
end
class Individual < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class RegisteredAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Relationship < Stripe::RequestParams
# Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
sig { returns(T.nilable(T::Boolean)) }
def director; end
sig { params(_director: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def director=(_director); end
# Whether the person has significant responsibility to control, manage, or direct the organization.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
sig { params(_executive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executive=(_executive); end
# Whether the person is an owner of the account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
sig { params(_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owner=(_owner); end
# The percent owned by the person of the account's legal entity.
sig { returns(T.nilable(T.any(String, Float))) }
def percent_ownership; end
sig {
params(_percent_ownership: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def percent_ownership=(_percent_ownership); end
# The person's title (e.g., CEO, Support Engineer).
sig { returns(T.nilable(String)) }
def title; end
sig { params(_title: T.nilable(String)).returns(T.nilable(String)) }
def title=(_title); end
sig {
params(director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), percent_ownership: T.nilable(T.any(String, Float)), title: T.nilable(String)).void
}
def initialize(
director: nil,
executive: nil,
owner: nil,
percent_ownership: nil,
title: nil
); end
end
class Verification < Stripe::RequestParams
class AdditionalDocument < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
class Document < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual::Verification::AdditionalDocument))
}
def additional_document; end
sig {
params(_additional_document: T.nilable(::Stripe::AccountService::UpdateParams::Individual::Verification::AdditionalDocument)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual::Verification::AdditionalDocument))
}
def additional_document=(_additional_document); end
# An identifying document, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::AccountService::UpdateParams::Individual::Verification::Document)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual::Verification::Document))
}
def document=(_document); end
sig {
params(additional_document: T.nilable(::Stripe::AccountService::UpdateParams::Individual::Verification::AdditionalDocument), document: T.nilable(::Stripe::AccountService::UpdateParams::Individual::Verification::Document)).void
}
def initialize(additional_document: nil, document: nil); end
end
# The individual's primary address.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::AccountService::UpdateParams::Individual::Address)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual::Address))
}
def address=(_address); end
# The Kana variation of the individual's primary address (Japan only).
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::AccountService::UpdateParams::Individual::AddressKana)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the individual's primary address (Japan only).
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::AccountService::UpdateParams::Individual::AddressKanji)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual::AddressKanji))
}
def address_kanji=(_address_kanji); end
# The individual's date of birth.
sig {
returns(T.nilable(T.any(String, ::Stripe::AccountService::UpdateParams::Individual::Dob)))
}
def dob; end
sig {
params(_dob: T.nilable(T.any(String, ::Stripe::AccountService::UpdateParams::Individual::Dob))).returns(T.nilable(T.any(String, ::Stripe::AccountService::UpdateParams::Individual::Dob)))
}
def dob=(_dob); end
# The individual's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The individual's first name.
sig { returns(T.nilable(String)) }
def first_name; end
sig { params(_first_name: T.nilable(String)).returns(T.nilable(String)) }
def first_name=(_first_name); end
# The Kana variation of the individual's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kana; end
sig { params(_first_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kana=(_first_name_kana); end
# The Kanji variation of the individual's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kanji; end
sig { params(_first_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kanji=(_first_name_kanji); end
# A list of alternate names or aliases that the individual is known by.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def full_name_aliases; end
sig {
params(_full_name_aliases: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def full_name_aliases=(_full_name_aliases); end
# The individual's gender
sig { returns(T.nilable(String)) }
def gender; end
sig { params(_gender: T.nilable(String)).returns(T.nilable(String)) }
def gender=(_gender); end
# The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number; end
sig { params(_id_number: T.nilable(String)).returns(T.nilable(String)) }
def id_number=(_id_number); end
# The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number_secondary; end
sig { params(_id_number_secondary: T.nilable(String)).returns(T.nilable(String)) }
def id_number_secondary=(_id_number_secondary); end
# The individual's last name.
sig { returns(T.nilable(String)) }
def last_name; end
sig { params(_last_name: T.nilable(String)).returns(T.nilable(String)) }
def last_name=(_last_name); end
# The Kana variation of the individual's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kana; end
sig { params(_last_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kana=(_last_name_kana); end
# The Kanji variation of the individual's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kanji; end
sig { params(_last_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kanji=(_last_name_kanji); end
# The individual's maiden name.
sig { returns(T.nilable(String)) }
def maiden_name; end
sig { params(_maiden_name: T.nilable(String)).returns(T.nilable(String)) }
def maiden_name=(_maiden_name); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The individual's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
sig { returns(T.nilable(String)) }
def political_exposure; end
sig { params(_political_exposure: T.nilable(String)).returns(T.nilable(String)) }
def political_exposure=(_political_exposure); end
# The individual's registered address.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual::RegisteredAddress))
}
def registered_address; end
sig {
params(_registered_address: T.nilable(::Stripe::AccountService::UpdateParams::Individual::RegisteredAddress)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual::RegisteredAddress))
}
def registered_address=(_registered_address); end
# Describes the person’s relationship to the account.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual::Relationship)) }
def relationship; end
sig {
params(_relationship: T.nilable(::Stripe::AccountService::UpdateParams::Individual::Relationship)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual::Relationship))
}
def relationship=(_relationship); end
# The last four digits of the individual's Social Security Number (U.S. only).
sig { returns(T.nilable(String)) }
def ssn_last_4; end
sig { params(_ssn_last_4: T.nilable(String)).returns(T.nilable(String)) }
def ssn_last_4=(_ssn_last_4); end
# The individual's verification document information.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual::Verification)) }
def verification; end
sig {
params(_verification: T.nilable(::Stripe::AccountService::UpdateParams::Individual::Verification)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual::Verification))
}
def verification=(_verification); end
sig {
params(address: T.nilable(::Stripe::AccountService::UpdateParams::Individual::Address), address_kana: T.nilable(::Stripe::AccountService::UpdateParams::Individual::AddressKana), address_kanji: T.nilable(::Stripe::AccountService::UpdateParams::Individual::AddressKanji), dob: T.nilable(T.any(String, ::Stripe::AccountService::UpdateParams::Individual::Dob)), email: T.nilable(String), first_name: T.nilable(String), first_name_kana: T.nilable(String), first_name_kanji: T.nilable(String), full_name_aliases: T.nilable(T.any(String, T::Array[String])), gender: T.nilable(String), id_number: T.nilable(String), id_number_secondary: T.nilable(String), last_name: T.nilable(String), last_name_kana: T.nilable(String), last_name_kanji: T.nilable(String), maiden_name: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), phone: T.nilable(String), political_exposure: T.nilable(String), registered_address: T.nilable(::Stripe::AccountService::UpdateParams::Individual::RegisteredAddress), relationship: T.nilable(::Stripe::AccountService::UpdateParams::Individual::Relationship), ssn_last_4: T.nilable(String), verification: T.nilable(::Stripe::AccountService::UpdateParams::Individual::Verification)).void
}
def initialize(
address: nil,
address_kana: nil,
address_kanji: nil,
dob: nil,
email: nil,
first_name: nil,
first_name_kana: nil,
first_name_kanji: nil,
full_name_aliases: nil,
gender: nil,
id_number: nil,
id_number_secondary: nil,
last_name: nil,
last_name_kana: nil,
last_name_kanji: nil,
maiden_name: nil,
metadata: nil,
phone: nil,
political_exposure: nil,
registered_address: nil,
relationship: nil,
ssn_last_4: nil,
verification: nil
); end
end
class RiskControls < Stripe::RequestParams
class Charges < Stripe::RequestParams
# To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.
# There can be a delay before the risk control is paused or unpaused.
sig { returns(T.nilable(T::Boolean)) }
def pause_requested; end
sig { params(_pause_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def pause_requested=(_pause_requested); end
sig { params(pause_requested: T.nilable(T::Boolean)).void }
def initialize(pause_requested: nil); end
end
class Payouts < Stripe::RequestParams
# To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.
# There can be a delay before the risk control is paused or unpaused.
sig { returns(T.nilable(T::Boolean)) }
def pause_requested; end
sig { params(_pause_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def pause_requested=(_pause_requested); end
sig { params(pause_requested: T.nilable(T::Boolean)).void }
def initialize(pause_requested: nil); end
end
# Represents the risk control status of charges. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::RiskControls::Charges)) }
def charges; end
sig {
params(_charges: T.nilable(::Stripe::AccountService::UpdateParams::RiskControls::Charges)).returns(T.nilable(::Stripe::AccountService::UpdateParams::RiskControls::Charges))
}
def charges=(_charges); end
# Represents the risk control status of payouts. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::RiskControls::Payouts)) }
def payouts; end
sig {
params(_payouts: T.nilable(::Stripe::AccountService::UpdateParams::RiskControls::Payouts)).returns(T.nilable(::Stripe::AccountService::UpdateParams::RiskControls::Payouts))
}
def payouts=(_payouts); end
sig {
params(charges: T.nilable(::Stripe::AccountService::UpdateParams::RiskControls::Charges), payouts: T.nilable(::Stripe::AccountService::UpdateParams::RiskControls::Payouts)).void
}
def initialize(charges: nil, payouts: nil); end
end
class Settings < Stripe::RequestParams
class BacsDebitPayments < Stripe::RequestParams
# The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
sig { params(display_name: T.nilable(String)).void }
def initialize(display_name: nil); end
end
class BankBcaOnboarding < Stripe::RequestParams
# Bank BCA business account holder name
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# Bank BCA business account number
sig { returns(T.nilable(String)) }
def business_account_number; end
sig { params(_business_account_number: T.nilable(String)).returns(T.nilable(String)) }
def business_account_number=(_business_account_number); end
sig {
params(account_holder_name: T.nilable(String), business_account_number: T.nilable(String)).void
}
def initialize(account_holder_name: nil, business_account_number: nil); end
end
class Branding < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.
sig { returns(T.nilable(String)) }
def icon; end
sig { params(_icon: T.nilable(String)).returns(T.nilable(String)) }
def icon=(_icon); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.
sig { returns(T.nilable(String)) }
def logo; end
sig { params(_logo: T.nilable(String)).returns(T.nilable(String)) }
def logo=(_logo); end
# A CSS hex color value representing the primary branding color for this account.
sig { returns(T.nilable(String)) }
def primary_color; end
sig { params(_primary_color: T.nilable(String)).returns(T.nilable(String)) }
def primary_color=(_primary_color); end
# A CSS hex color value representing the secondary branding color for this account.
sig { returns(T.nilable(String)) }
def secondary_color; end
sig { params(_secondary_color: T.nilable(String)).returns(T.nilable(String)) }
def secondary_color=(_secondary_color); end
sig {
params(icon: T.nilable(String), logo: T.nilable(String), primary_color: T.nilable(String), secondary_color: T.nilable(String)).void
}
def initialize(icon: nil, logo: nil, primary_color: nil, secondary_color: nil); end
end
class Capital < Stripe::RequestParams
# Per-currency mapping of user-selected destination accounts used to pay out loans.
sig { returns(T.nilable(T::Hash[String, String])) }
def payout_destination; end
sig {
params(_payout_destination: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def payout_destination=(_payout_destination); end
# Per-currency mapping of all destination accounts eligible to receive Capital financing payouts.
sig { returns(T.nilable(T::Hash[String, T::Array[String]])) }
def payout_destination_selector; end
sig {
params(_payout_destination_selector: T.nilable(T::Hash[String, T::Array[String]])).returns(T.nilable(T::Hash[String, T::Array[String]]))
}
def payout_destination_selector=(_payout_destination_selector); end
sig {
params(payout_destination: T.nilable(T::Hash[String, String]), payout_destination_selector: T.nilable(T::Hash[String, T::Array[String]])).void
}
def initialize(payout_destination: nil, payout_destination_selector: nil); end
end
class CardIssuing < Stripe::RequestParams
class TosAcceptance < Stripe::RequestParams
# The Unix timestamp marking when the account representative accepted the service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](/issuing/connect/tos_acceptance).
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::CardIssuing::TosAcceptance))
}
def tos_acceptance; end
sig {
params(_tos_acceptance: T.nilable(::Stripe::AccountService::UpdateParams::Settings::CardIssuing::TosAcceptance)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::CardIssuing::TosAcceptance))
}
def tos_acceptance=(_tos_acceptance); end
sig {
params(tos_acceptance: T.nilable(::Stripe::AccountService::UpdateParams::Settings::CardIssuing::TosAcceptance)).void
}
def initialize(tos_acceptance: nil); end
end
class CardPayments < Stripe::RequestParams
class DeclineOn < Stripe::RequestParams
# Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.
sig { returns(T.nilable(T::Boolean)) }
def avs_failure; end
sig { params(_avs_failure: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def avs_failure=(_avs_failure); end
# Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.
sig { returns(T.nilable(T::Boolean)) }
def cvc_failure; end
sig { params(_cvc_failure: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def cvc_failure=(_cvc_failure); end
sig {
params(avs_failure: T.nilable(T::Boolean), cvc_failure: T.nilable(T::Boolean)).void
}
def initialize(avs_failure: nil, cvc_failure: nil); end
end
# Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::CardPayments::DeclineOn))
}
def decline_on; end
sig {
params(_decline_on: T.nilable(::Stripe::AccountService::UpdateParams::Settings::CardPayments::DeclineOn)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::CardPayments::DeclineOn))
}
def decline_on=(_decline_on); end
# The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix; end
sig { params(_statement_descriptor_prefix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_prefix=(_statement_descriptor_prefix); end
# The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion.
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix_kana; end
sig {
params(_statement_descriptor_prefix_kana: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_prefix_kana=(_statement_descriptor_prefix_kana); end
# The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion.
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix_kanji; end
sig {
params(_statement_descriptor_prefix_kanji: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_prefix_kanji=(_statement_descriptor_prefix_kanji); end
sig {
params(decline_on: T.nilable(::Stripe::AccountService::UpdateParams::Settings::CardPayments::DeclineOn), statement_descriptor_prefix: T.nilable(String), statement_descriptor_prefix_kana: T.nilable(String), statement_descriptor_prefix_kanji: T.nilable(String)).void
}
def initialize(
decline_on: nil,
statement_descriptor_prefix: nil,
statement_descriptor_prefix_kana: nil,
statement_descriptor_prefix_kanji: nil
); end
end
class Invoices < Stripe::RequestParams
# The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_account_tax_ids; end
sig {
params(_default_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_account_tax_ids=(_default_account_tax_ids); end
# Whether payment methods should be saved when a payment is completed for a one-time invoices on a hosted invoice page.
sig { returns(T.nilable(String)) }
def hosted_payment_method_save; end
sig { params(_hosted_payment_method_save: T.nilable(String)).returns(T.nilable(String)) }
def hosted_payment_method_save=(_hosted_payment_method_save); end
sig {
params(default_account_tax_ids: T.nilable(T.any(String, T::Array[String])), hosted_payment_method_save: T.nilable(String)).void
}
def initialize(default_account_tax_ids: nil, hosted_payment_method_save: nil); end
end
class Payments < Stripe::RequestParams
# The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a `statement_descriptor_prefix`, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the `statement_descriptor` text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the [account settings documentation](https://docs.stripe.com/get-started/account/statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor_kana; end
sig { params(_statement_descriptor_kana: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_kana=(_statement_descriptor_kana); end
# The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor_kanji; end
sig { params(_statement_descriptor_kanji: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_kanji=(_statement_descriptor_kanji); end
sig {
params(statement_descriptor: T.nilable(String), statement_descriptor_kana: T.nilable(String), statement_descriptor_kanji: T.nilable(String)).void
}
def initialize(
statement_descriptor: nil,
statement_descriptor_kana: nil,
statement_descriptor_kanji: nil
); end
end
class Payouts < Stripe::RequestParams
class Schedule < Stripe::RequestParams
# The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](/connect/manage-payout-schedule).
sig { returns(T.nilable(T.any(String, Integer))) }
def delay_days; end
sig {
params(_delay_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def delay_days=(_delay_days); end
# How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# The day of the month when available funds are paid out, specified as a number between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`.
sig { returns(T.nilable(Integer)) }
def monthly_anchor; end
sig { params(_monthly_anchor: T.nilable(Integer)).returns(T.nilable(Integer)) }
def monthly_anchor=(_monthly_anchor); end
# The days of the month when available funds are paid out, specified as an array of numbers between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly` and `monthly_anchor` is not set.
sig { returns(T.nilable(T::Array[Integer])) }
def monthly_payout_days; end
sig {
params(_monthly_payout_days: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def monthly_payout_days=(_monthly_payout_days); end
# The day of the week when available funds are paid out, specified as `monday`, `tuesday`, etc. Required and applicable only if `interval` is `weekly`.
sig { returns(T.nilable(String)) }
def weekly_anchor; end
sig { params(_weekly_anchor: T.nilable(String)).returns(T.nilable(String)) }
def weekly_anchor=(_weekly_anchor); end
# The days of the week when available funds are paid out, specified as an array, e.g., [`monday`, `tuesday`]. Required and applicable only if `interval` is `weekly`.
sig { returns(T.nilable(T::Array[String])) }
def weekly_payout_days; end
sig {
params(_weekly_payout_days: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def weekly_payout_days=(_weekly_payout_days); end
sig {
params(delay_days: T.nilable(T.any(String, Integer)), interval: T.nilable(String), monthly_anchor: T.nilable(Integer), monthly_payout_days: T.nilable(T::Array[Integer]), weekly_anchor: T.nilable(String), weekly_payout_days: T.nilable(T::Array[String])).void
}
def initialize(
delay_days: nil,
interval: nil,
monthly_anchor: nil,
monthly_payout_days: nil,
weekly_anchor: nil,
weekly_payout_days: nil
); end
end
# A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/connect/account-balances).
sig { returns(T.nilable(T::Boolean)) }
def debit_negative_balances; end
sig {
params(_debit_negative_balances: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def debit_negative_balances=(_debit_negative_balances); end
# Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](/connect/bank-transfers#payout-information) documentation.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::Payouts::Schedule))
}
def schedule; end
sig {
params(_schedule: T.nilable(::Stripe::AccountService::UpdateParams::Settings::Payouts::Schedule)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::Payouts::Schedule))
}
def schedule=(_schedule); end
# The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
sig {
params(debit_negative_balances: T.nilable(T::Boolean), schedule: T.nilable(::Stripe::AccountService::UpdateParams::Settings::Payouts::Schedule), statement_descriptor: T.nilable(String)).void
}
def initialize(
debit_negative_balances: nil,
schedule: nil,
statement_descriptor: nil
); end
end
class TaxForms < Stripe::RequestParams
# Whether the account opted out of receiving their tax forms by postal delivery.
sig { returns(T.nilable(T::Boolean)) }
def consented_to_paperless_delivery; end
sig {
params(_consented_to_paperless_delivery: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consented_to_paperless_delivery=(_consented_to_paperless_delivery); end
sig { params(consented_to_paperless_delivery: T.nilable(T::Boolean)).void }
def initialize(consented_to_paperless_delivery: nil); end
end
class Treasury < Stripe::RequestParams
class TosAcceptance < Stripe::RequestParams
# The Unix timestamp marking when the account representative accepted the service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Details on the account's acceptance of the Stripe Treasury Services Agreement.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::Treasury::TosAcceptance))
}
def tos_acceptance; end
sig {
params(_tos_acceptance: T.nilable(::Stripe::AccountService::UpdateParams::Settings::Treasury::TosAcceptance)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::Treasury::TosAcceptance))
}
def tos_acceptance=(_tos_acceptance); end
sig {
params(tos_acceptance: T.nilable(::Stripe::AccountService::UpdateParams::Settings::Treasury::TosAcceptance)).void
}
def initialize(tos_acceptance: nil); end
end
# Settings specific to Bacs Direct Debit payments.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::BacsDebitPayments))
}
def bacs_debit_payments; end
sig {
params(_bacs_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Settings::BacsDebitPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::BacsDebitPayments))
}
def bacs_debit_payments=(_bacs_debit_payments); end
# Settings specific to bank BCA onboarding for Indonesia bank transfers payments method.
sig {
returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::BankBcaOnboarding))
}
def bank_bca_onboarding; end
sig {
params(_bank_bca_onboarding: T.nilable(::Stripe::AccountService::UpdateParams::Settings::BankBcaOnboarding)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::BankBcaOnboarding))
}
def bank_bca_onboarding=(_bank_bca_onboarding); end
# Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::Branding)) }
def branding; end
sig {
params(_branding: T.nilable(::Stripe::AccountService::UpdateParams::Settings::Branding)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::Branding))
}
def branding=(_branding); end
# Settings specific to the account's use of the Capital product.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::Capital)) }
def capital; end
sig {
params(_capital: T.nilable(::Stripe::AccountService::UpdateParams::Settings::Capital)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::Capital))
}
def capital=(_capital); end
# Settings specific to the account's use of the Card Issuing product.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::CardIssuing)) }
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::AccountService::UpdateParams::Settings::CardIssuing)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::CardIssuing))
}
def card_issuing=(_card_issuing); end
# Settings specific to card charging on the account.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::CardPayments)) }
def card_payments; end
sig {
params(_card_payments: T.nilable(::Stripe::AccountService::UpdateParams::Settings::CardPayments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::CardPayments))
}
def card_payments=(_card_payments); end
# Settings specific to the account's use of Invoices.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::Invoices)) }
def invoices; end
sig {
params(_invoices: T.nilable(::Stripe::AccountService::UpdateParams::Settings::Invoices)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::Invoices))
}
def invoices=(_invoices); end
# Settings that apply across payment methods for charging on the account.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::Payments)) }
def payments; end
sig {
params(_payments: T.nilable(::Stripe::AccountService::UpdateParams::Settings::Payments)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::Payments))
}
def payments=(_payments); end
# Settings specific to the account's payouts.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::Payouts)) }
def payouts; end
sig {
params(_payouts: T.nilable(::Stripe::AccountService::UpdateParams::Settings::Payouts)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::Payouts))
}
def payouts=(_payouts); end
# Settings specific to the account's tax forms.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::TaxForms)) }
def tax_forms; end
sig {
params(_tax_forms: T.nilable(::Stripe::AccountService::UpdateParams::Settings::TaxForms)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::TaxForms))
}
def tax_forms=(_tax_forms); end
# Settings specific to the account's Treasury FinancialAccounts.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::Treasury)) }
def treasury; end
sig {
params(_treasury: T.nilable(::Stripe::AccountService::UpdateParams::Settings::Treasury)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings::Treasury))
}
def treasury=(_treasury); end
sig {
params(bacs_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Settings::BacsDebitPayments), bank_bca_onboarding: T.nilable(::Stripe::AccountService::UpdateParams::Settings::BankBcaOnboarding), branding: T.nilable(::Stripe::AccountService::UpdateParams::Settings::Branding), capital: T.nilable(::Stripe::AccountService::UpdateParams::Settings::Capital), card_issuing: T.nilable(::Stripe::AccountService::UpdateParams::Settings::CardIssuing), card_payments: T.nilable(::Stripe::AccountService::UpdateParams::Settings::CardPayments), invoices: T.nilable(::Stripe::AccountService::UpdateParams::Settings::Invoices), payments: T.nilable(::Stripe::AccountService::UpdateParams::Settings::Payments), payouts: T.nilable(::Stripe::AccountService::UpdateParams::Settings::Payouts), tax_forms: T.nilable(::Stripe::AccountService::UpdateParams::Settings::TaxForms), treasury: T.nilable(::Stripe::AccountService::UpdateParams::Settings::Treasury)).void
}
def initialize(
bacs_debit_payments: nil,
bank_bca_onboarding: nil,
branding: nil,
capital: nil,
card_issuing: nil,
card_payments: nil,
invoices: nil,
payments: nil,
payouts: nil,
tax_forms: nil,
treasury: nil
); end
end
class TosAcceptance < Stripe::RequestParams
# The Unix timestamp marking when the account representative accepted their service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the account representative accepted their service agreement.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user's service agreement type.
sig { returns(T.nilable(String)) }
def service_agreement; end
sig { params(_service_agreement: T.nilable(String)).returns(T.nilable(String)) }
def service_agreement=(_service_agreement); end
# The user agent of the browser from which the account representative accepted their service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), service_agreement: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, service_agreement: nil, user_agent: nil); end
end
# An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.
sig { returns(T.nilable(String)) }
def account_token; end
sig { params(_account_token: T.nilable(String)).returns(T.nilable(String)) }
def account_token=(_account_token); end
# Business information about the account.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::BusinessProfile)) }
def business_profile; end
sig {
params(_business_profile: T.nilable(::Stripe::AccountService::UpdateParams::BusinessProfile)).returns(T.nilable(::Stripe::AccountService::UpdateParams::BusinessProfile))
}
def business_profile=(_business_profile); end
# The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig { returns(T.nilable(String)) }
def business_type; end
sig { params(_business_type: T.nilable(String)).returns(T.nilable(String)) }
def business_type=(_business_type); end
# Each key of the dictionary represents a capability, and each capability
# maps to its settings (for example, whether it has been requested or not). Each
# capability is inactive until you have provided its specific
# requirements and Stripe has verified them. An account might have some
# of its requested capabilities be active and some be inactive.
#
# Required when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type)
# is `none`, which includes Custom accounts.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities)) }
def capabilities; end
sig {
params(_capabilities: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities))
}
def capabilities=(_capabilities); end
# Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Company)) }
def company; end
sig {
params(_company: T.nilable(::Stripe::AccountService::UpdateParams::Company)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Company))
}
def company=(_company); end
# Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).
sig { returns(T.nilable(String)) }
def default_currency; end
sig { params(_default_currency: T.nilable(String)).returns(T.nilable(String)) }
def default_currency=(_default_currency); end
# Documents that may be submitted to satisfy various informational requests.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents)) }
def documents; end
sig {
params(_documents: T.nilable(::Stripe::AccountService::UpdateParams::Documents)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Documents))
}
def documents=(_documents); end
# The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.
By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig {
returns(T.nilable(T.any(String, T.any(String, ::Stripe::AccountService::UpdateParams::BankAccount, ::Stripe::AccountService::UpdateParams::Card, ::Stripe::AccountService::UpdateParams::CardToken))))
}
def external_account; end
sig {
params(_external_account: T.nilable(T.any(String, T.any(String, ::Stripe::AccountService::UpdateParams::BankAccount, ::Stripe::AccountService::UpdateParams::Card, ::Stripe::AccountService::UpdateParams::CardToken)))).returns(T.nilable(T.any(String, T.any(String, ::Stripe::AccountService::UpdateParams::BankAccount, ::Stripe::AccountService::UpdateParams::Card, ::Stripe::AccountService::UpdateParams::CardToken))))
}
def external_account=(_external_account); end
# A hash of account group type to tokens. These are account groups this account should be added to.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Groups)) }
def groups; end
sig {
params(_groups: T.nilable(::Stripe::AccountService::UpdateParams::Groups)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Groups))
}
def groups=(_groups); end
# Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual)) }
def individual; end
sig {
params(_individual: T.nilable(::Stripe::AccountService::UpdateParams::Individual)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Individual))
}
def individual=(_individual); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# A hash to configure risk controls on the account. Please see [this page for more details](/connect/pausing-payments-or-payouts-on-connected-accounts).
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::RiskControls)) }
def risk_controls; end
sig {
params(_risk_controls: T.nilable(::Stripe::AccountService::UpdateParams::RiskControls)).returns(T.nilable(::Stripe::AccountService::UpdateParams::RiskControls))
}
def risk_controls=(_risk_controls); end
# Options for customizing how the account functions within Stripe.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings)) }
def settings; end
sig {
params(_settings: T.nilable(::Stripe::AccountService::UpdateParams::Settings)).returns(T.nilable(::Stripe::AccountService::UpdateParams::Settings))
}
def settings=(_settings); end
# Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.
sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::TosAcceptance)) }
def tos_acceptance; end
sig {
params(_tos_acceptance: T.nilable(::Stripe::AccountService::UpdateParams::TosAcceptance)).returns(T.nilable(::Stripe::AccountService::UpdateParams::TosAcceptance))
}
def tos_acceptance=(_tos_acceptance); end
sig {
params(account_token: T.nilable(String), business_profile: T.nilable(::Stripe::AccountService::UpdateParams::BusinessProfile), business_type: T.nilable(String), capabilities: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities), company: T.nilable(::Stripe::AccountService::UpdateParams::Company), default_currency: T.nilable(String), documents: T.nilable(::Stripe::AccountService::UpdateParams::Documents), email: T.nilable(String), expand: T.nilable(T::Array[String]), external_account: T.nilable(T.any(String, T.any(String, ::Stripe::AccountService::UpdateParams::BankAccount, ::Stripe::AccountService::UpdateParams::Card, ::Stripe::AccountService::UpdateParams::CardToken))), groups: T.nilable(::Stripe::AccountService::UpdateParams::Groups), individual: T.nilable(::Stripe::AccountService::UpdateParams::Individual), metadata: T.nilable(T.any(String, T::Hash[String, String])), risk_controls: T.nilable(::Stripe::AccountService::UpdateParams::RiskControls), settings: T.nilable(::Stripe::AccountService::UpdateParams::Settings), tos_acceptance: T.nilable(::Stripe::AccountService::UpdateParams::TosAcceptance)).void
}
def initialize(
account_token: nil,
business_profile: nil,
business_type: nil,
capabilities: nil,
company: nil,
default_currency: nil,
documents: nil,
email: nil,
expand: nil,
external_account: nil,
groups: nil,
individual: nil,
metadata: nil,
risk_controls: nil,
settings: nil,
tos_acceptance: nil
); end
end
class RetrieveCurrentParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return connected accounts that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::AccountService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::AccountService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::AccountService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::AccountService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class BankAccount < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The account number for the bank account, in string form. Must be a checking account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The country in which the bank account is located.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts)
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(object: String, account_holder_name: T.nilable(String), account_holder_type: T.nilable(String), account_number: String, country: String, currency: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
object: nil,
account_holder_name: nil,
account_holder_type: nil,
account_number: nil,
country: nil,
currency: nil,
routing_number: nil
); end
end
class BusinessProfile < Stripe::RequestParams
class AnnualRevenue < Stripe::RequestParams
# A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
sig { returns(String) }
def fiscal_year_end; end
sig { params(_fiscal_year_end: String).returns(String) }
def fiscal_year_end=(_fiscal_year_end); end
sig { params(amount: Integer, currency: String, fiscal_year_end: String).void }
def initialize(amount: nil, currency: nil, fiscal_year_end: nil); end
end
class MonthlyEstimatedRevenue < Stripe::RequestParams
# A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
sig { params(amount: Integer, currency: String).void }
def initialize(amount: nil, currency: nil); end
end
class SupportAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The applicant's gross annual revenue for its preceding fiscal year.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::BusinessProfile::AnnualRevenue))
}
def annual_revenue; end
sig {
params(_annual_revenue: T.nilable(::Stripe::AccountService::CreateParams::BusinessProfile::AnnualRevenue)).returns(T.nilable(::Stripe::AccountService::CreateParams::BusinessProfile::AnnualRevenue))
}
def annual_revenue=(_annual_revenue); end
# An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
sig { returns(T.nilable(Integer)) }
def estimated_worker_count; end
sig { params(_estimated_worker_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def estimated_worker_count=(_estimated_worker_count); end
# [The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
sig { returns(T.nilable(String)) }
def mcc; end
sig { params(_mcc: T.nilable(String)).returns(T.nilable(String)) }
def mcc=(_mcc); end
# Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business.
sig { returns(T.nilable(T::Array[String])) }
def minority_owned_business_designation; end
sig {
params(_minority_owned_business_designation: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def minority_owned_business_designation=(_minority_owned_business_designation); end
# An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::BusinessProfile::MonthlyEstimatedRevenue))
}
def monthly_estimated_revenue; end
sig {
params(_monthly_estimated_revenue: T.nilable(::Stripe::AccountService::CreateParams::BusinessProfile::MonthlyEstimatedRevenue)).returns(T.nilable(::Stripe::AccountService::CreateParams::BusinessProfile::MonthlyEstimatedRevenue))
}
def monthly_estimated_revenue=(_monthly_estimated_revenue); end
# The customer-facing business name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# A publicly available mailing address for sending support issues to.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::BusinessProfile::SupportAddress))
}
def support_address; end
sig {
params(_support_address: T.nilable(::Stripe::AccountService::CreateParams::BusinessProfile::SupportAddress)).returns(T.nilable(::Stripe::AccountService::CreateParams::BusinessProfile::SupportAddress))
}
def support_address=(_support_address); end
# A publicly available email address for sending support issues to.
sig { returns(T.nilable(String)) }
def support_email; end
sig { params(_support_email: T.nilable(String)).returns(T.nilable(String)) }
def support_email=(_support_email); end
# A publicly available phone number to call with support issues.
sig { returns(T.nilable(String)) }
def support_phone; end
sig { params(_support_phone: T.nilable(String)).returns(T.nilable(String)) }
def support_phone=(_support_phone); end
# A publicly available website for handling support issues.
sig { returns(T.nilable(String)) }
def support_url; end
sig { params(_support_url: T.nilable(String)).returns(T.nilable(String)) }
def support_url=(_support_url); end
# The business's publicly available website.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(annual_revenue: T.nilable(::Stripe::AccountService::CreateParams::BusinessProfile::AnnualRevenue), estimated_worker_count: T.nilable(Integer), mcc: T.nilable(String), minority_owned_business_designation: T.nilable(T::Array[String]), monthly_estimated_revenue: T.nilable(::Stripe::AccountService::CreateParams::BusinessProfile::MonthlyEstimatedRevenue), name: T.nilable(String), product_description: T.nilable(String), support_address: T.nilable(::Stripe::AccountService::CreateParams::BusinessProfile::SupportAddress), support_email: T.nilable(String), support_phone: T.nilable(String), support_url: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
annual_revenue: nil,
estimated_worker_count: nil,
mcc: nil,
minority_owned_business_designation: nil,
monthly_estimated_revenue: nil,
name: nil,
product_description: nil,
support_address: nil,
support_email: nil,
support_phone: nil,
support_url: nil,
url: nil
); end
end
class Capabilities < Stripe::RequestParams
class AcssDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AffirmPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AfterpayClearpayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AlmaPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AmazonPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AuBecsDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AutomaticIndirectTax < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BacsDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BancontactPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BilliePayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BlikPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BoletoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CardIssuing < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CardPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CartesBancairesPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CashappPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CryptoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class EpsPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class FpxPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GbBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GiropayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GopayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GrabpayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IdBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IdBankTransferPaymentsBca < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IdealPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IndiaInternationalPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class JcbPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class JpBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KakaoPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KlarnaPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KonbiniPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KrCardPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class LegacyPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class LinkPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MbWayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MobilepayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MultibancoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MxBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class NaverPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class NzBankAccountBecsDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class OxxoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class P24Payments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PayByBankPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaycoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaynowPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaypalPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaypayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaytoPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PixPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PromptpayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class QrisPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class RechnungPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class RevolutPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SamsungPayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SatispayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SepaBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SepaDebitPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class ShopeepayPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SofortPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class StripeBalancePayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SwishPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TaxReportingUs1099K < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TaxReportingUs1099Misc < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class Transfers < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class Treasury < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TreasuryEvolve < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TreasuryFifthThird < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TreasuryGoldmanSachs < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TwintPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class UsBankAccountAchPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class UsBankTransferPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class ZipPayments < Stripe::RequestParams
# Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
# The acss_debit_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AcssDebitPayments))
}
def acss_debit_payments; end
sig {
params(_acss_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AcssDebitPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AcssDebitPayments))
}
def acss_debit_payments=(_acss_debit_payments); end
# The affirm_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AffirmPayments))
}
def affirm_payments; end
sig {
params(_affirm_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AffirmPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AffirmPayments))
}
def affirm_payments=(_affirm_payments); end
# The afterpay_clearpay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AfterpayClearpayPayments))
}
def afterpay_clearpay_payments; end
sig {
params(_afterpay_clearpay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AfterpayClearpayPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AfterpayClearpayPayments))
}
def afterpay_clearpay_payments=(_afterpay_clearpay_payments); end
# The alma_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AlmaPayments))
}
def alma_payments; end
sig {
params(_alma_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AlmaPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AlmaPayments))
}
def alma_payments=(_alma_payments); end
# The amazon_pay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AmazonPayPayments))
}
def amazon_pay_payments; end
sig {
params(_amazon_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AmazonPayPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AmazonPayPayments))
}
def amazon_pay_payments=(_amazon_pay_payments); end
# The au_becs_debit_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AuBecsDebitPayments))
}
def au_becs_debit_payments; end
sig {
params(_au_becs_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AuBecsDebitPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AuBecsDebitPayments))
}
def au_becs_debit_payments=(_au_becs_debit_payments); end
# The automatic_indirect_tax capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AutomaticIndirectTax))
}
def automatic_indirect_tax; end
sig {
params(_automatic_indirect_tax: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AutomaticIndirectTax)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AutomaticIndirectTax))
}
def automatic_indirect_tax=(_automatic_indirect_tax); end
# The bacs_debit_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BacsDebitPayments))
}
def bacs_debit_payments; end
sig {
params(_bacs_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BacsDebitPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BacsDebitPayments))
}
def bacs_debit_payments=(_bacs_debit_payments); end
# The bancontact_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BancontactPayments))
}
def bancontact_payments; end
sig {
params(_bancontact_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BancontactPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BancontactPayments))
}
def bancontact_payments=(_bancontact_payments); end
# The bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BankTransferPayments))
}
def bank_transfer_payments; end
sig {
params(_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BankTransferPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BankTransferPayments))
}
def bank_transfer_payments=(_bank_transfer_payments); end
# The billie_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BilliePayments))
}
def billie_payments; end
sig {
params(_billie_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BilliePayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BilliePayments))
}
def billie_payments=(_billie_payments); end
# The blik_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BlikPayments))
}
def blik_payments; end
sig {
params(_blik_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BlikPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BlikPayments))
}
def blik_payments=(_blik_payments); end
# The boleto_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BoletoPayments))
}
def boleto_payments; end
sig {
params(_boleto_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BoletoPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BoletoPayments))
}
def boleto_payments=(_boleto_payments); end
# The card_issuing capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CardIssuing))
}
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CardIssuing)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CardIssuing))
}
def card_issuing=(_card_issuing); end
# The card_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CardPayments))
}
def card_payments; end
sig {
params(_card_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CardPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CardPayments))
}
def card_payments=(_card_payments); end
# The cartes_bancaires_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CartesBancairesPayments))
}
def cartes_bancaires_payments; end
sig {
params(_cartes_bancaires_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CartesBancairesPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CartesBancairesPayments))
}
def cartes_bancaires_payments=(_cartes_bancaires_payments); end
# The cashapp_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CashappPayments))
}
def cashapp_payments; end
sig {
params(_cashapp_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CashappPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CashappPayments))
}
def cashapp_payments=(_cashapp_payments); end
# The crypto_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CryptoPayments))
}
def crypto_payments; end
sig {
params(_crypto_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CryptoPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CryptoPayments))
}
def crypto_payments=(_crypto_payments); end
# The eps_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::EpsPayments))
}
def eps_payments; end
sig {
params(_eps_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::EpsPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::EpsPayments))
}
def eps_payments=(_eps_payments); end
# The fpx_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::FpxPayments))
}
def fpx_payments; end
sig {
params(_fpx_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::FpxPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::FpxPayments))
}
def fpx_payments=(_fpx_payments); end
# The gb_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GbBankTransferPayments))
}
def gb_bank_transfer_payments; end
sig {
params(_gb_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GbBankTransferPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GbBankTransferPayments))
}
def gb_bank_transfer_payments=(_gb_bank_transfer_payments); end
# The giropay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GiropayPayments))
}
def giropay_payments; end
sig {
params(_giropay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GiropayPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GiropayPayments))
}
def giropay_payments=(_giropay_payments); end
# The gopay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GopayPayments))
}
def gopay_payments; end
sig {
params(_gopay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GopayPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GopayPayments))
}
def gopay_payments=(_gopay_payments); end
# The grabpay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GrabpayPayments))
}
def grabpay_payments; end
sig {
params(_grabpay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GrabpayPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GrabpayPayments))
}
def grabpay_payments=(_grabpay_payments); end
# The id_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IdBankTransferPayments))
}
def id_bank_transfer_payments; end
sig {
params(_id_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IdBankTransferPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IdBankTransferPayments))
}
def id_bank_transfer_payments=(_id_bank_transfer_payments); end
# The id_bank_transfer_payments_bca capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IdBankTransferPaymentsBca))
}
def id_bank_transfer_payments_bca; end
sig {
params(_id_bank_transfer_payments_bca: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IdBankTransferPaymentsBca)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IdBankTransferPaymentsBca))
}
def id_bank_transfer_payments_bca=(_id_bank_transfer_payments_bca); end
# The ideal_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IdealPayments))
}
def ideal_payments; end
sig {
params(_ideal_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IdealPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IdealPayments))
}
def ideal_payments=(_ideal_payments); end
# The india_international_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IndiaInternationalPayments))
}
def india_international_payments; end
sig {
params(_india_international_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IndiaInternationalPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IndiaInternationalPayments))
}
def india_international_payments=(_india_international_payments); end
# The jcb_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::JcbPayments))
}
def jcb_payments; end
sig {
params(_jcb_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::JcbPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::JcbPayments))
}
def jcb_payments=(_jcb_payments); end
# The jp_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::JpBankTransferPayments))
}
def jp_bank_transfer_payments; end
sig {
params(_jp_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::JpBankTransferPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::JpBankTransferPayments))
}
def jp_bank_transfer_payments=(_jp_bank_transfer_payments); end
# The kakao_pay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KakaoPayPayments))
}
def kakao_pay_payments; end
sig {
params(_kakao_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KakaoPayPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KakaoPayPayments))
}
def kakao_pay_payments=(_kakao_pay_payments); end
# The klarna_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KlarnaPayments))
}
def klarna_payments; end
sig {
params(_klarna_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KlarnaPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KlarnaPayments))
}
def klarna_payments=(_klarna_payments); end
# The konbini_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KonbiniPayments))
}
def konbini_payments; end
sig {
params(_konbini_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KonbiniPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KonbiniPayments))
}
def konbini_payments=(_konbini_payments); end
# The kr_card_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KrCardPayments))
}
def kr_card_payments; end
sig {
params(_kr_card_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KrCardPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KrCardPayments))
}
def kr_card_payments=(_kr_card_payments); end
# The legacy_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::LegacyPayments))
}
def legacy_payments; end
sig {
params(_legacy_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::LegacyPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::LegacyPayments))
}
def legacy_payments=(_legacy_payments); end
# The link_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::LinkPayments))
}
def link_payments; end
sig {
params(_link_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::LinkPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::LinkPayments))
}
def link_payments=(_link_payments); end
# The mb_way_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MbWayPayments))
}
def mb_way_payments; end
sig {
params(_mb_way_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MbWayPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MbWayPayments))
}
def mb_way_payments=(_mb_way_payments); end
# The mobilepay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MobilepayPayments))
}
def mobilepay_payments; end
sig {
params(_mobilepay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MobilepayPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MobilepayPayments))
}
def mobilepay_payments=(_mobilepay_payments); end
# The multibanco_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MultibancoPayments))
}
def multibanco_payments; end
sig {
params(_multibanco_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MultibancoPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MultibancoPayments))
}
def multibanco_payments=(_multibanco_payments); end
# The mx_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MxBankTransferPayments))
}
def mx_bank_transfer_payments; end
sig {
params(_mx_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MxBankTransferPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MxBankTransferPayments))
}
def mx_bank_transfer_payments=(_mx_bank_transfer_payments); end
# The naver_pay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::NaverPayPayments))
}
def naver_pay_payments; end
sig {
params(_naver_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::NaverPayPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::NaverPayPayments))
}
def naver_pay_payments=(_naver_pay_payments); end
# The nz_bank_account_becs_debit_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::NzBankAccountBecsDebitPayments))
}
def nz_bank_account_becs_debit_payments; end
sig {
params(_nz_bank_account_becs_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::NzBankAccountBecsDebitPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::NzBankAccountBecsDebitPayments))
}
def nz_bank_account_becs_debit_payments=(_nz_bank_account_becs_debit_payments); end
# The oxxo_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::OxxoPayments))
}
def oxxo_payments; end
sig {
params(_oxxo_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::OxxoPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::OxxoPayments))
}
def oxxo_payments=(_oxxo_payments); end
# The p24_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::P24Payments))
}
def p24_payments; end
sig {
params(_p24_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::P24Payments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::P24Payments))
}
def p24_payments=(_p24_payments); end
# The pay_by_bank_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PayByBankPayments))
}
def pay_by_bank_payments; end
sig {
params(_pay_by_bank_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PayByBankPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PayByBankPayments))
}
def pay_by_bank_payments=(_pay_by_bank_payments); end
# The payco_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaycoPayments))
}
def payco_payments; end
sig {
params(_payco_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaycoPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaycoPayments))
}
def payco_payments=(_payco_payments); end
# The paynow_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaynowPayments))
}
def paynow_payments; end
sig {
params(_paynow_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaynowPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaynowPayments))
}
def paynow_payments=(_paynow_payments); end
# The paypal_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaypalPayments))
}
def paypal_payments; end
sig {
params(_paypal_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaypalPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaypalPayments))
}
def paypal_payments=(_paypal_payments); end
# The paypay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaypayPayments))
}
def paypay_payments; end
sig {
params(_paypay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaypayPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaypayPayments))
}
def paypay_payments=(_paypay_payments); end
# The payto_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaytoPayments))
}
def payto_payments; end
sig {
params(_payto_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaytoPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaytoPayments))
}
def payto_payments=(_payto_payments); end
# The pix_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PixPayments))
}
def pix_payments; end
sig {
params(_pix_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PixPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PixPayments))
}
def pix_payments=(_pix_payments); end
# The promptpay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PromptpayPayments))
}
def promptpay_payments; end
sig {
params(_promptpay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PromptpayPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PromptpayPayments))
}
def promptpay_payments=(_promptpay_payments); end
# The qris_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::QrisPayments))
}
def qris_payments; end
sig {
params(_qris_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::QrisPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::QrisPayments))
}
def qris_payments=(_qris_payments); end
# The rechnung_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::RechnungPayments))
}
def rechnung_payments; end
sig {
params(_rechnung_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::RechnungPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::RechnungPayments))
}
def rechnung_payments=(_rechnung_payments); end
# The revolut_pay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::RevolutPayPayments))
}
def revolut_pay_payments; end
sig {
params(_revolut_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::RevolutPayPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::RevolutPayPayments))
}
def revolut_pay_payments=(_revolut_pay_payments); end
# The samsung_pay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SamsungPayPayments))
}
def samsung_pay_payments; end
sig {
params(_samsung_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SamsungPayPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SamsungPayPayments))
}
def samsung_pay_payments=(_samsung_pay_payments); end
# The satispay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SatispayPayments))
}
def satispay_payments; end
sig {
params(_satispay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SatispayPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SatispayPayments))
}
def satispay_payments=(_satispay_payments); end
# The sepa_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SepaBankTransferPayments))
}
def sepa_bank_transfer_payments; end
sig {
params(_sepa_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SepaBankTransferPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SepaBankTransferPayments))
}
def sepa_bank_transfer_payments=(_sepa_bank_transfer_payments); end
# The sepa_debit_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SepaDebitPayments))
}
def sepa_debit_payments; end
sig {
params(_sepa_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SepaDebitPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SepaDebitPayments))
}
def sepa_debit_payments=(_sepa_debit_payments); end
# The shopeepay_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::ShopeepayPayments))
}
def shopeepay_payments; end
sig {
params(_shopeepay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::ShopeepayPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::ShopeepayPayments))
}
def shopeepay_payments=(_shopeepay_payments); end
# The sofort_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SofortPayments))
}
def sofort_payments; end
sig {
params(_sofort_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SofortPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SofortPayments))
}
def sofort_payments=(_sofort_payments); end
# The stripe_balance_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::StripeBalancePayments))
}
def stripe_balance_payments; end
sig {
params(_stripe_balance_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::StripeBalancePayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::StripeBalancePayments))
}
def stripe_balance_payments=(_stripe_balance_payments); end
# The swish_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SwishPayments))
}
def swish_payments; end
sig {
params(_swish_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SwishPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SwishPayments))
}
def swish_payments=(_swish_payments); end
# The tax_reporting_us_1099_k capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TaxReportingUs1099K))
}
def tax_reporting_us_1099_k; end
sig {
params(_tax_reporting_us_1099_k: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TaxReportingUs1099K)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TaxReportingUs1099K))
}
def tax_reporting_us_1099_k=(_tax_reporting_us_1099_k); end
# The tax_reporting_us_1099_misc capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TaxReportingUs1099Misc))
}
def tax_reporting_us_1099_misc; end
sig {
params(_tax_reporting_us_1099_misc: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TaxReportingUs1099Misc)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TaxReportingUs1099Misc))
}
def tax_reporting_us_1099_misc=(_tax_reporting_us_1099_misc); end
# The transfers capability.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::Transfers)) }
def transfers; end
sig {
params(_transfers: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::Transfers)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::Transfers))
}
def transfers=(_transfers); end
# The treasury capability.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::Treasury)) }
def treasury; end
sig {
params(_treasury: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::Treasury)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::Treasury))
}
def treasury=(_treasury); end
# The treasury_evolve capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TreasuryEvolve))
}
def treasury_evolve; end
sig {
params(_treasury_evolve: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TreasuryEvolve)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TreasuryEvolve))
}
def treasury_evolve=(_treasury_evolve); end
# The treasury_fifth_third capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TreasuryFifthThird))
}
def treasury_fifth_third; end
sig {
params(_treasury_fifth_third: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TreasuryFifthThird)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TreasuryFifthThird))
}
def treasury_fifth_third=(_treasury_fifth_third); end
# The treasury_goldman_sachs capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TreasuryGoldmanSachs))
}
def treasury_goldman_sachs; end
sig {
params(_treasury_goldman_sachs: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TreasuryGoldmanSachs)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TreasuryGoldmanSachs))
}
def treasury_goldman_sachs=(_treasury_goldman_sachs); end
# The twint_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TwintPayments))
}
def twint_payments; end
sig {
params(_twint_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TwintPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TwintPayments))
}
def twint_payments=(_twint_payments); end
# The us_bank_account_ach_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::UsBankAccountAchPayments))
}
def us_bank_account_ach_payments; end
sig {
params(_us_bank_account_ach_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::UsBankAccountAchPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::UsBankAccountAchPayments))
}
def us_bank_account_ach_payments=(_us_bank_account_ach_payments); end
# The us_bank_transfer_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::UsBankTransferPayments))
}
def us_bank_transfer_payments; end
sig {
params(_us_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::UsBankTransferPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::UsBankTransferPayments))
}
def us_bank_transfer_payments=(_us_bank_transfer_payments); end
# The zip_payments capability.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::ZipPayments))
}
def zip_payments; end
sig {
params(_zip_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::ZipPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::ZipPayments))
}
def zip_payments=(_zip_payments); end
sig {
params(acss_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AcssDebitPayments), affirm_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AffirmPayments), afterpay_clearpay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AfterpayClearpayPayments), alma_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AlmaPayments), amazon_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AmazonPayPayments), au_becs_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AuBecsDebitPayments), automatic_indirect_tax: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AutomaticIndirectTax), bacs_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BacsDebitPayments), bancontact_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BancontactPayments), bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BankTransferPayments), billie_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BilliePayments), blik_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BlikPayments), boleto_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BoletoPayments), card_issuing: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CardIssuing), card_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CardPayments), cartes_bancaires_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CartesBancairesPayments), cashapp_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CashappPayments), crypto_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CryptoPayments), eps_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::EpsPayments), fpx_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::FpxPayments), gb_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GbBankTransferPayments), giropay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GiropayPayments), gopay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GopayPayments), grabpay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GrabpayPayments), id_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IdBankTransferPayments), id_bank_transfer_payments_bca: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IdBankTransferPaymentsBca), ideal_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IdealPayments), india_international_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IndiaInternationalPayments), jcb_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::JcbPayments), jp_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::JpBankTransferPayments), kakao_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KakaoPayPayments), klarna_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KlarnaPayments), konbini_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KonbiniPayments), kr_card_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KrCardPayments), legacy_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::LegacyPayments), link_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::LinkPayments), mb_way_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MbWayPayments), mobilepay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MobilepayPayments), multibanco_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MultibancoPayments), mx_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MxBankTransferPayments), naver_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::NaverPayPayments), nz_bank_account_becs_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::NzBankAccountBecsDebitPayments), oxxo_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::OxxoPayments), p24_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::P24Payments), pay_by_bank_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PayByBankPayments), payco_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaycoPayments), paynow_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaynowPayments), paypal_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaypalPayments), paypay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaypayPayments), payto_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaytoPayments), pix_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PixPayments), promptpay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PromptpayPayments), qris_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::QrisPayments), rechnung_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::RechnungPayments), revolut_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::RevolutPayPayments), samsung_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SamsungPayPayments), satispay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SatispayPayments), sepa_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SepaBankTransferPayments), sepa_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SepaDebitPayments), shopeepay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::ShopeepayPayments), sofort_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SofortPayments), stripe_balance_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::StripeBalancePayments), swish_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SwishPayments), tax_reporting_us_1099_k: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TaxReportingUs1099K), tax_reporting_us_1099_misc: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TaxReportingUs1099Misc), transfers: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::Transfers), treasury: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::Treasury), treasury_evolve: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TreasuryEvolve), treasury_fifth_third: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TreasuryFifthThird), treasury_goldman_sachs: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TreasuryGoldmanSachs), twint_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TwintPayments), us_bank_account_ach_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::UsBankAccountAchPayments), us_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::UsBankTransferPayments), zip_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::ZipPayments)).void
}
def initialize(
acss_debit_payments: nil,
affirm_payments: nil,
afterpay_clearpay_payments: nil,
alma_payments: nil,
amazon_pay_payments: nil,
au_becs_debit_payments: nil,
automatic_indirect_tax: nil,
bacs_debit_payments: nil,
bancontact_payments: nil,
bank_transfer_payments: nil,
billie_payments: nil,
blik_payments: nil,
boleto_payments: nil,
card_issuing: nil,
card_payments: nil,
cartes_bancaires_payments: nil,
cashapp_payments: nil,
crypto_payments: nil,
eps_payments: nil,
fpx_payments: nil,
gb_bank_transfer_payments: nil,
giropay_payments: nil,
gopay_payments: nil,
grabpay_payments: nil,
id_bank_transfer_payments: nil,
id_bank_transfer_payments_bca: nil,
ideal_payments: nil,
india_international_payments: nil,
jcb_payments: nil,
jp_bank_transfer_payments: nil,
kakao_pay_payments: nil,
klarna_payments: nil,
konbini_payments: nil,
kr_card_payments: nil,
legacy_payments: nil,
link_payments: nil,
mb_way_payments: nil,
mobilepay_payments: nil,
multibanco_payments: nil,
mx_bank_transfer_payments: nil,
naver_pay_payments: nil,
nz_bank_account_becs_debit_payments: nil,
oxxo_payments: nil,
p24_payments: nil,
pay_by_bank_payments: nil,
payco_payments: nil,
paynow_payments: nil,
paypal_payments: nil,
paypay_payments: nil,
payto_payments: nil,
pix_payments: nil,
promptpay_payments: nil,
qris_payments: nil,
rechnung_payments: nil,
revolut_pay_payments: nil,
samsung_pay_payments: nil,
satispay_payments: nil,
sepa_bank_transfer_payments: nil,
sepa_debit_payments: nil,
shopeepay_payments: nil,
sofort_payments: nil,
stripe_balance_payments: nil,
swish_payments: nil,
tax_reporting_us_1099_k: nil,
tax_reporting_us_1099_misc: nil,
transfers: nil,
treasury: nil,
treasury_evolve: nil,
treasury_fifth_third: nil,
treasury_goldman_sachs: nil,
twint_payments: nil,
us_bank_account_ach_payments: nil,
us_bank_transfer_payments: nil,
zip_payments: nil
); end
end
class Card < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# Attribute for param field address_city
sig { returns(T.nilable(String)) }
def address_city; end
sig { params(_address_city: T.nilable(String)).returns(T.nilable(String)) }
def address_city=(_address_city); end
# Attribute for param field address_country
sig { returns(T.nilable(String)) }
def address_country; end
sig { params(_address_country: T.nilable(String)).returns(T.nilable(String)) }
def address_country=(_address_country); end
# Attribute for param field address_line1
sig { returns(T.nilable(String)) }
def address_line1; end
sig { params(_address_line1: T.nilable(String)).returns(T.nilable(String)) }
def address_line1=(_address_line1); end
# Attribute for param field address_line2
sig { returns(T.nilable(String)) }
def address_line2; end
sig { params(_address_line2: T.nilable(String)).returns(T.nilable(String)) }
def address_line2=(_address_line2); end
# Attribute for param field address_state
sig { returns(T.nilable(String)) }
def address_state; end
sig { params(_address_state: T.nilable(String)).returns(T.nilable(String)) }
def address_state=(_address_state); end
# Attribute for param field address_zip
sig { returns(T.nilable(String)) }
def address_zip; end
sig { params(_address_zip: T.nilable(String)).returns(T.nilable(String)) }
def address_zip=(_address_zip); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Attribute for param field cvc
sig { returns(T.nilable(String)) }
def cvc; end
sig { params(_cvc: T.nilable(String)).returns(T.nilable(String)) }
def cvc=(_cvc); end
# Attribute for param field exp_month
sig { returns(Integer) }
def exp_month; end
sig { params(_exp_month: Integer).returns(Integer) }
def exp_month=(_exp_month); end
# Attribute for param field exp_year
sig { returns(Integer) }
def exp_year; end
sig { params(_exp_year: Integer).returns(Integer) }
def exp_year=(_exp_year); end
# Attribute for param field name
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Attribute for param field number
sig { returns(String) }
def number; end
sig { params(_number: String).returns(String) }
def number=(_number); end
# 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Attribute for param field default_for_currency
sig { returns(T.nilable(T::Boolean)) }
def default_for_currency; end
sig { params(_default_for_currency: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def default_for_currency=(_default_for_currency); end
sig {
params(object: String, address_city: T.nilable(String), address_country: T.nilable(String), address_line1: T.nilable(String), address_line2: T.nilable(String), address_state: T.nilable(String), address_zip: T.nilable(String), currency: T.nilable(String), cvc: T.nilable(String), exp_month: Integer, exp_year: Integer, name: T.nilable(String), number: String, metadata: T.nilable(T::Hash[String, String]), default_for_currency: T.nilable(T::Boolean)).void
}
def initialize(
object: nil,
address_city: nil,
address_country: nil,
address_line1: nil,
address_line2: nil,
address_state: nil,
address_zip: nil,
currency: nil,
cvc: nil,
exp_month: nil,
exp_year: nil,
name: nil,
number: nil,
metadata: nil,
default_for_currency: nil
); end
end
class CardToken < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Attribute for param field token
sig { returns(String) }
def token; end
sig { params(_token: String).returns(String) }
def token=(_token); end
sig { params(object: String, currency: T.nilable(String), token: String).void }
def initialize(object: nil, currency: nil, token: nil); end
end
class Company < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class DirectorshipDeclaration < Stripe::RequestParams
# The Unix timestamp marking when the directorship declaration attestation was made.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the directorship declaration attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the directorship declaration attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class OwnershipDeclaration < Stripe::RequestParams
# The Unix timestamp marking when the beneficial owner attestation was made.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class RegistrationDate < Stripe::RequestParams
# The day of registration, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of registration, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of registration.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Verification < Stripe::RequestParams
class Document < Stripe::RequestParams
# The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# A document verifying the business.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Company::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::AccountService::CreateParams::Company::Verification::Document)).returns(T.nilable(::Stripe::AccountService::CreateParams::Company::Verification::Document))
}
def document=(_document); end
sig {
params(document: T.nilable(::Stripe::AccountService::CreateParams::Company::Verification::Document)).void
}
def initialize(document: nil); end
end
# The company's primary address.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Company::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::AccountService::CreateParams::Company::Address)).returns(T.nilable(::Stripe::AccountService::CreateParams::Company::Address))
}
def address=(_address); end
# The Kana variation of the company's primary address (Japan only).
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Company::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::AccountService::CreateParams::Company::AddressKana)).returns(T.nilable(::Stripe::AccountService::CreateParams::Company::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the company's primary address (Japan only).
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Company::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::AccountService::CreateParams::Company::AddressKanji)).returns(T.nilable(::Stripe::AccountService::CreateParams::Company::AddressKanji))
}
def address_kanji=(_address_kanji); end
# Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.
sig { returns(T.nilable(T::Boolean)) }
def directors_provided; end
sig { params(_directors_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def directors_provided=(_directors_provided); end
# This hash is used to attest that the directors information provided to Stripe is both current and correct.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Company::DirectorshipDeclaration))
}
def directorship_declaration; end
sig {
params(_directorship_declaration: T.nilable(::Stripe::AccountService::CreateParams::Company::DirectorshipDeclaration)).returns(T.nilable(::Stripe::AccountService::CreateParams::Company::DirectorshipDeclaration))
}
def directorship_declaration=(_directorship_declaration); end
# Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](/api/persons) for accounts with a `relationship.executive` requirement.
sig { returns(T.nilable(T::Boolean)) }
def executives_provided; end
sig { params(_executives_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executives_provided=(_executives_provided); end
# The export license ID number of the company, also referred as Import Export Code (India only).
sig { returns(T.nilable(String)) }
def export_license_id; end
sig { params(_export_license_id: T.nilable(String)).returns(T.nilable(String)) }
def export_license_id=(_export_license_id); end
# The purpose code to use for export transactions (India only).
sig { returns(T.nilable(String)) }
def export_purpose_code; end
sig { params(_export_purpose_code: T.nilable(String)).returns(T.nilable(String)) }
def export_purpose_code=(_export_purpose_code); end
# The company's legal name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The Kana variation of the company's legal name (Japan only).
sig { returns(T.nilable(String)) }
def name_kana; end
sig { params(_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def name_kana=(_name_kana); end
# The Kanji variation of the company's legal name (Japan only).
sig { returns(T.nilable(String)) }
def name_kanji; end
sig { params(_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def name_kanji=(_name_kanji); end
# Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](/api/persons) for accounts with a `relationship.owner` requirement.
sig { returns(T.nilable(T::Boolean)) }
def owners_provided; end
sig { params(_owners_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owners_provided=(_owners_provided); end
# This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Company::OwnershipDeclaration))
}
def ownership_declaration; end
sig {
params(_ownership_declaration: T.nilable(::Stripe::AccountService::CreateParams::Company::OwnershipDeclaration)).returns(T.nilable(::Stripe::AccountService::CreateParams::Company::OwnershipDeclaration))
}
def ownership_declaration=(_ownership_declaration); end
# This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.
sig { returns(T.nilable(T.any(String, String))) }
def ownership_exemption_reason; end
sig {
params(_ownership_exemption_reason: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def ownership_exemption_reason=(_ownership_exemption_reason); end
# The company's phone number (used for verification).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# When the business was incorporated or registered.
sig {
returns(T.nilable(T.any(String, ::Stripe::AccountService::CreateParams::Company::RegistrationDate)))
}
def registration_date; end
sig {
params(_registration_date: T.nilable(T.any(String, ::Stripe::AccountService::CreateParams::Company::RegistrationDate))).returns(T.nilable(T.any(String, ::Stripe::AccountService::CreateParams::Company::RegistrationDate)))
}
def registration_date=(_registration_date); end
# The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).
sig { returns(T.nilable(String)) }
def registration_number; end
sig { params(_registration_number: T.nilable(String)).returns(T.nilable(String)) }
def registration_number=(_registration_number); end
# The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
sig { returns(T.nilable(T.any(String, String))) }
def structure; end
sig {
params(_structure: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def structure=(_structure); end
# The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
# The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
sig { returns(T.nilable(String)) }
def tax_id_registrar; end
sig { params(_tax_id_registrar: T.nilable(String)).returns(T.nilable(String)) }
def tax_id_registrar=(_tax_id_registrar); end
# The VAT number of the company.
sig { returns(T.nilable(String)) }
def vat_id; end
sig { params(_vat_id: T.nilable(String)).returns(T.nilable(String)) }
def vat_id=(_vat_id); end
# Information on the verification state of the company.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Company::Verification)) }
def verification; end
sig {
params(_verification: T.nilable(::Stripe::AccountService::CreateParams::Company::Verification)).returns(T.nilable(::Stripe::AccountService::CreateParams::Company::Verification))
}
def verification=(_verification); end
sig {
params(address: T.nilable(::Stripe::AccountService::CreateParams::Company::Address), address_kana: T.nilable(::Stripe::AccountService::CreateParams::Company::AddressKana), address_kanji: T.nilable(::Stripe::AccountService::CreateParams::Company::AddressKanji), directors_provided: T.nilable(T::Boolean), directorship_declaration: T.nilable(::Stripe::AccountService::CreateParams::Company::DirectorshipDeclaration), executives_provided: T.nilable(T::Boolean), export_license_id: T.nilable(String), export_purpose_code: T.nilable(String), name: T.nilable(String), name_kana: T.nilable(String), name_kanji: T.nilable(String), owners_provided: T.nilable(T::Boolean), ownership_declaration: T.nilable(::Stripe::AccountService::CreateParams::Company::OwnershipDeclaration), ownership_exemption_reason: T.nilable(T.any(String, String)), phone: T.nilable(String), registration_date: T.nilable(T.any(String, ::Stripe::AccountService::CreateParams::Company::RegistrationDate)), registration_number: T.nilable(String), structure: T.nilable(T.any(String, String)), tax_id: T.nilable(String), tax_id_registrar: T.nilable(String), vat_id: T.nilable(String), verification: T.nilable(::Stripe::AccountService::CreateParams::Company::Verification)).void
}
def initialize(
address: nil,
address_kana: nil,
address_kanji: nil,
directors_provided: nil,
directorship_declaration: nil,
executives_provided: nil,
export_license_id: nil,
export_purpose_code: nil,
name: nil,
name_kana: nil,
name_kanji: nil,
owners_provided: nil,
ownership_declaration: nil,
ownership_exemption_reason: nil,
phone: nil,
registration_date: nil,
registration_number: nil,
structure: nil,
tax_id: nil,
tax_id_registrar: nil,
vat_id: nil,
verification: nil
); end
end
class Controller < Stripe::RequestParams
class Application < Stripe::RequestParams
# Whether the controller is liable for losses on this account. For details, see [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances).
sig { returns(T::Boolean) }
def loss_liable; end
sig { params(_loss_liable: T::Boolean).returns(T::Boolean) }
def loss_liable=(_loss_liable); end
# Whether the controller owns onboarding for this account.
sig { returns(T.nilable(T::Boolean)) }
def onboarding_owner; end
sig { params(_onboarding_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def onboarding_owner=(_onboarding_owner); end
# Whether the controller has pricing controls for this account.
sig { returns(T.nilable(T::Boolean)) }
def pricing_controls; end
sig { params(_pricing_controls: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def pricing_controls=(_pricing_controls); end
sig {
params(loss_liable: T::Boolean, onboarding_owner: T.nilable(T::Boolean), pricing_controls: T.nilable(T::Boolean)).void
}
def initialize(loss_liable: nil, onboarding_owner: nil, pricing_controls: nil); end
end
class Dashboard < Stripe::RequestParams
# Whether this account should have access to the full Stripe Dashboard (`full`), to the Express Dashboard (`express`), or to no Stripe-hosted dashboard (`none`). Defaults to `full`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig { params(type: T.nilable(String)).void }
def initialize(type: nil); end
end
class Fees < Stripe::RequestParams
# A value indicating the responsible payer of Stripe fees on this account. Defaults to `account`. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).
sig { returns(T.nilable(String)) }
def payer; end
sig { params(_payer: T.nilable(String)).returns(T.nilable(String)) }
def payer=(_payer); end
sig { params(payer: T.nilable(String)).void }
def initialize(payer: nil); end
end
class Losses < Stripe::RequestParams
# A value indicating who is liable when this account can't pay back negative balances resulting from payments. Defaults to `stripe`.
sig { returns(T.nilable(String)) }
def payments; end
sig { params(_payments: T.nilable(String)).returns(T.nilable(String)) }
def payments=(_payments); end
sig { params(payments: T.nilable(String)).void }
def initialize(payments: nil); end
end
class StripeDashboard < Stripe::RequestParams
# Whether this account should have access to the full Stripe Dashboard (`full`), to the Express Dashboard (`express`), or to no Stripe-hosted dashboard (`none`). Defaults to `full`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig { params(type: T.nilable(String)).void }
def initialize(type: nil); end
end
# A hash of configuration describing the Connect application that controls the account.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Controller::Application)) }
def application; end
sig {
params(_application: T.nilable(::Stripe::AccountService::CreateParams::Controller::Application)).returns(T.nilable(::Stripe::AccountService::CreateParams::Controller::Application))
}
def application=(_application); end
# Properties of the account's dashboard.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Controller::Dashboard)) }
def dashboard; end
sig {
params(_dashboard: T.nilable(::Stripe::AccountService::CreateParams::Controller::Dashboard)).returns(T.nilable(::Stripe::AccountService::CreateParams::Controller::Dashboard))
}
def dashboard=(_dashboard); end
# A hash of configuration for who pays Stripe fees for product usage on this account.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Controller::Fees)) }
def fees; end
sig {
params(_fees: T.nilable(::Stripe::AccountService::CreateParams::Controller::Fees)).returns(T.nilable(::Stripe::AccountService::CreateParams::Controller::Fees))
}
def fees=(_fees); end
# A hash of configuration for products that have negative balance liability, and whether Stripe or a Connect application is responsible for them.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Controller::Losses)) }
def losses; end
sig {
params(_losses: T.nilable(::Stripe::AccountService::CreateParams::Controller::Losses)).returns(T.nilable(::Stripe::AccountService::CreateParams::Controller::Losses))
}
def losses=(_losses); end
# A value indicating responsibility for collecting updated information when requirements on the account are due or change. Defaults to `stripe`.
sig { returns(T.nilable(String)) }
def requirement_collection; end
sig { params(_requirement_collection: T.nilable(String)).returns(T.nilable(String)) }
def requirement_collection=(_requirement_collection); end
# A hash of configuration for Stripe-hosted dashboards.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Controller::StripeDashboard))
}
def stripe_dashboard; end
sig {
params(_stripe_dashboard: T.nilable(::Stripe::AccountService::CreateParams::Controller::StripeDashboard)).returns(T.nilable(::Stripe::AccountService::CreateParams::Controller::StripeDashboard))
}
def stripe_dashboard=(_stripe_dashboard); end
sig {
params(application: T.nilable(::Stripe::AccountService::CreateParams::Controller::Application), dashboard: T.nilable(::Stripe::AccountService::CreateParams::Controller::Dashboard), fees: T.nilable(::Stripe::AccountService::CreateParams::Controller::Fees), losses: T.nilable(::Stripe::AccountService::CreateParams::Controller::Losses), requirement_collection: T.nilable(String), stripe_dashboard: T.nilable(::Stripe::AccountService::CreateParams::Controller::StripeDashboard)).void
}
def initialize(
application: nil,
dashboard: nil,
fees: nil,
losses: nil,
requirement_collection: nil,
stripe_dashboard: nil
); end
end
class Documents < Stripe::RequestParams
class BankAccountOwnershipVerification < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyLicense < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyMemorandumOfAssociation < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyMinisterialDecree < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyRegistrationVerification < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class CompanyTaxIdVerification < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class ProofOfAddress < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class ProofOfRegistration < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class ProofOfUltimateBeneficialOwnership < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
# One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::BankAccountOwnershipVerification))
}
def bank_account_ownership_verification; end
sig {
params(_bank_account_ownership_verification: T.nilable(::Stripe::AccountService::CreateParams::Documents::BankAccountOwnershipVerification)).returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::BankAccountOwnershipVerification))
}
def bank_account_ownership_verification=(_bank_account_ownership_verification); end
# One or more documents that demonstrate proof of a company's license to operate.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyLicense))
}
def company_license; end
sig {
params(_company_license: T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyLicense)).returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyLicense))
}
def company_license=(_company_license); end
# One or more documents showing the company's Memorandum of Association.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyMemorandumOfAssociation))
}
def company_memorandum_of_association; end
sig {
params(_company_memorandum_of_association: T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyMemorandumOfAssociation)).returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyMemorandumOfAssociation))
}
def company_memorandum_of_association=(_company_memorandum_of_association); end
# (Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyMinisterialDecree))
}
def company_ministerial_decree; end
sig {
params(_company_ministerial_decree: T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyMinisterialDecree)).returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyMinisterialDecree))
}
def company_ministerial_decree=(_company_ministerial_decree); end
# One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyRegistrationVerification))
}
def company_registration_verification; end
sig {
params(_company_registration_verification: T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyRegistrationVerification)).returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyRegistrationVerification))
}
def company_registration_verification=(_company_registration_verification); end
# One or more documents that demonstrate proof of a company's tax ID.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyTaxIdVerification))
}
def company_tax_id_verification; end
sig {
params(_company_tax_id_verification: T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyTaxIdVerification)).returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyTaxIdVerification))
}
def company_tax_id_verification=(_company_tax_id_verification); end
# One or more documents that demonstrate proof of address.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::ProofOfAddress))
}
def proof_of_address; end
sig {
params(_proof_of_address: T.nilable(::Stripe::AccountService::CreateParams::Documents::ProofOfAddress)).returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::ProofOfAddress))
}
def proof_of_address=(_proof_of_address); end
# One or more documents showing the company’s proof of registration with the national business registry.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::ProofOfRegistration))
}
def proof_of_registration; end
sig {
params(_proof_of_registration: T.nilable(::Stripe::AccountService::CreateParams::Documents::ProofOfRegistration)).returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::ProofOfRegistration))
}
def proof_of_registration=(_proof_of_registration); end
# One or more documents that demonstrate proof of ultimate beneficial ownership.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::ProofOfUltimateBeneficialOwnership))
}
def proof_of_ultimate_beneficial_ownership; end
sig {
params(_proof_of_ultimate_beneficial_ownership: T.nilable(::Stripe::AccountService::CreateParams::Documents::ProofOfUltimateBeneficialOwnership)).returns(T.nilable(::Stripe::AccountService::CreateParams::Documents::ProofOfUltimateBeneficialOwnership))
}
def proof_of_ultimate_beneficial_ownership=(_proof_of_ultimate_beneficial_ownership); end
sig {
params(bank_account_ownership_verification: T.nilable(::Stripe::AccountService::CreateParams::Documents::BankAccountOwnershipVerification), company_license: T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyLicense), company_memorandum_of_association: T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyMemorandumOfAssociation), company_ministerial_decree: T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyMinisterialDecree), company_registration_verification: T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyRegistrationVerification), company_tax_id_verification: T.nilable(::Stripe::AccountService::CreateParams::Documents::CompanyTaxIdVerification), proof_of_address: T.nilable(::Stripe::AccountService::CreateParams::Documents::ProofOfAddress), proof_of_registration: T.nilable(::Stripe::AccountService::CreateParams::Documents::ProofOfRegistration), proof_of_ultimate_beneficial_ownership: T.nilable(::Stripe::AccountService::CreateParams::Documents::ProofOfUltimateBeneficialOwnership)).void
}
def initialize(
bank_account_ownership_verification: nil,
company_license: nil,
company_memorandum_of_association: nil,
company_ministerial_decree: nil,
company_registration_verification: nil,
company_tax_id_verification: nil,
proof_of_address: nil,
proof_of_registration: nil,
proof_of_ultimate_beneficial_ownership: nil
); end
end
class Groups < Stripe::RequestParams
# The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details.
sig { returns(T.nilable(String)) }
def payments_pricing; end
sig { params(_payments_pricing: T.nilable(String)).returns(T.nilable(String)) }
def payments_pricing=(_payments_pricing); end
sig { params(payments_pricing: T.nilable(String)).void }
def initialize(payments_pricing: nil); end
end
class Individual < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class RegisteredAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Relationship < Stripe::RequestParams
# Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
sig { returns(T.nilable(T::Boolean)) }
def director; end
sig { params(_director: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def director=(_director); end
# Whether the person has significant responsibility to control, manage, or direct the organization.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
sig { params(_executive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executive=(_executive); end
# Whether the person is an owner of the account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
sig { params(_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owner=(_owner); end
# The percent owned by the person of the account's legal entity.
sig { returns(T.nilable(T.any(String, Float))) }
def percent_ownership; end
sig {
params(_percent_ownership: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def percent_ownership=(_percent_ownership); end
# The person's title (e.g., CEO, Support Engineer).
sig { returns(T.nilable(String)) }
def title; end
sig { params(_title: T.nilable(String)).returns(T.nilable(String)) }
def title=(_title); end
sig {
params(director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), percent_ownership: T.nilable(T.any(String, Float)), title: T.nilable(String)).void
}
def initialize(
director: nil,
executive: nil,
owner: nil,
percent_ownership: nil,
title: nil
); end
end
class Verification < Stripe::RequestParams
class AdditionalDocument < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
class Document < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Individual::Verification::AdditionalDocument))
}
def additional_document; end
sig {
params(_additional_document: T.nilable(::Stripe::AccountService::CreateParams::Individual::Verification::AdditionalDocument)).returns(T.nilable(::Stripe::AccountService::CreateParams::Individual::Verification::AdditionalDocument))
}
def additional_document=(_additional_document); end
# An identifying document, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Individual::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::AccountService::CreateParams::Individual::Verification::Document)).returns(T.nilable(::Stripe::AccountService::CreateParams::Individual::Verification::Document))
}
def document=(_document); end
sig {
params(additional_document: T.nilable(::Stripe::AccountService::CreateParams::Individual::Verification::AdditionalDocument), document: T.nilable(::Stripe::AccountService::CreateParams::Individual::Verification::Document)).void
}
def initialize(additional_document: nil, document: nil); end
end
# The individual's primary address.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Individual::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::AccountService::CreateParams::Individual::Address)).returns(T.nilable(::Stripe::AccountService::CreateParams::Individual::Address))
}
def address=(_address); end
# The Kana variation of the individual's primary address (Japan only).
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Individual::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::AccountService::CreateParams::Individual::AddressKana)).returns(T.nilable(::Stripe::AccountService::CreateParams::Individual::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the individual's primary address (Japan only).
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Individual::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::AccountService::CreateParams::Individual::AddressKanji)).returns(T.nilable(::Stripe::AccountService::CreateParams::Individual::AddressKanji))
}
def address_kanji=(_address_kanji); end
# The individual's date of birth.
sig {
returns(T.nilable(T.any(String, ::Stripe::AccountService::CreateParams::Individual::Dob)))
}
def dob; end
sig {
params(_dob: T.nilable(T.any(String, ::Stripe::AccountService::CreateParams::Individual::Dob))).returns(T.nilable(T.any(String, ::Stripe::AccountService::CreateParams::Individual::Dob)))
}
def dob=(_dob); end
# The individual's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The individual's first name.
sig { returns(T.nilable(String)) }
def first_name; end
sig { params(_first_name: T.nilable(String)).returns(T.nilable(String)) }
def first_name=(_first_name); end
# The Kana variation of the individual's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kana; end
sig { params(_first_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kana=(_first_name_kana); end
# The Kanji variation of the individual's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kanji; end
sig { params(_first_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kanji=(_first_name_kanji); end
# A list of alternate names or aliases that the individual is known by.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def full_name_aliases; end
sig {
params(_full_name_aliases: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def full_name_aliases=(_full_name_aliases); end
# The individual's gender
sig { returns(T.nilable(String)) }
def gender; end
sig { params(_gender: T.nilable(String)).returns(T.nilable(String)) }
def gender=(_gender); end
# The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number; end
sig { params(_id_number: T.nilable(String)).returns(T.nilable(String)) }
def id_number=(_id_number); end
# The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number_secondary; end
sig { params(_id_number_secondary: T.nilable(String)).returns(T.nilable(String)) }
def id_number_secondary=(_id_number_secondary); end
# The individual's last name.
sig { returns(T.nilable(String)) }
def last_name; end
sig { params(_last_name: T.nilable(String)).returns(T.nilable(String)) }
def last_name=(_last_name); end
# The Kana variation of the individual's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kana; end
sig { params(_last_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kana=(_last_name_kana); end
# The Kanji variation of the individual's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kanji; end
sig { params(_last_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kanji=(_last_name_kanji); end
# The individual's maiden name.
sig { returns(T.nilable(String)) }
def maiden_name; end
sig { params(_maiden_name: T.nilable(String)).returns(T.nilable(String)) }
def maiden_name=(_maiden_name); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The individual's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
sig { returns(T.nilable(String)) }
def political_exposure; end
sig { params(_political_exposure: T.nilable(String)).returns(T.nilable(String)) }
def political_exposure=(_political_exposure); end
# The individual's registered address.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Individual::RegisteredAddress))
}
def registered_address; end
sig {
params(_registered_address: T.nilable(::Stripe::AccountService::CreateParams::Individual::RegisteredAddress)).returns(T.nilable(::Stripe::AccountService::CreateParams::Individual::RegisteredAddress))
}
def registered_address=(_registered_address); end
# Describes the person’s relationship to the account.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Individual::Relationship)) }
def relationship; end
sig {
params(_relationship: T.nilable(::Stripe::AccountService::CreateParams::Individual::Relationship)).returns(T.nilable(::Stripe::AccountService::CreateParams::Individual::Relationship))
}
def relationship=(_relationship); end
# The last four digits of the individual's Social Security Number (U.S. only).
sig { returns(T.nilable(String)) }
def ssn_last_4; end
sig { params(_ssn_last_4: T.nilable(String)).returns(T.nilable(String)) }
def ssn_last_4=(_ssn_last_4); end
# The individual's verification document information.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Individual::Verification)) }
def verification; end
sig {
params(_verification: T.nilable(::Stripe::AccountService::CreateParams::Individual::Verification)).returns(T.nilable(::Stripe::AccountService::CreateParams::Individual::Verification))
}
def verification=(_verification); end
sig {
params(address: T.nilable(::Stripe::AccountService::CreateParams::Individual::Address), address_kana: T.nilable(::Stripe::AccountService::CreateParams::Individual::AddressKana), address_kanji: T.nilable(::Stripe::AccountService::CreateParams::Individual::AddressKanji), dob: T.nilable(T.any(String, ::Stripe::AccountService::CreateParams::Individual::Dob)), email: T.nilable(String), first_name: T.nilable(String), first_name_kana: T.nilable(String), first_name_kanji: T.nilable(String), full_name_aliases: T.nilable(T.any(String, T::Array[String])), gender: T.nilable(String), id_number: T.nilable(String), id_number_secondary: T.nilable(String), last_name: T.nilable(String), last_name_kana: T.nilable(String), last_name_kanji: T.nilable(String), maiden_name: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), phone: T.nilable(String), political_exposure: T.nilable(String), registered_address: T.nilable(::Stripe::AccountService::CreateParams::Individual::RegisteredAddress), relationship: T.nilable(::Stripe::AccountService::CreateParams::Individual::Relationship), ssn_last_4: T.nilable(String), verification: T.nilable(::Stripe::AccountService::CreateParams::Individual::Verification)).void
}
def initialize(
address: nil,
address_kana: nil,
address_kanji: nil,
dob: nil,
email: nil,
first_name: nil,
first_name_kana: nil,
first_name_kanji: nil,
full_name_aliases: nil,
gender: nil,
id_number: nil,
id_number_secondary: nil,
last_name: nil,
last_name_kana: nil,
last_name_kanji: nil,
maiden_name: nil,
metadata: nil,
phone: nil,
political_exposure: nil,
registered_address: nil,
relationship: nil,
ssn_last_4: nil,
verification: nil
); end
end
class RiskControls < Stripe::RequestParams
class Charges < Stripe::RequestParams
# To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.
# There can be a delay before the risk control is paused or unpaused.
sig { returns(T.nilable(T::Boolean)) }
def pause_requested; end
sig { params(_pause_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def pause_requested=(_pause_requested); end
sig { params(pause_requested: T.nilable(T::Boolean)).void }
def initialize(pause_requested: nil); end
end
class Payouts < Stripe::RequestParams
# To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.
# There can be a delay before the risk control is paused or unpaused.
sig { returns(T.nilable(T::Boolean)) }
def pause_requested; end
sig { params(_pause_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def pause_requested=(_pause_requested); end
sig { params(pause_requested: T.nilable(T::Boolean)).void }
def initialize(pause_requested: nil); end
end
# Represents the risk control status of charges. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::RiskControls::Charges)) }
def charges; end
sig {
params(_charges: T.nilable(::Stripe::AccountService::CreateParams::RiskControls::Charges)).returns(T.nilable(::Stripe::AccountService::CreateParams::RiskControls::Charges))
}
def charges=(_charges); end
# Represents the risk control status of payouts. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::RiskControls::Payouts)) }
def payouts; end
sig {
params(_payouts: T.nilable(::Stripe::AccountService::CreateParams::RiskControls::Payouts)).returns(T.nilable(::Stripe::AccountService::CreateParams::RiskControls::Payouts))
}
def payouts=(_payouts); end
sig {
params(charges: T.nilable(::Stripe::AccountService::CreateParams::RiskControls::Charges), payouts: T.nilable(::Stripe::AccountService::CreateParams::RiskControls::Payouts)).void
}
def initialize(charges: nil, payouts: nil); end
end
class Settings < Stripe::RequestParams
class BacsDebitPayments < Stripe::RequestParams
# The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
sig { params(display_name: T.nilable(String)).void }
def initialize(display_name: nil); end
end
class BankBcaOnboarding < Stripe::RequestParams
# Bank BCA business account holder name
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# Bank BCA business account number
sig { returns(T.nilable(String)) }
def business_account_number; end
sig { params(_business_account_number: T.nilable(String)).returns(T.nilable(String)) }
def business_account_number=(_business_account_number); end
sig {
params(account_holder_name: T.nilable(String), business_account_number: T.nilable(String)).void
}
def initialize(account_holder_name: nil, business_account_number: nil); end
end
class Branding < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.
sig { returns(T.nilable(String)) }
def icon; end
sig { params(_icon: T.nilable(String)).returns(T.nilable(String)) }
def icon=(_icon); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.
sig { returns(T.nilable(String)) }
def logo; end
sig { params(_logo: T.nilable(String)).returns(T.nilable(String)) }
def logo=(_logo); end
# A CSS hex color value representing the primary branding color for this account.
sig { returns(T.nilable(String)) }
def primary_color; end
sig { params(_primary_color: T.nilable(String)).returns(T.nilable(String)) }
def primary_color=(_primary_color); end
# A CSS hex color value representing the secondary branding color for this account.
sig { returns(T.nilable(String)) }
def secondary_color; end
sig { params(_secondary_color: T.nilable(String)).returns(T.nilable(String)) }
def secondary_color=(_secondary_color); end
sig {
params(icon: T.nilable(String), logo: T.nilable(String), primary_color: T.nilable(String), secondary_color: T.nilable(String)).void
}
def initialize(icon: nil, logo: nil, primary_color: nil, secondary_color: nil); end
end
class Capital < Stripe::RequestParams
# Per-currency mapping of user-selected destination accounts used to pay out loans.
sig { returns(T.nilable(T::Hash[String, String])) }
def payout_destination; end
sig {
params(_payout_destination: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def payout_destination=(_payout_destination); end
# Per-currency mapping of all destination accounts eligible to receive Capital financing payouts.
sig { returns(T.nilable(T::Hash[String, T::Array[String]])) }
def payout_destination_selector; end
sig {
params(_payout_destination_selector: T.nilable(T::Hash[String, T::Array[String]])).returns(T.nilable(T::Hash[String, T::Array[String]]))
}
def payout_destination_selector=(_payout_destination_selector); end
sig {
params(payout_destination: T.nilable(T::Hash[String, String]), payout_destination_selector: T.nilable(T::Hash[String, T::Array[String]])).void
}
def initialize(payout_destination: nil, payout_destination_selector: nil); end
end
class CardIssuing < Stripe::RequestParams
class TosAcceptance < Stripe::RequestParams
# The Unix timestamp marking when the account representative accepted the service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](/issuing/connect/tos_acceptance).
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::CardIssuing::TosAcceptance))
}
def tos_acceptance; end
sig {
params(_tos_acceptance: T.nilable(::Stripe::AccountService::CreateParams::Settings::CardIssuing::TosAcceptance)).returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::CardIssuing::TosAcceptance))
}
def tos_acceptance=(_tos_acceptance); end
sig {
params(tos_acceptance: T.nilable(::Stripe::AccountService::CreateParams::Settings::CardIssuing::TosAcceptance)).void
}
def initialize(tos_acceptance: nil); end
end
class CardPayments < Stripe::RequestParams
class DeclineOn < Stripe::RequestParams
# Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.
sig { returns(T.nilable(T::Boolean)) }
def avs_failure; end
sig { params(_avs_failure: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def avs_failure=(_avs_failure); end
# Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.
sig { returns(T.nilable(T::Boolean)) }
def cvc_failure; end
sig { params(_cvc_failure: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def cvc_failure=(_cvc_failure); end
sig {
params(avs_failure: T.nilable(T::Boolean), cvc_failure: T.nilable(T::Boolean)).void
}
def initialize(avs_failure: nil, cvc_failure: nil); end
end
# Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::CardPayments::DeclineOn))
}
def decline_on; end
sig {
params(_decline_on: T.nilable(::Stripe::AccountService::CreateParams::Settings::CardPayments::DeclineOn)).returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::CardPayments::DeclineOn))
}
def decline_on=(_decline_on); end
# The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix; end
sig { params(_statement_descriptor_prefix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_prefix=(_statement_descriptor_prefix); end
# The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion.
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix_kana; end
sig {
params(_statement_descriptor_prefix_kana: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_prefix_kana=(_statement_descriptor_prefix_kana); end
# The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion.
sig { returns(T.nilable(String)) }
def statement_descriptor_prefix_kanji; end
sig {
params(_statement_descriptor_prefix_kanji: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_prefix_kanji=(_statement_descriptor_prefix_kanji); end
sig {
params(decline_on: T.nilable(::Stripe::AccountService::CreateParams::Settings::CardPayments::DeclineOn), statement_descriptor_prefix: T.nilable(String), statement_descriptor_prefix_kana: T.nilable(String), statement_descriptor_prefix_kanji: T.nilable(String)).void
}
def initialize(
decline_on: nil,
statement_descriptor_prefix: nil,
statement_descriptor_prefix_kana: nil,
statement_descriptor_prefix_kanji: nil
); end
end
class Invoices < Stripe::RequestParams
# Whether payment methods should be saved when a payment is completed for a one-time invoices on a hosted invoice page.
sig { returns(T.nilable(String)) }
def hosted_payment_method_save; end
sig { params(_hosted_payment_method_save: T.nilable(String)).returns(T.nilable(String)) }
def hosted_payment_method_save=(_hosted_payment_method_save); end
sig { params(hosted_payment_method_save: T.nilable(String)).void }
def initialize(hosted_payment_method_save: nil); end
end
class Payments < Stripe::RequestParams
# The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a `statement_descriptor_prefix`, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the `statement_descriptor` text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the [account settings documentation](https://docs.stripe.com/get-started/account/statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor_kana; end
sig { params(_statement_descriptor_kana: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_kana=(_statement_descriptor_kana); end
# The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor_kanji; end
sig { params(_statement_descriptor_kanji: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_kanji=(_statement_descriptor_kanji); end
sig {
params(statement_descriptor: T.nilable(String), statement_descriptor_kana: T.nilable(String), statement_descriptor_kanji: T.nilable(String)).void
}
def initialize(
statement_descriptor: nil,
statement_descriptor_kana: nil,
statement_descriptor_kanji: nil
); end
end
class Payouts < Stripe::RequestParams
class Schedule < Stripe::RequestParams
# The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](/connect/manage-payout-schedule).
sig { returns(T.nilable(T.any(String, Integer))) }
def delay_days; end
sig {
params(_delay_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def delay_days=(_delay_days); end
# How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# The day of the month when available funds are paid out, specified as a number between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`.
sig { returns(T.nilable(Integer)) }
def monthly_anchor; end
sig { params(_monthly_anchor: T.nilable(Integer)).returns(T.nilable(Integer)) }
def monthly_anchor=(_monthly_anchor); end
# The days of the month when available funds are paid out, specified as an array of numbers between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly` and `monthly_anchor` is not set.
sig { returns(T.nilable(T::Array[Integer])) }
def monthly_payout_days; end
sig {
params(_monthly_payout_days: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def monthly_payout_days=(_monthly_payout_days); end
# The day of the week when available funds are paid out, specified as `monday`, `tuesday`, etc. Required and applicable only if `interval` is `weekly`.
sig { returns(T.nilable(String)) }
def weekly_anchor; end
sig { params(_weekly_anchor: T.nilable(String)).returns(T.nilable(String)) }
def weekly_anchor=(_weekly_anchor); end
# The days of the week when available funds are paid out, specified as an array, e.g., [`monday`, `tuesday`]. Required and applicable only if `interval` is `weekly`.
sig { returns(T.nilable(T::Array[String])) }
def weekly_payout_days; end
sig {
params(_weekly_payout_days: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def weekly_payout_days=(_weekly_payout_days); end
sig {
params(delay_days: T.nilable(T.any(String, Integer)), interval: T.nilable(String), monthly_anchor: T.nilable(Integer), monthly_payout_days: T.nilable(T::Array[Integer]), weekly_anchor: T.nilable(String), weekly_payout_days: T.nilable(T::Array[String])).void
}
def initialize(
delay_days: nil,
interval: nil,
monthly_anchor: nil,
monthly_payout_days: nil,
weekly_anchor: nil,
weekly_payout_days: nil
); end
end
# A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/connect/account-balances).
sig { returns(T.nilable(T::Boolean)) }
def debit_negative_balances; end
sig {
params(_debit_negative_balances: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def debit_negative_balances=(_debit_negative_balances); end
# Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](/connect/bank-transfers#payout-information) documentation.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::Payouts::Schedule))
}
def schedule; end
sig {
params(_schedule: T.nilable(::Stripe::AccountService::CreateParams::Settings::Payouts::Schedule)).returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::Payouts::Schedule))
}
def schedule=(_schedule); end
# The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
sig {
params(debit_negative_balances: T.nilable(T::Boolean), schedule: T.nilable(::Stripe::AccountService::CreateParams::Settings::Payouts::Schedule), statement_descriptor: T.nilable(String)).void
}
def initialize(
debit_negative_balances: nil,
schedule: nil,
statement_descriptor: nil
); end
end
class TaxForms < Stripe::RequestParams
# Whether the account opted out of receiving their tax forms by postal delivery.
sig { returns(T.nilable(T::Boolean)) }
def consented_to_paperless_delivery; end
sig {
params(_consented_to_paperless_delivery: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consented_to_paperless_delivery=(_consented_to_paperless_delivery); end
sig { params(consented_to_paperless_delivery: T.nilable(T::Boolean)).void }
def initialize(consented_to_paperless_delivery: nil); end
end
class Treasury < Stripe::RequestParams
class TosAcceptance < Stripe::RequestParams
# The Unix timestamp marking when the account representative accepted the service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Details on the account's acceptance of the Stripe Treasury Services Agreement.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::Treasury::TosAcceptance))
}
def tos_acceptance; end
sig {
params(_tos_acceptance: T.nilable(::Stripe::AccountService::CreateParams::Settings::Treasury::TosAcceptance)).returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::Treasury::TosAcceptance))
}
def tos_acceptance=(_tos_acceptance); end
sig {
params(tos_acceptance: T.nilable(::Stripe::AccountService::CreateParams::Settings::Treasury::TosAcceptance)).void
}
def initialize(tos_acceptance: nil); end
end
# Settings specific to Bacs Direct Debit.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::BacsDebitPayments))
}
def bacs_debit_payments; end
sig {
params(_bacs_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Settings::BacsDebitPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::BacsDebitPayments))
}
def bacs_debit_payments=(_bacs_debit_payments); end
# Settings specific to bank BCA onboarding for Indonesia bank transfers payments method.
sig {
returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::BankBcaOnboarding))
}
def bank_bca_onboarding; end
sig {
params(_bank_bca_onboarding: T.nilable(::Stripe::AccountService::CreateParams::Settings::BankBcaOnboarding)).returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::BankBcaOnboarding))
}
def bank_bca_onboarding=(_bank_bca_onboarding); end
# Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::Branding)) }
def branding; end
sig {
params(_branding: T.nilable(::Stripe::AccountService::CreateParams::Settings::Branding)).returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::Branding))
}
def branding=(_branding); end
# Settings specific to the account's use of the Capital product.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::Capital)) }
def capital; end
sig {
params(_capital: T.nilable(::Stripe::AccountService::CreateParams::Settings::Capital)).returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::Capital))
}
def capital=(_capital); end
# Settings specific to the account's use of the Card Issuing product.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::CardIssuing)) }
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::AccountService::CreateParams::Settings::CardIssuing)).returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::CardIssuing))
}
def card_issuing=(_card_issuing); end
# Settings specific to card charging on the account.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::CardPayments)) }
def card_payments; end
sig {
params(_card_payments: T.nilable(::Stripe::AccountService::CreateParams::Settings::CardPayments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::CardPayments))
}
def card_payments=(_card_payments); end
# Settings specific to the account’s use of Invoices.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::Invoices)) }
def invoices; end
sig {
params(_invoices: T.nilable(::Stripe::AccountService::CreateParams::Settings::Invoices)).returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::Invoices))
}
def invoices=(_invoices); end
# Settings that apply across payment methods for charging on the account.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::Payments)) }
def payments; end
sig {
params(_payments: T.nilable(::Stripe::AccountService::CreateParams::Settings::Payments)).returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::Payments))
}
def payments=(_payments); end
# Settings specific to the account's payouts.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::Payouts)) }
def payouts; end
sig {
params(_payouts: T.nilable(::Stripe::AccountService::CreateParams::Settings::Payouts)).returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::Payouts))
}
def payouts=(_payouts); end
# Settings specific to the account's tax forms.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::TaxForms)) }
def tax_forms; end
sig {
params(_tax_forms: T.nilable(::Stripe::AccountService::CreateParams::Settings::TaxForms)).returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::TaxForms))
}
def tax_forms=(_tax_forms); end
# Settings specific to the account's Treasury FinancialAccounts.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::Treasury)) }
def treasury; end
sig {
params(_treasury: T.nilable(::Stripe::AccountService::CreateParams::Settings::Treasury)).returns(T.nilable(::Stripe::AccountService::CreateParams::Settings::Treasury))
}
def treasury=(_treasury); end
sig {
params(bacs_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Settings::BacsDebitPayments), bank_bca_onboarding: T.nilable(::Stripe::AccountService::CreateParams::Settings::BankBcaOnboarding), branding: T.nilable(::Stripe::AccountService::CreateParams::Settings::Branding), capital: T.nilable(::Stripe::AccountService::CreateParams::Settings::Capital), card_issuing: T.nilable(::Stripe::AccountService::CreateParams::Settings::CardIssuing), card_payments: T.nilable(::Stripe::AccountService::CreateParams::Settings::CardPayments), invoices: T.nilable(::Stripe::AccountService::CreateParams::Settings::Invoices), payments: T.nilable(::Stripe::AccountService::CreateParams::Settings::Payments), payouts: T.nilable(::Stripe::AccountService::CreateParams::Settings::Payouts), tax_forms: T.nilable(::Stripe::AccountService::CreateParams::Settings::TaxForms), treasury: T.nilable(::Stripe::AccountService::CreateParams::Settings::Treasury)).void
}
def initialize(
bacs_debit_payments: nil,
bank_bca_onboarding: nil,
branding: nil,
capital: nil,
card_issuing: nil,
card_payments: nil,
invoices: nil,
payments: nil,
payouts: nil,
tax_forms: nil,
treasury: nil
); end
end
class TosAcceptance < Stripe::RequestParams
# The Unix timestamp marking when the account representative accepted their service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the account representative accepted their service agreement.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user's service agreement type.
sig { returns(T.nilable(String)) }
def service_agreement; end
sig { params(_service_agreement: T.nilable(String)).returns(T.nilable(String)) }
def service_agreement=(_service_agreement); end
# The user agent of the browser from which the account representative accepted their service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), service_agreement: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, service_agreement: nil, user_agent: nil); end
end
# An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.
sig { returns(T.nilable(String)) }
def account_token; end
sig { params(_account_token: T.nilable(String)).returns(T.nilable(String)) }
def account_token=(_account_token); end
# Business information about the account.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::BusinessProfile)) }
def business_profile; end
sig {
params(_business_profile: T.nilable(::Stripe::AccountService::CreateParams::BusinessProfile)).returns(T.nilable(::Stripe::AccountService::CreateParams::BusinessProfile))
}
def business_profile=(_business_profile); end
# The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig { returns(T.nilable(String)) }
def business_type; end
sig { params(_business_type: T.nilable(String)).returns(T.nilable(String)) }
def business_type=(_business_type); end
# Each key of the dictionary represents a capability, and each capability
# maps to its settings (for example, whether it has been requested or not). Each
# capability is inactive until you have provided its specific
# requirements and Stripe has verified them. An account might have some
# of its requested capabilities be active and some be inactive.
#
# Required when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type)
# is `none`, which includes Custom accounts.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities)) }
def capabilities; end
sig {
params(_capabilities: T.nilable(::Stripe::AccountService::CreateParams::Capabilities)).returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities))
}
def capabilities=(_capabilities); end
# Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Company)) }
def company; end
sig {
params(_company: T.nilable(::Stripe::AccountService::CreateParams::Company)).returns(T.nilable(::Stripe::AccountService::CreateParams::Company))
}
def company=(_company); end
# A hash of configuration describing the account controller's attributes.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Controller)) }
def controller; end
sig {
params(_controller: T.nilable(::Stripe::AccountService::CreateParams::Controller)).returns(T.nilable(::Stripe::AccountService::CreateParams::Controller))
}
def controller=(_controller); end
# The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported.
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).
sig { returns(T.nilable(String)) }
def default_currency; end
sig { params(_default_currency: T.nilable(String)).returns(T.nilable(String)) }
def default_currency=(_default_currency); end
# Documents that may be submitted to satisfy various informational requests.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Documents)) }
def documents; end
sig {
params(_documents: T.nilable(::Stripe::AccountService::CreateParams::Documents)).returns(T.nilable(::Stripe::AccountService::CreateParams::Documents))
}
def documents=(_documents); end
# The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.
By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig {
returns(T.nilable(T.any(String, ::Stripe::AccountService::CreateParams::BankAccount, ::Stripe::AccountService::CreateParams::Card, ::Stripe::AccountService::CreateParams::CardToken)))
}
def external_account; end
sig {
params(_external_account: T.nilable(T.any(String, ::Stripe::AccountService::CreateParams::BankAccount, ::Stripe::AccountService::CreateParams::Card, ::Stripe::AccountService::CreateParams::CardToken))).returns(T.nilable(T.any(String, ::Stripe::AccountService::CreateParams::BankAccount, ::Stripe::AccountService::CreateParams::Card, ::Stripe::AccountService::CreateParams::CardToken)))
}
def external_account=(_external_account); end
# A hash of account group type to tokens. These are account groups this account should be added to.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Groups)) }
def groups; end
sig {
params(_groups: T.nilable(::Stripe::AccountService::CreateParams::Groups)).returns(T.nilable(::Stripe::AccountService::CreateParams::Groups))
}
def groups=(_groups); end
# Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Individual)) }
def individual; end
sig {
params(_individual: T.nilable(::Stripe::AccountService::CreateParams::Individual)).returns(T.nilable(::Stripe::AccountService::CreateParams::Individual))
}
def individual=(_individual); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# A hash to configure risk controls on the account. Please see [this page for more details](/connect/pausing-payments-or-payouts-on-connected-accounts).
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::RiskControls)) }
def risk_controls; end
sig {
params(_risk_controls: T.nilable(::Stripe::AccountService::CreateParams::RiskControls)).returns(T.nilable(::Stripe::AccountService::CreateParams::RiskControls))
}
def risk_controls=(_risk_controls); end
# Options for customizing how the account functions within Stripe.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Settings)) }
def settings; end
sig {
params(_settings: T.nilable(::Stripe::AccountService::CreateParams::Settings)).returns(T.nilable(::Stripe::AccountService::CreateParams::Settings))
}
def settings=(_settings); end
# Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.
sig { returns(T.nilable(::Stripe::AccountService::CreateParams::TosAcceptance)) }
def tos_acceptance; end
sig {
params(_tos_acceptance: T.nilable(::Stripe::AccountService::CreateParams::TosAcceptance)).returns(T.nilable(::Stripe::AccountService::CreateParams::TosAcceptance))
}
def tos_acceptance=(_tos_acceptance); end
# The type of Stripe account to create. May be one of `custom`, `express` or `standard`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(account_token: T.nilable(String), business_profile: T.nilable(::Stripe::AccountService::CreateParams::BusinessProfile), business_type: T.nilable(String), capabilities: T.nilable(::Stripe::AccountService::CreateParams::Capabilities), company: T.nilable(::Stripe::AccountService::CreateParams::Company), controller: T.nilable(::Stripe::AccountService::CreateParams::Controller), country: T.nilable(String), default_currency: T.nilable(String), documents: T.nilable(::Stripe::AccountService::CreateParams::Documents), email: T.nilable(String), expand: T.nilable(T::Array[String]), external_account: T.nilable(T.any(String, ::Stripe::AccountService::CreateParams::BankAccount, ::Stripe::AccountService::CreateParams::Card, ::Stripe::AccountService::CreateParams::CardToken)), groups: T.nilable(::Stripe::AccountService::CreateParams::Groups), individual: T.nilable(::Stripe::AccountService::CreateParams::Individual), metadata: T.nilable(T.any(String, T::Hash[String, String])), risk_controls: T.nilable(::Stripe::AccountService::CreateParams::RiskControls), settings: T.nilable(::Stripe::AccountService::CreateParams::Settings), tos_acceptance: T.nilable(::Stripe::AccountService::CreateParams::TosAcceptance), type: T.nilable(String)).void
}
def initialize(
account_token: nil,
business_profile: nil,
business_type: nil,
capabilities: nil,
company: nil,
controller: nil,
country: nil,
default_currency: nil,
documents: nil,
email: nil,
expand: nil,
external_account: nil,
groups: nil,
individual: nil,
metadata: nil,
risk_controls: nil,
settings: nil,
tos_acceptance: nil,
type: nil
); end
end
class RejectParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`.
sig { returns(String) }
def reason; end
sig { params(_reason: String).returns(String) }
def reason=(_reason); end
sig { params(expand: T.nilable(T::Array[String]), reason: String).void }
def initialize(expand: nil, reason: nil); end
end
# With [Connect](https://docs.stripe.com/docs/connect), you can create Stripe accounts for your users.
# To do this, you'll first need to [register your platform](https://dashboard.stripe.com/account/applications/settings).
#
# If you've already collected information for your connected accounts, you [can prefill that information](https://docs.stripe.com/docs/connect/best-practices#onboarding) when
# creating the account. Connect Onboarding won't ask for the prefilled information during account onboarding.
# You can prefill any information on the account.
sig {
params(params: T.any(::Stripe::AccountService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Account)
}
def create(params = {}, opts = {}); end
# With [Connect](https://docs.stripe.com/connect), you can delete accounts you manage.
#
# Test-mode accounts can be deleted at any time.
#
# Live-mode accounts that have access to the standard dashboard and Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. All other Live-mode accounts, can be deleted when all [balances](https://docs.stripe.com/api/balance/balance_object) are zero.
#
# If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead.
sig {
params(account: String, params: T.any(::Stripe::AccountService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Account)
}
def delete(account, params = {}, opts = {}); end
# Returns a list of accounts connected to your platform via [Connect](https://docs.stripe.com/docs/connect). If you're not a platform, the list is empty.
sig {
params(params: T.any(::Stripe::AccountService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# With [Connect](https://docs.stripe.com/connect), you can reject accounts that you have flagged as suspicious.
#
# Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.
sig {
params(account: String, params: T.any(::Stripe::AccountService::RejectParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Account)
}
def reject(account, params = {}, opts = {}); end
# Retrieves the details of an account.
sig {
params(account: String, params: T.any(::Stripe::AccountService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Account)
}
def retrieve(account, params = {}, opts = {}); end
# Retrieves the details of an account.
sig {
params(params: T.any(::Stripe::AccountService::RetrieveCurrentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Account)
}
def retrieve_current(params = {}, opts = {}); end
# Updates a [connected account](https://docs.stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are
# left unchanged.
#
# For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection)
# is application, which includes Custom accounts, you can update any information on the account.
#
# For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection)
# is stripe, which includes Standard and Express accounts, you can update all information until you create
# an [Account Link or Account Session](https://docs.stripe.com/api/account_links) to start Connect onboarding,
# after which some properties can no longer be updated.
#
# To update your own account, use the [Dashboard](https://dashboard.stripe.com/settings/account). Refer to our
# [Connect](https://docs.stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts.
sig {
params(account: String, params: T.any(::Stripe::AccountService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Account)
}
def update(account, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class AccountCapabilityService < StripeService
class ListParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the `requirements` arrays.
#
# If a capability isn't permanent, you can remove it from the account by passing false. Some capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(expand: T.nilable(T::Array[String]), requested: T.nilable(T::Boolean)).void }
def initialize(expand: nil, requested: nil); end
end
# Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.
sig {
params(account: String, params: T.any(::Stripe::AccountCapabilityService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(account, params = {}, opts = {}); end
# Retrieves information about the specified Account Capability.
sig {
params(account: String, capability: String, params: T.any(::Stripe::AccountCapabilityService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Capability)
}
def retrieve(account, capability, params = {}, opts = {}); end
# Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.
sig {
params(account: String, capability: String, params: T.any(::Stripe::AccountCapabilityService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Capability)
}
def update(account, capability, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class AccountExternalAccountService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Documents < Stripe::RequestParams
class BankAccountOwnershipVerification < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
# One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check.
sig {
returns(T.nilable(::Stripe::AccountExternalAccountService::UpdateParams::Documents::BankAccountOwnershipVerification))
}
def bank_account_ownership_verification; end
sig {
params(_bank_account_ownership_verification: T.nilable(::Stripe::AccountExternalAccountService::UpdateParams::Documents::BankAccountOwnershipVerification)).returns(T.nilable(::Stripe::AccountExternalAccountService::UpdateParams::Documents::BankAccountOwnershipVerification))
}
def bank_account_ownership_verification=(_bank_account_ownership_verification); end
sig {
params(bank_account_ownership_verification: T.nilable(::Stripe::AccountExternalAccountService::UpdateParams::Documents::BankAccountOwnershipVerification)).void
}
def initialize(bank_account_ownership_verification: nil); end
end
# The name of the person or business that owns the bank account.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The type of entity that holds the account. This can be either `individual` or `company`.
sig { returns(T.nilable(T.any(String, String))) }
def account_holder_type; end
sig {
params(_account_holder_type: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def account_holder_type=(_account_holder_type); end
# The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# City/District/Suburb/Town/Village.
sig { returns(T.nilable(String)) }
def address_city; end
sig { params(_address_city: T.nilable(String)).returns(T.nilable(String)) }
def address_city=(_address_city); end
# Billing address country, if provided when creating card.
sig { returns(T.nilable(String)) }
def address_country; end
sig { params(_address_country: T.nilable(String)).returns(T.nilable(String)) }
def address_country=(_address_country); end
# Address line 1 (Street address/PO Box/Company name).
sig { returns(T.nilable(String)) }
def address_line1; end
sig { params(_address_line1: T.nilable(String)).returns(T.nilable(String)) }
def address_line1=(_address_line1); end
# Address line 2 (Apartment/Suite/Unit/Building).
sig { returns(T.nilable(String)) }
def address_line2; end
sig { params(_address_line2: T.nilable(String)).returns(T.nilable(String)) }
def address_line2=(_address_line2); end
# State/County/Province/Region.
sig { returns(T.nilable(String)) }
def address_state; end
sig { params(_address_state: T.nilable(String)).returns(T.nilable(String)) }
def address_state=(_address_state); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def address_zip; end
sig { params(_address_zip: T.nilable(String)).returns(T.nilable(String)) }
def address_zip=(_address_zip); end
# When set to true, this becomes the default external account for its currency.
sig { returns(T.nilable(T::Boolean)) }
def default_for_currency; end
sig { params(_default_for_currency: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def default_for_currency=(_default_for_currency); end
# Documents that may be submitted to satisfy various informational requests.
sig { returns(T.nilable(::Stripe::AccountExternalAccountService::UpdateParams::Documents)) }
def documents; end
sig {
params(_documents: T.nilable(::Stripe::AccountExternalAccountService::UpdateParams::Documents)).returns(T.nilable(::Stripe::AccountExternalAccountService::UpdateParams::Documents))
}
def documents=(_documents); end
# Two digit number representing the card’s expiration month.
sig { returns(T.nilable(String)) }
def exp_month; end
sig { params(_exp_month: T.nilable(String)).returns(T.nilable(String)) }
def exp_month=(_exp_month); end
# Four digit number representing the card’s expiration year.
sig { returns(T.nilable(String)) }
def exp_year; end
sig { params(_exp_year: T.nilable(String)).returns(T.nilable(String)) }
def exp_year=(_exp_year); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Cardholder name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(account_holder_name: T.nilable(String), account_holder_type: T.nilable(T.any(String, String)), account_type: T.nilable(String), address_city: T.nilable(String), address_country: T.nilable(String), address_line1: T.nilable(String), address_line2: T.nilable(String), address_state: T.nilable(String), address_zip: T.nilable(String), default_for_currency: T.nilable(T::Boolean), documents: T.nilable(::Stripe::AccountExternalAccountService::UpdateParams::Documents), exp_month: T.nilable(String), exp_year: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String)).void
}
def initialize(
account_holder_name: nil,
account_holder_type: nil,
account_type: nil,
address_city: nil,
address_country: nil,
address_line1: nil,
address_line2: nil,
address_state: nil,
address_zip: nil,
default_for_currency: nil,
documents: nil,
exp_month: nil,
exp_year: nil,
expand: nil,
metadata: nil,
name: nil
); end
end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Filter external accounts according to a particular object type.
sig { returns(T.nilable(String)) }
def object; end
sig { params(_object: T.nilable(String)).returns(T.nilable(String)) }
def object=(_object); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), object: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
object: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class BankAccount < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The account number for the bank account, in string form. Must be a checking account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The country in which the bank account is located.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts)
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(object: String, account_holder_name: T.nilable(String), account_holder_type: T.nilable(String), account_number: String, country: String, currency: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
object: nil,
account_holder_name: nil,
account_holder_type: nil,
account_number: nil,
country: nil,
currency: nil,
routing_number: nil
); end
end
class Card < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# Attribute for param field address_city
sig { returns(T.nilable(String)) }
def address_city; end
sig { params(_address_city: T.nilable(String)).returns(T.nilable(String)) }
def address_city=(_address_city); end
# Attribute for param field address_country
sig { returns(T.nilable(String)) }
def address_country; end
sig { params(_address_country: T.nilable(String)).returns(T.nilable(String)) }
def address_country=(_address_country); end
# Attribute for param field address_line1
sig { returns(T.nilable(String)) }
def address_line1; end
sig { params(_address_line1: T.nilable(String)).returns(T.nilable(String)) }
def address_line1=(_address_line1); end
# Attribute for param field address_line2
sig { returns(T.nilable(String)) }
def address_line2; end
sig { params(_address_line2: T.nilable(String)).returns(T.nilable(String)) }
def address_line2=(_address_line2); end
# Attribute for param field address_state
sig { returns(T.nilable(String)) }
def address_state; end
sig { params(_address_state: T.nilable(String)).returns(T.nilable(String)) }
def address_state=(_address_state); end
# Attribute for param field address_zip
sig { returns(T.nilable(String)) }
def address_zip; end
sig { params(_address_zip: T.nilable(String)).returns(T.nilable(String)) }
def address_zip=(_address_zip); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Attribute for param field cvc
sig { returns(T.nilable(String)) }
def cvc; end
sig { params(_cvc: T.nilable(String)).returns(T.nilable(String)) }
def cvc=(_cvc); end
# Attribute for param field exp_month
sig { returns(Integer) }
def exp_month; end
sig { params(_exp_month: Integer).returns(Integer) }
def exp_month=(_exp_month); end
# Attribute for param field exp_year
sig { returns(Integer) }
def exp_year; end
sig { params(_exp_year: Integer).returns(Integer) }
def exp_year=(_exp_year); end
# Attribute for param field name
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Attribute for param field number
sig { returns(String) }
def number; end
sig { params(_number: String).returns(String) }
def number=(_number); end
# 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(object: String, address_city: T.nilable(String), address_country: T.nilable(String), address_line1: T.nilable(String), address_line2: T.nilable(String), address_state: T.nilable(String), address_zip: T.nilable(String), currency: T.nilable(String), cvc: T.nilable(String), exp_month: Integer, exp_year: Integer, name: T.nilable(String), number: String, metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(
object: nil,
address_city: nil,
address_country: nil,
address_line1: nil,
address_line2: nil,
address_state: nil,
address_zip: nil,
currency: nil,
cvc: nil,
exp_month: nil,
exp_year: nil,
name: nil,
number: nil,
metadata: nil
); end
end
class CardToken < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Attribute for param field token
sig { returns(String) }
def token; end
sig { params(_token: String).returns(String) }
def token=(_token); end
sig { params(object: String, currency: T.nilable(String), token: String).void }
def initialize(object: nil, currency: nil, token: nil); end
end
# When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
sig { returns(T.nilable(T::Boolean)) }
def default_for_currency; end
sig { params(_default_for_currency: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def default_for_currency=(_default_for_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js) or a dictionary containing a user's external account details (with the options shown below). Please refer to full [documentation](https://stripe.com/docs/api/external_accounts) instead.
sig {
returns(T.any(String, ::Stripe::AccountExternalAccountService::CreateParams::Card, ::Stripe::AccountExternalAccountService::CreateParams::BankAccount, ::Stripe::AccountExternalAccountService::CreateParams::CardToken))
}
def external_account; end
sig {
params(_external_account: T.any(String, ::Stripe::AccountExternalAccountService::CreateParams::Card, ::Stripe::AccountExternalAccountService::CreateParams::BankAccount, ::Stripe::AccountExternalAccountService::CreateParams::CardToken)).returns(T.any(String, ::Stripe::AccountExternalAccountService::CreateParams::Card, ::Stripe::AccountExternalAccountService::CreateParams::BankAccount, ::Stripe::AccountExternalAccountService::CreateParams::CardToken))
}
def external_account=(_external_account); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(default_for_currency: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), external_account: T.any(String, ::Stripe::AccountExternalAccountService::CreateParams::Card, ::Stripe::AccountExternalAccountService::CreateParams::BankAccount, ::Stripe::AccountExternalAccountService::CreateParams::CardToken), metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(
default_for_currency: nil,
expand: nil,
external_account: nil,
metadata: nil
); end
end
# Create an external account for a given account.
sig {
params(account: String, params: T.any(::Stripe::AccountExternalAccountService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.any(Stripe::BankAccount, Stripe::Card))
}
def create(account, params = {}, opts = {}); end
# Delete a specified external account for a given account.
sig {
params(account: String, id: String, params: T.any(::Stripe::AccountExternalAccountService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.any(Stripe::BankAccount, Stripe::Card))
}
def delete(account, id, params = {}, opts = {}); end
# List external accounts for an account.
sig {
params(account: String, params: T.any(::Stripe::AccountExternalAccountService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(account, params = {}, opts = {}); end
# Retrieve a specified external account for a given account.
sig {
params(account: String, id: String, params: T.any(::Stripe::AccountExternalAccountService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.any(Stripe::BankAccount, Stripe::Card))
}
def retrieve(account, id, params = {}, opts = {}); end
# Updates the metadata, account holder name, account holder type of a bank account belonging to
# a connected account and optionally sets it as the default for its currency. Other bank account
# details are not editable by design.
#
# You can only update bank accounts when [account.controller.requirement_collection is application, which includes Custom accounts](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection).
#
# You can re-enable a disabled bank account by performing an update call without providing any
# arguments or changes.
sig {
params(account: String, id: String, params: T.any(::Stripe::AccountExternalAccountService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.any(Stripe::BankAccount, Stripe::Card))
}
def update(account, id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class AccountLoginLinkService < StripeService
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Creates a login link for a connected account to access the Express Dashboard.
#
# You can only create login links for accounts that use the [Express Dashboard](https://docs.stripe.com/connect/express-dashboard) and are connected to your platform.
sig {
params(account: String, params: T.any(::Stripe::AccountLoginLinkService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::LoginLink)
}
def create(account, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class AccountPersonService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class AdditionalTosAcceptances < Stripe::RequestParams
class Account < Stripe::RequestParams
# The Unix timestamp marking when the account representative accepted the service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Details on the legal guardian's acceptance of the main Stripe service agreement.
sig {
returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::AdditionalTosAcceptances::Account))
}
def account; end
sig {
params(_account: T.nilable(::Stripe::AccountPersonService::UpdateParams::AdditionalTosAcceptances::Account)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::AdditionalTosAcceptances::Account))
}
def account=(_account); end
sig {
params(account: T.nilable(::Stripe::AccountPersonService::UpdateParams::AdditionalTosAcceptances::Account)).void
}
def initialize(account: nil); end
end
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Documents < Stripe::RequestParams
class CompanyAuthorization < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class Passport < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class Visa < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
# One or more documents that demonstrate proof that this person is authorized to represent the company.
sig {
returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Documents::CompanyAuthorization))
}
def company_authorization; end
sig {
params(_company_authorization: T.nilable(::Stripe::AccountPersonService::UpdateParams::Documents::CompanyAuthorization)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Documents::CompanyAuthorization))
}
def company_authorization=(_company_authorization); end
# One or more documents showing the person's passport page with photo and personal data.
sig {
returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Documents::Passport))
}
def passport; end
sig {
params(_passport: T.nilable(::Stripe::AccountPersonService::UpdateParams::Documents::Passport)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Documents::Passport))
}
def passport=(_passport); end
# One or more documents showing the person's visa required for living in the country where they are residing.
sig { returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Documents::Visa)) }
def visa; end
sig {
params(_visa: T.nilable(::Stripe::AccountPersonService::UpdateParams::Documents::Visa)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Documents::Visa))
}
def visa=(_visa); end
sig {
params(company_authorization: T.nilable(::Stripe::AccountPersonService::UpdateParams::Documents::CompanyAuthorization), passport: T.nilable(::Stripe::AccountPersonService::UpdateParams::Documents::Passport), visa: T.nilable(::Stripe::AccountPersonService::UpdateParams::Documents::Visa)).void
}
def initialize(company_authorization: nil, passport: nil, visa: nil); end
end
class RegisteredAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Relationship < Stripe::RequestParams
# Whether the person is the authorizer of the account's representative.
sig { returns(T.nilable(T::Boolean)) }
def authorizer; end
sig { params(_authorizer: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def authorizer=(_authorizer); end
# Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
sig { returns(T.nilable(T::Boolean)) }
def director; end
sig { params(_director: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def director=(_director); end
# Whether the person has significant responsibility to control, manage, or direct the organization.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
sig { params(_executive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executive=(_executive); end
# Whether the person is the legal guardian of the account's representative.
sig { returns(T.nilable(T::Boolean)) }
def legal_guardian; end
sig { params(_legal_guardian: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def legal_guardian=(_legal_guardian); end
# Whether the person is an owner of the account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
sig { params(_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owner=(_owner); end
# The percent owned by the person of the account's legal entity.
sig { returns(T.nilable(T.any(String, Float))) }
def percent_ownership; end
sig {
params(_percent_ownership: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def percent_ownership=(_percent_ownership); end
# Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
sig { returns(T.nilable(T::Boolean)) }
def representative; end
sig { params(_representative: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def representative=(_representative); end
# The person's title (e.g., CEO, Support Engineer).
sig { returns(T.nilable(String)) }
def title; end
sig { params(_title: T.nilable(String)).returns(T.nilable(String)) }
def title=(_title); end
sig {
params(authorizer: T.nilable(T::Boolean), director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), legal_guardian: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), percent_ownership: T.nilable(T.any(String, Float)), representative: T.nilable(T::Boolean), title: T.nilable(String)).void
}
def initialize(
authorizer: nil,
director: nil,
executive: nil,
legal_guardian: nil,
owner: nil,
percent_ownership: nil,
representative: nil,
title: nil
); end
end
class UsCfpbData < Stripe::RequestParams
class EthnicityDetails < Stripe::RequestParams
# The persons ethnicity
sig { returns(T.nilable(T::Array[String])) }
def ethnicity; end
sig {
params(_ethnicity: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def ethnicity=(_ethnicity); end
# Please specify your origin, when other is selected.
sig { returns(T.nilable(String)) }
def ethnicity_other; end
sig { params(_ethnicity_other: T.nilable(String)).returns(T.nilable(String)) }
def ethnicity_other=(_ethnicity_other); end
sig {
params(ethnicity: T.nilable(T::Array[String]), ethnicity_other: T.nilable(String)).void
}
def initialize(ethnicity: nil, ethnicity_other: nil); end
end
class RaceDetails < Stripe::RequestParams
# The persons race.
sig { returns(T.nilable(T::Array[String])) }
def race; end
sig { params(_race: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def race=(_race); end
# Please specify your race, when other is selected.
sig { returns(T.nilable(String)) }
def race_other; end
sig { params(_race_other: T.nilable(String)).returns(T.nilable(String)) }
def race_other=(_race_other); end
sig { params(race: T.nilable(T::Array[String]), race_other: T.nilable(String)).void }
def initialize(race: nil, race_other: nil); end
end
# The persons ethnicity details
sig {
returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::UsCfpbData::EthnicityDetails))
}
def ethnicity_details; end
sig {
params(_ethnicity_details: T.nilable(::Stripe::AccountPersonService::UpdateParams::UsCfpbData::EthnicityDetails)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::UsCfpbData::EthnicityDetails))
}
def ethnicity_details=(_ethnicity_details); end
# The persons race details
sig {
returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::UsCfpbData::RaceDetails))
}
def race_details; end
sig {
params(_race_details: T.nilable(::Stripe::AccountPersonService::UpdateParams::UsCfpbData::RaceDetails)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::UsCfpbData::RaceDetails))
}
def race_details=(_race_details); end
# The persons self-identified gender
sig { returns(T.nilable(String)) }
def self_identified_gender; end
sig { params(_self_identified_gender: T.nilable(String)).returns(T.nilable(String)) }
def self_identified_gender=(_self_identified_gender); end
sig {
params(ethnicity_details: T.nilable(::Stripe::AccountPersonService::UpdateParams::UsCfpbData::EthnicityDetails), race_details: T.nilable(::Stripe::AccountPersonService::UpdateParams::UsCfpbData::RaceDetails), self_identified_gender: T.nilable(String)).void
}
def initialize(ethnicity_details: nil, race_details: nil, self_identified_gender: nil); end
end
class Verification < Stripe::RequestParams
class AdditionalDocument < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
class Document < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig {
returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Verification::AdditionalDocument))
}
def additional_document; end
sig {
params(_additional_document: T.nilable(::Stripe::AccountPersonService::UpdateParams::Verification::AdditionalDocument)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Verification::AdditionalDocument))
}
def additional_document=(_additional_document); end
# An identifying document, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::AccountPersonService::UpdateParams::Verification::Document)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Verification::Document))
}
def document=(_document); end
sig {
params(additional_document: T.nilable(::Stripe::AccountPersonService::UpdateParams::Verification::AdditionalDocument), document: T.nilable(::Stripe::AccountPersonService::UpdateParams::Verification::Document)).void
}
def initialize(additional_document: nil, document: nil); end
end
# Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.
sig {
returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::AdditionalTosAcceptances))
}
def additional_tos_acceptances; end
sig {
params(_additional_tos_acceptances: T.nilable(::Stripe::AccountPersonService::UpdateParams::AdditionalTosAcceptances)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::AdditionalTosAcceptances))
}
def additional_tos_acceptances=(_additional_tos_acceptances); end
# The person's address.
sig { returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::AccountPersonService::UpdateParams::Address)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Address))
}
def address=(_address); end
# The Kana variation of the person's address (Japan only).
sig { returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::AccountPersonService::UpdateParams::AddressKana)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the person's address (Japan only).
sig { returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::AccountPersonService::UpdateParams::AddressKanji)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::AddressKanji))
}
def address_kanji=(_address_kanji); end
# The person's date of birth.
sig { returns(T.nilable(T.any(String, ::Stripe::AccountPersonService::UpdateParams::Dob))) }
def dob; end
sig {
params(_dob: T.nilable(T.any(String, ::Stripe::AccountPersonService::UpdateParams::Dob))).returns(T.nilable(T.any(String, ::Stripe::AccountPersonService::UpdateParams::Dob)))
}
def dob=(_dob); end
# Documents that may be submitted to satisfy various informational requests.
sig { returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Documents)) }
def documents; end
sig {
params(_documents: T.nilable(::Stripe::AccountPersonService::UpdateParams::Documents)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Documents))
}
def documents=(_documents); end
# The person's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The person's first name.
sig { returns(T.nilable(String)) }
def first_name; end
sig { params(_first_name: T.nilable(String)).returns(T.nilable(String)) }
def first_name=(_first_name); end
# The Kana variation of the person's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kana; end
sig { params(_first_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kana=(_first_name_kana); end
# The Kanji variation of the person's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kanji; end
sig { params(_first_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kanji=(_first_name_kanji); end
# A list of alternate names or aliases that the person is known by.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def full_name_aliases; end
sig {
params(_full_name_aliases: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def full_name_aliases=(_full_name_aliases); end
# The person's gender (International regulations require either "male" or "female").
sig { returns(T.nilable(String)) }
def gender; end
sig { params(_gender: T.nilable(String)).returns(T.nilable(String)) }
def gender=(_gender); end
# The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number; end
sig { params(_id_number: T.nilable(String)).returns(T.nilable(String)) }
def id_number=(_id_number); end
# The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number_secondary; end
sig { params(_id_number_secondary: T.nilable(String)).returns(T.nilable(String)) }
def id_number_secondary=(_id_number_secondary); end
# The person's last name.
sig { returns(T.nilable(String)) }
def last_name; end
sig { params(_last_name: T.nilable(String)).returns(T.nilable(String)) }
def last_name=(_last_name); end
# The Kana variation of the person's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kana; end
sig { params(_last_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kana=(_last_name_kana); end
# The Kanji variation of the person's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kanji; end
sig { params(_last_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kanji=(_last_name_kanji); end
# The person's maiden name.
sig { returns(T.nilable(String)) }
def maiden_name; end
sig { params(_maiden_name: T.nilable(String)).returns(T.nilable(String)) }
def maiden_name=(_maiden_name); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable.
sig { returns(T.nilable(String)) }
def nationality; end
sig { params(_nationality: T.nilable(String)).returns(T.nilable(String)) }
def nationality=(_nationality); end
# A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.
sig { returns(T.nilable(String)) }
def person_token; end
sig { params(_person_token: T.nilable(String)).returns(T.nilable(String)) }
def person_token=(_person_token); end
# The person's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
sig { returns(T.nilable(String)) }
def political_exposure; end
sig { params(_political_exposure: T.nilable(String)).returns(T.nilable(String)) }
def political_exposure=(_political_exposure); end
# The person's registered address.
sig { returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::RegisteredAddress)) }
def registered_address; end
sig {
params(_registered_address: T.nilable(::Stripe::AccountPersonService::UpdateParams::RegisteredAddress)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::RegisteredAddress))
}
def registered_address=(_registered_address); end
# The relationship that this person has with the account's legal entity.
sig { returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Relationship)) }
def relationship; end
sig {
params(_relationship: T.nilable(::Stripe::AccountPersonService::UpdateParams::Relationship)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Relationship))
}
def relationship=(_relationship); end
# The last four digits of the person's Social Security number (U.S. only).
sig { returns(T.nilable(String)) }
def ssn_last_4; end
sig { params(_ssn_last_4: T.nilable(String)).returns(T.nilable(String)) }
def ssn_last_4=(_ssn_last_4); end
# Demographic data related to the person.
sig { returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::UsCfpbData)) }
def us_cfpb_data; end
sig {
params(_us_cfpb_data: T.nilable(::Stripe::AccountPersonService::UpdateParams::UsCfpbData)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::UsCfpbData))
}
def us_cfpb_data=(_us_cfpb_data); end
# The person's verification status.
sig { returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Verification)) }
def verification; end
sig {
params(_verification: T.nilable(::Stripe::AccountPersonService::UpdateParams::Verification)).returns(T.nilable(::Stripe::AccountPersonService::UpdateParams::Verification))
}
def verification=(_verification); end
sig {
params(additional_tos_acceptances: T.nilable(::Stripe::AccountPersonService::UpdateParams::AdditionalTosAcceptances), address: T.nilable(::Stripe::AccountPersonService::UpdateParams::Address), address_kana: T.nilable(::Stripe::AccountPersonService::UpdateParams::AddressKana), address_kanji: T.nilable(::Stripe::AccountPersonService::UpdateParams::AddressKanji), dob: T.nilable(T.any(String, ::Stripe::AccountPersonService::UpdateParams::Dob)), documents: T.nilable(::Stripe::AccountPersonService::UpdateParams::Documents), email: T.nilable(String), expand: T.nilable(T::Array[String]), first_name: T.nilable(String), first_name_kana: T.nilable(String), first_name_kanji: T.nilable(String), full_name_aliases: T.nilable(T.any(String, T::Array[String])), gender: T.nilable(String), id_number: T.nilable(String), id_number_secondary: T.nilable(String), last_name: T.nilable(String), last_name_kana: T.nilable(String), last_name_kanji: T.nilable(String), maiden_name: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), nationality: T.nilable(String), person_token: T.nilable(String), phone: T.nilable(String), political_exposure: T.nilable(String), registered_address: T.nilable(::Stripe::AccountPersonService::UpdateParams::RegisteredAddress), relationship: T.nilable(::Stripe::AccountPersonService::UpdateParams::Relationship), ssn_last_4: T.nilable(String), us_cfpb_data: T.nilable(::Stripe::AccountPersonService::UpdateParams::UsCfpbData), verification: T.nilable(::Stripe::AccountPersonService::UpdateParams::Verification)).void
}
def initialize(
additional_tos_acceptances: nil,
address: nil,
address_kana: nil,
address_kanji: nil,
dob: nil,
documents: nil,
email: nil,
expand: nil,
first_name: nil,
first_name_kana: nil,
first_name_kanji: nil,
full_name_aliases: nil,
gender: nil,
id_number: nil,
id_number_secondary: nil,
last_name: nil,
last_name_kana: nil,
last_name_kanji: nil,
maiden_name: nil,
metadata: nil,
nationality: nil,
person_token: nil,
phone: nil,
political_exposure: nil,
registered_address: nil,
relationship: nil,
ssn_last_4: nil,
us_cfpb_data: nil,
verification: nil
); end
end
class ListParams < Stripe::RequestParams
class Relationship < Stripe::RequestParams
# A filter on the list of people returned based on whether these people are authorizers of the account's representative.
sig { returns(T.nilable(T::Boolean)) }
def authorizer; end
sig { params(_authorizer: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def authorizer=(_authorizer); end
# A filter on the list of people returned based on whether these people are directors of the account's company.
sig { returns(T.nilable(T::Boolean)) }
def director; end
sig { params(_director: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def director=(_director); end
# A filter on the list of people returned based on whether these people are executives of the account's company.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
sig { params(_executive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executive=(_executive); end
# A filter on the list of people returned based on whether these people are legal guardians of the account's representative.
sig { returns(T.nilable(T::Boolean)) }
def legal_guardian; end
sig { params(_legal_guardian: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def legal_guardian=(_legal_guardian); end
# A filter on the list of people returned based on whether these people are owners of the account's company.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
sig { params(_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owner=(_owner); end
# A filter on the list of people returned based on whether these people are the representative of the account's company.
sig { returns(T.nilable(T::Boolean)) }
def representative; end
sig { params(_representative: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def representative=(_representative); end
sig {
params(authorizer: T.nilable(T::Boolean), director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), legal_guardian: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), representative: T.nilable(T::Boolean)).void
}
def initialize(
authorizer: nil,
director: nil,
executive: nil,
legal_guardian: nil,
owner: nil,
representative: nil
); end
end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Filters on the list of people returned based on the person's relationship to the account's company.
sig { returns(T.nilable(::Stripe::AccountPersonService::ListParams::Relationship)) }
def relationship; end
sig {
params(_relationship: T.nilable(::Stripe::AccountPersonService::ListParams::Relationship)).returns(T.nilable(::Stripe::AccountPersonService::ListParams::Relationship))
}
def relationship=(_relationship); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), relationship: T.nilable(::Stripe::AccountPersonService::ListParams::Relationship), starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
relationship: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class AdditionalTosAcceptances < Stripe::RequestParams
class Account < Stripe::RequestParams
# The Unix timestamp marking when the account representative accepted the service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Details on the legal guardian's acceptance of the main Stripe service agreement.
sig {
returns(T.nilable(::Stripe::AccountPersonService::CreateParams::AdditionalTosAcceptances::Account))
}
def account; end
sig {
params(_account: T.nilable(::Stripe::AccountPersonService::CreateParams::AdditionalTosAcceptances::Account)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::AdditionalTosAcceptances::Account))
}
def account=(_account); end
sig {
params(account: T.nilable(::Stripe::AccountPersonService::CreateParams::AdditionalTosAcceptances::Account)).void
}
def initialize(account: nil); end
end
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Documents < Stripe::RequestParams
class CompanyAuthorization < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class Passport < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class Visa < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
# One or more documents that demonstrate proof that this person is authorized to represent the company.
sig {
returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Documents::CompanyAuthorization))
}
def company_authorization; end
sig {
params(_company_authorization: T.nilable(::Stripe::AccountPersonService::CreateParams::Documents::CompanyAuthorization)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Documents::CompanyAuthorization))
}
def company_authorization=(_company_authorization); end
# One or more documents showing the person's passport page with photo and personal data.
sig {
returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Documents::Passport))
}
def passport; end
sig {
params(_passport: T.nilable(::Stripe::AccountPersonService::CreateParams::Documents::Passport)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Documents::Passport))
}
def passport=(_passport); end
# One or more documents showing the person's visa required for living in the country where they are residing.
sig { returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Documents::Visa)) }
def visa; end
sig {
params(_visa: T.nilable(::Stripe::AccountPersonService::CreateParams::Documents::Visa)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Documents::Visa))
}
def visa=(_visa); end
sig {
params(company_authorization: T.nilable(::Stripe::AccountPersonService::CreateParams::Documents::CompanyAuthorization), passport: T.nilable(::Stripe::AccountPersonService::CreateParams::Documents::Passport), visa: T.nilable(::Stripe::AccountPersonService::CreateParams::Documents::Visa)).void
}
def initialize(company_authorization: nil, passport: nil, visa: nil); end
end
class RegisteredAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Relationship < Stripe::RequestParams
# Whether the person is the authorizer of the account's representative.
sig { returns(T.nilable(T::Boolean)) }
def authorizer; end
sig { params(_authorizer: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def authorizer=(_authorizer); end
# Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
sig { returns(T.nilable(T::Boolean)) }
def director; end
sig { params(_director: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def director=(_director); end
# Whether the person has significant responsibility to control, manage, or direct the organization.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
sig { params(_executive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executive=(_executive); end
# Whether the person is the legal guardian of the account's representative.
sig { returns(T.nilable(T::Boolean)) }
def legal_guardian; end
sig { params(_legal_guardian: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def legal_guardian=(_legal_guardian); end
# Whether the person is an owner of the account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
sig { params(_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owner=(_owner); end
# The percent owned by the person of the account's legal entity.
sig { returns(T.nilable(T.any(String, Float))) }
def percent_ownership; end
sig {
params(_percent_ownership: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def percent_ownership=(_percent_ownership); end
# Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
sig { returns(T.nilable(T::Boolean)) }
def representative; end
sig { params(_representative: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def representative=(_representative); end
# The person's title (e.g., CEO, Support Engineer).
sig { returns(T.nilable(String)) }
def title; end
sig { params(_title: T.nilable(String)).returns(T.nilable(String)) }
def title=(_title); end
sig {
params(authorizer: T.nilable(T::Boolean), director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), legal_guardian: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), percent_ownership: T.nilable(T.any(String, Float)), representative: T.nilable(T::Boolean), title: T.nilable(String)).void
}
def initialize(
authorizer: nil,
director: nil,
executive: nil,
legal_guardian: nil,
owner: nil,
percent_ownership: nil,
representative: nil,
title: nil
); end
end
class UsCfpbData < Stripe::RequestParams
class EthnicityDetails < Stripe::RequestParams
# The persons ethnicity
sig { returns(T.nilable(T::Array[String])) }
def ethnicity; end
sig {
params(_ethnicity: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def ethnicity=(_ethnicity); end
# Please specify your origin, when other is selected.
sig { returns(T.nilable(String)) }
def ethnicity_other; end
sig { params(_ethnicity_other: T.nilable(String)).returns(T.nilable(String)) }
def ethnicity_other=(_ethnicity_other); end
sig {
params(ethnicity: T.nilable(T::Array[String]), ethnicity_other: T.nilable(String)).void
}
def initialize(ethnicity: nil, ethnicity_other: nil); end
end
class RaceDetails < Stripe::RequestParams
# The persons race.
sig { returns(T.nilable(T::Array[String])) }
def race; end
sig { params(_race: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def race=(_race); end
# Please specify your race, when other is selected.
sig { returns(T.nilable(String)) }
def race_other; end
sig { params(_race_other: T.nilable(String)).returns(T.nilable(String)) }
def race_other=(_race_other); end
sig { params(race: T.nilable(T::Array[String]), race_other: T.nilable(String)).void }
def initialize(race: nil, race_other: nil); end
end
# The persons ethnicity details
sig {
returns(T.nilable(::Stripe::AccountPersonService::CreateParams::UsCfpbData::EthnicityDetails))
}
def ethnicity_details; end
sig {
params(_ethnicity_details: T.nilable(::Stripe::AccountPersonService::CreateParams::UsCfpbData::EthnicityDetails)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::UsCfpbData::EthnicityDetails))
}
def ethnicity_details=(_ethnicity_details); end
# The persons race details
sig {
returns(T.nilable(::Stripe::AccountPersonService::CreateParams::UsCfpbData::RaceDetails))
}
def race_details; end
sig {
params(_race_details: T.nilable(::Stripe::AccountPersonService::CreateParams::UsCfpbData::RaceDetails)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::UsCfpbData::RaceDetails))
}
def race_details=(_race_details); end
# The persons self-identified gender
sig { returns(T.nilable(String)) }
def self_identified_gender; end
sig { params(_self_identified_gender: T.nilable(String)).returns(T.nilable(String)) }
def self_identified_gender=(_self_identified_gender); end
sig {
params(ethnicity_details: T.nilable(::Stripe::AccountPersonService::CreateParams::UsCfpbData::EthnicityDetails), race_details: T.nilable(::Stripe::AccountPersonService::CreateParams::UsCfpbData::RaceDetails), self_identified_gender: T.nilable(String)).void
}
def initialize(ethnicity_details: nil, race_details: nil, self_identified_gender: nil); end
end
class Verification < Stripe::RequestParams
class AdditionalDocument < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
class Document < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig {
returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Verification::AdditionalDocument))
}
def additional_document; end
sig {
params(_additional_document: T.nilable(::Stripe::AccountPersonService::CreateParams::Verification::AdditionalDocument)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Verification::AdditionalDocument))
}
def additional_document=(_additional_document); end
# An identifying document, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::AccountPersonService::CreateParams::Verification::Document)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Verification::Document))
}
def document=(_document); end
sig {
params(additional_document: T.nilable(::Stripe::AccountPersonService::CreateParams::Verification::AdditionalDocument), document: T.nilable(::Stripe::AccountPersonService::CreateParams::Verification::Document)).void
}
def initialize(additional_document: nil, document: nil); end
end
# Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.
sig {
returns(T.nilable(::Stripe::AccountPersonService::CreateParams::AdditionalTosAcceptances))
}
def additional_tos_acceptances; end
sig {
params(_additional_tos_acceptances: T.nilable(::Stripe::AccountPersonService::CreateParams::AdditionalTosAcceptances)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::AdditionalTosAcceptances))
}
def additional_tos_acceptances=(_additional_tos_acceptances); end
# The person's address.
sig { returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::AccountPersonService::CreateParams::Address)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Address))
}
def address=(_address); end
# The Kana variation of the person's address (Japan only).
sig { returns(T.nilable(::Stripe::AccountPersonService::CreateParams::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::AccountPersonService::CreateParams::AddressKana)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the person's address (Japan only).
sig { returns(T.nilable(::Stripe::AccountPersonService::CreateParams::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::AccountPersonService::CreateParams::AddressKanji)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::AddressKanji))
}
def address_kanji=(_address_kanji); end
# The person's date of birth.
sig { returns(T.nilable(T.any(String, ::Stripe::AccountPersonService::CreateParams::Dob))) }
def dob; end
sig {
params(_dob: T.nilable(T.any(String, ::Stripe::AccountPersonService::CreateParams::Dob))).returns(T.nilable(T.any(String, ::Stripe::AccountPersonService::CreateParams::Dob)))
}
def dob=(_dob); end
# Documents that may be submitted to satisfy various informational requests.
sig { returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Documents)) }
def documents; end
sig {
params(_documents: T.nilable(::Stripe::AccountPersonService::CreateParams::Documents)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Documents))
}
def documents=(_documents); end
# The person's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The person's first name.
sig { returns(T.nilable(String)) }
def first_name; end
sig { params(_first_name: T.nilable(String)).returns(T.nilable(String)) }
def first_name=(_first_name); end
# The Kana variation of the person's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kana; end
sig { params(_first_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kana=(_first_name_kana); end
# The Kanji variation of the person's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kanji; end
sig { params(_first_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kanji=(_first_name_kanji); end
# A list of alternate names or aliases that the person is known by.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def full_name_aliases; end
sig {
params(_full_name_aliases: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def full_name_aliases=(_full_name_aliases); end
# The person's gender (International regulations require either "male" or "female").
sig { returns(T.nilable(String)) }
def gender; end
sig { params(_gender: T.nilable(String)).returns(T.nilable(String)) }
def gender=(_gender); end
# The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number; end
sig { params(_id_number: T.nilable(String)).returns(T.nilable(String)) }
def id_number=(_id_number); end
# The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number_secondary; end
sig { params(_id_number_secondary: T.nilable(String)).returns(T.nilable(String)) }
def id_number_secondary=(_id_number_secondary); end
# The person's last name.
sig { returns(T.nilable(String)) }
def last_name; end
sig { params(_last_name: T.nilable(String)).returns(T.nilable(String)) }
def last_name=(_last_name); end
# The Kana variation of the person's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kana; end
sig { params(_last_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kana=(_last_name_kana); end
# The Kanji variation of the person's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kanji; end
sig { params(_last_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kanji=(_last_name_kanji); end
# The person's maiden name.
sig { returns(T.nilable(String)) }
def maiden_name; end
sig { params(_maiden_name: T.nilable(String)).returns(T.nilable(String)) }
def maiden_name=(_maiden_name); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable.
sig { returns(T.nilable(String)) }
def nationality; end
sig { params(_nationality: T.nilable(String)).returns(T.nilable(String)) }
def nationality=(_nationality); end
# A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.
sig { returns(T.nilable(String)) }
def person_token; end
sig { params(_person_token: T.nilable(String)).returns(T.nilable(String)) }
def person_token=(_person_token); end
# The person's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
sig { returns(T.nilable(String)) }
def political_exposure; end
sig { params(_political_exposure: T.nilable(String)).returns(T.nilable(String)) }
def political_exposure=(_political_exposure); end
# The person's registered address.
sig { returns(T.nilable(::Stripe::AccountPersonService::CreateParams::RegisteredAddress)) }
def registered_address; end
sig {
params(_registered_address: T.nilable(::Stripe::AccountPersonService::CreateParams::RegisteredAddress)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::RegisteredAddress))
}
def registered_address=(_registered_address); end
# The relationship that this person has with the account's legal entity.
sig { returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Relationship)) }
def relationship; end
sig {
params(_relationship: T.nilable(::Stripe::AccountPersonService::CreateParams::Relationship)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Relationship))
}
def relationship=(_relationship); end
# The last four digits of the person's Social Security number (U.S. only).
sig { returns(T.nilable(String)) }
def ssn_last_4; end
sig { params(_ssn_last_4: T.nilable(String)).returns(T.nilable(String)) }
def ssn_last_4=(_ssn_last_4); end
# Demographic data related to the person.
sig { returns(T.nilable(::Stripe::AccountPersonService::CreateParams::UsCfpbData)) }
def us_cfpb_data; end
sig {
params(_us_cfpb_data: T.nilable(::Stripe::AccountPersonService::CreateParams::UsCfpbData)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::UsCfpbData))
}
def us_cfpb_data=(_us_cfpb_data); end
# The person's verification status.
sig { returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Verification)) }
def verification; end
sig {
params(_verification: T.nilable(::Stripe::AccountPersonService::CreateParams::Verification)).returns(T.nilable(::Stripe::AccountPersonService::CreateParams::Verification))
}
def verification=(_verification); end
sig {
params(additional_tos_acceptances: T.nilable(::Stripe::AccountPersonService::CreateParams::AdditionalTosAcceptances), address: T.nilable(::Stripe::AccountPersonService::CreateParams::Address), address_kana: T.nilable(::Stripe::AccountPersonService::CreateParams::AddressKana), address_kanji: T.nilable(::Stripe::AccountPersonService::CreateParams::AddressKanji), dob: T.nilable(T.any(String, ::Stripe::AccountPersonService::CreateParams::Dob)), documents: T.nilable(::Stripe::AccountPersonService::CreateParams::Documents), email: T.nilable(String), expand: T.nilable(T::Array[String]), first_name: T.nilable(String), first_name_kana: T.nilable(String), first_name_kanji: T.nilable(String), full_name_aliases: T.nilable(T.any(String, T::Array[String])), gender: T.nilable(String), id_number: T.nilable(String), id_number_secondary: T.nilable(String), last_name: T.nilable(String), last_name_kana: T.nilable(String), last_name_kanji: T.nilable(String), maiden_name: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), nationality: T.nilable(String), person_token: T.nilable(String), phone: T.nilable(String), political_exposure: T.nilable(String), registered_address: T.nilable(::Stripe::AccountPersonService::CreateParams::RegisteredAddress), relationship: T.nilable(::Stripe::AccountPersonService::CreateParams::Relationship), ssn_last_4: T.nilable(String), us_cfpb_data: T.nilable(::Stripe::AccountPersonService::CreateParams::UsCfpbData), verification: T.nilable(::Stripe::AccountPersonService::CreateParams::Verification)).void
}
def initialize(
additional_tos_acceptances: nil,
address: nil,
address_kana: nil,
address_kanji: nil,
dob: nil,
documents: nil,
email: nil,
expand: nil,
first_name: nil,
first_name_kana: nil,
first_name_kanji: nil,
full_name_aliases: nil,
gender: nil,
id_number: nil,
id_number_secondary: nil,
last_name: nil,
last_name_kana: nil,
last_name_kanji: nil,
maiden_name: nil,
metadata: nil,
nationality: nil,
person_token: nil,
phone: nil,
political_exposure: nil,
registered_address: nil,
relationship: nil,
ssn_last_4: nil,
us_cfpb_data: nil,
verification: nil
); end
end
# Creates a new person.
sig {
params(account: String, params: T.any(::Stripe::AccountPersonService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Person)
}
def create(account, params = {}, opts = {}); end
# Deletes an existing person's relationship to the account's legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
sig {
params(account: String, person: String, params: T.any(::Stripe::AccountPersonService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Person)
}
def delete(account, person, params = {}, opts = {}); end
# Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
sig {
params(account: String, params: T.any(::Stripe::AccountPersonService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(account, params = {}, opts = {}); end
# Retrieves an existing person.
sig {
params(account: String, person: String, params: T.any(::Stripe::AccountPersonService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Person)
}
def retrieve(account, person, params = {}, opts = {}); end
# Updates an existing person.
sig {
params(account: String, person: String, params: T.any(::Stripe::AccountPersonService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Person)
}
def update(account, person, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class AccountLinkService < StripeService
class CreateParams < Stripe::RequestParams
class CollectionOptions < Stripe::RequestParams
# Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify `collection_options`, the default value is `currently_due`.
sig { returns(T.nilable(String)) }
def fields; end
sig { params(_fields: T.nilable(String)).returns(T.nilable(String)) }
def fields=(_fields); end
# Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
sig { returns(T.nilable(String)) }
def future_requirements; end
sig { params(_future_requirements: T.nilable(String)).returns(T.nilable(String)) }
def future_requirements=(_future_requirements); end
sig { params(fields: T.nilable(String), future_requirements: T.nilable(String)).void }
def initialize(fields: nil, future_requirements: nil); end
end
# The identifier of the account to create an account link for.
sig { returns(String) }
def account; end
sig { params(_account: String).returns(String) }
def account=(_account); end
# The collect parameter is deprecated. Use `collection_options` instead.
sig { returns(T.nilable(String)) }
def collect; end
sig { params(_collect: T.nilable(String)).returns(T.nilable(String)) }
def collect=(_collect); end
# Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.
sig { returns(T.nilable(::Stripe::AccountLinkService::CreateParams::CollectionOptions)) }
def collection_options; end
sig {
params(_collection_options: T.nilable(::Stripe::AccountLinkService::CreateParams::CollectionOptions)).returns(T.nilable(::Stripe::AccountLinkService::CreateParams::CollectionOptions))
}
def collection_options=(_collection_options); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user.
sig { returns(T.nilable(String)) }
def refresh_url; end
sig { params(_refresh_url: T.nilable(String)).returns(T.nilable(String)) }
def refresh_url=(_refresh_url); end
# The URL that the user will be redirected to upon leaving or completing the linked flow.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# The type of account link the user is requesting.
#
# You can create Account Links of type `account_update` only for connected accounts where your platform is responsible for collecting requirements, including Custom accounts. You can't create them for accounts that have access to a Stripe-hosted Dashboard. If you use [Connect embedded components](/connect/get-started-connect-embedded-components), you can include components that allow your connected accounts to update their own information. For an account without Stripe-hosted Dashboard access where Stripe is liable for negative balances, you must use embedded components.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(account: String, collect: T.nilable(String), collection_options: T.nilable(::Stripe::AccountLinkService::CreateParams::CollectionOptions), expand: T.nilable(T::Array[String]), refresh_url: T.nilable(String), return_url: T.nilable(String), type: String).void
}
def initialize(
account: nil,
collect: nil,
collection_options: nil,
expand: nil,
refresh_url: nil,
return_url: nil,
type: nil
); end
end
# Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.
sig {
params(params: T.any(::Stripe::AccountLinkService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::AccountLink)
}
def create(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class AccountNoticeService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Set to false to only return unsent AccountNotices.
sig { returns(T.nilable(T::Boolean)) }
def sent; end
sig { params(_sent: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def sent=(_sent); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), sent: T.nilable(T::Boolean), starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
sent: nil,
starting_after: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Email < Stripe::RequestParams
# Content of the email in plain text. The copy must match exactly the language that Stripe Compliance has approved for use.
sig { returns(String) }
def plain_text; end
sig { params(_plain_text: String).returns(String) }
def plain_text=(_plain_text); end
# Email address of the recipient.
sig { returns(String) }
def recipient; end
sig { params(_recipient: String).returns(String) }
def recipient=(_recipient); end
# Subject of the email.
sig { returns(String) }
def subject; end
sig { params(_subject: String).returns(String) }
def subject=(_subject); end
sig { params(plain_text: String, recipient: String, subject: String).void }
def initialize(plain_text: nil, recipient: nil, subject: nil); end
end
# Information about the email you sent.
sig { returns(::Stripe::AccountNoticeService::UpdateParams::Email) }
def email; end
sig {
params(_email: ::Stripe::AccountNoticeService::UpdateParams::Email).returns(::Stripe::AccountNoticeService::UpdateParams::Email)
}
def email=(_email); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Date when you sent the notice.
sig { returns(Integer) }
def sent_at; end
sig { params(_sent_at: Integer).returns(Integer) }
def sent_at=(_sent_at); end
sig {
params(email: ::Stripe::AccountNoticeService::UpdateParams::Email, expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), sent_at: Integer).void
}
def initialize(email: nil, expand: nil, metadata: nil, sent_at: nil); end
end
# Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
sig {
params(params: T.any(::Stripe::AccountNoticeService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves an AccountNotice object.
sig {
params(account_notice: String, params: T.any(::Stripe::AccountNoticeService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::AccountNotice)
}
def retrieve(account_notice, params = {}, opts = {}); end
# Updates an AccountNotice object.
sig {
params(account_notice: String, params: T.any(::Stripe::AccountNoticeService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::AccountNotice)
}
def update(account_notice, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class AccountSessionService < StripeService
class CreateParams < Stripe::RequestParams
class Components < Stripe::RequestParams
class AccountManagement < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def disable_stripe_user_authentication; end
sig {
params(_disable_stripe_user_authentication: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def disable_stripe_user_authentication=(_disable_stripe_user_authentication); end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T.nilable(T::Boolean)) }
def external_account_collection; end
sig {
params(_external_account_collection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def external_account_collection=(_external_account_collection); end
sig {
params(disable_stripe_user_authentication: T.nilable(T::Boolean), external_account_collection: T.nilable(T::Boolean)).void
}
def initialize(
disable_stripe_user_authentication: nil,
external_account_collection: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountManagement::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountManagement::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountManagement::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountManagement::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class AccountOnboarding < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def disable_stripe_user_authentication; end
sig {
params(_disable_stripe_user_authentication: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def disable_stripe_user_authentication=(_disable_stripe_user_authentication); end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T.nilable(T::Boolean)) }
def external_account_collection; end
sig {
params(_external_account_collection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def external_account_collection=(_external_account_collection); end
sig {
params(disable_stripe_user_authentication: T.nilable(T::Boolean), external_account_collection: T.nilable(T::Boolean)).void
}
def initialize(
disable_stripe_user_authentication: nil,
external_account_collection: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountOnboarding::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountOnboarding::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountOnboarding::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountOnboarding::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class AppInstall < Stripe::RequestParams
class Features < Stripe::RequestParams
# The list of apps allowed to be enabled in the embedded component.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def allowed_apps; end
sig {
params(_allowed_apps: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def allowed_apps=(_allowed_apps); end
sig { params(allowed_apps: T.nilable(T.any(String, T::Array[String]))).void }
def initialize(allowed_apps: nil); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AppInstall::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AppInstall::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AppInstall::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AppInstall::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class AppViewport < Stripe::RequestParams
class Features < Stripe::RequestParams
# The list of apps allowed to be enabled in the embedded component.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def allowed_apps; end
sig {
params(_allowed_apps: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def allowed_apps=(_allowed_apps); end
sig { params(allowed_apps: T.nilable(T.any(String, T::Array[String]))).void }
def initialize(allowed_apps: nil); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AppViewport::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AppViewport::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AppViewport::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AppViewport::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class BalanceReport < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::BalanceReport::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::BalanceReport::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::BalanceReport::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::BalanceReport::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class Balances < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def disable_stripe_user_authentication; end
sig {
params(_disable_stripe_user_authentication: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def disable_stripe_user_authentication=(_disable_stripe_user_authentication); end
# Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T.nilable(T::Boolean)) }
def edit_payout_schedule; end
sig {
params(_edit_payout_schedule: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def edit_payout_schedule=(_edit_payout_schedule); end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T.nilable(T::Boolean)) }
def external_account_collection; end
sig {
params(_external_account_collection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def external_account_collection=(_external_account_collection); end
# Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T.nilable(T::Boolean)) }
def instant_payouts; end
sig { params(_instant_payouts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def instant_payouts=(_instant_payouts); end
# Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T.nilable(T::Boolean)) }
def standard_payouts; end
sig { params(_standard_payouts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def standard_payouts=(_standard_payouts); end
sig {
params(disable_stripe_user_authentication: T.nilable(T::Boolean), edit_payout_schedule: T.nilable(T::Boolean), external_account_collection: T.nilable(T::Boolean), instant_payouts: T.nilable(T::Boolean), standard_payouts: T.nilable(T::Boolean)).void
}
def initialize(
disable_stripe_user_authentication: nil,
edit_payout_schedule: nil,
external_account_collection: nil,
instant_payouts: nil,
standard_payouts: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Balances::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Balances::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Balances::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Balances::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class CapitalFinancing < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancing::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancing::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancing::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancing::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class CapitalFinancingApplication < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancingApplication::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancingApplication::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancingApplication::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancingApplication::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class CapitalFinancingPromotion < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancingPromotion::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancingPromotion::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancingPromotion::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancingPromotion::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class CapitalOverview < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalOverview::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalOverview::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalOverview::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalOverview::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class DisputesList < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether to allow capturing and cancelling payment intents. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def capture_payments; end
sig { params(_capture_payments: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def capture_payments=(_capture_payments); end
# Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
sig { returns(T.nilable(T::Boolean)) }
def destination_on_behalf_of_charge_management; end
sig {
params(_destination_on_behalf_of_charge_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def destination_on_behalf_of_charge_management=(
_destination_on_behalf_of_charge_management
); end
# Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def dispute_management; end
sig {
params(_dispute_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def dispute_management=(_dispute_management); end
# Whether sending refunds is enabled. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def refund_management; end
sig { params(_refund_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refund_management=(_refund_management); end
sig {
params(capture_payments: T.nilable(T::Boolean), destination_on_behalf_of_charge_management: T.nilable(T::Boolean), dispute_management: T.nilable(T::Boolean), refund_management: T.nilable(T::Boolean)).void
}
def initialize(
capture_payments: nil,
destination_on_behalf_of_charge_management: nil,
dispute_management: nil,
refund_management: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::DisputesList::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::DisputesList::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::DisputesList::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::DisputesList::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class Documents < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Documents::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Documents::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Documents::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Documents::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class ExportTaxTransactions < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ExportTaxTransactions::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ExportTaxTransactions::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ExportTaxTransactions::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ExportTaxTransactions::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class FinancialAccount < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def disable_stripe_user_authentication; end
sig {
params(_disable_stripe_user_authentication: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def disable_stripe_user_authentication=(_disable_stripe_user_authentication); end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T.nilable(T::Boolean)) }
def external_account_collection; end
sig {
params(_external_account_collection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def external_account_collection=(_external_account_collection); end
# Whether to allow sending money.
sig { returns(T.nilable(T::Boolean)) }
def send_money; end
sig { params(_send_money: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def send_money=(_send_money); end
# Whether to allow transferring balance.
sig { returns(T.nilable(T::Boolean)) }
def transfer_balance; end
sig { params(_transfer_balance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def transfer_balance=(_transfer_balance); end
sig {
params(disable_stripe_user_authentication: T.nilable(T::Boolean), external_account_collection: T.nilable(T::Boolean), send_money: T.nilable(T::Boolean), transfer_balance: T.nilable(T::Boolean)).void
}
def initialize(
disable_stripe_user_authentication: nil,
external_account_collection: nil,
send_money: nil,
transfer_balance: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccount::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccount::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccount::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccount::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class FinancialAccountTransactions < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether to allow card spend dispute management features.
sig { returns(T.nilable(T::Boolean)) }
def card_spend_dispute_management; end
sig {
params(_card_spend_dispute_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def card_spend_dispute_management=(_card_spend_dispute_management); end
sig { params(card_spend_dispute_management: T.nilable(T::Boolean)).void }
def initialize(card_spend_dispute_management: nil); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccountTransactions::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccountTransactions::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccountTransactions::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccountTransactions::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class InstantPayoutsPromotion < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def disable_stripe_user_authentication; end
sig {
params(_disable_stripe_user_authentication: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def disable_stripe_user_authentication=(_disable_stripe_user_authentication); end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T.nilable(T::Boolean)) }
def external_account_collection; end
sig {
params(_external_account_collection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def external_account_collection=(_external_account_collection); end
# Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T.nilable(T::Boolean)) }
def instant_payouts; end
sig { params(_instant_payouts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def instant_payouts=(_instant_payouts); end
sig {
params(disable_stripe_user_authentication: T.nilable(T::Boolean), external_account_collection: T.nilable(T::Boolean), instant_payouts: T.nilable(T::Boolean)).void
}
def initialize(
disable_stripe_user_authentication: nil,
external_account_collection: nil,
instant_payouts: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::InstantPayoutsPromotion::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::InstantPayoutsPromotion::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::InstantPayoutsPromotion::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::InstantPayoutsPromotion::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class IssuingCard < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether to allow card management features.
sig { returns(T.nilable(T::Boolean)) }
def card_management; end
sig { params(_card_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def card_management=(_card_management); end
# Whether to allow card spend dispute management features.
sig { returns(T.nilable(T::Boolean)) }
def card_spend_dispute_management; end
sig {
params(_card_spend_dispute_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def card_spend_dispute_management=(_card_spend_dispute_management); end
# Whether to allow cardholder management features.
sig { returns(T.nilable(T::Boolean)) }
def cardholder_management; end
sig {
params(_cardholder_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def cardholder_management=(_cardholder_management); end
# Whether to allow spend control management features.
sig { returns(T.nilable(T::Boolean)) }
def spend_control_management; end
sig {
params(_spend_control_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def spend_control_management=(_spend_control_management); end
sig {
params(card_management: T.nilable(T::Boolean), card_spend_dispute_management: T.nilable(T::Boolean), cardholder_management: T.nilable(T::Boolean), spend_control_management: T.nilable(T::Boolean)).void
}
def initialize(
card_management: nil,
card_spend_dispute_management: nil,
cardholder_management: nil,
spend_control_management: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCard::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCard::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCard::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCard::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class IssuingCardsList < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether to allow card management features.
sig { returns(T.nilable(T::Boolean)) }
def card_management; end
sig { params(_card_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def card_management=(_card_management); end
# Whether to allow card spend dispute management features.
sig { returns(T.nilable(T::Boolean)) }
def card_spend_dispute_management; end
sig {
params(_card_spend_dispute_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def card_spend_dispute_management=(_card_spend_dispute_management); end
# Whether to allow cardholder management features.
sig { returns(T.nilable(T::Boolean)) }
def cardholder_management; end
sig {
params(_cardholder_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def cardholder_management=(_cardholder_management); end
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def disable_stripe_user_authentication; end
sig {
params(_disable_stripe_user_authentication: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def disable_stripe_user_authentication=(_disable_stripe_user_authentication); end
# Whether to allow spend control management features.
sig { returns(T.nilable(T::Boolean)) }
def spend_control_management; end
sig {
params(_spend_control_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def spend_control_management=(_spend_control_management); end
sig {
params(card_management: T.nilable(T::Boolean), card_spend_dispute_management: T.nilable(T::Boolean), cardholder_management: T.nilable(T::Boolean), disable_stripe_user_authentication: T.nilable(T::Boolean), spend_control_management: T.nilable(T::Boolean)).void
}
def initialize(
card_management: nil,
card_spend_dispute_management: nil,
cardholder_management: nil,
disable_stripe_user_authentication: nil,
spend_control_management: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCardsList::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCardsList::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCardsList::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCardsList::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class NotificationBanner < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def disable_stripe_user_authentication; end
sig {
params(_disable_stripe_user_authentication: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def disable_stripe_user_authentication=(_disable_stripe_user_authentication); end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T.nilable(T::Boolean)) }
def external_account_collection; end
sig {
params(_external_account_collection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def external_account_collection=(_external_account_collection); end
sig {
params(disable_stripe_user_authentication: T.nilable(T::Boolean), external_account_collection: T.nilable(T::Boolean)).void
}
def initialize(
disable_stripe_user_authentication: nil,
external_account_collection: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::NotificationBanner::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::NotificationBanner::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::NotificationBanner::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::NotificationBanner::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class PaymentDetails < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether to allow capturing and cancelling payment intents. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def capture_payments; end
sig { params(_capture_payments: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def capture_payments=(_capture_payments); end
# Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
sig { returns(T.nilable(T::Boolean)) }
def destination_on_behalf_of_charge_management; end
sig {
params(_destination_on_behalf_of_charge_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def destination_on_behalf_of_charge_management=(
_destination_on_behalf_of_charge_management
); end
# Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def dispute_management; end
sig {
params(_dispute_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def dispute_management=(_dispute_management); end
# Whether sending refunds is enabled. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def refund_management; end
sig { params(_refund_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refund_management=(_refund_management); end
sig {
params(capture_payments: T.nilable(T::Boolean), destination_on_behalf_of_charge_management: T.nilable(T::Boolean), dispute_management: T.nilable(T::Boolean), refund_management: T.nilable(T::Boolean)).void
}
def initialize(
capture_payments: nil,
destination_on_behalf_of_charge_management: nil,
dispute_management: nil,
refund_management: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDetails::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDetails::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDetails::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDetails::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class PaymentDisputes < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
sig { returns(T.nilable(T::Boolean)) }
def destination_on_behalf_of_charge_management; end
sig {
params(_destination_on_behalf_of_charge_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def destination_on_behalf_of_charge_management=(
_destination_on_behalf_of_charge_management
); end
# Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def dispute_management; end
sig {
params(_dispute_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def dispute_management=(_dispute_management); end
# Whether sending refunds is enabled. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def refund_management; end
sig { params(_refund_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refund_management=(_refund_management); end
sig {
params(destination_on_behalf_of_charge_management: T.nilable(T::Boolean), dispute_management: T.nilable(T::Boolean), refund_management: T.nilable(T::Boolean)).void
}
def initialize(
destination_on_behalf_of_charge_management: nil,
dispute_management: nil,
refund_management: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDisputes::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDisputes::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDisputes::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDisputes::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class PaymentMethodSettings < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentMethodSettings::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentMethodSettings::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentMethodSettings::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentMethodSettings::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class Payments < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether to allow capturing and cancelling payment intents. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def capture_payments; end
sig { params(_capture_payments: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def capture_payments=(_capture_payments); end
# Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
sig { returns(T.nilable(T::Boolean)) }
def destination_on_behalf_of_charge_management; end
sig {
params(_destination_on_behalf_of_charge_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def destination_on_behalf_of_charge_management=(
_destination_on_behalf_of_charge_management
); end
# Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def dispute_management; end
sig {
params(_dispute_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def dispute_management=(_dispute_management); end
# Whether sending refunds is enabled. This is `true` by default.
sig { returns(T.nilable(T::Boolean)) }
def refund_management; end
sig { params(_refund_management: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refund_management=(_refund_management); end
sig {
params(capture_payments: T.nilable(T::Boolean), destination_on_behalf_of_charge_management: T.nilable(T::Boolean), dispute_management: T.nilable(T::Boolean), refund_management: T.nilable(T::Boolean)).void
}
def initialize(
capture_payments: nil,
destination_on_behalf_of_charge_management: nil,
dispute_management: nil,
refund_management: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payments::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payments::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payments::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payments::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class PayoutDetails < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutDetails::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutDetails::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutDetails::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutDetails::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class PayoutReconciliationReport < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutReconciliationReport::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutReconciliationReport::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutReconciliationReport::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutReconciliationReport::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class Payouts < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def disable_stripe_user_authentication; end
sig {
params(_disable_stripe_user_authentication: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def disable_stripe_user_authentication=(_disable_stripe_user_authentication); end
# Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T.nilable(T::Boolean)) }
def edit_payout_schedule; end
sig {
params(_edit_payout_schedule: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def edit_payout_schedule=(_edit_payout_schedule); end
# Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
sig { returns(T.nilable(T::Boolean)) }
def external_account_collection; end
sig {
params(_external_account_collection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def external_account_collection=(_external_account_collection); end
# Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T.nilable(T::Boolean)) }
def instant_payouts; end
sig { params(_instant_payouts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def instant_payouts=(_instant_payouts); end
# Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
sig { returns(T.nilable(T::Boolean)) }
def standard_payouts; end
sig { params(_standard_payouts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def standard_payouts=(_standard_payouts); end
sig {
params(disable_stripe_user_authentication: T.nilable(T::Boolean), edit_payout_schedule: T.nilable(T::Boolean), external_account_collection: T.nilable(T::Boolean), instant_payouts: T.nilable(T::Boolean), standard_payouts: T.nilable(T::Boolean)).void
}
def initialize(
disable_stripe_user_authentication: nil,
edit_payout_schedule: nil,
external_account_collection: nil,
instant_payouts: nil,
standard_payouts: nil
); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of features enabled in the embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payouts::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payouts::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payouts::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payouts::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class PayoutsList < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutsList::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutsList::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutsList::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutsList::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class ProductTaxCodeSelector < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ProductTaxCodeSelector::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ProductTaxCodeSelector::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ProductTaxCodeSelector::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ProductTaxCodeSelector::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class Recipients < Stripe::RequestParams
class Features < Stripe::RequestParams
# Whether to allow sending money.
sig { returns(T.nilable(T::Boolean)) }
def send_money; end
sig { params(_send_money: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def send_money=(_send_money); end
sig { params(send_money: T.nilable(T::Boolean)).void }
def initialize(send_money: nil); end
end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Attribute for param field features
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Recipients::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Recipients::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Recipients::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Recipients::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class ReportingChart < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ReportingChart::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ReportingChart::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ReportingChart::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ReportingChart::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class TaxRegistrations < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxRegistrations::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxRegistrations::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxRegistrations::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxRegistrations::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class TaxSettings < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxSettings::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxSettings::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxSettings::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxSettings::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
class TaxThresholdMonitoring < Stripe::RequestParams
class Features < Stripe::RequestParams; end
# Whether the embedded component is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# An empty list, because this embedded component has no features.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxThresholdMonitoring::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxThresholdMonitoring::Features)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxThresholdMonitoring::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxThresholdMonitoring::Features)).void
}
def initialize(enabled: nil, features: nil); end
end
# Configuration for the [account management](/connect/supported-embedded-components/account-management/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountManagement))
}
def account_management; end
sig {
params(_account_management: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountManagement)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountManagement))
}
def account_management=(_account_management); end
# Configuration for the [account onboarding](/connect/supported-embedded-components/account-onboarding/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountOnboarding))
}
def account_onboarding; end
sig {
params(_account_onboarding: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountOnboarding)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountOnboarding))
}
def account_onboarding=(_account_onboarding); end
# Configuration for the [app install](/connect/supported-embedded-components/app-install/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AppInstall))
}
def app_install; end
sig {
params(_app_install: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AppInstall)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AppInstall))
}
def app_install=(_app_install); end
# Configuration for the [app viewport](/connect/supported-embedded-components/app-viewport/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AppViewport))
}
def app_viewport; end
sig {
params(_app_viewport: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AppViewport)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AppViewport))
}
def app_viewport=(_app_viewport); end
# Configuration for the [balance report](/connect/supported-embedded-components/financial-reports#balance-report) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::BalanceReport))
}
def balance_report; end
sig {
params(_balance_report: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::BalanceReport)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::BalanceReport))
}
def balance_report=(_balance_report); end
# Configuration for the [balances](/connect/supported-embedded-components/balances/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Balances))
}
def balances; end
sig {
params(_balances: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Balances)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Balances))
}
def balances=(_balances); end
# Configuration for the [Capital financing](/connect/supported-embedded-components/capital-financing/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancing))
}
def capital_financing; end
sig {
params(_capital_financing: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancing)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancing))
}
def capital_financing=(_capital_financing); end
# Configuration for the [Capital financing application](/connect/supported-embedded-components/capital-financing-application/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancingApplication))
}
def capital_financing_application; end
sig {
params(_capital_financing_application: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancingApplication)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancingApplication))
}
def capital_financing_application=(_capital_financing_application); end
# Configuration for the [Capital financing promotion](/connect/supported-embedded-components/capital-financing-promotion/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancingPromotion))
}
def capital_financing_promotion; end
sig {
params(_capital_financing_promotion: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancingPromotion)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancingPromotion))
}
def capital_financing_promotion=(_capital_financing_promotion); end
# Configuration for the [Capital overview](/connect/supported-embedded-components/capital-overview/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalOverview))
}
def capital_overview; end
sig {
params(_capital_overview: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalOverview)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalOverview))
}
def capital_overview=(_capital_overview); end
# Configuration for the [disputes list](/connect/supported-embedded-components/disputes-list/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::DisputesList))
}
def disputes_list; end
sig {
params(_disputes_list: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::DisputesList)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::DisputesList))
}
def disputes_list=(_disputes_list); end
# Configuration for the [documents](/connect/supported-embedded-components/documents/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Documents))
}
def documents; end
sig {
params(_documents: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Documents)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Documents))
}
def documents=(_documents); end
# Configuration for the [export tax transactions](/connect/supported-embedded-components/export-tax-transactions/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ExportTaxTransactions))
}
def export_tax_transactions; end
sig {
params(_export_tax_transactions: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ExportTaxTransactions)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ExportTaxTransactions))
}
def export_tax_transactions=(_export_tax_transactions); end
# Configuration for the [financial account](/connect/supported-embedded-components/financial-account/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccount))
}
def financial_account; end
sig {
params(_financial_account: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccount)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccount))
}
def financial_account=(_financial_account); end
# Configuration for the [financial account transactions](/connect/supported-embedded-components/financial-account-transactions/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccountTransactions))
}
def financial_account_transactions; end
sig {
params(_financial_account_transactions: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccountTransactions)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccountTransactions))
}
def financial_account_transactions=(_financial_account_transactions); end
# Configuration for the [instant payouts promotion](/connect/supported-embedded-components/instant-payouts-promotion/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::InstantPayoutsPromotion))
}
def instant_payouts_promotion; end
sig {
params(_instant_payouts_promotion: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::InstantPayoutsPromotion)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::InstantPayoutsPromotion))
}
def instant_payouts_promotion=(_instant_payouts_promotion); end
# Configuration for the [issuing card](/connect/supported-embedded-components/issuing-card/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCard))
}
def issuing_card; end
sig {
params(_issuing_card: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCard)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCard))
}
def issuing_card=(_issuing_card); end
# Configuration for the [issuing cards list](/connect/supported-embedded-components/issuing-cards-list/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCardsList))
}
def issuing_cards_list; end
sig {
params(_issuing_cards_list: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCardsList)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCardsList))
}
def issuing_cards_list=(_issuing_cards_list); end
# Configuration for the [notification banner](/connect/supported-embedded-components/notification-banner/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::NotificationBanner))
}
def notification_banner; end
sig {
params(_notification_banner: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::NotificationBanner)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::NotificationBanner))
}
def notification_banner=(_notification_banner); end
# Configuration for the [payment details](/connect/supported-embedded-components/payment-details/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDetails))
}
def payment_details; end
sig {
params(_payment_details: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDetails)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDetails))
}
def payment_details=(_payment_details); end
# Configuration for the [payment disputes](/connect/supported-embedded-components/payment-disputes/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDisputes))
}
def payment_disputes; end
sig {
params(_payment_disputes: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDisputes)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDisputes))
}
def payment_disputes=(_payment_disputes); end
# Configuration for the [payment method settings](/connect/supported-embedded-components/payment-method-settings/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentMethodSettings))
}
def payment_method_settings; end
sig {
params(_payment_method_settings: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentMethodSettings)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentMethodSettings))
}
def payment_method_settings=(_payment_method_settings); end
# Configuration for the [payments](/connect/supported-embedded-components/payments/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payments))
}
def payments; end
sig {
params(_payments: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payments)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payments))
}
def payments=(_payments); end
# Configuration for the [payout details](/connect/supported-embedded-components/payout-details/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutDetails))
}
def payout_details; end
sig {
params(_payout_details: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutDetails)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutDetails))
}
def payout_details=(_payout_details); end
# Configuration for the [payout reconciliation report](/connect/supported-embedded-components/financial-reports#payout-reconciliation-report) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutReconciliationReport))
}
def payout_reconciliation_report; end
sig {
params(_payout_reconciliation_report: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutReconciliationReport)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutReconciliationReport))
}
def payout_reconciliation_report=(_payout_reconciliation_report); end
# Configuration for the [payouts](/connect/supported-embedded-components/payouts/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payouts))
}
def payouts; end
sig {
params(_payouts: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payouts)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payouts))
}
def payouts=(_payouts); end
# Configuration for the [payouts list](/connect/supported-embedded-components/payouts-list/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutsList))
}
def payouts_list; end
sig {
params(_payouts_list: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutsList)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutsList))
}
def payouts_list=(_payouts_list); end
# Configuration for the [product tax code selector](/connect/supported-embedded-components/product-tax-code-selector/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ProductTaxCodeSelector))
}
def product_tax_code_selector; end
sig {
params(_product_tax_code_selector: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ProductTaxCodeSelector)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ProductTaxCodeSelector))
}
def product_tax_code_selector=(_product_tax_code_selector); end
# Configuration for the [recipients](/connect/supported-embedded-components/recipients/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Recipients))
}
def recipients; end
sig {
params(_recipients: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Recipients)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Recipients))
}
def recipients=(_recipients); end
# Configuration for the [reporting chart](/connect/supported-embedded-components/reporting-chart/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ReportingChart))
}
def reporting_chart; end
sig {
params(_reporting_chart: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ReportingChart)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ReportingChart))
}
def reporting_chart=(_reporting_chart); end
# Configuration for the [tax registrations](/connect/supported-embedded-components/tax-registrations/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxRegistrations))
}
def tax_registrations; end
sig {
params(_tax_registrations: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxRegistrations)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxRegistrations))
}
def tax_registrations=(_tax_registrations); end
# Configuration for the [tax settings](/connect/supported-embedded-components/tax-settings/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxSettings))
}
def tax_settings; end
sig {
params(_tax_settings: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxSettings)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxSettings))
}
def tax_settings=(_tax_settings); end
# Configuration for the [tax threshold monitoring](/connect/supported-embedded-components/tax-threshold-monitoring/) embedded component.
sig {
returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxThresholdMonitoring))
}
def tax_threshold_monitoring; end
sig {
params(_tax_threshold_monitoring: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxThresholdMonitoring)).returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxThresholdMonitoring))
}
def tax_threshold_monitoring=(_tax_threshold_monitoring); end
sig {
params(account_management: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountManagement), account_onboarding: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountOnboarding), app_install: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AppInstall), app_viewport: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AppViewport), balance_report: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::BalanceReport), balances: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Balances), capital_financing: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancing), capital_financing_application: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancingApplication), capital_financing_promotion: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalFinancingPromotion), capital_overview: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::CapitalOverview), disputes_list: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::DisputesList), documents: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Documents), export_tax_transactions: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ExportTaxTransactions), financial_account: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccount), financial_account_transactions: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccountTransactions), instant_payouts_promotion: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::InstantPayoutsPromotion), issuing_card: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCard), issuing_cards_list: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCardsList), notification_banner: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::NotificationBanner), payment_details: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDetails), payment_disputes: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDisputes), payment_method_settings: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentMethodSettings), payments: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payments), payout_details: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutDetails), payout_reconciliation_report: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutReconciliationReport), payouts: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payouts), payouts_list: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutsList), product_tax_code_selector: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ProductTaxCodeSelector), recipients: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Recipients), reporting_chart: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::ReportingChart), tax_registrations: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxRegistrations), tax_settings: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxSettings), tax_threshold_monitoring: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxThresholdMonitoring)).void
}
def initialize(
account_management: nil,
account_onboarding: nil,
app_install: nil,
app_viewport: nil,
balance_report: nil,
balances: nil,
capital_financing: nil,
capital_financing_application: nil,
capital_financing_promotion: nil,
capital_overview: nil,
disputes_list: nil,
documents: nil,
export_tax_transactions: nil,
financial_account: nil,
financial_account_transactions: nil,
instant_payouts_promotion: nil,
issuing_card: nil,
issuing_cards_list: nil,
notification_banner: nil,
payment_details: nil,
payment_disputes: nil,
payment_method_settings: nil,
payments: nil,
payout_details: nil,
payout_reconciliation_report: nil,
payouts: nil,
payouts_list: nil,
product_tax_code_selector: nil,
recipients: nil,
reporting_chart: nil,
tax_registrations: nil,
tax_settings: nil,
tax_threshold_monitoring: nil
); end
end
# The identifier of the account to create an Account Session for.
sig { returns(String) }
def account; end
sig { params(_account: String).returns(String) }
def account=(_account); end
# Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).
sig { returns(::Stripe::AccountSessionService::CreateParams::Components) }
def components; end
sig {
params(_components: ::Stripe::AccountSessionService::CreateParams::Components).returns(::Stripe::AccountSessionService::CreateParams::Components)
}
def components=(_components); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(account: String, components: ::Stripe::AccountSessionService::CreateParams::Components, expand: T.nilable(T::Array[String])).void
}
def initialize(account: nil, components: nil, expand: nil); end
end
# Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
sig {
params(params: T.any(::Stripe::AccountSessionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::AccountSession)
}
def create(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class ApplePayDomainService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ListParams < Stripe::RequestParams
# Attribute for param field domain_name
sig { returns(T.nilable(String)) }
def domain_name; end
sig { params(_domain_name: T.nilable(String)).returns(T.nilable(String)) }
def domain_name=(_domain_name); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(domain_name: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
domain_name: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# Attribute for param field domain_name
sig { returns(String) }
def domain_name; end
sig { params(_domain_name: String).returns(String) }
def domain_name=(_domain_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(domain_name: String, expand: T.nilable(T::Array[String])).void }
def initialize(domain_name: nil, expand: nil); end
end
# Create an apple pay domain.
sig {
params(params: T.any(::Stripe::ApplePayDomainService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ApplePayDomain)
}
def create(params = {}, opts = {}); end
# Delete an apple pay domain.
sig {
params(domain: String, params: T.any(::Stripe::ApplePayDomainService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ApplePayDomain)
}
def delete(domain, params = {}, opts = {}); end
# List apple pay domains.
sig {
params(params: T.any(::Stripe::ApplePayDomainService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieve an apple pay domain.
sig {
params(domain: String, params: T.any(::Stripe::ApplePayDomainService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ApplePayDomain)
}
def retrieve(domain, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class ApplicationFeeService < StripeService
attr_reader :refunds
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return application fees for the charge specified by this charge ID.
sig { returns(T.nilable(String)) }
def charge; end
sig { params(_charge: T.nilable(String)).returns(T.nilable(String)) }
def charge=(_charge); end
# Only return applications fees that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::ApplicationFeeService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::ApplicationFeeService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::ApplicationFeeService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(charge: T.nilable(String), created: T.nilable(T.any(::Stripe::ApplicationFeeService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
charge: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of application fees you've previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.
sig {
params(params: T.any(::Stripe::ApplicationFeeService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.
sig {
params(id: String, params: T.any(::Stripe::ApplicationFeeService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ApplicationFee)
}
def retrieve(id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class ApplicationFeeRefundService < StripeService
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, metadata: nil); end
end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateParams < Stripe::RequestParams
# A positive integer, in _cents (or local equivalent)_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(amount: T.nilable(Integer), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(amount: nil, expand: nil, metadata: nil); end
end
# Refunds an application fee that has previously been collected but not yet refunded.
# Funds will be refunded to the Stripe account from which the fee was originally collected.
#
# You can optionally refund only part of an application fee.
# You can do so multiple times, until the entire fee has been refunded.
#
# Once entirely refunded, an application fee can't be refunded again.
# This method will raise an error when called on an already-refunded application fee,
# or when trying to refund more money than is left on an application fee.
sig {
params(id: String, params: T.any(::Stripe::ApplicationFeeRefundService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ApplicationFeeRefund)
}
def create(id, params = {}, opts = {}); end
# You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.
sig {
params(id: String, params: T.any(::Stripe::ApplicationFeeRefundService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(id, params = {}, opts = {}); end
# By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.
sig {
params(fee: String, id: String, params: T.any(::Stripe::ApplicationFeeRefundService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ApplicationFeeRefund)
}
def retrieve(fee, id, params = {}, opts = {}); end
# Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
#
# This request only accepts metadata as an argument.
sig {
params(fee: String, id: String, params: T.any(::Stripe::ApplicationFeeRefundService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ApplicationFeeRefund)
}
def update(fee, id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class AppsService < StripeService
attr_reader :secrets
end
end
# typed: true
module Stripe
module Apps
class SecretService < StripeService
class ListParams < Stripe::RequestParams
class Scope < Stripe::RequestParams
# The secret scope type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
sig { returns(T.nilable(String)) }
def user; end
sig { params(_user: T.nilable(String)).returns(T.nilable(String)) }
def user=(_user); end
sig { params(type: String, user: T.nilable(String)).void }
def initialize(type: nil, user: nil); end
end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
sig { returns(::Stripe::Apps::SecretService::ListParams::Scope) }
def scope; end
sig {
params(_scope: ::Stripe::Apps::SecretService::ListParams::Scope).returns(::Stripe::Apps::SecretService::ListParams::Scope)
}
def scope=(_scope); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), scope: ::Stripe::Apps::SecretService::ListParams::Scope, starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
scope: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Scope < Stripe::RequestParams
# The secret scope type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
sig { returns(T.nilable(String)) }
def user; end
sig { params(_user: T.nilable(String)).returns(T.nilable(String)) }
def user=(_user); end
sig { params(type: String, user: T.nilable(String)).void }
def initialize(type: nil, user: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The Unix timestamp for the expiry time of the secret, after which the secret deletes.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# A name for the secret that's unique within the scope.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The plaintext secret value to be stored.
sig { returns(String) }
def payload; end
sig { params(_payload: String).returns(String) }
def payload=(_payload); end
# Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
sig { returns(::Stripe::Apps::SecretService::CreateParams::Scope) }
def scope; end
sig {
params(_scope: ::Stripe::Apps::SecretService::CreateParams::Scope).returns(::Stripe::Apps::SecretService::CreateParams::Scope)
}
def scope=(_scope); end
sig {
params(expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), name: String, payload: String, scope: ::Stripe::Apps::SecretService::CreateParams::Scope).void
}
def initialize(expand: nil, expires_at: nil, name: nil, payload: nil, scope: nil); end
end
class FindParams < Stripe::RequestParams
class Scope < Stripe::RequestParams
# The secret scope type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
sig { returns(T.nilable(String)) }
def user; end
sig { params(_user: T.nilable(String)).returns(T.nilable(String)) }
def user=(_user); end
sig { params(type: String, user: T.nilable(String)).void }
def initialize(type: nil, user: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A name for the secret that's unique within the scope.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
sig { returns(::Stripe::Apps::SecretService::FindParams::Scope) }
def scope; end
sig {
params(_scope: ::Stripe::Apps::SecretService::FindParams::Scope).returns(::Stripe::Apps::SecretService::FindParams::Scope)
}
def scope=(_scope); end
sig {
params(expand: T.nilable(T::Array[String]), name: String, scope: ::Stripe::Apps::SecretService::FindParams::Scope).void
}
def initialize(expand: nil, name: nil, scope: nil); end
end
class DeleteWhereParams < Stripe::RequestParams
class Scope < Stripe::RequestParams
# The secret scope type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
sig { returns(T.nilable(String)) }
def user; end
sig { params(_user: T.nilable(String)).returns(T.nilable(String)) }
def user=(_user); end
sig { params(type: String, user: T.nilable(String)).void }
def initialize(type: nil, user: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A name for the secret that's unique within the scope.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
sig { returns(::Stripe::Apps::SecretService::DeleteWhereParams::Scope) }
def scope; end
sig {
params(_scope: ::Stripe::Apps::SecretService::DeleteWhereParams::Scope).returns(::Stripe::Apps::SecretService::DeleteWhereParams::Scope)
}
def scope=(_scope); end
sig {
params(expand: T.nilable(T::Array[String]), name: String, scope: ::Stripe::Apps::SecretService::DeleteWhereParams::Scope).void
}
def initialize(expand: nil, name: nil, scope: nil); end
end
# Create or replace a secret in the secret store.
sig {
params(params: T.any(::Stripe::Apps::SecretService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Apps::Secret)
}
def create(params = {}, opts = {}); end
# Deletes a secret from the secret store by name and scope.
sig {
params(params: T.any(::Stripe::Apps::SecretService::DeleteWhereParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Apps::Secret)
}
def delete_where(params = {}, opts = {}); end
# Finds a secret in the secret store by name and scope.
sig {
params(params: T.any(::Stripe::Apps::SecretService::FindParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Apps::Secret)
}
def find(params = {}, opts = {}); end
# List all secrets stored on the given scope.
sig {
params(params: T.any(::Stripe::Apps::SecretService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class BalanceService < StripeService
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Retrieves the current account balance, based on the authentication that was used to make the request.
# For a sample request, see [Accounting for negative balances](https://docs.stripe.com/docs/connect/account-balances#accounting-for-negative-balances).
sig {
params(params: T.any(::Stripe::BalanceService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Balance)
}
def retrieve(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class BalanceSettingsService < StripeService
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Payments < Stripe::RequestParams
class Payouts < Stripe::RequestParams
class Schedule < Stripe::RequestParams
# How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# The days of the month when available funds are paid out, specified as an array of numbers between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`.
sig { returns(T.nilable(T::Array[Integer])) }
def monthly_payout_days; end
sig {
params(_monthly_payout_days: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def monthly_payout_days=(_monthly_payout_days); end
# The days of the week when available funds are paid out, specified as an array, e.g., [`monday`, `tuesday`]. Required and applicable only if `interval` is `weekly`.
sig { returns(T.nilable(T::Array[String])) }
def weekly_payout_days; end
sig {
params(_weekly_payout_days: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def weekly_payout_days=(_weekly_payout_days); end
sig {
params(interval: T.nilable(String), monthly_payout_days: T.nilable(T::Array[Integer]), weekly_payout_days: T.nilable(T::Array[String])).void
}
def initialize(interval: nil, monthly_payout_days: nil, weekly_payout_days: nil); end
end
# The minimum balance amount to retain per currency after automatic payouts. Only funds that exceed these amounts are paid out. Learn more about the [minimum balances for automatic payouts](/payouts/minimum-balances-for-automatic-payouts).
sig { returns(T.nilable(T.any(String, T::Hash[String, T.any(String, Integer)]))) }
def minimum_balance_by_currency; end
sig {
params(_minimum_balance_by_currency: T.nilable(T.any(String, T::Hash[String, T.any(String, Integer)]))).returns(T.nilable(T.any(String, T::Hash[String, T.any(String, Integer)])))
}
def minimum_balance_by_currency=(_minimum_balance_by_currency); end
# Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](/connect/bank-transfers#payout-information) documentation.
sig {
returns(T.nilable(::Stripe::BalanceSettingsService::UpdateParams::Payments::Payouts::Schedule))
}
def schedule; end
sig {
params(_schedule: T.nilable(::Stripe::BalanceSettingsService::UpdateParams::Payments::Payouts::Schedule)).returns(T.nilable(::Stripe::BalanceSettingsService::UpdateParams::Payments::Payouts::Schedule))
}
def schedule=(_schedule); end
# The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
sig {
params(minimum_balance_by_currency: T.nilable(T.any(String, T::Hash[String, T.any(String, Integer)])), schedule: T.nilable(::Stripe::BalanceSettingsService::UpdateParams::Payments::Payouts::Schedule), statement_descriptor: T.nilable(String)).void
}
def initialize(
minimum_balance_by_currency: nil,
schedule: nil,
statement_descriptor: nil
); end
end
class SettlementTiming < Stripe::RequestParams
# Change `delay_days` for this account, which determines the number of days charge funds are held before becoming available. The maximum value is 31. Passing an empty string to `delay_days_override` will return `delay_days` to the default, which is the lowest available value for the account. [Learn more about controlling delay days](/connect/manage-payout-schedule).
sig { returns(T.nilable(T.any(String, Integer))) }
def delay_days_override; end
sig {
params(_delay_days_override: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def delay_days_override=(_delay_days_override); end
sig { params(delay_days_override: T.nilable(T.any(String, Integer))).void }
def initialize(delay_days_override: nil); end
end
# A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/connect/account-balances).
sig { returns(T.nilable(T::Boolean)) }
def debit_negative_balances; end
sig {
params(_debit_negative_balances: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def debit_negative_balances=(_debit_negative_balances); end
# Settings specific to the account's payouts.
sig {
returns(T.nilable(::Stripe::BalanceSettingsService::UpdateParams::Payments::Payouts))
}
def payouts; end
sig {
params(_payouts: T.nilable(::Stripe::BalanceSettingsService::UpdateParams::Payments::Payouts)).returns(T.nilable(::Stripe::BalanceSettingsService::UpdateParams::Payments::Payouts))
}
def payouts=(_payouts); end
# Settings related to the account's balance settlement timing.
sig {
returns(T.nilable(::Stripe::BalanceSettingsService::UpdateParams::Payments::SettlementTiming))
}
def settlement_timing; end
sig {
params(_settlement_timing: T.nilable(::Stripe::BalanceSettingsService::UpdateParams::Payments::SettlementTiming)).returns(T.nilable(::Stripe::BalanceSettingsService::UpdateParams::Payments::SettlementTiming))
}
def settlement_timing=(_settlement_timing); end
sig {
params(debit_negative_balances: T.nilable(T::Boolean), payouts: T.nilable(::Stripe::BalanceSettingsService::UpdateParams::Payments::Payouts), settlement_timing: T.nilable(::Stripe::BalanceSettingsService::UpdateParams::Payments::SettlementTiming)).void
}
def initialize(debit_negative_balances: nil, payouts: nil, settlement_timing: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Settings that apply to the [Payments Balance](https://docs.stripe.com/api/balance).
sig { returns(T.nilable(::Stripe::BalanceSettingsService::UpdateParams::Payments)) }
def payments; end
sig {
params(_payments: T.nilable(::Stripe::BalanceSettingsService::UpdateParams::Payments)).returns(T.nilable(::Stripe::BalanceSettingsService::UpdateParams::Payments))
}
def payments=(_payments); end
sig {
params(expand: T.nilable(T::Array[String]), payments: T.nilable(::Stripe::BalanceSettingsService::UpdateParams::Payments)).void
}
def initialize(expand: nil, payments: nil); end
end
# Retrieves balance settings for a given connected account.
# Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication)
sig {
params(params: T.any(::Stripe::BalanceSettingsService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BalanceSettings)
}
def retrieve(params = {}, opts = {}); end
# Updates balance settings for a given connected account.
# Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication)
sig {
params(params: T.any(::Stripe::BalanceSettingsService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BalanceSettings)
}
def update(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class BalanceTransactionService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return transactions that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::BalanceTransactionService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::BalanceTransactionService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::BalanceTransactionService::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return transactions in a certain currency. 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
sig { returns(T.nilable(String)) }
def payout; end
sig { params(_payout: T.nilable(String)).returns(T.nilable(String)) }
def payout=(_payout); end
# Only returns the original transaction.
sig { returns(T.nilable(String)) }
def source; end
sig { params(_source: T.nilable(String)).returns(T.nilable(String)) }
def source=(_source); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(created: T.nilable(T.any(::Stripe::BalanceTransactionService::ListParams::Created, Integer)), currency: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payout: T.nilable(String), source: T.nilable(String), starting_after: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
created: nil,
currency: nil,
ending_before: nil,
expand: nil,
limit: nil,
payout: nil,
source: nil,
starting_after: nil,
type: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
#
# Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
sig {
params(params: T.any(::Stripe::BalanceTransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the balance transaction with the given ID.
#
# Note that this endpoint previously used the path /v1/balance/history/:id.
sig {
params(id: String, params: T.any(::Stripe::BalanceTransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BalanceTransaction)
}
def retrieve(id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class BillingService < StripeService
attr_reader :alerts
attr_reader :analytics
attr_reader :credit_balance_summary
attr_reader :credit_balance_transactions
attr_reader :credit_grants
attr_reader :meters
attr_reader :meter_events
attr_reader :meter_event_adjustments
end
end
# typed: true
module Stripe
module Billing
class AlertService < StripeService
class ListParams < Stripe::RequestParams
# Filter results to only include this type of alert.
sig { returns(T.nilable(String)) }
def alert_type; end
sig { params(_alert_type: T.nilable(String)).returns(T.nilable(String)) }
def alert_type=(_alert_type); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Filter results to only include alerts with the given meter.
sig { returns(T.nilable(String)) }
def meter; end
sig { params(_meter: T.nilable(String)).returns(T.nilable(String)) }
def meter=(_meter); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(alert_type: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), meter: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
alert_type: nil,
ending_before: nil,
expand: nil,
limit: nil,
meter: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class UsageThreshold < Stripe::RequestParams
class Filter < Stripe::RequestParams
# Limit the scope to this usage alert only to this customer.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# What type of filter is being applied to this usage alert.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(customer: T.nilable(String), type: String).void }
def initialize(customer: nil, type: nil); end
end
# The filters allows limiting the scope of this usage alert. You can only specify up to one filter at this time.
sig {
returns(T.nilable(T::Array[::Stripe::Billing::AlertService::CreateParams::UsageThreshold::Filter]))
}
def filters; end
sig {
params(_filters: T.nilable(T::Array[::Stripe::Billing::AlertService::CreateParams::UsageThreshold::Filter])).returns(T.nilable(T::Array[::Stripe::Billing::AlertService::CreateParams::UsageThreshold::Filter]))
}
def filters=(_filters); end
# Defines at which value the alert will fire.
sig { returns(Integer) }
def gte; end
sig { params(_gte: Integer).returns(Integer) }
def gte=(_gte); end
# The [Billing Meter](/api/billing/meter) ID whose usage is monitored.
sig { returns(String) }
def meter; end
sig { params(_meter: String).returns(String) }
def meter=(_meter); end
# Defines how the alert will behave.
sig { returns(String) }
def recurrence; end
sig { params(_recurrence: String).returns(String) }
def recurrence=(_recurrence); end
sig {
params(filters: T.nilable(T::Array[::Stripe::Billing::AlertService::CreateParams::UsageThreshold::Filter]), gte: Integer, meter: String, recurrence: String).void
}
def initialize(filters: nil, gte: nil, meter: nil, recurrence: nil); end
end
# The type of alert to create.
sig { returns(String) }
def alert_type; end
sig { params(_alert_type: String).returns(String) }
def alert_type=(_alert_type); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The title of the alert.
sig { returns(String) }
def title; end
sig { params(_title: String).returns(String) }
def title=(_title); end
# The configuration of the usage threshold.
sig { returns(T.nilable(::Stripe::Billing::AlertService::CreateParams::UsageThreshold)) }
def usage_threshold; end
sig {
params(_usage_threshold: T.nilable(::Stripe::Billing::AlertService::CreateParams::UsageThreshold)).returns(T.nilable(::Stripe::Billing::AlertService::CreateParams::UsageThreshold))
}
def usage_threshold=(_usage_threshold); end
sig {
params(alert_type: String, expand: T.nilable(T::Array[String]), title: String, usage_threshold: T.nilable(::Stripe::Billing::AlertService::CreateParams::UsageThreshold)).void
}
def initialize(alert_type: nil, expand: nil, title: nil, usage_threshold: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ActivateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ArchiveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class DeactivateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Reactivates this alert, allowing it to trigger again.
sig {
params(id: String, params: T.any(::Stripe::Billing::AlertService::ActivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
}
def activate(id, params = {}, opts = {}); end
# Archives this alert, removing it from the list view and APIs. This is non-reversible.
sig {
params(id: String, params: T.any(::Stripe::Billing::AlertService::ArchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
}
def archive(id, params = {}, opts = {}); end
# Creates a billing alert
sig {
params(params: T.any(::Stripe::Billing::AlertService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
}
def create(params = {}, opts = {}); end
# Deactivates this alert, preventing it from triggering.
sig {
params(id: String, params: T.any(::Stripe::Billing::AlertService::DeactivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
}
def deactivate(id, params = {}, opts = {}); end
# Lists billing active and inactive alerts
sig {
params(params: T.any(::Stripe::Billing::AlertService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a billing alert given an ID
sig {
params(id: String, params: T.any(::Stripe::Billing::AlertService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Billing
class AnalyticsService < StripeService
attr_reader :meter_usage
end
end
end
# typed: true
module Stripe
module Billing
module Analytics
class MeterUsageService < StripeService
class RetrieveParams < Stripe::RequestParams
class Meter < Stripe::RequestParams
# Key-value pairs used to filter usage events by meter dimension values. If specified, usage will be filtered for matching usage events.
sig { returns(T.nilable(T::Hash[String, String])) }
def dimension_filters; end
sig {
params(_dimension_filters: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def dimension_filters=(_dimension_filters); end
# List of meter dimension keys to group by. If specified, usage events will be grouped by the given meter dimension key's values.
sig { returns(T.nilable(T::Array[String])) }
def dimension_group_by_keys; end
sig {
params(_dimension_group_by_keys: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def dimension_group_by_keys=(_dimension_group_by_keys); end
# Meter id to query usage for.
sig { returns(String) }
def meter_id; end
sig { params(_meter_id: String).returns(String) }
def meter_id=(_meter_id); end
# Key-value pairs used to filter usage events by high cardinality tenant dimension values. If specified, usage will be filtered for matching usage events.
sig { returns(T.nilable(T::Hash[String, String])) }
def tenant_filters; end
sig {
params(_tenant_filters: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def tenant_filters=(_tenant_filters); end
sig {
params(dimension_filters: T.nilable(T::Hash[String, String]), dimension_group_by_keys: T.nilable(T::Array[String]), meter_id: String, tenant_filters: T.nilable(T::Hash[String, String])).void
}
def initialize(
dimension_filters: nil,
dimension_group_by_keys: nil,
meter_id: nil,
tenant_filters: nil
); end
end
# The customer id to fetch meter usage data for.
sig { returns(String) }
def customer; end
sig { params(_customer: String).returns(String) }
def customer=(_customer); end
# The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.
sig { returns(Integer) }
def end_time; end
sig { params(_end_time: Integer).returns(Integer) }
def end_time=(_end_time); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# An array of meter parameters to specify which meters to include in the usage data. If not specified, usage across all meters for the customer is included.
sig {
returns(T.nilable(T::Array[::Stripe::Billing::Analytics::MeterUsageService::RetrieveParams::Meter]))
}
def meters; end
sig {
params(_meters: T.nilable(T::Array[::Stripe::Billing::Analytics::MeterUsageService::RetrieveParams::Meter])).returns(T.nilable(T::Array[::Stripe::Billing::Analytics::MeterUsageService::RetrieveParams::Meter]))
}
def meters=(_meters); end
# The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.
sig { returns(Integer) }
def start_time; end
sig { params(_start_time: Integer).returns(Integer) }
def start_time=(_start_time); end
# The timezone to use for the start and end times. Defaults to UTC if not specified.
sig { returns(T.nilable(String)) }
def timezone; end
sig { params(_timezone: T.nilable(String)).returns(T.nilable(String)) }
def timezone=(_timezone); end
# Specifies what granularity to use when aggregating meter usage events. If not specified, a single event would be returned for the specified time range.
sig { returns(T.nilable(String)) }
def value_grouping_window; end
sig { params(_value_grouping_window: T.nilable(String)).returns(T.nilable(String)) }
def value_grouping_window=(_value_grouping_window); end
sig {
params(customer: String, end_time: Integer, expand: T.nilable(T::Array[String]), meters: T.nilable(T::Array[::Stripe::Billing::Analytics::MeterUsageService::RetrieveParams::Meter]), start_time: Integer, timezone: T.nilable(String), value_grouping_window: T.nilable(String)).void
}
def initialize(
customer: nil,
end_time: nil,
expand: nil,
meters: nil,
start_time: nil,
timezone: nil,
value_grouping_window: nil
); end
end
# Returns aggregated meter usage data for a customer within a specified time interval. The data can be grouped by various dimensions and can include multiple meters if specified.
sig {
params(params: T.any(::Stripe::Billing::Analytics::MeterUsageService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Analytics::MeterUsage)
}
def retrieve(params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module Billing
class CreditBalanceSummaryService < StripeService
class RetrieveParams < Stripe::RequestParams
class Filter < Stripe::RequestParams
class ApplicabilityScope < Stripe::RequestParams
class Price < Stripe::RequestParams
# The price ID this credit grant should apply to.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
sig { params(id: String).void }
def initialize(id: nil); end
end
# The price type that credit grants can apply to. We currently only support the `metered` price type. Cannot be used in combination with `prices`.
sig { returns(T.nilable(String)) }
def price_type; end
sig { params(_price_type: T.nilable(String)).returns(T.nilable(String)) }
def price_type=(_price_type); end
# A list of prices that the credit grant can apply to. We currently only support the `metered` prices. Cannot be used in combination with `price_type`.
sig {
returns(T.nilable(T::Array[::Stripe::Billing::CreditBalanceSummaryService::RetrieveParams::Filter::ApplicabilityScope::Price]))
}
def prices; end
sig {
params(_prices: T.nilable(T::Array[::Stripe::Billing::CreditBalanceSummaryService::RetrieveParams::Filter::ApplicabilityScope::Price])).returns(T.nilable(T::Array[::Stripe::Billing::CreditBalanceSummaryService::RetrieveParams::Filter::ApplicabilityScope::Price]))
}
def prices=(_prices); end
sig {
params(price_type: T.nilable(String), prices: T.nilable(T::Array[::Stripe::Billing::CreditBalanceSummaryService::RetrieveParams::Filter::ApplicabilityScope::Price])).void
}
def initialize(price_type: nil, prices: nil); end
end
# The billing credit applicability scope for which to fetch credit balance summary.
sig {
returns(T.nilable(::Stripe::Billing::CreditBalanceSummaryService::RetrieveParams::Filter::ApplicabilityScope))
}
def applicability_scope; end
sig {
params(_applicability_scope: T.nilable(::Stripe::Billing::CreditBalanceSummaryService::RetrieveParams::Filter::ApplicabilityScope)).returns(T.nilable(::Stripe::Billing::CreditBalanceSummaryService::RetrieveParams::Filter::ApplicabilityScope))
}
def applicability_scope=(_applicability_scope); end
# The credit grant for which to fetch credit balance summary.
sig { returns(T.nilable(String)) }
def credit_grant; end
sig { params(_credit_grant: T.nilable(String)).returns(T.nilable(String)) }
def credit_grant=(_credit_grant); end
# Specify the type of this filter.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(applicability_scope: T.nilable(::Stripe::Billing::CreditBalanceSummaryService::RetrieveParams::Filter::ApplicabilityScope), credit_grant: T.nilable(String), type: String).void
}
def initialize(applicability_scope: nil, credit_grant: nil, type: nil); end
end
# The customer for which to fetch credit balance summary.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The account for which to fetch credit balance summary.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The filter criteria for the credit balance summary.
sig { returns(::Stripe::Billing::CreditBalanceSummaryService::RetrieveParams::Filter) }
def filter; end
sig {
params(_filter: ::Stripe::Billing::CreditBalanceSummaryService::RetrieveParams::Filter).returns(::Stripe::Billing::CreditBalanceSummaryService::RetrieveParams::Filter)
}
def filter=(_filter); end
sig {
params(customer: T.nilable(String), customer_account: T.nilable(String), expand: T.nilable(T::Array[String]), filter: ::Stripe::Billing::CreditBalanceSummaryService::RetrieveParams::Filter).void
}
def initialize(customer: nil, customer_account: nil, expand: nil, filter: nil); end
end
# Retrieves the credit balance summary for a customer.
sig {
params(params: T.any(::Stripe::Billing::CreditBalanceSummaryService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::CreditBalanceSummary)
}
def retrieve(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Billing
class CreditBalanceTransactionService < StripeService
class ListParams < Stripe::RequestParams
# The credit grant for which to fetch credit balance transactions.
sig { returns(T.nilable(String)) }
def credit_grant; end
sig { params(_credit_grant: T.nilable(String)).returns(T.nilable(String)) }
def credit_grant=(_credit_grant); end
# The customer for which to fetch credit balance transactions.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The account for which to fetch credit balance transactions.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(credit_grant: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
credit_grant: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Retrieve a list of credit balance transactions.
sig {
params(params: T.any(::Stripe::Billing::CreditBalanceTransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a credit balance transaction.
sig {
params(id: String, params: T.any(::Stripe::Billing::CreditBalanceTransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::CreditBalanceTransaction)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Billing
class CreditGrantService < StripeService
class ListParams < Stripe::RequestParams
# Only return credit grants for this customer.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Only return credit grants for this account.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Amount < Stripe::RequestParams
class Monetary < Stripe::RequestParams
# Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `value` parameter.
sig { returns(String) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# A positive integer representing the amount of the credit grant.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(currency: String, value: Integer).void }
def initialize(currency: nil, value: nil); end
end
# The monetary amount.
sig {
returns(T.nilable(::Stripe::Billing::CreditGrantService::CreateParams::Amount::Monetary))
}
def monetary; end
sig {
params(_monetary: T.nilable(::Stripe::Billing::CreditGrantService::CreateParams::Amount::Monetary)).returns(T.nilable(::Stripe::Billing::CreditGrantService::CreateParams::Amount::Monetary))
}
def monetary=(_monetary); end
# The type of this amount. We currently only support `monetary` billing credits.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(monetary: T.nilable(::Stripe::Billing::CreditGrantService::CreateParams::Amount::Monetary), type: String).void
}
def initialize(monetary: nil, type: nil); end
end
class ApplicabilityConfig < Stripe::RequestParams
class Scope < Stripe::RequestParams
class Price < Stripe::RequestParams
# The price ID this credit grant should apply to.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
sig { params(id: String).void }
def initialize(id: nil); end
end
# The price type that credit grants can apply to. We currently only support the `metered` price type. Cannot be used in combination with `prices`.
sig { returns(T.nilable(String)) }
def price_type; end
sig { params(_price_type: T.nilable(String)).returns(T.nilable(String)) }
def price_type=(_price_type); end
# A list of prices that the credit grant can apply to. We currently only support the `metered` prices. Cannot be used in combination with `price_type`.
sig {
returns(T.nilable(T::Array[::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig::Scope::Price]))
}
def prices; end
sig {
params(_prices: T.nilable(T::Array[::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig::Scope::Price])).returns(T.nilable(T::Array[::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig::Scope::Price]))
}
def prices=(_prices); end
sig {
params(price_type: T.nilable(String), prices: T.nilable(T::Array[::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig::Scope::Price])).void
}
def initialize(price_type: nil, prices: nil); end
end
# Specify the scope of this applicability config.
sig {
returns(::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig::Scope)
}
def scope; end
sig {
params(_scope: ::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig::Scope).returns(::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig::Scope)
}
def scope=(_scope); end
sig {
params(scope: ::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig::Scope).void
}
def initialize(scope: nil); end
end
# Amount of this credit grant.
sig { returns(::Stripe::Billing::CreditGrantService::CreateParams::Amount) }
def amount; end
sig {
params(_amount: ::Stripe::Billing::CreditGrantService::CreateParams::Amount).returns(::Stripe::Billing::CreditGrantService::CreateParams::Amount)
}
def amount=(_amount); end
# Configuration specifying what this credit grant applies to. We currently only support `metered` prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.
sig { returns(::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig) }
def applicability_config; end
sig {
params(_applicability_config: ::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig).returns(::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig)
}
def applicability_config=(_applicability_config); end
# The category of this credit grant.
sig { returns(String) }
def category; end
sig { params(_category: String).returns(String) }
def category=(_category); end
# ID of the customer to receive the billing credits.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# ID of the account to receive the billing credits.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.
sig { returns(T.nilable(Integer)) }
def effective_at; end
sig { params(_effective_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def effective_at=(_effective_at); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The time when the billing credits expire. If not specified, the billing credits don't expire.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# A descriptive name shown in the Dashboard.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.
sig { returns(T.nilable(Integer)) }
def priority; end
sig { params(_priority: T.nilable(Integer)).returns(T.nilable(Integer)) }
def priority=(_priority); end
sig {
params(amount: ::Stripe::Billing::CreditGrantService::CreateParams::Amount, applicability_config: ::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig, category: String, customer: T.nilable(String), customer_account: T.nilable(String), effective_at: T.nilable(Integer), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), name: T.nilable(String), priority: T.nilable(Integer)).void
}
def initialize(
amount: nil,
applicability_config: nil,
category: nil,
customer: nil,
customer_account: nil,
effective_at: nil,
expand: nil,
expires_at: nil,
metadata: nil,
name: nil,
priority: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The time when the billing credits created by this credit grant expire. If set to empty, the billing credits never expire.
sig { returns(T.nilable(T.any(String, Integer))) }
def expires_at; end
sig {
params(_expires_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expires_at=(_expires_at); end
# Set of key-value pairs you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), expires_at: T.nilable(T.any(String, Integer)), metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(expand: nil, expires_at: nil, metadata: nil); end
end
class ExpireParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class VoidGrantParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Creates a credit grant.
sig {
params(params: T.any(::Stripe::Billing::CreditGrantService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::CreditGrant)
}
def create(params = {}, opts = {}); end
# Expires a credit grant.
sig {
params(id: String, params: T.any(::Stripe::Billing::CreditGrantService::ExpireParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::CreditGrant)
}
def expire(id, params = {}, opts = {}); end
# Retrieve a list of credit grants.
sig {
params(params: T.any(::Stripe::Billing::CreditGrantService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a credit grant.
sig {
params(id: String, params: T.any(::Stripe::Billing::CreditGrantService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::CreditGrant)
}
def retrieve(id, params = {}, opts = {}); end
# Updates a credit grant.
sig {
params(id: String, params: T.any(::Stripe::Billing::CreditGrantService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::CreditGrant)
}
def update(id, params = {}, opts = {}); end
# Voids a credit grant.
sig {
params(id: String, params: T.any(::Stripe::Billing::CreditGrantService::VoidGrantParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::CreditGrant)
}
def void_grant(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Billing
class MeterService < StripeService
attr_reader :event_summaries
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Filter results to only include meters with the given status.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class CustomerMapping < Stripe::RequestParams
# The key in the meter event payload to use for mapping the event to a customer.
sig { returns(String) }
def event_payload_key; end
sig { params(_event_payload_key: String).returns(String) }
def event_payload_key=(_event_payload_key); end
# The method for mapping a meter event to a customer. Must be `by_id`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(event_payload_key: String, type: String).void }
def initialize(event_payload_key: nil, type: nil); end
end
class DefaultAggregation < Stripe::RequestParams
# Specifies how events are aggregated. Allowed values are `count` to count the number of events, `sum` to sum each event's value and `last` to take the last event's value in the window.
sig { returns(String) }
def formula; end
sig { params(_formula: String).returns(String) }
def formula=(_formula); end
sig { params(formula: String).void }
def initialize(formula: nil); end
end
class ValueSettings < Stripe::RequestParams
# The key in the usage event payload to use as the value for this meter. For example, if the event payload contains usage on a `bytes_used` field, then set the event_payload_key to "bytes_used".
sig { returns(String) }
def event_payload_key; end
sig { params(_event_payload_key: String).returns(String) }
def event_payload_key=(_event_payload_key); end
sig { params(event_payload_key: String).void }
def initialize(event_payload_key: nil); end
end
# Fields that specify how to map a meter event to a customer.
sig { returns(T.nilable(::Stripe::Billing::MeterService::CreateParams::CustomerMapping)) }
def customer_mapping; end
sig {
params(_customer_mapping: T.nilable(::Stripe::Billing::MeterService::CreateParams::CustomerMapping)).returns(T.nilable(::Stripe::Billing::MeterService::CreateParams::CustomerMapping))
}
def customer_mapping=(_customer_mapping); end
# The default settings to aggregate a meter's events with.
sig { returns(::Stripe::Billing::MeterService::CreateParams::DefaultAggregation) }
def default_aggregation; end
sig {
params(_default_aggregation: ::Stripe::Billing::MeterService::CreateParams::DefaultAggregation).returns(::Stripe::Billing::MeterService::CreateParams::DefaultAggregation)
}
def default_aggregation=(_default_aggregation); end
# The meter’s name. Not visible to the customer.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.
sig { returns(String) }
def event_name; end
sig { params(_event_name: String).returns(String) }
def event_name=(_event_name); end
# The time window which meter events have been pre-aggregated for, if any.
sig { returns(T.nilable(String)) }
def event_time_window; end
sig { params(_event_time_window: T.nilable(String)).returns(T.nilable(String)) }
def event_time_window=(_event_time_window); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Fields that specify how to calculate a meter event's value.
sig { returns(T.nilable(::Stripe::Billing::MeterService::CreateParams::ValueSettings)) }
def value_settings; end
sig {
params(_value_settings: T.nilable(::Stripe::Billing::MeterService::CreateParams::ValueSettings)).returns(T.nilable(::Stripe::Billing::MeterService::CreateParams::ValueSettings))
}
def value_settings=(_value_settings); end
sig {
params(customer_mapping: T.nilable(::Stripe::Billing::MeterService::CreateParams::CustomerMapping), default_aggregation: ::Stripe::Billing::MeterService::CreateParams::DefaultAggregation, display_name: String, event_name: String, event_time_window: T.nilable(String), expand: T.nilable(T::Array[String]), value_settings: T.nilable(::Stripe::Billing::MeterService::CreateParams::ValueSettings)).void
}
def initialize(
customer_mapping: nil,
default_aggregation: nil,
display_name: nil,
event_name: nil,
event_time_window: nil,
expand: nil,
value_settings: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# The meter’s name. Not visible to the customer.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(display_name: T.nilable(String), expand: T.nilable(T::Array[String])).void }
def initialize(display_name: nil, expand: nil); end
end
class DeactivateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ReactivateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Creates a billing meter.
sig {
params(params: T.any(::Stripe::Billing::MeterService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Meter)
}
def create(params = {}, opts = {}); end
# When a meter is deactivated, no more meter events will be accepted for this meter. You can't attach a deactivated meter to a price.
sig {
params(id: String, params: T.any(::Stripe::Billing::MeterService::DeactivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Meter)
}
def deactivate(id, params = {}, opts = {}); end
# Retrieve a list of billing meters.
sig {
params(params: T.any(::Stripe::Billing::MeterService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
sig {
params(id: String, params: T.any(::Stripe::Billing::MeterService::ReactivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Meter)
}
def reactivate(id, params = {}, opts = {}); end
# Retrieves a billing meter given an ID.
sig {
params(id: String, params: T.any(::Stripe::Billing::MeterService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Meter)
}
def retrieve(id, params = {}, opts = {}); end
# Updates a billing meter.
sig {
params(id: String, params: T.any(::Stripe::Billing::MeterService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Meter)
}
def update(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Billing
class MeterEventSummaryService < StripeService
class ListParams < Stripe::RequestParams
# The customer for which to fetch event summaries.
sig { returns(String) }
def customer; end
sig { params(_customer: String).returns(String) }
def customer=(_customer); end
# The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.
sig { returns(Integer) }
def end_time; end
sig { params(_end_time: Integer).returns(Integer) }
def end_time=(_end_time); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.
sig { returns(Integer) }
def start_time; end
sig { params(_start_time: Integer).returns(Integer) }
def start_time=(_start_time); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).
sig { returns(T.nilable(String)) }
def value_grouping_window; end
sig { params(_value_grouping_window: T.nilable(String)).returns(T.nilable(String)) }
def value_grouping_window=(_value_grouping_window); end
sig {
params(customer: String, end_time: Integer, ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), start_time: Integer, starting_after: T.nilable(String), value_grouping_window: T.nilable(String)).void
}
def initialize(
customer: nil,
end_time: nil,
ending_before: nil,
expand: nil,
limit: nil,
start_time: nil,
starting_after: nil,
value_grouping_window: nil
); end
end
# Retrieve a list of billing meter event summaries.
sig {
params(id: String, params: T.any(::Stripe::Billing::MeterEventSummaryService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Billing
class MeterEventService < StripeService
class CreateParams < Stripe::RequestParams
# The name of the meter event. Corresponds with the `event_name` field on a meter.
sig { returns(String) }
def event_name; end
sig { params(_event_name: String).returns(String) }
def event_name=(_event_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.
sig { returns(T.nilable(String)) }
def identifier; end
sig { params(_identifier: T.nilable(String)).returns(T.nilable(String)) }
def identifier=(_identifier); end
# The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
sig { returns(T::Hash[String, String]) }
def payload; end
sig { params(_payload: T::Hash[String, String]).returns(T::Hash[String, String]) }
def payload=(_payload); end
# The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
sig {
params(event_name: String, expand: T.nilable(T::Array[String]), identifier: T.nilable(String), payload: T::Hash[String, String], timestamp: T.nilable(Integer)).void
}
def initialize(
event_name: nil,
expand: nil,
identifier: nil,
payload: nil,
timestamp: nil
); end
end
# Creates a billing meter event.
sig {
params(params: T.any(::Stripe::Billing::MeterEventService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::MeterEvent)
}
def create(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Billing
class MeterEventAdjustmentService < StripeService
class CreateParams < Stripe::RequestParams
class Cancel < Stripe::RequestParams
# Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.
sig { returns(T.nilable(String)) }
def identifier; end
sig { params(_identifier: T.nilable(String)).returns(T.nilable(String)) }
def identifier=(_identifier); end
sig { params(identifier: T.nilable(String)).void }
def initialize(identifier: nil); end
end
# Specifies which event to cancel.
sig {
returns(T.nilable(::Stripe::Billing::MeterEventAdjustmentService::CreateParams::Cancel))
}
def cancel; end
sig {
params(_cancel: T.nilable(::Stripe::Billing::MeterEventAdjustmentService::CreateParams::Cancel)).returns(T.nilable(::Stripe::Billing::MeterEventAdjustmentService::CreateParams::Cancel))
}
def cancel=(_cancel); end
# The name of the meter event. Corresponds with the `event_name` field on a meter.
sig { returns(String) }
def event_name; end
sig { params(_event_name: String).returns(String) }
def event_name=(_event_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(cancel: T.nilable(::Stripe::Billing::MeterEventAdjustmentService::CreateParams::Cancel), event_name: String, expand: T.nilable(T::Array[String]), type: String).void
}
def initialize(cancel: nil, event_name: nil, expand: nil, type: nil); end
end
# Creates a billing meter event adjustment.
sig {
params(params: T.any(::Stripe::Billing::MeterEventAdjustmentService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::MeterEventAdjustment)
}
def create(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class BillingPortalService < StripeService
attr_reader :configurations
attr_reader :sessions
end
end
# typed: true
module Stripe
module BillingPortal
class ConfigurationService < StripeService
class ListParams < Stripe::RequestParams
# Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).
sig { returns(T.nilable(T::Boolean)) }
def is_default; end
sig { params(_is_default: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def is_default=(_is_default); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(active: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), is_default: T.nilable(T::Boolean), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
active: nil,
ending_before: nil,
expand: nil,
is_default: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class BusinessProfile < Stripe::RequestParams
# The messaging shown to customers in the portal.
sig { returns(T.nilable(String)) }
def headline; end
sig { params(_headline: T.nilable(String)).returns(T.nilable(String)) }
def headline=(_headline); end
# A link to the business’s publicly available privacy policy.
sig { returns(T.nilable(String)) }
def privacy_policy_url; end
sig { params(_privacy_policy_url: T.nilable(String)).returns(T.nilable(String)) }
def privacy_policy_url=(_privacy_policy_url); end
# A link to the business’s publicly available terms of service.
sig { returns(T.nilable(String)) }
def terms_of_service_url; end
sig { params(_terms_of_service_url: T.nilable(String)).returns(T.nilable(String)) }
def terms_of_service_url=(_terms_of_service_url); end
sig {
params(headline: T.nilable(String), privacy_policy_url: T.nilable(String), terms_of_service_url: T.nilable(String)).void
}
def initialize(headline: nil, privacy_policy_url: nil, terms_of_service_url: nil); end
end
class Features < Stripe::RequestParams
class CustomerUpdate < Stripe::RequestParams
# The types of customer updates that are supported. When empty, customers are not updateable.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def allowed_updates; end
sig {
params(_allowed_updates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def allowed_updates=(_allowed_updates); end
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig {
params(allowed_updates: T.nilable(T.any(String, T::Array[String])), enabled: T::Boolean).void
}
def initialize(allowed_updates: nil, enabled: nil); end
end
class InvoiceHistory < Stripe::RequestParams
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class PaymentMethodUpdate < Stripe::RequestParams
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class SubscriptionCancel < Stripe::RequestParams
class CancellationReason < Stripe::RequestParams
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Which cancellation reasons will be given as options to the customer.
sig { returns(T.any(String, T::Array[String])) }
def options; end
sig {
params(_options: T.any(String, T::Array[String])).returns(T.any(String, T::Array[String]))
}
def options=(_options); end
sig { params(enabled: T::Boolean, options: T.any(String, T::Array[String])).void }
def initialize(enabled: nil, options: nil); end
end
# Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel::CancellationReason))
}
def cancellation_reason; end
sig {
params(_cancellation_reason: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel::CancellationReason)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel::CancellationReason))
}
def cancellation_reason=(_cancellation_reason); end
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Whether to cancel subscriptions immediately or at the end of the billing period.
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
sig {
params(cancellation_reason: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel::CancellationReason), enabled: T::Boolean, mode: T.nilable(String), proration_behavior: T.nilable(String)).void
}
def initialize(
cancellation_reason: nil,
enabled: nil,
mode: nil,
proration_behavior: nil
); end
end
class SubscriptionUpdate < Stripe::RequestParams
class Product < Stripe::RequestParams
class AdjustableQuantity < Stripe::RequestParams
# Set to true if the quantity can be adjusted to any non-negative integer.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum quantity that can be set for the product.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum quantity that can be set for the product.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil); end
end
# Control whether the quantity of the product can be adjusted.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity))
}
def adjustable_quantity; end
sig {
params(_adjustable_quantity: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity))
}
def adjustable_quantity=(_adjustable_quantity); end
# The list of price IDs for the product that a subscription can be updated to.
sig { returns(T::Array[String]) }
def prices; end
sig { params(_prices: T::Array[String]).returns(T::Array[String]) }
def prices=(_prices); end
# The product id.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
sig {
params(adjustable_quantity: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity), prices: T::Array[String], product: String).void
}
def initialize(adjustable_quantity: nil, prices: nil, product: nil); end
end
class ScheduleAtPeriodEnd < Stripe::RequestParams
class Condition < Stripe::RequestParams
# The type of condition.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
# List of conditions. When any condition is true, the update will be scheduled at the end of the current period.
sig {
returns(T.nilable(T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))
}
def conditions; end
sig {
params(_conditions: T.nilable(T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])).returns(T.nilable(T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))
}
def conditions=(_conditions); end
sig {
params(conditions: T.nilable(T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])).void
}
def initialize(conditions: nil); end
end
# The types of subscription updates that are supported. When empty, subscriptions are not updateable.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_allowed_updates; end
sig {
params(_default_allowed_updates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_allowed_updates=(_default_allowed_updates); end
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The list of up to 10 products that support subscription updates.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::Product])))
}
def products; end
sig {
params(_products: T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::Product]))).returns(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::Product])))
}
def products=(_products); end
# Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd))
}
def schedule_at_period_end; end
sig {
params(_schedule_at_period_end: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd))
}
def schedule_at_period_end=(_schedule_at_period_end); end
# The behavior when updating a subscription that is trialing.
sig { returns(T.nilable(String)) }
def trial_update_behavior; end
sig { params(_trial_update_behavior: T.nilable(String)).returns(T.nilable(String)) }
def trial_update_behavior=(_trial_update_behavior); end
sig {
params(default_allowed_updates: T.nilable(T.any(String, T::Array[String])), enabled: T::Boolean, products: T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::Product])), proration_behavior: T.nilable(String), schedule_at_period_end: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd), trial_update_behavior: T.nilable(String)).void
}
def initialize(
default_allowed_updates: nil,
enabled: nil,
products: nil,
proration_behavior: nil,
schedule_at_period_end: nil,
trial_update_behavior: nil
); end
end
# Information about updating the customer details in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::CustomerUpdate))
}
def customer_update; end
sig {
params(_customer_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::CustomerUpdate)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::CustomerUpdate))
}
def customer_update=(_customer_update); end
# Information about showing the billing history in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::InvoiceHistory))
}
def invoice_history; end
sig {
params(_invoice_history: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::InvoiceHistory)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::InvoiceHistory))
}
def invoice_history=(_invoice_history); end
# Information about updating payment methods in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::PaymentMethodUpdate))
}
def payment_method_update; end
sig {
params(_payment_method_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::PaymentMethodUpdate)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::PaymentMethodUpdate))
}
def payment_method_update=(_payment_method_update); end
# Information about canceling subscriptions in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel))
}
def subscription_cancel; end
sig {
params(_subscription_cancel: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel))
}
def subscription_cancel=(_subscription_cancel); end
# Information about updating subscriptions in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate))
}
def subscription_update; end
sig {
params(_subscription_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate))
}
def subscription_update=(_subscription_update); end
sig {
params(customer_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::CustomerUpdate), invoice_history: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::InvoiceHistory), payment_method_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::PaymentMethodUpdate), subscription_cancel: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate)).void
}
def initialize(
customer_update: nil,
invoice_history: nil,
payment_method_update: nil,
subscription_cancel: nil,
subscription_update: nil
); end
end
class LoginPage < Stripe::RequestParams
# Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
# The business information shown to customers in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::BusinessProfile))
}
def business_profile; end
sig {
params(_business_profile: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::BusinessProfile)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::BusinessProfile))
}
def business_profile=(_business_profile); end
# The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
sig { returns(T.nilable(String)) }
def default_return_url; end
sig { params(_default_return_url: T.nilable(String)).returns(T.nilable(String)) }
def default_return_url=(_default_return_url); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Information about the features available in the portal.
sig { returns(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features) }
def features; end
sig {
params(_features: ::Stripe::BillingPortal::ConfigurationService::CreateParams::Features).returns(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features)
}
def features=(_features); end
# The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::LoginPage))
}
def login_page; end
sig {
params(_login_page: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::LoginPage)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::LoginPage))
}
def login_page=(_login_page); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The name of the configuration.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(business_profile: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::BusinessProfile), default_return_url: T.nilable(String), expand: T.nilable(T::Array[String]), features: ::Stripe::BillingPortal::ConfigurationService::CreateParams::Features, login_page: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::LoginPage), metadata: T.nilable(T::Hash[String, String]), name: T.nilable(String)).void
}
def initialize(
business_profile: nil,
default_return_url: nil,
expand: nil,
features: nil,
login_page: nil,
metadata: nil,
name: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class BusinessProfile < Stripe::RequestParams
# The messaging shown to customers in the portal.
sig { returns(T.nilable(String)) }
def headline; end
sig { params(_headline: T.nilable(String)).returns(T.nilable(String)) }
def headline=(_headline); end
# A link to the business’s publicly available privacy policy.
sig { returns(T.nilable(String)) }
def privacy_policy_url; end
sig { params(_privacy_policy_url: T.nilable(String)).returns(T.nilable(String)) }
def privacy_policy_url=(_privacy_policy_url); end
# A link to the business’s publicly available terms of service.
sig { returns(T.nilable(String)) }
def terms_of_service_url; end
sig { params(_terms_of_service_url: T.nilable(String)).returns(T.nilable(String)) }
def terms_of_service_url=(_terms_of_service_url); end
sig {
params(headline: T.nilable(String), privacy_policy_url: T.nilable(String), terms_of_service_url: T.nilable(String)).void
}
def initialize(headline: nil, privacy_policy_url: nil, terms_of_service_url: nil); end
end
class Features < Stripe::RequestParams
class CustomerUpdate < Stripe::RequestParams
# The types of customer updates that are supported. When empty, customers are not updateable.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def allowed_updates; end
sig {
params(_allowed_updates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def allowed_updates=(_allowed_updates); end
# Whether the feature is enabled.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
sig {
params(allowed_updates: T.nilable(T.any(String, T::Array[String])), enabled: T.nilable(T::Boolean)).void
}
def initialize(allowed_updates: nil, enabled: nil); end
end
class InvoiceHistory < Stripe::RequestParams
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class PaymentMethodUpdate < Stripe::RequestParams
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class SubscriptionCancel < Stripe::RequestParams
class CancellationReason < Stripe::RequestParams
# Whether the feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Which cancellation reasons will be given as options to the customer.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def options; end
sig {
params(_options: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def options=(_options); end
sig {
params(enabled: T::Boolean, options: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(enabled: nil, options: nil); end
end
# Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel::CancellationReason))
}
def cancellation_reason; end
sig {
params(_cancellation_reason: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel::CancellationReason)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel::CancellationReason))
}
def cancellation_reason=(_cancellation_reason); end
# Whether the feature is enabled.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# Whether to cancel subscriptions immediately or at the end of the billing period.
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
sig {
params(cancellation_reason: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel::CancellationReason), enabled: T.nilable(T::Boolean), mode: T.nilable(String), proration_behavior: T.nilable(String)).void
}
def initialize(
cancellation_reason: nil,
enabled: nil,
mode: nil,
proration_behavior: nil
); end
end
class SubscriptionUpdate < Stripe::RequestParams
class Product < Stripe::RequestParams
class AdjustableQuantity < Stripe::RequestParams
# Set to true if the quantity can be adjusted to any non-negative integer.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum quantity that can be set for the product.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum quantity that can be set for the product.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil); end
end
# Control whether the quantity of the product can be adjusted.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity))
}
def adjustable_quantity; end
sig {
params(_adjustable_quantity: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity))
}
def adjustable_quantity=(_adjustable_quantity); end
# The list of price IDs for the product that a subscription can be updated to.
sig { returns(T::Array[String]) }
def prices; end
sig { params(_prices: T::Array[String]).returns(T::Array[String]) }
def prices=(_prices); end
# The product id.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
sig {
params(adjustable_quantity: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity), prices: T::Array[String], product: String).void
}
def initialize(adjustable_quantity: nil, prices: nil, product: nil); end
end
class ScheduleAtPeriodEnd < Stripe::RequestParams
class Condition < Stripe::RequestParams
# The type of condition.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
# List of conditions. When any condition is true, the update will be scheduled at the end of the current period.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])))
}
def conditions; end
sig {
params(_conditions: T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))).returns(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])))
}
def conditions=(_conditions); end
sig {
params(conditions: T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))).void
}
def initialize(conditions: nil); end
end
# The types of subscription updates that are supported. When empty, subscriptions are not updateable.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_allowed_updates; end
sig {
params(_default_allowed_updates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_allowed_updates=(_default_allowed_updates); end
# Whether the feature is enabled.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# The list of up to 10 products that support subscription updates.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::Product])))
}
def products; end
sig {
params(_products: T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::Product]))).returns(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::Product])))
}
def products=(_products); end
# Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd))
}
def schedule_at_period_end; end
sig {
params(_schedule_at_period_end: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd))
}
def schedule_at_period_end=(_schedule_at_period_end); end
# The behavior when updating a subscription that is trialing.
sig { returns(T.nilable(String)) }
def trial_update_behavior; end
sig { params(_trial_update_behavior: T.nilable(String)).returns(T.nilable(String)) }
def trial_update_behavior=(_trial_update_behavior); end
sig {
params(default_allowed_updates: T.nilable(T.any(String, T::Array[String])), enabled: T.nilable(T::Boolean), products: T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::Product])), proration_behavior: T.nilable(String), schedule_at_period_end: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd), trial_update_behavior: T.nilable(String)).void
}
def initialize(
default_allowed_updates: nil,
enabled: nil,
products: nil,
proration_behavior: nil,
schedule_at_period_end: nil,
trial_update_behavior: nil
); end
end
# Information about updating the customer details in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::CustomerUpdate))
}
def customer_update; end
sig {
params(_customer_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::CustomerUpdate)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::CustomerUpdate))
}
def customer_update=(_customer_update); end
# Information about showing the billing history in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::InvoiceHistory))
}
def invoice_history; end
sig {
params(_invoice_history: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::InvoiceHistory)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::InvoiceHistory))
}
def invoice_history=(_invoice_history); end
# Information about updating payment methods in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::PaymentMethodUpdate))
}
def payment_method_update; end
sig {
params(_payment_method_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::PaymentMethodUpdate)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::PaymentMethodUpdate))
}
def payment_method_update=(_payment_method_update); end
# Information about canceling subscriptions in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel))
}
def subscription_cancel; end
sig {
params(_subscription_cancel: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel))
}
def subscription_cancel=(_subscription_cancel); end
# Information about updating subscriptions in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate))
}
def subscription_update; end
sig {
params(_subscription_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate))
}
def subscription_update=(_subscription_update); end
sig {
params(customer_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::CustomerUpdate), invoice_history: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::InvoiceHistory), payment_method_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::PaymentMethodUpdate), subscription_cancel: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate)).void
}
def initialize(
customer_update: nil,
invoice_history: nil,
payment_method_update: nil,
subscription_cancel: nil,
subscription_update: nil
); end
end
class LoginPage < Stripe::RequestParams
# Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.
#
# Set to `false` to deactivate the `login_page.url`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
# Whether the configuration is active and can be used to create portal sessions.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# The business information shown to customers in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::BusinessProfile))
}
def business_profile; end
sig {
params(_business_profile: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::BusinessProfile)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::BusinessProfile))
}
def business_profile=(_business_profile); end
# The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
sig { returns(T.nilable(String)) }
def default_return_url; end
sig { params(_default_return_url: T.nilable(String)).returns(T.nilable(String)) }
def default_return_url=(_default_return_url); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Information about the features available in the portal.
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features))
}
def features=(_features); end
# The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
sig {
returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::LoginPage))
}
def login_page; end
sig {
params(_login_page: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::LoginPage)).returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::LoginPage))
}
def login_page=(_login_page); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The name of the configuration.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(active: T.nilable(T::Boolean), business_profile: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::BusinessProfile), default_return_url: T.nilable(String), expand: T.nilable(T::Array[String]), features: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features), login_page: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::LoginPage), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String)).void
}
def initialize(
active: nil,
business_profile: nil,
default_return_url: nil,
expand: nil,
features: nil,
login_page: nil,
metadata: nil,
name: nil
); end
end
# Creates a configuration that describes the functionality and behavior of a PortalSession
sig {
params(params: T.any(::Stripe::BillingPortal::ConfigurationService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BillingPortal::Configuration)
}
def create(params = {}, opts = {}); end
# Returns a list of configurations that describe the functionality of the customer portal.
sig {
params(params: T.any(::Stripe::BillingPortal::ConfigurationService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a configuration that describes the functionality of the customer portal.
sig {
params(configuration: String, params: T.any(::Stripe::BillingPortal::ConfigurationService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BillingPortal::Configuration)
}
def retrieve(configuration, params = {}, opts = {}); end
# Updates a configuration that describes the functionality of the customer portal.
sig {
params(configuration: String, params: T.any(::Stripe::BillingPortal::ConfigurationService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BillingPortal::Configuration)
}
def update(configuration, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module BillingPortal
class SessionService < StripeService
class CreateParams < Stripe::RequestParams
class FlowData < Stripe::RequestParams
class AfterCompletion < Stripe::RequestParams
class HostedConfirmation < Stripe::RequestParams
# A custom message to display to the customer after the flow is completed.
sig { returns(T.nilable(String)) }
def custom_message; end
sig { params(_custom_message: T.nilable(String)).returns(T.nilable(String)) }
def custom_message=(_custom_message); end
sig { params(custom_message: T.nilable(String)).void }
def initialize(custom_message: nil); end
end
class Redirect < Stripe::RequestParams
# The URL the customer will be redirected to after the flow is completed.
sig { returns(String) }
def return_url; end
sig { params(_return_url: String).returns(String) }
def return_url=(_return_url); end
sig { params(return_url: String).void }
def initialize(return_url: nil); end
end
# Configuration when `after_completion.type=hosted_confirmation`.
sig {
returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::HostedConfirmation))
}
def hosted_confirmation; end
sig {
params(_hosted_confirmation: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::HostedConfirmation)).returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::HostedConfirmation))
}
def hosted_confirmation=(_hosted_confirmation); end
# Configuration when `after_completion.type=redirect`.
sig {
returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::Redirect))
}
def redirect; end
sig {
params(_redirect: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::Redirect)).returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::Redirect))
}
def redirect=(_redirect); end
# The specified behavior after the flow is completed.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(hosted_confirmation: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::HostedConfirmation), redirect: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::Redirect), type: String).void
}
def initialize(hosted_confirmation: nil, redirect: nil, type: nil); end
end
class SubscriptionCancel < Stripe::RequestParams
class Retention < Stripe::RequestParams
class CouponOffer < Stripe::RequestParams
# The ID of the coupon to be offered.
sig { returns(String) }
def coupon; end
sig { params(_coupon: String).returns(String) }
def coupon=(_coupon); end
sig { params(coupon: String).void }
def initialize(coupon: nil); end
end
# Configuration when `retention.type=coupon_offer`.
sig {
returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel::Retention::CouponOffer)
}
def coupon_offer; end
sig {
params(_coupon_offer: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel::Retention::CouponOffer).returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel::Retention::CouponOffer)
}
def coupon_offer=(_coupon_offer); end
# Type of retention strategy to use with the customer.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(coupon_offer: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel::Retention::CouponOffer, type: String).void
}
def initialize(coupon_offer: nil, type: nil); end
end
# Specify a retention strategy to be used in the cancellation flow.
sig {
returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel::Retention))
}
def retention; end
sig {
params(_retention: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel::Retention)).returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel::Retention))
}
def retention=(_retention); end
# The ID of the subscription to be canceled.
sig { returns(String) }
def subscription; end
sig { params(_subscription: String).returns(String) }
def subscription=(_subscription); end
sig {
params(retention: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel::Retention), subscription: String).void
}
def initialize(retention: nil, subscription: nil); end
end
class SubscriptionUpdate < Stripe::RequestParams
# The ID of the subscription to be updated.
sig { returns(String) }
def subscription; end
sig { params(_subscription: String).returns(String) }
def subscription=(_subscription); end
sig { params(subscription: String).void }
def initialize(subscription: nil); end
end
class SubscriptionUpdateConfirm < Stripe::RequestParams
class Discount < Stripe::RequestParams
# The ID of the coupon to apply to this subscription update.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# The ID of a promotion code to apply to this subscription update.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig { params(coupon: T.nilable(String), promotion_code: T.nilable(String)).void }
def initialize(coupon: nil, promotion_code: nil); end
end
class Item < Stripe::RequestParams
# The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
# The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
sig {
params(id: String, price: T.nilable(String), quantity: T.nilable(Integer)).void
}
def initialize(id: nil, price: nil, quantity: nil); end
end
# The coupon or promotion code to apply to this subscription update.
sig {
returns(T.nilable(T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount])).returns(T.nilable(T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount]))
}
def discounts=(_discounts); end
# The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
sig {
returns(T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Item])
}
def items; end
sig {
params(_items: T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Item]).returns(T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Item])
}
def items=(_items); end
# The ID of the subscription to be updated.
sig { returns(String) }
def subscription; end
sig { params(_subscription: String).returns(String) }
def subscription=(_subscription); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount]), items: T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Item], subscription: String).void
}
def initialize(discounts: nil, items: nil, subscription: nil); end
end
# Behavior after the flow is completed.
sig {
returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion))
}
def after_completion; end
sig {
params(_after_completion: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion)).returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion))
}
def after_completion=(_after_completion); end
# Configuration when `flow_data.type=subscription_cancel`.
sig {
returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel))
}
def subscription_cancel; end
sig {
params(_subscription_cancel: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel)).returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel))
}
def subscription_cancel=(_subscription_cancel); end
# Configuration when `flow_data.type=subscription_update`.
sig {
returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdate))
}
def subscription_update; end
sig {
params(_subscription_update: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdate)).returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdate))
}
def subscription_update=(_subscription_update); end
# Configuration when `flow_data.type=subscription_update_confirm`.
sig {
returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm))
}
def subscription_update_confirm; end
sig {
params(_subscription_update_confirm: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm)).returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm))
}
def subscription_update_confirm=(_subscription_update_confirm); end
# Type of flow that the customer will go through.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(after_completion: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion), subscription_cancel: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdate), subscription_update_confirm: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm), type: String).void
}
def initialize(
after_completion: nil,
subscription_cancel: nil,
subscription_update: nil,
subscription_update_confirm: nil,
type: nil
); end
end
# The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
sig { returns(T.nilable(String)) }
def configuration; end
sig { params(_configuration: T.nilable(String)).returns(T.nilable(String)) }
def configuration=(_configuration); end
# The ID of an existing customer.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The ID of an existing account.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
sig { returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData)) }
def flow_data; end
sig {
params(_flow_data: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData)).returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData))
}
def flow_data=(_flow_data); end
# The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
sig { returns(T.nilable(String)) }
def locale; end
sig { params(_locale: T.nilable(String)).returns(T.nilable(String)) }
def locale=(_locale); end
# The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# The default URL to redirect customers to when they click on the portal's link to return to your website.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(configuration: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), expand: T.nilable(T::Array[String]), flow_data: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData), locale: T.nilable(String), on_behalf_of: T.nilable(String), return_url: T.nilable(String)).void
}
def initialize(
configuration: nil,
customer: nil,
customer_account: nil,
expand: nil,
flow_data: nil,
locale: nil,
on_behalf_of: nil,
return_url: nil
); end
end
# Creates a session of the customer portal.
sig {
params(params: T.any(::Stripe::BillingPortal::SessionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BillingPortal::Session)
}
def create(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class CapitalService < StripeService
attr_reader :financing_offers
attr_reader :financing_summary
attr_reader :financing_transactions
end
end
# typed: true
module Stripe
module Capital
class FinancingOfferService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# limit list to offers belonging to given connected account
sig { returns(T.nilable(String)) }
def connected_account; end
sig { params(_connected_account: T.nilable(String)).returns(T.nilable(String)) }
def connected_account=(_connected_account); end
# Only return offers that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Capital::FinancingOfferService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Capital::FinancingOfferService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Capital::FinancingOfferService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# limit list to offers with given status
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(connected_account: T.nilable(String), created: T.nilable(T.any(::Stripe::Capital::FinancingOfferService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
connected_account: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class MarkDeliveredParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Retrieves the financing offers available for Connected accounts that belong to your platform.
sig {
params(params: T.any(::Stripe::Capital::FinancingOfferService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Acknowledges that platform has received and delivered the financing_offer to
# the intended merchant recipient.
sig {
params(financing_offer: String, params: T.any(::Stripe::Capital::FinancingOfferService::MarkDeliveredParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Capital::FinancingOffer)
}
def mark_delivered(financing_offer, params = {}, opts = {}); end
# Get the details of the financing offer
sig {
params(financing_offer: String, params: T.any(::Stripe::Capital::FinancingOfferService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Capital::FinancingOffer)
}
def retrieve(financing_offer, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Capital
class FinancingSummaryService < StripeService
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Retrieve the financing state for the account that was authenticated in the request.
sig {
params(params: T.any(::Stripe::Capital::FinancingSummaryService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Capital::FinancingSummary)
}
def retrieve(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Capital
class FinancingTransactionService < StripeService
class ListParams < Stripe::RequestParams
# For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this charge.
sig { returns(T.nilable(String)) }
def charge; end
sig { params(_charge: T.nilable(String)).returns(T.nilable(String)) }
def charge=(_charge); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Returns transactions that were created that apply to this financing offer ID.
sig { returns(T.nilable(String)) }
def financing_offer; end
sig { params(_financing_offer: T.nilable(String)).returns(T.nilable(String)) }
def financing_offer=(_financing_offer); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only returns transactions that are responsible for reversing this financing transaction ID.
sig { returns(T.nilable(String)) }
def reversed_transaction; end
sig { params(_reversed_transaction: T.nilable(String)).returns(T.nilable(String)) }
def reversed_transaction=(_reversed_transaction); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this Treasury Transaction.
sig { returns(T.nilable(String)) }
def treasury_transaction; end
sig { params(_treasury_transaction: T.nilable(String)).returns(T.nilable(String)) }
def treasury_transaction=(_treasury_transaction); end
sig {
params(charge: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financing_offer: T.nilable(String), limit: T.nilable(Integer), reversed_transaction: T.nilable(String), starting_after: T.nilable(String), treasury_transaction: T.nilable(String)).void
}
def initialize(
charge: nil,
ending_before: nil,
expand: nil,
financing_offer: nil,
limit: nil,
reversed_transaction: nil,
starting_after: nil,
treasury_transaction: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of financing transactions. The transactions are returned in sorted order,
# with the most recent transactions appearing first.
sig {
params(params: T.any(::Stripe::Capital::FinancingTransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a financing transaction for a financing offer.
sig {
params(financing_transaction: String, params: T.any(::Stripe::Capital::FinancingTransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Capital::FinancingTransaction)
}
def retrieve(financing_transaction, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class ChargeService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return charges that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::ChargeService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::ChargeService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::ChargeService::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return charges for the customer specified by this customer ID.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return charges for this transfer group, limited to 100.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(created: T.nilable(T.any(::Stripe::ChargeService::ListParams::Created, Integer)), customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_intent: T.nilable(String), starting_after: T.nilable(String), transfer_group: T.nilable(String)).void
}
def initialize(
created: nil,
customer: nil,
ending_before: nil,
expand: nil,
limit: nil,
payment_intent: nil,
starting_after: nil,
transfer_group: nil
); end
end
class CreateParams < Stripe::RequestParams
class Destination < Stripe::RequestParams
# ID of an existing, connected Stripe account.
sig { returns(String) }
def account; end
sig { params(_account: String).returns(String) }
def account=(_account); end
# The amount to transfer to the destination account without creating an `Application Fee` object. Cannot be combined with the `application_fee` parameter. Must be less than or equal to the charge amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
sig { params(account: String, amount: T.nilable(Integer)).void }
def initialize(account: nil, amount: nil); end
end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address.
sig { returns(::Stripe::ChargeService::CreateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::ChargeService::CreateParams::Shipping::Address).returns(::Stripe::ChargeService::CreateParams::Shipping::Address)
}
def address=(_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
sig { params(_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def tracking_number=(_tracking_number); end
sig {
params(address: ::Stripe::ChargeService::CreateParams::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
}
def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
end
class TransferData < Stripe::RequestParams
# The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Attribute for param field application_fee
sig { returns(T.nilable(Integer)) }
def application_fee; end
sig { params(_application_fee: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee=(_application_fee); end
# A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation.
sig { returns(T.nilable(T::Boolean)) }
def capture; end
sig { params(_capture: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def capture=(_capture); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The ID of an existing customer that will be charged in this request.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Attribute for param field destination
sig { returns(T.nilable(::Stripe::ChargeService::CreateParams::Destination)) }
def destination; end
sig {
params(_destination: T.nilable(::Stripe::ChargeService::CreateParams::Destination)).returns(T.nilable(::Stripe::ChargeService::CreateParams::Destination))
}
def destination=(_destination); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant).
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig { returns(T.nilable(::Stripe::ChargeService::CreateParams::RadarOptions)) }
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::ChargeService::CreateParams::RadarOptions)).returns(T.nilable(::Stripe::ChargeService::CreateParams::RadarOptions))
}
def radar_options=(_radar_options); end
# The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
sig { returns(T.nilable(String)) }
def receipt_email; end
sig { params(_receipt_email: T.nilable(String)).returns(T.nilable(String)) }
def receipt_email=(_receipt_email); end
# Shipping information for the charge. Helps prevent fraud on charges for physical goods.
sig { returns(T.nilable(::Stripe::ChargeService::CreateParams::Shipping)) }
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::ChargeService::CreateParams::Shipping)).returns(T.nilable(::Stripe::ChargeService::CreateParams::Shipping))
}
def shipping=(_shipping); end
# A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer.
sig { returns(T.nilable(String)) }
def source; end
sig { params(_source: T.nilable(String)).returns(T.nilable(String)) }
def source=(_source); end
# For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
sig { returns(T.nilable(::Stripe::ChargeService::CreateParams::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::ChargeService::CreateParams::TransferData)).returns(T.nilable(::Stripe::ChargeService::CreateParams::TransferData))
}
def transfer_data=(_transfer_data); end
# A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options).
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(amount: T.nilable(Integer), application_fee: T.nilable(Integer), application_fee_amount: T.nilable(Integer), capture: T.nilable(T::Boolean), currency: T.nilable(String), customer: T.nilable(String), description: T.nilable(String), destination: T.nilable(::Stripe::ChargeService::CreateParams::Destination), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), on_behalf_of: T.nilable(String), radar_options: T.nilable(::Stripe::ChargeService::CreateParams::RadarOptions), receipt_email: T.nilable(String), shipping: T.nilable(::Stripe::ChargeService::CreateParams::Shipping), source: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::ChargeService::CreateParams::TransferData), transfer_group: T.nilable(String)).void
}
def initialize(
amount: nil,
application_fee: nil,
application_fee_amount: nil,
capture: nil,
currency: nil,
customer: nil,
description: nil,
destination: nil,
expand: nil,
metadata: nil,
on_behalf_of: nil,
radar_options: nil,
receipt_email: nil,
shipping: nil,
source: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil,
transfer_group: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class FraudDetails < Stripe::RequestParams
# Either `safe` or `fraudulent`.
sig { returns(T.any(String, String)) }
def user_report; end
sig { params(_user_report: T.any(String, String)).returns(T.any(String, String)) }
def user_report=(_user_report); end
sig { params(user_report: T.any(String, String)).void }
def initialize(user_report: nil); end
end
class PaymentDetails < Stripe::RequestParams
class CarRental < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Distance < Stripe::RequestParams
# Distance traveled.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
sig { params(amount: T.nilable(Integer), unit: T.nilable(String)).void }
def initialize(amount: nil, unit: nil); end
end
class Driver < Stripe::RequestParams
# Driver's identification number.
sig { returns(T.nilable(String)) }
def driver_identification_number; end
sig {
params(_driver_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def driver_identification_number=(_driver_identification_number); end
# Driver's tax number.
sig { returns(T.nilable(String)) }
def driver_tax_number; end
sig { params(_driver_tax_number: T.nilable(String)).returns(T.nilable(String)) }
def driver_tax_number=(_driver_tax_number); end
# Full name of the person or entity on the car reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(driver_identification_number: T.nilable(String), driver_tax_number: T.nilable(String), name: String).void
}
def initialize(
driver_identification_number: nil,
driver_tax_number: nil,
name: nil
); end
end
class PickupAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class ReturnAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Affiliate)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the car rental.
sig { returns(String) }
def booking_number; end
sig { params(_booking_number: String).returns(String) }
def booking_number=(_booking_number); end
# Class code of the car.
sig { returns(T.nilable(String)) }
def car_class_code; end
sig { params(_car_class_code: T.nilable(String)).returns(T.nilable(String)) }
def car_class_code=(_car_class_code); end
# Make of the car.
sig { returns(T.nilable(String)) }
def car_make; end
sig { params(_car_make: T.nilable(String)).returns(T.nilable(String)) }
def car_make=(_car_make); end
# Model of the car.
sig { returns(T.nilable(String)) }
def car_model; end
sig { params(_car_model: T.nilable(String)).returns(T.nilable(String)) }
def car_model=(_car_model); end
# The name of the rental car company.
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# The customer service phone number of the car rental company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# Number of days the car is being rented.
sig { returns(Integer) }
def days_rented; end
sig { params(_days_rented: Integer).returns(Integer) }
def days_rented=(_days_rented); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Delivery)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Delivery))
}
def delivery=(_delivery); end
# The details of the distance traveled during the rental period.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Distance))
}
def distance; end
sig {
params(_distance: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Distance)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Distance))
}
def distance=(_distance); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Driver]))
}
def drivers; end
sig {
params(_drivers: T.nilable(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Driver])).returns(T.nilable(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Driver]))
}
def drivers=(_drivers); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates if the customer did not keep nor cancel their booking.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# Car pick-up address.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address; end
sig {
params(_pickup_address: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::PickupAddress)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address=(_pickup_address); end
# Car pick-up time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def pickup_at; end
sig { params(_pickup_at: Integer).returns(Integer) }
def pickup_at=(_pickup_at); end
# Name of the pickup location.
sig { returns(T.nilable(String)) }
def pickup_location_name; end
sig { params(_pickup_location_name: T.nilable(String)).returns(T.nilable(String)) }
def pickup_location_name=(_pickup_location_name); end
# Rental rate.
sig { returns(T.nilable(Integer)) }
def rate_amount; end
sig { params(_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def rate_amount=(_rate_amount); end
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
sig { returns(T.nilable(String)) }
def rate_interval; end
sig { params(_rate_interval: T.nilable(String)).returns(T.nilable(String)) }
def rate_interval=(_rate_interval); end
# The name of the person or entity renting the car.
sig { returns(T.nilable(String)) }
def renter_name; end
sig { params(_renter_name: T.nilable(String)).returns(T.nilable(String)) }
def renter_name=(_renter_name); end
# Car return address.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address; end
sig {
params(_return_address: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::ReturnAddress)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address=(_return_address); end
# Car return time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def return_at; end
sig { params(_return_at: Integer).returns(Integer) }
def return_at=(_return_at); end
# Name of the return location.
sig { returns(T.nilable(String)) }
def return_location_name; end
sig { params(_return_location_name: T.nilable(String)).returns(T.nilable(String)) }
def return_location_name=(_return_location_name); end
# Indicates whether the goods or services are tax-exempt or tax is not collected.
sig { returns(T.nilable(T::Boolean)) }
def tax_exempt; end
sig { params(_tax_exempt: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def tax_exempt=(_tax_exempt); end
# The vehicle identification number.
sig { returns(T.nilable(String)) }
def vehicle_identification_number; end
sig {
params(_vehicle_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def vehicle_identification_number=(_vehicle_identification_number); end
sig {
params(affiliate: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Affiliate), booking_number: String, car_class_code: T.nilable(String), car_make: T.nilable(String), car_model: T.nilable(String), company: T.nilable(String), customer_service_phone_number: T.nilable(String), days_rented: Integer, delivery: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Delivery), distance: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Distance), drivers: T.nilable(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::Driver]), extra_charges: T.nilable(T::Array[String]), no_show: T.nilable(T::Boolean), pickup_address: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::PickupAddress), pickup_at: Integer, pickup_location_name: T.nilable(String), rate_amount: T.nilable(Integer), rate_interval: T.nilable(String), renter_name: T.nilable(String), return_address: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental::ReturnAddress), return_at: Integer, return_location_name: T.nilable(String), tax_exempt: T.nilable(T::Boolean), vehicle_identification_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
booking_number: nil,
car_class_code: nil,
car_make: nil,
car_model: nil,
company: nil,
customer_service_phone_number: nil,
days_rented: nil,
delivery: nil,
distance: nil,
drivers: nil,
extra_charges: nil,
no_show: nil,
pickup_address: nil,
pickup_at: nil,
pickup_location_name: nil,
rate_amount: nil,
rate_interval: nil,
renter_name: nil,
return_address: nil,
return_at: nil,
return_location_name: nil,
tax_exempt: nil,
vehicle_identification_number: nil
); end
end
class EventDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
# Indicates if the tickets are digitally checked when entering the venue.
sig { returns(T.nilable(T::Boolean)) }
def access_controlled_venue; end
sig {
params(_access_controlled_venue: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def access_controlled_venue=(_access_controlled_venue); end
# The event location's address.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Address)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Address))
}
def address=(_address); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Affiliate)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate=(_affiliate); end
# The name of the company
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Delivery)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Delivery))
}
def delivery=(_delivery); end
# Event end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Type of the event entertainment (concert, sports event etc)
sig { returns(T.nilable(String)) }
def genre; end
sig { params(_genre: T.nilable(String)).returns(T.nilable(String)) }
def genre=(_genre); end
# The name of the event.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Event start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(access_controlled_venue: T.nilable(T::Boolean), address: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Address), affiliate: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Affiliate), company: T.nilable(String), delivery: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails::Delivery), ends_at: T.nilable(Integer), genre: T.nilable(String), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
access_controlled_venue: nil,
address: nil,
affiliate: nil,
company: nil,
delivery: nil,
ends_at: nil,
genre: nil,
name: nil,
starts_at: nil
); end
end
class Flight < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Delivery::Recipient)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the flight reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Segment < Stripe::RequestParams
# The flight segment amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The International Air Transport Association (IATA) airport code for the arrival airport.
sig { returns(T.nilable(String)) }
def arrival_airport; end
sig { params(_arrival_airport: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport=(_arrival_airport); end
# The arrival time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def arrives_at; end
sig { params(_arrives_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def arrives_at=(_arrives_at); end
# The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The departure time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def departs_at; end
sig { params(_departs_at: Integer).returns(Integer) }
def departs_at=(_departs_at); end
# The International Air Transport Association (IATA) airport code for the departure airport.
sig { returns(T.nilable(String)) }
def departure_airport; end
sig { params(_departure_airport: T.nilable(String)).returns(T.nilable(String)) }
def departure_airport=(_departure_airport); end
# The flight number associated with the segment
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The fare class for the segment.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
sig {
params(amount: T.nilable(Integer), arrival_airport: T.nilable(String), arrives_at: T.nilable(Integer), carrier: T.nilable(String), departs_at: Integer, departure_airport: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String)).void
}
def initialize(
amount: nil,
arrival_airport: nil,
arrives_at: nil,
carrier: nil,
departs_at: nil,
departure_airport: nil,
flight_number: nil,
service_class: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Affiliate)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Affiliate))
}
def affiliate=(_affiliate); end
# The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
sig { returns(T.nilable(String)) }
def agency_number; end
sig { params(_agency_number: T.nilable(String)).returns(T.nilable(String)) }
def agency_number=(_agency_number); end
# The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Delivery)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Delivery))
}
def delivery=(_delivery); end
# The name of the person or entity on the reservation.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# The details of the passengers in the travel reservation.
sig {
returns(T.nilable(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Passenger])).returns(T.nilable(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Passenger]))
}
def passengers=(_passengers); end
# The individual flight segments associated with the trip.
sig {
returns(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Segment])
}
def segments; end
sig {
params(_segments: T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Segment]).returns(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Segment])
}
def segments=(_segments); end
# The ticket number associated with the travel reservation.
sig { returns(T.nilable(String)) }
def ticket_number; end
sig { params(_ticket_number: T.nilable(String)).returns(T.nilable(String)) }
def ticket_number=(_ticket_number); end
sig {
params(affiliate: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Affiliate), agency_number: T.nilable(String), carrier: T.nilable(String), delivery: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Delivery), passenger_name: T.nilable(String), passengers: T.nilable(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Passenger]), segments: T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight::Segment], ticket_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
agency_number: nil,
carrier: nil,
delivery: nil,
passenger_name: nil,
passengers: nil,
segments: nil,
ticket_number: nil
); end
end
class Lodging < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the lodging reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
# The lodging location's address.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Address)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Address))
}
def address=(_address); end
# The number of adults on the booking
sig { returns(T.nilable(Integer)) }
def adults; end
sig { params(_adults: T.nilable(Integer)).returns(T.nilable(Integer)) }
def adults=(_adults); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Affiliate)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the lodging reservation.
sig { returns(T.nilable(String)) }
def booking_number; end
sig { params(_booking_number: T.nilable(String)).returns(T.nilable(String)) }
def booking_number=(_booking_number); end
# The lodging category
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Lodging check-in time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkin_at; end
sig { params(_checkin_at: Integer).returns(Integer) }
def checkin_at=(_checkin_at); end
# Lodging check-out time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkout_at; end
sig { params(_checkout_at: Integer).returns(Integer) }
def checkout_at=(_checkout_at); end
# The customer service phone number of the lodging company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# The daily lodging room rate.
sig { returns(T.nilable(Integer)) }
def daily_room_rate_amount; end
sig { params(_daily_room_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def daily_room_rate_amount=(_daily_room_rate_amount); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Delivery)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Delivery))
}
def delivery=(_delivery); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates whether the lodging location is compliant with the Fire Safety Act.
sig { returns(T.nilable(T::Boolean)) }
def fire_safety_act_compliance; end
sig {
params(_fire_safety_act_compliance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def fire_safety_act_compliance=(_fire_safety_act_compliance); end
# The name of the lodging location.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Indicates if the customer did not keep their booking while failing to cancel the reservation.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# The number of rooms on the booking
sig { returns(T.nilable(Integer)) }
def number_of_rooms; end
sig { params(_number_of_rooms: T.nilable(Integer)).returns(T.nilable(Integer)) }
def number_of_rooms=(_number_of_rooms); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Passenger])).returns(T.nilable(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Passenger]))
}
def passengers=(_passengers); end
# The phone number of the lodging location.
sig { returns(T.nilable(String)) }
def property_phone_number; end
sig { params(_property_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def property_phone_number=(_property_phone_number); end
# The room class for this purchase.
sig { returns(T.nilable(String)) }
def room_class; end
sig { params(_room_class: T.nilable(String)).returns(T.nilable(String)) }
def room_class=(_room_class); end
# The number of room nights
sig { returns(T.nilable(Integer)) }
def room_nights; end
sig { params(_room_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def room_nights=(_room_nights); end
# The total tax amount associating with the room reservation.
sig { returns(T.nilable(Integer)) }
def total_room_tax_amount; end
sig { params(_total_room_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_room_tax_amount=(_total_room_tax_amount); end
# The total tax amount
sig { returns(T.nilable(Integer)) }
def total_tax_amount; end
sig { params(_total_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_tax_amount=(_total_tax_amount); end
sig {
params(address: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Address), adults: T.nilable(Integer), affiliate: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Affiliate), booking_number: T.nilable(String), category: T.nilable(String), checkin_at: Integer, checkout_at: Integer, customer_service_phone_number: T.nilable(String), daily_room_rate_amount: T.nilable(Integer), delivery: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Delivery), extra_charges: T.nilable(T::Array[String]), fire_safety_act_compliance: T.nilable(T::Boolean), name: T.nilable(String), no_show: T.nilable(T::Boolean), number_of_rooms: T.nilable(Integer), passengers: T.nilable(T::Array[::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging::Passenger]), property_phone_number: T.nilable(String), room_class: T.nilable(String), room_nights: T.nilable(Integer), total_room_tax_amount: T.nilable(Integer), total_tax_amount: T.nilable(Integer)).void
}
def initialize(
address: nil,
adults: nil,
affiliate: nil,
booking_number: nil,
category: nil,
checkin_at: nil,
checkout_at: nil,
customer_service_phone_number: nil,
daily_room_rate_amount: nil,
delivery: nil,
extra_charges: nil,
fire_safety_act_compliance: nil,
name: nil,
no_show: nil,
number_of_rooms: nil,
passengers: nil,
property_phone_number: nil,
room_class: nil,
room_nights: nil,
total_room_tax_amount: nil,
total_tax_amount: nil
); end
end
class Subscription < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class BillingInterval < Stripe::RequestParams
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def count; end
sig { params(_count: Integer).returns(Integer) }
def count=(_count); end
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig { params(count: Integer, interval: String).void }
def initialize(count: nil, interval: nil); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription::Affiliate)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate=(_affiliate); end
# Info whether the subscription will be auto renewed upon expiry.
sig { returns(T.nilable(T::Boolean)) }
def auto_renewal; end
sig { params(_auto_renewal: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_renewal=(_auto_renewal); end
# Subscription billing details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval; end
sig {
params(_billing_interval: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription::BillingInterval)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval=(_billing_interval); end
# Subscription end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Name of the product on subscription. e.g. Apple Music Subscription
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Subscription start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(affiliate: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription::Affiliate), auto_renewal: T.nilable(T::Boolean), billing_interval: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription::BillingInterval), ends_at: T.nilable(Integer), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
affiliate: nil,
auto_renewal: nil,
billing_interval: nil,
ends_at: nil,
name: nil,
starts_at: nil
); end
end
# Car rental details for this PaymentIntent.
sig { returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental)) }
def car_rental; end
sig {
params(_car_rental: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental))
}
def car_rental=(_car_rental); end
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
sig { returns(T.nilable(String)) }
def customer_reference; end
sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) }
def customer_reference=(_customer_reference); end
# Event details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails))
}
def event_details; end
sig {
params(_event_details: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails))
}
def event_details=(_event_details); end
# Flight reservation details for this PaymentIntent
sig { returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight)) }
def flight; end
sig {
params(_flight: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight))
}
def flight=(_flight); end
# Lodging reservation details for this PaymentIntent
sig { returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging)) }
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging))
}
def lodging=(_lodging); end
# A unique value assigned by the business to identify the transaction.
sig { returns(T.nilable(String)) }
def order_reference; end
sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) }
def order_reference=(_order_reference); end
# Subscription details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription))
}
def subscription; end
sig {
params(_subscription: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription))
}
def subscription=(_subscription); end
sig {
params(car_rental: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::CarRental), customer_reference: T.nilable(String), event_details: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::EventDetails), flight: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Flight), lodging: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Lodging), order_reference: T.nilable(String), subscription: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails::Subscription)).void
}
def initialize(
car_rental: nil,
customer_reference: nil,
event_details: nil,
flight: nil,
lodging: nil,
order_reference: nil,
subscription: nil
); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address.
sig { returns(::Stripe::ChargeService::UpdateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::ChargeService::UpdateParams::Shipping::Address).returns(::Stripe::ChargeService::UpdateParams::Shipping::Address)
}
def address=(_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
sig { params(_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def tracking_number=(_tracking_number); end
sig {
params(address: ::Stripe::ChargeService::UpdateParams::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
}
def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
end
# The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms.
sig { returns(T.nilable(::Stripe::ChargeService::UpdateParams::FraudDetails)) }
def fraud_details; end
sig {
params(_fraud_details: T.nilable(::Stripe::ChargeService::UpdateParams::FraudDetails)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::FraudDetails))
}
def fraud_details=(_fraud_details); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Provides industry-specific information about the charge.
sig { returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails)) }
def payment_details; end
sig {
params(_payment_details: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails))
}
def payment_details=(_payment_details); end
# This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.
sig { returns(T.nilable(String)) }
def receipt_email; end
sig { params(_receipt_email: T.nilable(String)).returns(T.nilable(String)) }
def receipt_email=(_receipt_email); end
# Shipping information for the charge. Helps prevent fraud on charges for physical goods.
sig { returns(T.nilable(::Stripe::ChargeService::UpdateParams::Shipping)) }
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::ChargeService::UpdateParams::Shipping)).returns(T.nilable(::Stripe::ChargeService::UpdateParams::Shipping))
}
def shipping=(_shipping); end
# A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(customer: T.nilable(String), description: T.nilable(String), expand: T.nilable(T::Array[String]), fraud_details: T.nilable(::Stripe::ChargeService::UpdateParams::FraudDetails), metadata: T.nilable(T.any(String, T::Hash[String, String])), payment_details: T.nilable(::Stripe::ChargeService::UpdateParams::PaymentDetails), receipt_email: T.nilable(String), shipping: T.nilable(::Stripe::ChargeService::UpdateParams::Shipping), transfer_group: T.nilable(String)).void
}
def initialize(
customer: nil,
description: nil,
expand: nil,
fraud_details: nil,
metadata: nil,
payment_details: nil,
receipt_email: nil,
shipping: nil,
transfer_group: nil
); end
end
class SearchParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
sig { returns(T.nilable(String)) }
def page; end
sig { params(_page: T.nilable(String)).returns(T.nilable(String)) }
def page=(_page); end
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for charges](https://stripe.com/docs/search#query-fields-for-charges).
sig { returns(String) }
def query; end
sig { params(_query: String).returns(String) }
def query=(_query); end
sig {
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
}
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
end
class CaptureParams < Stripe::RequestParams
class PaymentDetails < Stripe::RequestParams
class CarRental < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Distance < Stripe::RequestParams
# Distance traveled.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
sig { params(amount: T.nilable(Integer), unit: T.nilable(String)).void }
def initialize(amount: nil, unit: nil); end
end
class Driver < Stripe::RequestParams
# Driver's identification number.
sig { returns(T.nilable(String)) }
def driver_identification_number; end
sig {
params(_driver_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def driver_identification_number=(_driver_identification_number); end
# Driver's tax number.
sig { returns(T.nilable(String)) }
def driver_tax_number; end
sig { params(_driver_tax_number: T.nilable(String)).returns(T.nilable(String)) }
def driver_tax_number=(_driver_tax_number); end
# Full name of the person or entity on the car reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(driver_identification_number: T.nilable(String), driver_tax_number: T.nilable(String), name: String).void
}
def initialize(
driver_identification_number: nil,
driver_tax_number: nil,
name: nil
); end
end
class PickupAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class ReturnAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Affiliate)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the car rental.
sig { returns(String) }
def booking_number; end
sig { params(_booking_number: String).returns(String) }
def booking_number=(_booking_number); end
# Class code of the car.
sig { returns(T.nilable(String)) }
def car_class_code; end
sig { params(_car_class_code: T.nilable(String)).returns(T.nilable(String)) }
def car_class_code=(_car_class_code); end
# Make of the car.
sig { returns(T.nilable(String)) }
def car_make; end
sig { params(_car_make: T.nilable(String)).returns(T.nilable(String)) }
def car_make=(_car_make); end
# Model of the car.
sig { returns(T.nilable(String)) }
def car_model; end
sig { params(_car_model: T.nilable(String)).returns(T.nilable(String)) }
def car_model=(_car_model); end
# The name of the rental car company.
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# The customer service phone number of the car rental company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# Number of days the car is being rented.
sig { returns(Integer) }
def days_rented; end
sig { params(_days_rented: Integer).returns(Integer) }
def days_rented=(_days_rented); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Delivery)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Delivery))
}
def delivery=(_delivery); end
# The details of the distance traveled during the rental period.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Distance))
}
def distance; end
sig {
params(_distance: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Distance)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Distance))
}
def distance=(_distance); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Driver]))
}
def drivers; end
sig {
params(_drivers: T.nilable(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Driver])).returns(T.nilable(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Driver]))
}
def drivers=(_drivers); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates if the customer did not keep nor cancel their booking.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# Car pick-up address.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address; end
sig {
params(_pickup_address: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::PickupAddress)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address=(_pickup_address); end
# Car pick-up time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def pickup_at; end
sig { params(_pickup_at: Integer).returns(Integer) }
def pickup_at=(_pickup_at); end
# Name of the pickup location.
sig { returns(T.nilable(String)) }
def pickup_location_name; end
sig { params(_pickup_location_name: T.nilable(String)).returns(T.nilable(String)) }
def pickup_location_name=(_pickup_location_name); end
# Rental rate.
sig { returns(T.nilable(Integer)) }
def rate_amount; end
sig { params(_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def rate_amount=(_rate_amount); end
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
sig { returns(T.nilable(String)) }
def rate_interval; end
sig { params(_rate_interval: T.nilable(String)).returns(T.nilable(String)) }
def rate_interval=(_rate_interval); end
# The name of the person or entity renting the car.
sig { returns(T.nilable(String)) }
def renter_name; end
sig { params(_renter_name: T.nilable(String)).returns(T.nilable(String)) }
def renter_name=(_renter_name); end
# Car return address.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address; end
sig {
params(_return_address: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::ReturnAddress)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address=(_return_address); end
# Car return time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def return_at; end
sig { params(_return_at: Integer).returns(Integer) }
def return_at=(_return_at); end
# Name of the return location.
sig { returns(T.nilable(String)) }
def return_location_name; end
sig { params(_return_location_name: T.nilable(String)).returns(T.nilable(String)) }
def return_location_name=(_return_location_name); end
# Indicates whether the goods or services are tax-exempt or tax is not collected.
sig { returns(T.nilable(T::Boolean)) }
def tax_exempt; end
sig { params(_tax_exempt: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def tax_exempt=(_tax_exempt); end
# The vehicle identification number.
sig { returns(T.nilable(String)) }
def vehicle_identification_number; end
sig {
params(_vehicle_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def vehicle_identification_number=(_vehicle_identification_number); end
sig {
params(affiliate: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Affiliate), booking_number: String, car_class_code: T.nilable(String), car_make: T.nilable(String), car_model: T.nilable(String), company: T.nilable(String), customer_service_phone_number: T.nilable(String), days_rented: Integer, delivery: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Delivery), distance: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Distance), drivers: T.nilable(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::Driver]), extra_charges: T.nilable(T::Array[String]), no_show: T.nilable(T::Boolean), pickup_address: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::PickupAddress), pickup_at: Integer, pickup_location_name: T.nilable(String), rate_amount: T.nilable(Integer), rate_interval: T.nilable(String), renter_name: T.nilable(String), return_address: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental::ReturnAddress), return_at: Integer, return_location_name: T.nilable(String), tax_exempt: T.nilable(T::Boolean), vehicle_identification_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
booking_number: nil,
car_class_code: nil,
car_make: nil,
car_model: nil,
company: nil,
customer_service_phone_number: nil,
days_rented: nil,
delivery: nil,
distance: nil,
drivers: nil,
extra_charges: nil,
no_show: nil,
pickup_address: nil,
pickup_at: nil,
pickup_location_name: nil,
rate_amount: nil,
rate_interval: nil,
renter_name: nil,
return_address: nil,
return_at: nil,
return_location_name: nil,
tax_exempt: nil,
vehicle_identification_number: nil
); end
end
class EventDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
# Indicates if the tickets are digitally checked when entering the venue.
sig { returns(T.nilable(T::Boolean)) }
def access_controlled_venue; end
sig {
params(_access_controlled_venue: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def access_controlled_venue=(_access_controlled_venue); end
# The event location's address.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Address)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Address))
}
def address=(_address); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Affiliate)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate=(_affiliate); end
# The name of the company
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Delivery)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Delivery))
}
def delivery=(_delivery); end
# Event end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Type of the event entertainment (concert, sports event etc)
sig { returns(T.nilable(String)) }
def genre; end
sig { params(_genre: T.nilable(String)).returns(T.nilable(String)) }
def genre=(_genre); end
# The name of the event.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Event start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(access_controlled_venue: T.nilable(T::Boolean), address: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Address), affiliate: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Affiliate), company: T.nilable(String), delivery: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails::Delivery), ends_at: T.nilable(Integer), genre: T.nilable(String), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
access_controlled_venue: nil,
address: nil,
affiliate: nil,
company: nil,
delivery: nil,
ends_at: nil,
genre: nil,
name: nil,
starts_at: nil
); end
end
class Flight < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Delivery::Recipient)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the flight reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Segment < Stripe::RequestParams
# The flight segment amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The International Air Transport Association (IATA) airport code for the arrival airport.
sig { returns(T.nilable(String)) }
def arrival_airport; end
sig { params(_arrival_airport: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport=(_arrival_airport); end
# The arrival time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def arrives_at; end
sig { params(_arrives_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def arrives_at=(_arrives_at); end
# The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The departure time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def departs_at; end
sig { params(_departs_at: Integer).returns(Integer) }
def departs_at=(_departs_at); end
# The International Air Transport Association (IATA) airport code for the departure airport.
sig { returns(T.nilable(String)) }
def departure_airport; end
sig { params(_departure_airport: T.nilable(String)).returns(T.nilable(String)) }
def departure_airport=(_departure_airport); end
# The flight number associated with the segment
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The fare class for the segment.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
sig {
params(amount: T.nilable(Integer), arrival_airport: T.nilable(String), arrives_at: T.nilable(Integer), carrier: T.nilable(String), departs_at: Integer, departure_airport: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String)).void
}
def initialize(
amount: nil,
arrival_airport: nil,
arrives_at: nil,
carrier: nil,
departs_at: nil,
departure_airport: nil,
flight_number: nil,
service_class: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Affiliate)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Affiliate))
}
def affiliate=(_affiliate); end
# The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
sig { returns(T.nilable(String)) }
def agency_number; end
sig { params(_agency_number: T.nilable(String)).returns(T.nilable(String)) }
def agency_number=(_agency_number); end
# The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Delivery)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Delivery))
}
def delivery=(_delivery); end
# The name of the person or entity on the reservation.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# The details of the passengers in the travel reservation.
sig {
returns(T.nilable(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Passenger])).returns(T.nilable(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Passenger]))
}
def passengers=(_passengers); end
# The individual flight segments associated with the trip.
sig {
returns(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Segment])
}
def segments; end
sig {
params(_segments: T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Segment]).returns(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Segment])
}
def segments=(_segments); end
# The ticket number associated with the travel reservation.
sig { returns(T.nilable(String)) }
def ticket_number; end
sig { params(_ticket_number: T.nilable(String)).returns(T.nilable(String)) }
def ticket_number=(_ticket_number); end
sig {
params(affiliate: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Affiliate), agency_number: T.nilable(String), carrier: T.nilable(String), delivery: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Delivery), passenger_name: T.nilable(String), passengers: T.nilable(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Passenger]), segments: T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight::Segment], ticket_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
agency_number: nil,
carrier: nil,
delivery: nil,
passenger_name: nil,
passengers: nil,
segments: nil,
ticket_number: nil
); end
end
class Lodging < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the lodging reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
# The lodging location's address.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Address)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Address))
}
def address=(_address); end
# The number of adults on the booking
sig { returns(T.nilable(Integer)) }
def adults; end
sig { params(_adults: T.nilable(Integer)).returns(T.nilable(Integer)) }
def adults=(_adults); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Affiliate)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the lodging reservation.
sig { returns(T.nilable(String)) }
def booking_number; end
sig { params(_booking_number: T.nilable(String)).returns(T.nilable(String)) }
def booking_number=(_booking_number); end
# The lodging category
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Lodging check-in time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkin_at; end
sig { params(_checkin_at: Integer).returns(Integer) }
def checkin_at=(_checkin_at); end
# Lodging check-out time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkout_at; end
sig { params(_checkout_at: Integer).returns(Integer) }
def checkout_at=(_checkout_at); end
# The customer service phone number of the lodging company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# The daily lodging room rate.
sig { returns(T.nilable(Integer)) }
def daily_room_rate_amount; end
sig { params(_daily_room_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def daily_room_rate_amount=(_daily_room_rate_amount); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Delivery)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Delivery))
}
def delivery=(_delivery); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates whether the lodging location is compliant with the Fire Safety Act.
sig { returns(T.nilable(T::Boolean)) }
def fire_safety_act_compliance; end
sig {
params(_fire_safety_act_compliance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def fire_safety_act_compliance=(_fire_safety_act_compliance); end
# The name of the lodging location.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Indicates if the customer did not keep their booking while failing to cancel the reservation.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# The number of rooms on the booking
sig { returns(T.nilable(Integer)) }
def number_of_rooms; end
sig { params(_number_of_rooms: T.nilable(Integer)).returns(T.nilable(Integer)) }
def number_of_rooms=(_number_of_rooms); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Passenger])).returns(T.nilable(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Passenger]))
}
def passengers=(_passengers); end
# The phone number of the lodging location.
sig { returns(T.nilable(String)) }
def property_phone_number; end
sig { params(_property_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def property_phone_number=(_property_phone_number); end
# The room class for this purchase.
sig { returns(T.nilable(String)) }
def room_class; end
sig { params(_room_class: T.nilable(String)).returns(T.nilable(String)) }
def room_class=(_room_class); end
# The number of room nights
sig { returns(T.nilable(Integer)) }
def room_nights; end
sig { params(_room_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def room_nights=(_room_nights); end
# The total tax amount associating with the room reservation.
sig { returns(T.nilable(Integer)) }
def total_room_tax_amount; end
sig { params(_total_room_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_room_tax_amount=(_total_room_tax_amount); end
# The total tax amount
sig { returns(T.nilable(Integer)) }
def total_tax_amount; end
sig { params(_total_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_tax_amount=(_total_tax_amount); end
sig {
params(address: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Address), adults: T.nilable(Integer), affiliate: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Affiliate), booking_number: T.nilable(String), category: T.nilable(String), checkin_at: Integer, checkout_at: Integer, customer_service_phone_number: T.nilable(String), daily_room_rate_amount: T.nilable(Integer), delivery: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Delivery), extra_charges: T.nilable(T::Array[String]), fire_safety_act_compliance: T.nilable(T::Boolean), name: T.nilable(String), no_show: T.nilable(T::Boolean), number_of_rooms: T.nilable(Integer), passengers: T.nilable(T::Array[::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging::Passenger]), property_phone_number: T.nilable(String), room_class: T.nilable(String), room_nights: T.nilable(Integer), total_room_tax_amount: T.nilable(Integer), total_tax_amount: T.nilable(Integer)).void
}
def initialize(
address: nil,
adults: nil,
affiliate: nil,
booking_number: nil,
category: nil,
checkin_at: nil,
checkout_at: nil,
customer_service_phone_number: nil,
daily_room_rate_amount: nil,
delivery: nil,
extra_charges: nil,
fire_safety_act_compliance: nil,
name: nil,
no_show: nil,
number_of_rooms: nil,
passengers: nil,
property_phone_number: nil,
room_class: nil,
room_nights: nil,
total_room_tax_amount: nil,
total_tax_amount: nil
); end
end
class Subscription < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class BillingInterval < Stripe::RequestParams
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def count; end
sig { params(_count: Integer).returns(Integer) }
def count=(_count); end
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig { params(count: Integer, interval: String).void }
def initialize(count: nil, interval: nil); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription::Affiliate)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate=(_affiliate); end
# Info whether the subscription will be auto renewed upon expiry.
sig { returns(T.nilable(T::Boolean)) }
def auto_renewal; end
sig { params(_auto_renewal: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_renewal=(_auto_renewal); end
# Subscription billing details for this purchase.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval; end
sig {
params(_billing_interval: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription::BillingInterval)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval=(_billing_interval); end
# Subscription end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Name of the product on subscription. e.g. Apple Music Subscription
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Subscription start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(affiliate: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription::Affiliate), auto_renewal: T.nilable(T::Boolean), billing_interval: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription::BillingInterval), ends_at: T.nilable(Integer), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
affiliate: nil,
auto_renewal: nil,
billing_interval: nil,
ends_at: nil,
name: nil,
starts_at: nil
); end
end
# Car rental details for this PaymentIntent.
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental))
}
def car_rental; end
sig {
params(_car_rental: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental))
}
def car_rental=(_car_rental); end
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
sig { returns(T.nilable(String)) }
def customer_reference; end
sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) }
def customer_reference=(_customer_reference); end
# Event details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails))
}
def event_details; end
sig {
params(_event_details: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails))
}
def event_details=(_event_details); end
# Flight reservation details for this PaymentIntent
sig { returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight)) }
def flight; end
sig {
params(_flight: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight))
}
def flight=(_flight); end
# Lodging reservation details for this PaymentIntent
sig { returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging)) }
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging))
}
def lodging=(_lodging); end
# A unique value assigned by the business to identify the transaction.
sig { returns(T.nilable(String)) }
def order_reference; end
sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) }
def order_reference=(_order_reference); end
# Subscription details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription))
}
def subscription; end
sig {
params(_subscription: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription))
}
def subscription=(_subscription); end
sig {
params(car_rental: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::CarRental), customer_reference: T.nilable(String), event_details: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::EventDetails), flight: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Flight), lodging: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Lodging), order_reference: T.nilable(String), subscription: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails::Subscription)).void
}
def initialize(
car_rental: nil,
customer_reference: nil,
event_details: nil,
flight: nil,
lodging: nil,
order_reference: nil,
subscription: nil
); end
end
class TransferData < Stripe::RequestParams
# The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
sig { params(amount: T.nilable(Integer)).void }
def initialize(amount: nil); end
end
# The amount to capture, which must be less than or equal to the original amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# An application fee to add on to this charge.
sig { returns(T.nilable(Integer)) }
def application_fee; end
sig { params(_application_fee: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee=(_application_fee); end
# An application fee amount to add on to this charge, which must be less than or equal to the original amount.
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Provides industry-specific information about the charge.
sig { returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails)) }
def payment_details; end
sig {
params(_payment_details: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails))
}
def payment_details=(_payment_details); end
# The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.
sig { returns(T.nilable(String)) }
def receipt_email; end
sig { params(_receipt_email: T.nilable(String)).returns(T.nilable(String)) }
def receipt_email=(_receipt_email); end
# For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
sig { returns(T.nilable(::Stripe::ChargeService::CaptureParams::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::ChargeService::CaptureParams::TransferData)).returns(T.nilable(::Stripe::ChargeService::CaptureParams::TransferData))
}
def transfer_data=(_transfer_data); end
# A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(amount: T.nilable(Integer), application_fee: T.nilable(Integer), application_fee_amount: T.nilable(Integer), expand: T.nilable(T::Array[String]), payment_details: T.nilable(::Stripe::ChargeService::CaptureParams::PaymentDetails), receipt_email: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::ChargeService::CaptureParams::TransferData), transfer_group: T.nilable(String)).void
}
def initialize(
amount: nil,
application_fee: nil,
application_fee_amount: nil,
expand: nil,
payment_details: nil,
receipt_email: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil,
transfer_group: nil
); end
end
# Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
#
# Uncaptured payments expire a set number of days after they are created ([7 by default](https://docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
#
# Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/capture).
sig {
params(charge: String, params: T.any(::Stripe::ChargeService::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge)
}
def capture(charge, params = {}, opts = {}); end
# This method is no longer recommended—use the [Payment Intents API](https://docs.stripe.com/docs/api/payment_intents)
# to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge
# object used to request payment.
sig {
params(params: T.any(::Stripe::ChargeService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge)
}
def create(params = {}, opts = {}); end
# Returns a list of charges you've previously created. The charges are returned in sorted order, with the most recent charges appearing first.
sig {
params(params: T.any(::Stripe::ChargeService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.
sig {
params(charge: String, params: T.any(::Stripe::ChargeService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge)
}
def retrieve(charge, params = {}, opts = {}); end
# Search for charges 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.
sig {
params(params: T.any(::Stripe::ChargeService::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
}
def search(params = {}, opts = {}); end
# Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(charge: String, params: T.any(::Stripe::ChargeService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge)
}
def update(charge, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class CheckoutService < StripeService
attr_reader :sessions
end
end
# typed: true
module Stripe
module Checkout
class SessionService < StripeService
attr_reader :line_items
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class CustomerDetails < Stripe::RequestParams
# Customer's email address.
sig { returns(String) }
def email; end
sig { params(_email: String).returns(String) }
def email=(_email); end
sig { params(email: String).void }
def initialize(email: nil); end
end
# Only return Checkout Sessions that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Checkout::SessionService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Checkout::SessionService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Checkout::SessionService::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return the Checkout Sessions for the Customer specified.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Only return the Checkout Sessions for the Account specified.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Only return the Checkout Sessions for the Customer details specified.
sig { returns(T.nilable(::Stripe::Checkout::SessionService::ListParams::CustomerDetails)) }
def customer_details; end
sig {
params(_customer_details: T.nilable(::Stripe::Checkout::SessionService::ListParams::CustomerDetails)).returns(T.nilable(::Stripe::Checkout::SessionService::ListParams::CustomerDetails))
}
def customer_details=(_customer_details); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return the Checkout Session for the PaymentIntent specified.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# Only return the Checkout Sessions for the Payment Link specified.
sig { returns(T.nilable(String)) }
def payment_link; end
sig { params(_payment_link: T.nilable(String)).returns(T.nilable(String)) }
def payment_link=(_payment_link); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return the Checkout Sessions matching the given status.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# Only return the Checkout Session for the subscription specified.
sig { returns(T.nilable(String)) }
def subscription; end
sig { params(_subscription: T.nilable(String)).returns(T.nilable(String)) }
def subscription=(_subscription); end
sig {
params(created: T.nilable(T.any(::Stripe::Checkout::SessionService::ListParams::Created, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), customer_details: T.nilable(::Stripe::Checkout::SessionService::ListParams::CustomerDetails), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_intent: T.nilable(String), payment_link: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String), subscription: T.nilable(String)).void
}
def initialize(
created: nil,
customer: nil,
customer_account: nil,
customer_details: nil,
ending_before: nil,
expand: nil,
limit: nil,
payment_intent: nil,
payment_link: nil,
starting_after: nil,
status: nil,
subscription: nil
); end
end
class CreateParams < Stripe::RequestParams
class AdaptivePricing < Stripe::RequestParams
# If set to `true`, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions). Defaults to your [dashboard setting](https://dashboard.stripe.com/settings/adaptive-pricing).
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
sig { params(enabled: T.nilable(T::Boolean)).void }
def initialize(enabled: nil); end
end
class AfterExpiration < Stripe::RequestParams
class Recovery < Stripe::RequestParams
# Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
sig { returns(T.nilable(T::Boolean)) }
def allow_promotion_codes; end
sig {
params(_allow_promotion_codes: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def allow_promotion_codes=(_allow_promotion_codes); end
# If `true`, a recovery URL will be generated to recover this Checkout Session if it
# expires before a successful transaction is completed. It will be attached to the
# Checkout Session object upon expiration.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(allow_promotion_codes: T.nilable(T::Boolean), enabled: T::Boolean).void }
def initialize(allow_promotion_codes: nil, enabled: nil); end
end
# Configure a Checkout Session that can be used to recover an expired session.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration::Recovery))
}
def recovery; end
sig {
params(_recovery: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration::Recovery)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration::Recovery))
}
def recovery=(_recovery); end
sig {
params(recovery: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration::Recovery)).void
}
def initialize(recovery: nil); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
#
# Enabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class BrandingSettings < Stripe::RequestParams
class Icon < Stripe::RequestParams
# The ID of a [File upload](https://stripe.com/docs/api/files) representing the icon. Purpose must be `business_icon`. Required if `type` is `file` and disallowed otherwise.
sig { returns(T.nilable(String)) }
def file; end
sig { params(_file: T.nilable(String)).returns(T.nilable(String)) }
def file=(_file); end
# The type of image for the icon. Must be one of `file` or `url`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The URL of the image. Required if `type` is `url` and disallowed otherwise.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig { params(file: T.nilable(String), type: String, url: T.nilable(String)).void }
def initialize(file: nil, type: nil, url: nil); end
end
class Logo < Stripe::RequestParams
# The ID of a [File upload](https://stripe.com/docs/api/files) representing the logo. Purpose must be `business_logo`. Required if `type` is `file` and disallowed otherwise.
sig { returns(T.nilable(String)) }
def file; end
sig { params(_file: T.nilable(String)).returns(T.nilable(String)) }
def file=(_file); end
# The type of image for the logo. Must be one of `file` or `url`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The URL of the image. Required if `type` is `url` and disallowed otherwise.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig { params(file: T.nilable(String), type: String, url: T.nilable(String)).void }
def initialize(file: nil, type: nil, url: nil); end
end
# A hex color value starting with `#` representing the background color for the Checkout Session.
sig { returns(T.nilable(String)) }
def background_color; end
sig { params(_background_color: T.nilable(String)).returns(T.nilable(String)) }
def background_color=(_background_color); end
# The border style for the Checkout Session.
sig { returns(T.nilable(T.any(String, String))) }
def border_style; end
sig {
params(_border_style: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def border_style=(_border_style); end
# A hex color value starting with `#` representing the button color for the Checkout Session.
sig { returns(T.nilable(String)) }
def button_color; end
sig { params(_button_color: T.nilable(String)).returns(T.nilable(String)) }
def button_color=(_button_color); end
# A string to override the business name shown on the Checkout Session.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# The font family for the Checkout Session corresponding to one of the [supported font families](https://docs.stripe.com/payments/checkout/customization/appearance?payment-ui=stripe-hosted#font-compatibility).
sig { returns(T.nilable(T.any(String, String))) }
def font_family; end
sig {
params(_font_family: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def font_family=(_font_family); end
# The icon for the Checkout Session. You cannot set both `logo` and `icon`.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::BrandingSettings::Icon))
}
def icon; end
sig {
params(_icon: T.nilable(::Stripe::Checkout::SessionService::CreateParams::BrandingSettings::Icon)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::BrandingSettings::Icon))
}
def icon=(_icon); end
# The logo for the Checkout Session. You cannot set both `logo` and `icon`.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::BrandingSettings::Logo))
}
def logo; end
sig {
params(_logo: T.nilable(::Stripe::Checkout::SessionService::CreateParams::BrandingSettings::Logo)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::BrandingSettings::Logo))
}
def logo=(_logo); end
sig {
params(background_color: T.nilable(String), border_style: T.nilable(T.any(String, String)), button_color: T.nilable(String), display_name: T.nilable(String), font_family: T.nilable(T.any(String, String)), icon: T.nilable(::Stripe::Checkout::SessionService::CreateParams::BrandingSettings::Icon), logo: T.nilable(::Stripe::Checkout::SessionService::CreateParams::BrandingSettings::Logo)).void
}
def initialize(
background_color: nil,
border_style: nil,
button_color: nil,
display_name: nil,
font_family: nil,
icon: nil,
logo: nil
); end
end
class ConsentCollection < Stripe::RequestParams
class PaymentMethodReuseAgreement < Stripe::RequestParams
# Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's
# defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
sig { returns(String) }
def position; end
sig { params(_position: String).returns(String) }
def position=(_position); end
sig { params(position: String).void }
def initialize(position: nil); end
end
# Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement))
}
def payment_method_reuse_agreement; end
sig {
params(_payment_method_reuse_agreement: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement))
}
def payment_method_reuse_agreement=(_payment_method_reuse_agreement); end
# If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
# Session will determine whether to display an option to opt into promotional communication
# from the merchant depending on the customer's locale. Only available to US merchants.
sig { returns(T.nilable(String)) }
def promotions; end
sig { params(_promotions: T.nilable(String)).returns(T.nilable(String)) }
def promotions=(_promotions); end
# If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
# There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
sig { returns(T.nilable(String)) }
def terms_of_service; end
sig { params(_terms_of_service: T.nilable(String)).returns(T.nilable(String)) }
def terms_of_service=(_terms_of_service); end
sig {
params(payment_method_reuse_agreement: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement), promotions: T.nilable(String), terms_of_service: T.nilable(String)).void
}
def initialize(
payment_method_reuse_agreement: nil,
promotions: nil,
terms_of_service: nil
); end
end
class CustomField < Stripe::RequestParams
class Dropdown < Stripe::RequestParams
class Option < Stripe::RequestParams
# The label for the option, displayed to the customer. Up to 100 characters.
sig { returns(String) }
def label; end
sig { params(_label: String).returns(String) }
def label=(_label); end
# The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(label: String, value: String).void }
def initialize(label: nil, value: nil); end
end
# The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The options available for the customer to select. Up to 200 options allowed.
sig {
returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown::Option])
}
def options; end
sig {
params(_options: T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown::Option]).returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown::Option])
}
def options=(_options); end
sig {
params(default_value: T.nilable(String), options: T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown::Option]).void
}
def initialize(default_value: nil, options: nil); end
end
class Label < Stripe::RequestParams
# Custom text for the label, displayed to the customer. Up to 50 characters.
sig { returns(String) }
def custom; end
sig { params(_custom: String).returns(String) }
def custom=(_custom); end
# The type of the label.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(custom: String, type: String).void }
def initialize(custom: nil, type: nil); end
end
class Numeric < Stripe::RequestParams
# The value that will pre-fill the field on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The maximum character length constraint for the customer's input.
sig { returns(T.nilable(Integer)) }
def maximum_length; end
sig { params(_maximum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_length=(_maximum_length); end
# The minimum character length requirement for the customer's input.
sig { returns(T.nilable(Integer)) }
def minimum_length; end
sig { params(_minimum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_length=(_minimum_length); end
sig {
params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
}
def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
end
class Text < Stripe::RequestParams
# The value that will pre-fill the field on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The maximum character length constraint for the customer's input.
sig { returns(T.nilable(Integer)) }
def maximum_length; end
sig { params(_maximum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_length=(_maximum_length); end
# The minimum character length requirement for the customer's input.
sig { returns(T.nilable(Integer)) }
def minimum_length; end
sig { params(_minimum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_length=(_minimum_length); end
sig {
params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
}
def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
end
# Configuration for `type=dropdown` fields.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown))
}
def dropdown; end
sig {
params(_dropdown: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown))
}
def dropdown=(_dropdown); end
# String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
sig { returns(String) }
def key; end
sig { params(_key: String).returns(String) }
def key=(_key); end
# The label for the field, displayed to the customer.
sig { returns(::Stripe::Checkout::SessionService::CreateParams::CustomField::Label) }
def label; end
sig {
params(_label: ::Stripe::Checkout::SessionService::CreateParams::CustomField::Label).returns(::Stripe::Checkout::SessionService::CreateParams::CustomField::Label)
}
def label=(_label); end
# Configuration for `type=numeric` fields.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Numeric))
}
def numeric; end
sig {
params(_numeric: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Numeric)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Numeric))
}
def numeric=(_numeric); end
# Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def optional; end
sig { params(_optional: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def optional=(_optional); end
# Configuration for `type=text` fields.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Text))
}
def text; end
sig {
params(_text: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Text)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Text))
}
def text=(_text); end
# The type of the field.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(dropdown: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown), key: String, label: ::Stripe::Checkout::SessionService::CreateParams::CustomField::Label, numeric: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Numeric), optional: T.nilable(T::Boolean), text: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Text), type: String).void
}
def initialize(
dropdown: nil,
key: nil,
label: nil,
numeric: nil,
optional: nil,
text: nil,
type: nil
); end
end
class CustomText < Stripe::RequestParams
class AfterSubmit < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class ShippingAddress < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class Submit < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class TermsOfServiceAcceptance < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
# Custom text that should be displayed after the payment confirmation button.
sig {
returns(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::AfterSubmit)))
}
def after_submit; end
sig {
params(_after_submit: T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::AfterSubmit))).returns(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::AfterSubmit)))
}
def after_submit=(_after_submit); end
# Custom text that should be displayed alongside shipping address collection.
sig {
returns(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::ShippingAddress)))
}
def shipping_address; end
sig {
params(_shipping_address: T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::ShippingAddress))).returns(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::ShippingAddress)))
}
def shipping_address=(_shipping_address); end
# Custom text that should be displayed alongside the payment confirmation button.
sig {
returns(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::Submit)))
}
def submit; end
sig {
params(_submit: T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::Submit))).returns(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::Submit)))
}
def submit=(_submit); end
# Custom text that should be displayed in place of the default terms of service agreement text.
sig {
returns(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::TermsOfServiceAcceptance)))
}
def terms_of_service_acceptance; end
sig {
params(_terms_of_service_acceptance: T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::TermsOfServiceAcceptance))).returns(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::TermsOfServiceAcceptance)))
}
def terms_of_service_acceptance=(_terms_of_service_acceptance); end
sig {
params(after_submit: T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::AfterSubmit)), shipping_address: T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::ShippingAddress)), submit: T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::Submit)), terms_of_service_acceptance: T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::TermsOfServiceAcceptance))).void
}
def initialize(
after_submit: nil,
shipping_address: nil,
submit: nil,
terms_of_service_acceptance: nil
); end
end
class CustomerUpdate < Stripe::RequestParams
# Describes whether Checkout saves the billing address onto `customer.address`.
# To always collect a full billing address, use `billing_address_collection`. Defaults to `never`.
sig { returns(T.nilable(String)) }
def address; end
sig { params(_address: T.nilable(String)).returns(T.nilable(String)) }
def address=(_address); end
# Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes whether Checkout saves shipping information onto `customer.shipping`.
# To collect shipping information, use `shipping_address_collection`. Defaults to `never`.
sig { returns(T.nilable(String)) }
def shipping; end
sig { params(_shipping: T.nilable(String)).returns(T.nilable(String)) }
def shipping=(_shipping); end
sig {
params(address: T.nilable(String), name: T.nilable(String), shipping: T.nilable(String)).void
}
def initialize(address: nil, name: nil, shipping: nil); end
end
class Discount < Stripe::RequestParams
class CouponData < Stripe::RequestParams
# A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
sig { returns(T.nilable(Integer)) }
def amount_off; end
sig { params(_amount_off: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_off=(_amount_off); end
# Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
sig { returns(T.nilable(String)) }
def duration; end
sig { params(_duration: T.nilable(String)).returns(T.nilable(String)) }
def duration=(_duration); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
sig { returns(T.nilable(Float)) }
def percent_off; end
sig { params(_percent_off: T.nilable(Float)).returns(T.nilable(Float)) }
def percent_off=(_percent_off); end
sig {
params(amount_off: T.nilable(Integer), currency: T.nilable(String), duration: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String), percent_off: T.nilable(Float)).void
}
def initialize(
amount_off: nil,
currency: nil,
duration: nil,
metadata: nil,
name: nil,
percent_off: nil
); end
end
# The ID of the coupon to apply to this Session.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# Data used to generate a new [Coupon](https://stripe.com/docs/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::Discount::CouponData))
}
def coupon_data; end
sig {
params(_coupon_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::Discount::CouponData)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::Discount::CouponData))
}
def coupon_data=(_coupon_data); end
# The ID of a promotion code to apply to this Session.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), coupon_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::Discount::CouponData), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, coupon_data: nil, promotion_code: nil); end
end
class InvoiceCreation < Stripe::RequestParams
class InvoiceData < Stripe::RequestParams
class CustomField < Stripe::RequestParams
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The value of the custom field. This may be up to 140 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
class RenderingOptions < Stripe::RequestParams
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(T.any(String, String))) }
def amount_tax_display; end
sig {
params(_amount_tax_display: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def amount_tax_display=(_amount_tax_display); end
# ID of the invoice rendering template to use for this invoice.
sig { returns(T.nilable(String)) }
def template; end
sig { params(_template: T.nilable(String)).returns(T.nilable(String)) }
def template=(_template); end
sig {
params(amount_tax_display: T.nilable(T.any(String, String)), template: T.nilable(String)).void
}
def initialize(amount_tax_display: nil, template: nil); end
end
# The account tax IDs associated with the invoice.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# Default custom fields to be displayed on invoices for this customer.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::CustomField])))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::CustomField]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::CustomField])))
}
def custom_fields=(_custom_fields); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Default footer to be displayed on invoices for this customer.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::Issuer)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::Issuer))
}
def issuer=(_issuer); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Default options for invoice PDF rendering for this customer.
sig {
returns(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)))
}
def rendering_options; end
sig {
params(_rendering_options: T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))).returns(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)))
}
def rendering_options=(_rendering_options); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), custom_fields: T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::CustomField])), description: T.nilable(String), footer: T.nilable(String), issuer: T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::Issuer), metadata: T.nilable(T::Hash[String, String]), rendering_options: T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))).void
}
def initialize(
account_tax_ids: nil,
custom_fields: nil,
description: nil,
footer: nil,
issuer: nil,
metadata: nil,
rendering_options: nil
); end
end
# Set to `true` to enable invoice creation.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Parameters passed when creating invoices for payment-mode Checkout Sessions.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData))
}
def invoice_data; end
sig {
params(_invoice_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData))
}
def invoice_data=(_invoice_data); end
sig {
params(enabled: T::Boolean, invoice_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData)).void
}
def initialize(enabled: nil, invoice_data: nil); end
end
class LineItem < Stripe::RequestParams
class AdjustableQuantity < Stripe::RequestParams
# Set to true if the quantity can be adjusted to any non-negative integer.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil); end
end
class PriceData < Stripe::RequestParams
class ProductData < Stripe::RequestParams
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T::Array[String])) }
def images; end
sig {
params(_images: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def images=(_images); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
sig {
params(description: T.nilable(String), images: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: String, tax_code: T.nilable(String), unit_label: T.nilable(String)).void
}
def initialize(
description: nil,
images: nil,
metadata: nil,
name: nil,
tax_code: nil,
unit_label: nil
); end
end
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::ProductData))
}
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::ProductData)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::ProductData))
}
def product_data=(_product_data); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::Recurring))
}
def recurring; end
sig {
params(_recurring: T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::Recurring)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::Recurring))
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: T.nilable(String), product_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::ProductData), recurring: T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
product_data: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::AdjustableQuantity))
}
def adjustable_quantity; end
sig {
params(_adjustable_quantity: T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::AdjustableQuantity)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::AdjustableQuantity))
}
def adjustable_quantity=(_adjustable_quantity); end
# The [tax rates](https://stripe.com/docs/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.
sig { returns(T.nilable(T::Array[String])) }
def dynamic_tax_rates; end
sig {
params(_dynamic_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def dynamic_tax_rates=(_dynamic_tax_rates); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData))
}
def price_data=(_price_data); end
# The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
sig {
params(adjustable_quantity: T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::AdjustableQuantity), dynamic_tax_rates: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), price: T.nilable(String), price_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String])).void
}
def initialize(
adjustable_quantity: nil,
dynamic_tax_rates: nil,
metadata: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class NameCollection < Stripe::RequestParams
class Business < Stripe::RequestParams
# Enable business name collection on the Checkout Session. Defaults to `false`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Whether the customer is required to provide a business name before completing the Checkout Session. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def optional; end
sig { params(_optional: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def optional=(_optional); end
sig { params(enabled: T::Boolean, optional: T.nilable(T::Boolean)).void }
def initialize(enabled: nil, optional: nil); end
end
class Individual < Stripe::RequestParams
# Enable individual name collection on the Checkout Session. Defaults to `false`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Whether the customer is required to provide their name before completing the Checkout Session. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def optional; end
sig { params(_optional: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def optional=(_optional); end
sig { params(enabled: T::Boolean, optional: T.nilable(T::Boolean)).void }
def initialize(enabled: nil, optional: nil); end
end
# Controls settings applied for collecting the customer's business name on the session.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::NameCollection::Business))
}
def business; end
sig {
params(_business: T.nilable(::Stripe::Checkout::SessionService::CreateParams::NameCollection::Business)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::NameCollection::Business))
}
def business=(_business); end
# Controls settings applied for collecting the customer's individual name on the session.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::NameCollection::Individual))
}
def individual; end
sig {
params(_individual: T.nilable(::Stripe::Checkout::SessionService::CreateParams::NameCollection::Individual)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::NameCollection::Individual))
}
def individual=(_individual); end
sig {
params(business: T.nilable(::Stripe::Checkout::SessionService::CreateParams::NameCollection::Business), individual: T.nilable(::Stripe::Checkout::SessionService::CreateParams::NameCollection::Individual)).void
}
def initialize(business: nil, individual: nil); end
end
class OptionalItem < Stripe::RequestParams
class AdjustableQuantity < Stripe::RequestParams
# Set to true if the quantity can be adjusted to any non-negative integer.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil); end
end
# When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::OptionalItem::AdjustableQuantity))
}
def adjustable_quantity; end
sig {
params(_adjustable_quantity: T.nilable(::Stripe::Checkout::SessionService::CreateParams::OptionalItem::AdjustableQuantity)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::OptionalItem::AdjustableQuantity))
}
def adjustable_quantity=(_adjustable_quantity); end
# The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# The initial quantity of the line item created when a customer chooses to add this optional item to their order.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
sig {
params(adjustable_quantity: T.nilable(::Stripe::Checkout::SessionService::CreateParams::OptionalItem::AdjustableQuantity), price: String, quantity: Integer).void
}
def initialize(adjustable_quantity: nil, price: nil, quantity: nil); end
end
class PaymentIntentData < Stripe::RequestParams
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(String) }
def line1; end
sig { params(_line1: String).returns(String) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: String, line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address.
sig {
returns(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping::Address)
}
def address; end
sig {
params(_address: ::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping::Address).returns(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping::Address)
}
def address=(_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
sig { params(_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def tracking_number=(_tracking_number); end
sig {
params(address: ::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
}
def initialize(
address: nil,
carrier: nil,
name: nil,
phone: nil,
tracking_number: nil
); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# If specified, successful charges will be attributed to the destination
# account for tax reporting, and the funds from charges will be transferred
# to the destination account. The ID of the resulting transfer will be
# returned on the successful charge's `transfer` field.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The Stripe account ID for which these funds are intended. For details,
# see the PaymentIntents [use case for connected
# accounts](/docs/payments/connected-accounts).
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
sig { returns(T.nilable(String)) }
def receipt_email; end
sig { params(_receipt_email: T.nilable(String)).returns(T.nilable(String)) }
def receipt_email=(_receipt_email); end
# Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment
# method collected by this Checkout Session.
#
# When setting this to `on_session`, Checkout will show a notice to the
# customer that their payment details will be saved.
#
# When setting this to `off_session`, Checkout will show a notice to the
# customer that their payment details will be saved and used for future
# payments.
#
# If a Customer has been provided or Checkout creates a new Customer,
# Checkout will attach the payment method to the Customer.
#
# If Checkout does not create a Customer, the payment method is not attached
# to a Customer. To reuse the payment method, you can retrieve it from the
# Checkout Session's PaymentIntent.
#
# When processing card payments, Checkout also uses `setup_future_usage`
# to dynamically optimize your payment flow and comply with regional
# legislation and network rules, such as SCA.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Shipping information for this payment.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping))
}
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping))
}
def shipping=(_shipping); end
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# The parameters used to automatically create a Transfer when the payment succeeds.
# For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::TransferData))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::TransferData)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::TransferData))
}
def transfer_data=(_transfer_data); end
# A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(application_fee_amount: T.nilable(Integer), capture_method: T.nilable(String), description: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), receipt_email: T.nilable(String), setup_future_usage: T.nilable(String), shipping: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::TransferData), transfer_group: T.nilable(String)).void
}
def initialize(
application_fee_amount: nil,
capture_method: nil,
description: nil,
metadata: nil,
on_behalf_of: nil,
receipt_email: nil,
setup_future_usage: nil,
shipping: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil,
transfer_group: nil
); end
end
class PaymentMethodData < Stripe::RequestParams
# Allow redisplay will be set on the payment method on confirmation and indicates whether this payment method can be shown again to the customer in a checkout flow. Only set this field if you wish to override the allow_redisplay value determined by Checkout.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
sig { params(allow_redisplay: T.nilable(String)).void }
def initialize(allow_redisplay: nil); end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.
sig { returns(T.nilable(T::Array[String])) }
def default_for; end
sig {
params(_default_for: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def default_for=(_default_for); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), default_for: T.nilable(T::Array[String]), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
default_for: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# 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). This is only accepted for Checkout Sessions in `setup` mode.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(currency: T.nilable(String), mandate_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions), setup_future_usage: T.nilable(String), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
currency: nil,
mandate_options: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class Affirm < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class AfterpayClearpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Alipay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class AmazonPay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class AuBecsDebit < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(setup_future_usage: T.nilable(String), target_date: T.nilable(String)).void
}
def initialize(setup_future_usage: nil, target_date: nil); end
end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions), setup_future_usage: T.nilable(String), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Bancontact < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Boleto < Stripe::RequestParams
# The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
# Setting to true enables installments for this Checkout Session.
# Setting to false will prevent any installment plan from applying to a payment.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
sig { params(enabled: T.nilable(T::Boolean)).void }
def initialize(enabled: nil); end
end
class Restrictions < Stripe::RequestParams
# Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can't complete the Session.
sig { returns(T.nilable(T::Array[String])) }
def brands_blocked; end
sig {
params(_brands_blocked: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def brands_blocked=(_brands_blocked); end
sig { params(brands_blocked: T.nilable(T::Array[String])).void }
def initialize(brands_blocked: nil); end
end
# Installment options for card payments
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Installments))
}
def installments; end
sig {
params(_installments: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Installments)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Installments))
}
def installments=(_installments); end
# Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
sig { returns(T.nilable(String)) }
def request_decremental_authorization; end
sig {
params(_request_decremental_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_decremental_authorization=(_request_decremental_authorization); end
# Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
sig { returns(T.nilable(String)) }
def request_extended_authorization; end
sig {
params(_request_extended_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_extended_authorization=(_request_extended_authorization); end
# Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
sig { returns(T.nilable(String)) }
def request_incremental_authorization; end
sig {
params(_request_incremental_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_incremental_authorization=(_request_incremental_authorization); end
# Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
sig { returns(T.nilable(String)) }
def request_multicapture; end
sig { params(_request_multicapture: T.nilable(String)).returns(T.nilable(String)) }
def request_multicapture=(_request_multicapture); end
# Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
sig { returns(T.nilable(String)) }
def request_overcapture; end
sig { params(_request_overcapture: T.nilable(String)).returns(T.nilable(String)) }
def request_overcapture=(_request_overcapture); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
# Restrictions to apply to the card payment method. For example, you can block specific card brands.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Restrictions))
}
def restrictions; end
sig {
params(_restrictions: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Restrictions)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Restrictions))
}
def restrictions=(_restrictions); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kana; end
sig {
params(_statement_descriptor_suffix_kana: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_suffix_kana=(_statement_descriptor_suffix_kana); end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kanji; end
sig {
params(_statement_descriptor_suffix_kanji: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_suffix_kanji=(_statement_descriptor_suffix_kanji); end
sig {
params(installments: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Installments), request_decremental_authorization: T.nilable(String), request_extended_authorization: T.nilable(String), request_incremental_authorization: T.nilable(String), request_multicapture: T.nilable(String), request_overcapture: T.nilable(String), request_three_d_secure: T.nilable(String), restrictions: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Restrictions), setup_future_usage: T.nilable(String), statement_descriptor_suffix_kana: T.nilable(String), statement_descriptor_suffix_kanji: T.nilable(String)).void
}
def initialize(
installments: nil,
request_decremental_authorization: nil,
request_extended_authorization: nil,
request_incremental_authorization: nil,
request_multicapture: nil,
request_overcapture: nil,
request_three_d_secure: nil,
restrictions: nil,
setup_future_usage: nil,
statement_descriptor_suffix_kana: nil,
statement_descriptor_suffix_kanji: nil
); end
end
class Cashapp < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
sig {
params(_requested_address_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested_address_types=(_requested_address_types); end
# The list of bank transfer types that this PaymentIntent is allowed to use for funding.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
}
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(bank_transfer: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
end
class Eps < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Fpx < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Giropay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Grabpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Ideal < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class KakaoPay < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Klarna < Stripe::RequestParams
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
}
def next_billing; end
sig {
params(_next_billing: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling).returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling, reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Subscription details if the Checkout Session sets up a future subscription.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(setup_future_usage: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(setup_future_usage: nil, subscriptions: nil); end
end
class Konbini < Stripe::RequestParams
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class KrCard < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Link < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Mobilepay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Multibanco < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class NaverPay < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Oxxo < Stripe::RequestParams
# The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class P24 < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Confirm that the payer has accepted the P24 terms and conditions.
sig { returns(T.nilable(T::Boolean)) }
def tos_shown_and_accepted; end
sig {
params(_tos_shown_and_accepted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def tos_shown_and_accepted=(_tos_shown_and_accepted); end
sig {
params(setup_future_usage: T.nilable(String), tos_shown_and_accepted: T.nilable(T::Boolean)).void
}
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Paynow < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Paypal < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference_id; end
sig { params(_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def reference_id=(_reference_id); end
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
sig { returns(T.nilable(String)) }
def risk_correlation_id; end
sig { params(_risk_correlation_id: T.nilable(String)).returns(T.nilable(String)) }
def risk_correlation_id=(_risk_correlation_id); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(capture_method: T.nilable(String), preferred_locale: T.nilable(String), reference: T.nilable(String), reference_id: T.nilable(String), risk_correlation_id: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String)), subsellers: T.nilable(T::Array[String])).void
}
def initialize(
capture_method: nil,
preferred_locale: nil,
reference: nil,
reference_id: nil,
risk_correlation_id: nil,
setup_future_usage: nil,
subsellers: nil
); end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
sig { params(_payments_per_period: T.nilable(Integer)).returns(T.nilable(Integer)) }
def payments_per_period=(_payments_per_period); end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
sig { params(_purpose: T.nilable(String)).returns(T.nilable(String)) }
def purpose=(_purpose); end
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), payments_per_period: T.nilable(Integer), purpose: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil,
start_date: nil
); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto::MandateOptions)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(mandate_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto::MandateOptions), setup_future_usage: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil); end
end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Type of amount. Defaults to `maximum`.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), amount_type: T.nilable(String), currency: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), reference: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
amount_type: nil,
currency: nil,
end_date: nil,
payment_schedule: nil,
reference: nil,
start_date: nil
); end
end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
sig { returns(T.nilable(Integer)) }
def expires_after_seconds; end
sig { params(_expires_after_seconds: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_seconds=(_expires_after_seconds); end
# Additional fields for mandate creation.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(amount_includes_iof: T.nilable(String), expires_after_seconds: T.nilable(Integer), mandate_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Pix::MandateOptions), setup_future_usage: T.nilable(String)).void
}
def initialize(
amount_includes_iof: nil,
expires_after_seconds: nil,
mandate_options: nil,
setup_future_usage: nil
); end
end
class RevolutPay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class SamsungPay < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions), setup_future_usage: T.nilable(String), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Sofort < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Swish < Stripe::RequestParams
# The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
sig { params(reference: T.nilable(String)).void }
def initialize(reference: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
sig {
params(permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String])).void
}
def initialize(permissions: nil, prefetch: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), setup_future_usage: T.nilable(String), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
financial_connections: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class WechatPay < Stripe::RequestParams
# The app ID registered with WeChat Pay. Only required when client is ios or android.
sig { returns(T.nilable(String)) }
def app_id; end
sig { params(_app_id: T.nilable(String)).returns(T.nilable(String)) }
def app_id=(_app_id); end
# The client type that the end customer will pay from
sig { returns(String) }
def client; end
sig { params(_client: String).returns(String) }
def client=(_client); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(app_id: T.nilable(String), client: String, setup_future_usage: T.nilable(String)).void
}
def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
end
# contains details about the ACSS Debit payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit))
}
def acss_debit=(_acss_debit); end
# contains details about the Affirm payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Affirm))
}
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Affirm)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Affirm))
}
def affirm=(_affirm); end
# contains details about the Afterpay Clearpay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AfterpayClearpay)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# contains details about the Alipay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Alipay))
}
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Alipay)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Alipay))
}
def alipay=(_alipay); end
# contains details about the AmazonPay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AmazonPay)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# contains details about the AU Becs Debit payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AuBecsDebit)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# contains details about the Bacs Debit payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# contains details about the Bancontact payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Bancontact)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Bancontact))
}
def bancontact=(_bancontact); end
# contains details about the Boleto payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Boleto))
}
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Boleto)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Boleto))
}
def boleto=(_boleto); end
# contains details about the Card payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card))
}
def card=(_card); end
# contains details about the Cashapp Pay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Cashapp))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Cashapp)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Cashapp))
}
def cashapp=(_cashapp); end
# contains details about the Customer Balance payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# contains details about the EPS payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Eps))
}
def eps; end
sig {
params(_eps: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Eps)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Eps))
}
def eps=(_eps); end
# contains details about the FPX payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Fpx))
}
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Fpx)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Fpx))
}
def fpx=(_fpx); end
# contains details about the Giropay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Giropay))
}
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Giropay)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Giropay))
}
def giropay=(_giropay); end
# contains details about the Grabpay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Grabpay))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Grabpay)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Grabpay))
}
def grabpay=(_grabpay); end
# contains details about the Ideal payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Ideal))
}
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Ideal)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Ideal))
}
def ideal=(_ideal); end
# contains details about the Kakao Pay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KakaoPay))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KakaoPay)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# contains details about the Klarna payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# contains details about the Konbini payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Konbini))
}
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Konbini)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Konbini))
}
def konbini=(_konbini); end
# contains details about the Korean card payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KrCard))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KrCard)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KrCard))
}
def kr_card=(_kr_card); end
# contains details about the Link payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Link))
}
def link; end
sig {
params(_link: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Link)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Link))
}
def link=(_link); end
# contains details about the Mobilepay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Mobilepay)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Mobilepay))
}
def mobilepay=(_mobilepay); end
# contains details about the Multibanco payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Multibanco)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Multibanco))
}
def multibanco=(_multibanco); end
# contains details about the Naver Pay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::NaverPay))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::NaverPay)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::NaverPay))
}
def naver_pay=(_naver_pay); end
# contains details about the OXXO payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Oxxo))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Oxxo)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Oxxo))
}
def oxxo=(_oxxo); end
# contains details about the P24 payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::P24))
}
def p24; end
sig {
params(_p24: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::P24)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::P24))
}
def p24=(_p24); end
# contains details about the Pay By Bank payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::PayByBank)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# contains details about the PAYCO payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payco))
}
def payco; end
sig {
params(_payco: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payco)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payco))
}
def payco=(_payco); end
# contains details about the PayNow payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paynow))
}
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paynow)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paynow))
}
def paynow=(_paynow); end
# contains details about the PayPal payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
# contains details about the PayTo payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto))
}
def payto; end
sig {
params(_payto: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto))
}
def payto=(_payto); end
# contains details about the Pix payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Pix))
}
def pix; end
sig {
params(_pix: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Pix)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Pix))
}
def pix=(_pix); end
# contains details about the RevolutPay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::RevolutPay)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# contains details about the Samsung Pay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SamsungPay)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# contains details about the Sepa Debit payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# contains details about the Sofort payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Sofort))
}
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Sofort)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Sofort))
}
def sofort=(_sofort); end
# contains details about the Swish payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Swish))
}
def swish; end
sig {
params(_swish: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Swish)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Swish))
}
def swish=(_swish); end
# contains details about the Us Bank Account payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# contains details about the WeChat Pay payment method options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::WechatPay)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::WechatPay))
}
def wechat_pay=(_wechat_pay); end
sig {
params(acss_debit: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit), affirm: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Affirm), afterpay_clearpay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AfterpayClearpay), alipay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Alipay), amazon_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AmazonPay), au_becs_debit: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AuBecsDebit), bacs_debit: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit), bancontact: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Bancontact), boleto: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Boleto), card: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card), cashapp: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Cashapp), customer_balance: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance), eps: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Eps), fpx: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Fpx), giropay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Giropay), grabpay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Grabpay), ideal: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Ideal), kakao_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KakaoPay), klarna: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna), konbini: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Konbini), kr_card: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KrCard), link: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Link), mobilepay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Mobilepay), multibanco: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Multibanco), naver_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::NaverPay), oxxo: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Oxxo), p24: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::P24), pay_by_bank: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::PayByBank), payco: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payco), paynow: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paynow), paypal: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paypal), payto: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto), pix: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Pix), revolut_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::RevolutPay), samsung_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SamsungPay), sepa_debit: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit), sofort: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Sofort), swish: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Swish), us_bank_account: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount), wechat_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::WechatPay)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
boleto: nil,
card: nil,
cashapp: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
grabpay: nil,
ideal: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
payto: nil,
pix: nil,
revolut_pay: nil,
samsung_pay: nil,
sepa_debit: nil,
sofort: nil,
swish: nil,
us_bank_account: nil,
wechat_pay: nil
); end
end
class Permissions < Stripe::RequestParams
class Update < Stripe::RequestParams
# Determines which entity is allowed to update the line items.
#
# Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
#
# When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
sig { returns(T.nilable(String)) }
def line_items; end
sig { params(_line_items: T.nilable(String)).returns(T.nilable(String)) }
def line_items=(_line_items); end
# Determines which entity is allowed to update the shipping details.
#
# Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
#
# When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
sig { returns(T.nilable(String)) }
def shipping_details; end
sig { params(_shipping_details: T.nilable(String)).returns(T.nilable(String)) }
def shipping_details=(_shipping_details); end
sig { params(line_items: T.nilable(String), shipping_details: T.nilable(String)).void }
def initialize(line_items: nil, shipping_details: nil); end
end
# Permissions for updating the Checkout Session.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::Permissions::Update))
}
def update; end
sig {
params(_update: T.nilable(::Stripe::Checkout::SessionService::CreateParams::Permissions::Update)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::Permissions::Update))
}
def update=(_update); end
# Determines which entity is allowed to update the discounts (coupons or promotion codes) that apply to this session.
#
# Default is `client_only`. Stripe Checkout client will automatically handle discount updates. If set to `server_only`, only your server is allowed to update discounts.
sig { returns(T.nilable(String)) }
def update_discounts; end
sig { params(_update_discounts: T.nilable(String)).returns(T.nilable(String)) }
def update_discounts=(_update_discounts); end
# Determines which entity is allowed to update the line items.
#
# Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
#
# When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
sig { returns(T.nilable(String)) }
def update_line_items; end
sig { params(_update_line_items: T.nilable(String)).returns(T.nilable(String)) }
def update_line_items=(_update_line_items); end
# Determines which entity is allowed to update the shipping details.
#
# Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
#
# When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
sig { returns(T.nilable(String)) }
def update_shipping_details; end
sig { params(_update_shipping_details: T.nilable(String)).returns(T.nilable(String)) }
def update_shipping_details=(_update_shipping_details); end
sig {
params(update: T.nilable(::Stripe::Checkout::SessionService::CreateParams::Permissions::Update), update_discounts: T.nilable(String), update_line_items: T.nilable(String), update_shipping_details: T.nilable(String)).void
}
def initialize(
update: nil,
update_discounts: nil,
update_line_items: nil,
update_shipping_details: nil
); end
end
class PhoneNumberCollection < Stripe::RequestParams
# Set to `true` to enable phone number collection.
#
# Can only be set in `payment` and `subscription` mode.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class SavedPaymentMethodOptions < Stripe::RequestParams
# Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.
sig { returns(T.nilable(T::Array[String])) }
def allow_redisplay_filters; end
sig {
params(_allow_redisplay_filters: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allow_redisplay_filters=(_allow_redisplay_filters); end
# Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
sig { returns(T.nilable(String)) }
def payment_method_remove; end
sig { params(_payment_method_remove: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_remove=(_payment_method_remove); end
# Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
sig { returns(T.nilable(String)) }
def payment_method_save; end
sig { params(_payment_method_save: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_save=(_payment_method_save); end
sig {
params(allow_redisplay_filters: T.nilable(T::Array[String]), payment_method_remove: T.nilable(String), payment_method_save: T.nilable(String)).void
}
def initialize(
allow_redisplay_filters: nil,
payment_method_remove: nil,
payment_method_save: nil
); end
end
class SetupIntentData < Stripe::RequestParams
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The Stripe account for which the setup is intended.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
sig {
params(description: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String)).void
}
def initialize(description: nil, metadata: nil, on_behalf_of: nil); end
end
class ShippingAddressCollection < Stripe::RequestParams
# An array of two-letter ISO country codes representing which countries Checkout should provide as options for
# shipping locations.
sig { returns(T::Array[String]) }
def allowed_countries; end
sig { params(_allowed_countries: T::Array[String]).returns(T::Array[String]) }
def allowed_countries=(_allowed_countries); end
sig { params(allowed_countries: T::Array[String]).void }
def initialize(allowed_countries: nil); end
end
class ShippingOption < Stripe::RequestParams
class ShippingRateData < Stripe::RequestParams
class DeliveryEstimate < Stripe::RequestParams
class Maximum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
class Minimum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum; end
sig {
params(_maximum: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum=(_maximum); end
# The lower bound of the estimated range. If empty, represents no lower bound.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum; end
sig {
params(_minimum: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum=(_minimum); end
sig {
params(maximum: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum), minimum: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)).void
}
def initialize(maximum: nil, minimum: nil); end
end
class FixedAmount < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig { params(amount: Integer, tax_behavior: T.nilable(String)).void }
def initialize(amount: nil, tax_behavior: nil); end
end
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(amount: Integer, currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])).void
}
def initialize(amount: nil, currency: nil, currency_options: nil); end
end
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate; end
sig {
params(_delivery_estimate: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate=(_delivery_estimate); end
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount))
}
def fixed_amount; end
sig {
params(_fixed_amount: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount))
}
def fixed_amount=(_fixed_amount); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The type of calculation to use on the shipping rate.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(delivery_estimate: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate), display_name: String, fixed_amount: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount), metadata: T.nilable(T::Hash[String, String]), tax_behavior: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
delivery_estimate: nil,
display_name: nil,
fixed_amount: nil,
metadata: nil,
tax_behavior: nil,
tax_code: nil,
type: nil
); end
end
# The ID of the Shipping Rate to use for this shipping option.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
# Parameters to be passed to Shipping Rate creation for this shipping option.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData))
}
def shipping_rate_data; end
sig {
params(_shipping_rate_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData))
}
def shipping_rate_data=(_shipping_rate_data); end
sig {
params(shipping_rate: T.nilable(String), shipping_rate_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData)).void
}
def initialize(shipping_rate: nil, shipping_rate_data: nil); end
end
class SubscriptionData < Stripe::RequestParams
class BillingMode < Stripe::RequestParams
class Flexible < Stripe::RequestParams
# Set to `true` to display gross amounts, net amounts, and discount amounts consistently between prorations and non-proration items on invoices, line items, and invoice items. Once set to `true`, you can't change it back to `false`.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
sig {
params(_consistent_proration_discount_amounts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consistent_proration_discount_amounts=(
_consistent_proration_discount_amounts
); end
sig { params(consistent_proration_discount_amounts: T.nilable(T::Boolean)).void }
def initialize(consistent_proration_discount_amounts: nil); end
end
# Configure behavior for flexible billing mode.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::BillingMode::Flexible))
}
def flexible; end
sig {
params(_flexible: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::BillingMode::Flexible)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::BillingMode::Flexible))
}
def flexible=(_flexible); end
# Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(flexible: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::BillingMode::Flexible), type: String).void
}
def initialize(flexible: nil, type: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(issuer: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings::Issuer)).void
}
def initialize(issuer: nil); end
end
class TransferData < Stripe::RequestParams
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount_percent: T.nilable(Float), destination: String).void }
def initialize(amount_percent: nil, destination: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
sig { returns(String) }
def missing_payment_method; end
sig { params(_missing_payment_method: String).returns(String) }
def missing_payment_method=(_missing_payment_method); end
sig { params(missing_payment_method: String).void }
def initialize(missing_payment_method: nil); end
end
# Defines how the subscription should behave when the user's free trial ends.
sig {
returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
}
def end_behavior; end
sig {
params(_end_behavior: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings::EndBehavior).returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings::EndBehavior).void
}
def initialize(end_behavior: nil); end
end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
sig { params(_application_fee_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def application_fee_percent=(_application_fee_percent); end
# A future timestamp to anchor the subscription's billing cycle for new subscriptions.
sig { returns(T.nilable(Integer)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(Integer)).returns(T.nilable(Integer)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::BillingMode))
}
def billing_mode; end
sig {
params(_billing_mode: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::BillingMode)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::BillingMode))
}
def billing_mode=(_billing_mode); end
# The tax rates that will apply to any subscription item that does not have
# `tax_rates` set. Invoices created will have their `default_tax_rates` populated
# from the subscription.
sig { returns(T.nilable(T::Array[String])) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def default_tax_rates=(_default_tax_rates); end
# The subscription's description, meant to be displayable to the customer.
# Use this field to optionally store an explanation of the subscription
# for rendering in the [customer portal](https://stripe.com/docs/customer-management).
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The account on behalf of which to charge, for each of the subscription's invoices.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TransferData))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TransferData)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TransferData))
}
def transfer_data=(_transfer_data); end
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.
sig { returns(T.nilable(Integer)) }
def trial_end; end
sig { params(_trial_end: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_end=(_trial_end); end
# Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
sig { returns(T.nilable(Integer)) }
def trial_period_days; end
sig { params(_trial_period_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_period_days=(_trial_period_days); end
# Settings related to subscription trials.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings))
}
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(application_fee_percent: T.nilable(Float), billing_cycle_anchor: T.nilable(Integer), billing_mode: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::BillingMode), default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), invoice_settings: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TransferData), trial_end: T.nilable(Integer), trial_period_days: T.nilable(Integer), trial_settings: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings)).void
}
def initialize(
application_fee_percent: nil,
billing_cycle_anchor: nil,
billing_mode: nil,
default_tax_rates: nil,
description: nil,
invoice_settings: nil,
metadata: nil,
on_behalf_of: nil,
proration_behavior: nil,
transfer_data: nil,
trial_end: nil,
trial_period_days: nil,
trial_settings: nil
); end
end
class TaxIdCollection < Stripe::RequestParams
# Enable tax ID collection during checkout. Defaults to `false`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Describes whether a tax ID is required during checkout. Defaults to `never`.
sig { returns(T.nilable(String)) }
def required; end
sig { params(_required: T.nilable(String)).returns(T.nilable(String)) }
def required=(_required); end
sig { params(enabled: T::Boolean, required: T.nilable(String)).void }
def initialize(enabled: nil, required: nil); end
end
class WalletOptions < Stripe::RequestParams
class Link < Stripe::RequestParams
# Specifies whether Checkout should display Link as a payment option. By default, Checkout will display all the supported wallets that the Checkout Session was created with. This is the `auto` behavior, and it is the default choice.
sig { returns(T.nilable(String)) }
def display; end
sig { params(_display: T.nilable(String)).returns(T.nilable(String)) }
def display=(_display); end
sig { params(display: T.nilable(String)).void }
def initialize(display: nil); end
end
# contains details about the Link wallet options.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::WalletOptions::Link))
}
def link; end
sig {
params(_link: T.nilable(::Stripe::Checkout::SessionService::CreateParams::WalletOptions::Link)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::WalletOptions::Link))
}
def link=(_link); end
sig {
params(link: T.nilable(::Stripe::Checkout::SessionService::CreateParams::WalletOptions::Link)).void
}
def initialize(link: nil); end
end
# Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::AdaptivePricing))
}
def adaptive_pricing; end
sig {
params(_adaptive_pricing: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AdaptivePricing)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::AdaptivePricing))
}
def adaptive_pricing=(_adaptive_pricing); end
# Configure actions after a Checkout Session has expired.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration))
}
def after_expiration; end
sig {
params(_after_expiration: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration))
}
def after_expiration=(_after_expiration); end
# Enables user redeemable promotion codes.
sig { returns(T.nilable(T::Boolean)) }
def allow_promotion_codes; end
sig { params(_allow_promotion_codes: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def allow_promotion_codes=(_allow_promotion_codes); end
# Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
sig { returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
sig { returns(T.nilable(String)) }
def billing_address_collection; end
sig { params(_billing_address_collection: T.nilable(String)).returns(T.nilable(String)) }
def billing_address_collection=(_billing_address_collection); end
# The branding settings for the Checkout Session. This parameter is not allowed if ui_mode is `custom`.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::BrandingSettings))
}
def branding_settings; end
sig {
params(_branding_settings: T.nilable(::Stripe::Checkout::SessionService::CreateParams::BrandingSettings)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::BrandingSettings))
}
def branding_settings=(_branding_settings); end
# If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded` or `custom`.
sig { returns(T.nilable(String)) }
def cancel_url; end
sig { params(_cancel_url: T.nilable(String)).returns(T.nilable(String)) }
def cancel_url=(_cancel_url); end
# A unique string to reference the Checkout Session. This can be a
# customer ID, a cart ID, or similar, and can be used to reconcile the
# session with your internal systems.
sig { returns(T.nilable(String)) }
def client_reference_id; end
sig { params(_client_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def client_reference_id=(_client_reference_id); end
# Configure fields for the Checkout Session to gather active consent from customers.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection))
}
def consent_collection; end
sig {
params(_consent_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection))
}
def consent_collection=(_consent_collection); end
# 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). Required in `setup` mode when `payment_method_types` is not set.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Collect additional information from your customer using custom fields. Up to 3 fields are supported.
sig {
returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField]))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField])).returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField]))
}
def custom_fields=(_custom_fields); end
# Display additional text for your customers using custom text.
sig { returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText)) }
def custom_text; end
sig {
params(_custom_text: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText))
}
def custom_text=(_custom_text); end
# ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card
# payment method will be used to prefill the email, name, card details, and billing address
# on the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)
# will be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.
#
# If the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.
# If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.
#
# If blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow.
#
# You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# ID of an existing Account, if one exists. Has the same behavior as `customer`.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
#
# When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
# with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).
#
# Sessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)
# in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.
#
# Can only be set in `payment` and `setup` mode.
sig { returns(T.nilable(String)) }
def customer_creation; end
sig { params(_customer_creation: T.nilable(String)).returns(T.nilable(String)) }
def customer_creation=(_customer_creation); end
# If provided, this value will be used when the Customer object is created.
# If not provided, customers will be asked to enter their email address.
# Use this parameter to prefill customer data if you already have an email
# on file. To access information about the customer once a session is
# complete, use the `customer` field.
sig { returns(T.nilable(String)) }
def customer_email; end
sig { params(_customer_email: T.nilable(String)).returns(T.nilable(String)) }
def customer_email=(_customer_email); end
# Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
sig { returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomerUpdate)) }
def customer_update; end
sig {
params(_customer_update: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomerUpdate)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomerUpdate))
}
def customer_update=(_customer_update); end
# The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
sig {
returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::Discount])).returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::Discount]))
}
def discounts=(_discounts); end
# A list of the types of payment methods (e.g., `card`) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
sig { returns(T.nilable(T::Array[String])) }
def excluded_payment_method_types; end
sig {
params(_excluded_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def excluded_payment_method_types=(_excluded_payment_method_types); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# Generate a post-purchase Invoice for one-time payments.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation))
}
def invoice_creation; end
sig {
params(_invoice_creation: T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation))
}
def invoice_creation=(_invoice_creation); end
# A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). The parameter is required for `payment` and `subscription` mode.
#
# For `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.
#
# For `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.
sig {
returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::LineItem]))
}
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::LineItem])).returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::LineItem]))
}
def line_items=(_line_items); end
# The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
sig { returns(T.nilable(String)) }
def locale; end
sig { params(_locale: T.nilable(String)).returns(T.nilable(String)) }
def locale=(_locale); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Controls name collection settings for the session.
#
# You can configure Checkout to collect your customers' business names, individual names, or both. Each name field can be either required or optional.
#
# If a [Customer](https://stripe.com/docs/api/customers) is created or provided, the names can be saved to the Customer object as well.
sig { returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::NameCollection)) }
def name_collection; end
sig {
params(_name_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::NameCollection)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::NameCollection))
}
def name_collection=(_name_collection); end
# A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
#
# There is a maximum of 10 optional items allowed on a Checkout Session, and the existing limits on the number of line items allowed on a Checkout Session apply to the combined number of line items and optional items.
#
# For `payment` mode, there is a maximum of 100 combined line items and optional items, however it is recommended to consolidate items if there are more than a few dozen.
#
# For `subscription` mode, there is a maximum of 20 line items and optional items with recurring Prices and 20 line items and optional items with one-time Prices.
sig {
returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::OptionalItem]))
}
def optional_items; end
sig {
params(_optional_items: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::OptionalItem])).returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::OptionalItem]))
}
def optional_items=(_optional_items); end
# Where the user is coming from. This informs the optimizations that are applied to the session.
sig { returns(T.nilable(String)) }
def origin_context; end
sig { params(_origin_context: T.nilable(String)).returns(T.nilable(String)) }
def origin_context=(_origin_context); end
# A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData))
}
def payment_intent_data; end
sig {
params(_payment_intent_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData))
}
def payment_intent_data=(_payment_intent_data); end
# Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.
# This may occur if the Checkout Session includes a free trial or a discount.
#
# Can only be set in `subscription` mode. Defaults to `always`.
#
# If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
sig { returns(T.nilable(String)) }
def payment_method_collection; end
sig { params(_payment_method_collection: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_collection=(_payment_method_collection); end
# The ID of the payment method configuration to use with this Checkout session.
sig { returns(T.nilable(String)) }
def payment_method_configuration; end
sig { params(_payment_method_configuration: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_configuration=(_payment_method_configuration); end
# This parameter allows you to set some attributes on the payment method created during a Checkout session.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodData))
}
def payment_method_data; end
sig {
params(_payment_method_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodData)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodData))
}
def payment_method_data=(_payment_method_data); end
# Payment-method-specific configuration.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
#
# You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
# See [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.
#
# Read more about the supported payment methods and their requirements in our [payment
# method details guide](/docs/payments/checkout/payment-methods).
#
# If multiple payment methods are passed, Checkout will dynamically reorder them to
# prioritize the most relevant payment methods based on the customer's location and
# other characteristics.
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
# This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object. Can only be set when creating `embedded` or `custom` sessions.
#
# For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.
sig { returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::Permissions)) }
def permissions; end
sig {
params(_permissions: T.nilable(::Stripe::Checkout::SessionService::CreateParams::Permissions)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::Permissions))
}
def permissions=(_permissions); end
# Controls phone number collection settings for the session.
#
# We recommend that you review your privacy policy and check with your legal contacts
# before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PhoneNumberCollection))
}
def phone_number_collection; end
sig {
params(_phone_number_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PhoneNumberCollection)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PhoneNumberCollection))
}
def phone_number_collection=(_phone_number_collection); end
# This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
sig { returns(T.nilable(String)) }
def redirect_on_completion; end
sig { params(_redirect_on_completion: T.nilable(String)).returns(T.nilable(String)) }
def redirect_on_completion=(_redirect_on_completion); end
# The URL to redirect your customer back to after they authenticate or cancel their payment on the
# payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`
# and redirect-based payment methods are enabled on the session.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SavedPaymentMethodOptions))
}
def saved_payment_method_options; end
sig {
params(_saved_payment_method_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SavedPaymentMethodOptions)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SavedPaymentMethodOptions))
}
def saved_payment_method_options=(_saved_payment_method_options); end
# A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SetupIntentData))
}
def setup_intent_data; end
sig {
params(_setup_intent_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SetupIntentData)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SetupIntentData))
}
def setup_intent_data=(_setup_intent_data); end
# When set, provides configuration for Checkout to collect a shipping address from a customer.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingAddressCollection))
}
def shipping_address_collection; end
sig {
params(_shipping_address_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingAddressCollection)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingAddressCollection))
}
def shipping_address_collection=(_shipping_address_collection); end
# The shipping rate options to apply to this Session. Up to a maximum of 5.
sig {
returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::ShippingOption]))
}
def shipping_options; end
sig {
params(_shipping_options: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::ShippingOption])).returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::ShippingOption]))
}
def shipping_options=(_shipping_options); end
# Describes the type of transaction being performed by Checkout in order
# to customize relevant text on the page, such as the submit button.
# `submit_type` can only be specified on Checkout Sessions in
# `payment` or `subscription` mode. If blank or `auto`, `pay` is used.
sig { returns(T.nilable(String)) }
def submit_type; end
sig { params(_submit_type: T.nilable(String)).returns(T.nilable(String)) }
def submit_type=(_submit_type); end
# A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData))
}
def subscription_data; end
sig {
params(_subscription_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData))
}
def subscription_data=(_subscription_data); end
# The URL to which Stripe should send customers when payment or setup
# is complete.
# This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use
# information from the successful Checkout Session on your page, read the
# guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).
sig { returns(T.nilable(String)) }
def success_url; end
sig { params(_success_url: T.nilable(String)).returns(T.nilable(String)) }
def success_url=(_success_url); end
# Controls tax ID collection during checkout.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::TaxIdCollection))
}
def tax_id_collection; end
sig {
params(_tax_id_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::TaxIdCollection)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::TaxIdCollection))
}
def tax_id_collection=(_tax_id_collection); end
# The UI mode of the Session. Defaults to `hosted`.
sig { returns(T.nilable(String)) }
def ui_mode; end
sig { params(_ui_mode: T.nilable(String)).returns(T.nilable(String)) }
def ui_mode=(_ui_mode); end
# Wallet-specific configuration.
sig { returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::WalletOptions)) }
def wallet_options; end
sig {
params(_wallet_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::WalletOptions)).returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::WalletOptions))
}
def wallet_options=(_wallet_options); end
sig {
params(adaptive_pricing: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AdaptivePricing), after_expiration: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration), allow_promotion_codes: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax), billing_address_collection: T.nilable(String), branding_settings: T.nilable(::Stripe::Checkout::SessionService::CreateParams::BrandingSettings), cancel_url: T.nilable(String), client_reference_id: T.nilable(String), consent_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection), currency: T.nilable(String), custom_fields: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField]), custom_text: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText), customer: T.nilable(String), customer_account: T.nilable(String), customer_creation: T.nilable(String), customer_email: T.nilable(String), customer_update: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomerUpdate), discounts: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::Discount]), excluded_payment_method_types: T.nilable(T::Array[String]), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), invoice_creation: T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::LineItem]), locale: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), mode: T.nilable(String), name_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::NameCollection), optional_items: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::OptionalItem]), origin_context: T.nilable(String), payment_intent_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), permissions: T.nilable(::Stripe::Checkout::SessionService::CreateParams::Permissions), phone_number_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PhoneNumberCollection), redirect_on_completion: T.nilable(String), return_url: T.nilable(String), saved_payment_method_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SavedPaymentMethodOptions), setup_intent_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SetupIntentData), shipping_address_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingAddressCollection), shipping_options: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::ShippingOption]), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData), success_url: T.nilable(String), tax_id_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::TaxIdCollection), ui_mode: T.nilable(String), wallet_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::WalletOptions)).void
}
def initialize(
adaptive_pricing: nil,
after_expiration: nil,
allow_promotion_codes: nil,
automatic_tax: nil,
billing_address_collection: nil,
branding_settings: nil,
cancel_url: nil,
client_reference_id: nil,
consent_collection: nil,
currency: nil,
custom_fields: nil,
custom_text: nil,
customer: nil,
customer_account: nil,
customer_creation: nil,
customer_email: nil,
customer_update: nil,
discounts: nil,
excluded_payment_method_types: nil,
expand: nil,
expires_at: nil,
invoice_creation: nil,
line_items: nil,
locale: nil,
metadata: nil,
mode: nil,
name_collection: nil,
optional_items: nil,
origin_context: nil,
payment_intent_data: nil,
payment_method_collection: nil,
payment_method_configuration: nil,
payment_method_data: nil,
payment_method_options: nil,
payment_method_types: nil,
permissions: nil,
phone_number_collection: nil,
redirect_on_completion: nil,
return_url: nil,
saved_payment_method_options: nil,
setup_intent_data: nil,
shipping_address_collection: nil,
shipping_options: nil,
submit_type: nil,
subscription_data: nil,
success_url: nil,
tax_id_collection: nil,
ui_mode: nil,
wallet_options: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(liability: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::AutomaticTax::Liability)).void
}
def initialize(liability: nil); end
end
class CollectedInformation < Stripe::RequestParams
class ShippingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(String) }
def line1; end
sig { params(_line1: String).returns(String) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: String, line1: String, line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The address of the customer
sig {
returns(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails::Address)
}
def address; end
sig {
params(_address: ::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails::Address).returns(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails::Address)
}
def address=(_address); end
# The name of customer
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(address: ::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails::Address, name: String).void
}
def initialize(address: nil, name: nil); end
end
# The shipping details to apply to this Session.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails))
}
def shipping_details; end
sig {
params(_shipping_details: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails))
}
def shipping_details=(_shipping_details); end
sig {
params(shipping_details: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails)).void
}
def initialize(shipping_details: nil); end
end
class Discount < Stripe::RequestParams
class CouponData < Stripe::RequestParams
# A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
sig { returns(T.nilable(Integer)) }
def amount_off; end
sig { params(_amount_off: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_off=(_amount_off); end
# Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
sig { returns(T.nilable(String)) }
def duration; end
sig { params(_duration: T.nilable(String)).returns(T.nilable(String)) }
def duration=(_duration); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
sig { returns(T.nilable(Float)) }
def percent_off; end
sig { params(_percent_off: T.nilable(Float)).returns(T.nilable(Float)) }
def percent_off=(_percent_off); end
sig {
params(amount_off: T.nilable(Integer), currency: T.nilable(String), duration: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String), percent_off: T.nilable(Float)).void
}
def initialize(
amount_off: nil,
currency: nil,
duration: nil,
metadata: nil,
name: nil,
percent_off: nil
); end
end
# The ID of the [Coupon](https://stripe.com/docs/api/coupons) to apply to this Session. One of `coupon` or `coupon_data` is required when updating discounts.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# Data used to generate a new [Coupon](https://stripe.com/docs/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::Discount::CouponData))
}
def coupon_data; end
sig {
params(_coupon_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::Discount::CouponData)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::Discount::CouponData))
}
def coupon_data=(_coupon_data); end
sig {
params(coupon: T.nilable(String), coupon_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::Discount::CouponData)).void
}
def initialize(coupon: nil, coupon_data: nil); end
end
class InvoiceCreation < Stripe::RequestParams
class InvoiceData < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::InvoiceCreation::InvoiceData::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::InvoiceCreation::InvoiceData::Issuer)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::InvoiceCreation::InvoiceData::Issuer))
}
def issuer=(_issuer); end
sig {
params(issuer: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::InvoiceCreation::InvoiceData::Issuer)).void
}
def initialize(issuer: nil); end
end
# Parameters passed when creating invoices for payment-mode Checkout Sessions.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::InvoiceCreation::InvoiceData))
}
def invoice_data; end
sig {
params(_invoice_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::InvoiceCreation::InvoiceData)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::InvoiceCreation::InvoiceData))
}
def invoice_data=(_invoice_data); end
sig {
params(invoice_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::InvoiceCreation::InvoiceData)).void
}
def initialize(invoice_data: nil); end
end
class LineItem < Stripe::RequestParams
class AdjustableQuantity < Stripe::RequestParams
# Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil); end
end
class PriceData < Stripe::RequestParams
class ProductData < Stripe::RequestParams
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T::Array[String])) }
def images; end
sig {
params(_images: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def images=(_images); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
sig {
params(description: T.nilable(String), images: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: String, tax_code: T.nilable(String), unit_label: T.nilable(String)).void
}
def initialize(
description: nil,
images: nil,
metadata: nil,
name: nil,
tax_code: nil,
unit_label: nil
); end
end
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::PriceData::ProductData))
}
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::PriceData::ProductData)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::PriceData::ProductData))
}
def product_data=(_product_data); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::PriceData::Recurring))
}
def recurring; end
sig {
params(_recurring: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::PriceData::Recurring)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::PriceData::Recurring))
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: T.nilable(String), product_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::PriceData::ProductData), recurring: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::PriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
product_data: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::AdjustableQuantity))
}
def adjustable_quantity; end
sig {
params(_adjustable_quantity: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::AdjustableQuantity)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::AdjustableQuantity))
}
def adjustable_quantity=(_adjustable_quantity); end
# ID of an existing line item.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The ID of the [Price](https://stripe.com/docs/api/prices). One of `price` or `price_data` is required when creating a new line item.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required when creating a new line item.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::PriceData)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::PriceData))
}
def price_data=(_price_data); end
# The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(adjustable_quantity: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::AdjustableQuantity), id: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), price: T.nilable(String), price_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
adjustable_quantity: nil,
id: nil,
metadata: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class ShippingOption < Stripe::RequestParams
class ShippingRateData < Stripe::RequestParams
class DeliveryEstimate < Stripe::RequestParams
class Maximum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
class Minimum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum; end
sig {
params(_maximum: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum=(_maximum); end
# The lower bound of the estimated range. If empty, represents no lower bound.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum; end
sig {
params(_minimum: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum=(_minimum); end
sig {
params(maximum: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum), minimum: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)).void
}
def initialize(maximum: nil, minimum: nil); end
end
class FixedAmount < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig { params(amount: Integer, tax_behavior: T.nilable(String)).void }
def initialize(amount: nil, tax_behavior: nil); end
end
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(amount: Integer, currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])).void
}
def initialize(amount: nil, currency: nil, currency_options: nil); end
end
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate; end
sig {
params(_delivery_estimate: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate=(_delivery_estimate); end
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount))
}
def fixed_amount; end
sig {
params(_fixed_amount: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount))
}
def fixed_amount=(_fixed_amount); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The type of calculation to use on the shipping rate.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(delivery_estimate: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate), display_name: String, fixed_amount: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount), metadata: T.nilable(T::Hash[String, String]), tax_behavior: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
delivery_estimate: nil,
display_name: nil,
fixed_amount: nil,
metadata: nil,
tax_behavior: nil,
tax_code: nil,
type: nil
); end
end
# The ID of the Shipping Rate to use for this shipping option.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
# Parameters to be passed to Shipping Rate creation for this shipping option.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData))
}
def shipping_rate_data; end
sig {
params(_shipping_rate_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData))
}
def shipping_rate_data=(_shipping_rate_data); end
sig {
params(shipping_rate: T.nilable(String), shipping_rate_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData)).void
}
def initialize(shipping_rate: nil, shipping_rate_data: nil); end
end
class SubscriptionData < Stripe::RequestParams
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::SubscriptionData::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::SubscriptionData::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::SubscriptionData::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(issuer: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::SubscriptionData::InvoiceSettings::Issuer)).void
}
def initialize(issuer: nil); end
end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::SubscriptionData::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::SubscriptionData::InvoiceSettings)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::SubscriptionData::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.
sig { returns(T.nilable(Integer)) }
def trial_end; end
sig { params(_trial_end: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_end=(_trial_end); end
# Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
sig { returns(T.nilable(T.any(String, Integer))) }
def trial_period_days; end
sig {
params(_trial_period_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def trial_period_days=(_trial_period_days); end
sig {
params(invoice_settings: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::SubscriptionData::InvoiceSettings), trial_end: T.nilable(Integer), trial_period_days: T.nilable(T.any(String, Integer))).void
}
def initialize(invoice_settings: nil, trial_end: nil, trial_period_days: nil); end
end
# Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
sig { returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::AutomaticTax)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Information about the customer collected within the Checkout Session. Can only be set when updating `embedded` or `custom` sessions.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation))
}
def collected_information; end
sig {
params(_collected_information: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation))
}
def collected_information=(_collected_information); end
# List of coupons and promotion codes attached to the Checkout Session.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::UpdateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::UpdateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::UpdateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Generate a post-purchase Invoice for one-time payments.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::InvoiceCreation))
}
def invoice_creation; end
sig {
params(_invoice_creation: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::InvoiceCreation)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::InvoiceCreation))
}
def invoice_creation=(_invoice_creation); end
# A list of items the customer is purchasing.
#
# When updating line items, you must retransmit the entire array of line items.
#
# To retain an existing line item, specify its `id`.
#
# To update an existing line item, specify its `id` along with the new values of the fields to update.
#
# To add a new line item, specify one of `price` or `price_data` and `quantity`.
#
# To remove an existing line item, omit the line item's ID from the retransmitted array.
#
# To reorder a line item, specify it at the desired position in the retransmitted array.
sig {
returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::UpdateParams::LineItem]))
}
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::Checkout::SessionService::UpdateParams::LineItem])).returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::UpdateParams::LineItem]))
}
def line_items=(_line_items); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The shipping rate options to apply to this Session. Up to a maximum of 5.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::UpdateParams::ShippingOption])))
}
def shipping_options; end
sig {
params(_shipping_options: T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::UpdateParams::ShippingOption]))).returns(T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::UpdateParams::ShippingOption])))
}
def shipping_options=(_shipping_options); end
# A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
sig {
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::SubscriptionData))
}
def subscription_data; end
sig {
params(_subscription_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::SubscriptionData)).returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::SubscriptionData))
}
def subscription_data=(_subscription_data); end
sig {
params(automatic_tax: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::AutomaticTax), collected_information: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation), discounts: T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::UpdateParams::Discount])), expand: T.nilable(T::Array[String]), invoice_creation: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::Checkout::SessionService::UpdateParams::LineItem]), metadata: T.nilable(T.any(String, T::Hash[String, String])), shipping_options: T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::UpdateParams::ShippingOption])), subscription_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::SubscriptionData)).void
}
def initialize(
automatic_tax: nil,
collected_information: nil,
discounts: nil,
expand: nil,
invoice_creation: nil,
line_items: nil,
metadata: nil,
shipping_options: nil,
subscription_data: nil
); end
end
class ExpireParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Creates a Checkout Session object.
sig {
params(params: T.any(::Stripe::Checkout::SessionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
}
def create(params = {}, opts = {}); end
# A Checkout Session can be expired when it is in one of these statuses: open
#
# 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.
sig {
params(session: String, params: T.any(::Stripe::Checkout::SessionService::ExpireParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
}
def expire(session, params = {}, opts = {}); end
# Returns a list of Checkout Sessions.
sig {
params(params: T.any(::Stripe::Checkout::SessionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a Checkout Session object.
sig {
params(session: String, params: T.any(::Stripe::Checkout::SessionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
}
def retrieve(session, params = {}, opts = {}); end
# Updates a Checkout Session object.
#
# Related guide: [Dynamically update Checkout](https://docs.stripe.com/payments/checkout/dynamic-updates)
sig {
params(session: String, params: T.any(::Stripe::Checkout::SessionService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
}
def update(session, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Checkout
class SessionLineItemService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
sig {
params(session: String, params: T.any(::Stripe::Checkout::SessionLineItemService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(session, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class ClimateService < StripeService
attr_reader :orders
attr_reader :products
attr_reader :suppliers
end
end
# typed: true
module Stripe
module Climate
class OrderService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateParams < Stripe::RequestParams
class Beneficiary < Stripe::RequestParams
# Publicly displayable name for the end beneficiary of carbon removal.
sig { returns(String) }
def public_name; end
sig { params(_public_name: String).returns(String) }
def public_name=(_public_name); end
sig { params(public_name: String).void }
def initialize(public_name: nil); end
end
# Requested amount of carbon removal units. Either this or `metric_tons` must be specified.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.
sig { returns(T.nilable(::Stripe::Climate::OrderService::CreateParams::Beneficiary)) }
def beneficiary; end
sig {
params(_beneficiary: T.nilable(::Stripe::Climate::OrderService::CreateParams::Beneficiary)).returns(T.nilable(::Stripe::Climate::OrderService::CreateParams::Beneficiary))
}
def beneficiary=(_beneficiary); end
# Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Requested number of tons for the order. Either this or `amount` must be specified.
sig { returns(T.nilable(String)) }
def metric_tons; end
sig { params(_metric_tons: T.nilable(String)).returns(T.nilable(String)) }
def metric_tons=(_metric_tons); end
# Unique identifier of the Climate product.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
sig {
params(amount: T.nilable(Integer), beneficiary: T.nilable(::Stripe::Climate::OrderService::CreateParams::Beneficiary), currency: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), metric_tons: T.nilable(String), product: String).void
}
def initialize(
amount: nil,
beneficiary: nil,
currency: nil,
expand: nil,
metadata: nil,
metric_tons: nil,
product: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Beneficiary < Stripe::RequestParams
# Publicly displayable name for the end beneficiary of carbon removal.
sig { returns(String) }
def public_name; end
sig { params(_public_name: String).returns(String) }
def public_name=(_public_name); end
sig { params(public_name: String).void }
def initialize(public_name: nil); end
end
# Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.
sig {
returns(T.nilable(T.any(String, ::Stripe::Climate::OrderService::UpdateParams::Beneficiary)))
}
def beneficiary; end
sig {
params(_beneficiary: T.nilable(T.any(String, ::Stripe::Climate::OrderService::UpdateParams::Beneficiary))).returns(T.nilable(T.any(String, ::Stripe::Climate::OrderService::UpdateParams::Beneficiary)))
}
def beneficiary=(_beneficiary); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(beneficiary: T.nilable(T.any(String, ::Stripe::Climate::OrderService::UpdateParams::Beneficiary)), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(beneficiary: nil, expand: nil, metadata: nil); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
# reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
# might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
# provides 90 days advance notice and refunds the amount_total.
sig {
params(order: String, params: T.any(::Stripe::Climate::OrderService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Climate::Order)
}
def cancel(order, params = {}, opts = {}); end
# Creates a Climate order object for a given Climate product. The order will be processed immediately
# after creation and payment will be deducted your Stripe balance.
sig {
params(params: T.any(::Stripe::Climate::OrderService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Climate::Order)
}
def create(params = {}, opts = {}); end
# Lists all Climate order objects. The orders are returned sorted by creation date, with the
# most recently created orders appearing first.
sig {
params(params: T.any(::Stripe::Climate::OrderService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of a Climate order object with the given ID.
sig {
params(order: String, params: T.any(::Stripe::Climate::OrderService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Climate::Order)
}
def retrieve(order, params = {}, opts = {}); end
# Updates the specified order by setting the values of the parameters passed.
sig {
params(order: String, params: T.any(::Stripe::Climate::OrderService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Climate::Order)
}
def update(order, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Climate
class ProductService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Lists all available Climate product objects.
sig {
params(params: T.any(::Stripe::Climate::ProductService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of a Climate product with the given ID.
sig {
params(product: String, params: T.any(::Stripe::Climate::ProductService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Climate::Product)
}
def retrieve(product, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Climate
class SupplierService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Lists all available Climate supplier objects.
sig {
params(params: T.any(::Stripe::Climate::SupplierService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a Climate supplier object.
sig {
params(supplier: String, params: T.any(::Stripe::Climate::SupplierService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Climate::Supplier)
}
def retrieve(supplier, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class ConfirmationTokenService < StripeService
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Retrieves an existing ConfirmationToken object
sig {
params(confirmation_token: String, params: T.any(::Stripe::ConfirmationTokenService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ConfirmationToken)
}
def retrieve(confirmation_token, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class CountrySpecService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Lists all Country Spec objects available in the API.
sig {
params(params: T.any(::Stripe::CountrySpecService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Returns a Country Spec for a given Country code.
sig {
params(country: String, params: T.any(::Stripe::CountrySpecService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CountrySpec)
}
def retrieve(country, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class CouponService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A positive integer representing the amount to subtract from an invoice total.
sig { returns(Integer) }
def amount_off; end
sig { params(_amount_off: Integer).returns(Integer) }
def amount_off=(_amount_off); end
sig { params(amount_off: Integer).void }
def initialize(amount_off: nil); end
end
# Coupons defined in each available currency option (only supported if the coupon is amount-based). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::CouponService::UpdateParams::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::CouponService::UpdateParams::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::CouponService::UpdateParams::CurrencyOptions]))
}
def currency_options=(_currency_options); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(currency_options: T.nilable(T::Hash[String, ::Stripe::CouponService::UpdateParams::CurrencyOptions]), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String)).void
}
def initialize(currency_options: nil, expand: nil, metadata: nil, name: nil); end
end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
sig { returns(T.nilable(T.any(::Stripe::CouponService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::CouponService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::CouponService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::CouponService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class AppliesTo < Stripe::RequestParams
# An array of Product IDs that this Coupon will apply to.
sig { returns(T.nilable(T::Array[String])) }
def products; end
sig { params(_products: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def products=(_products); end
sig { params(products: T.nilable(T::Array[String])).void }
def initialize(products: nil); end
end
class CurrencyOptions < Stripe::RequestParams
# A positive integer representing the amount to subtract from an invoice total.
sig { returns(Integer) }
def amount_off; end
sig { params(_amount_off: Integer).returns(Integer) }
def amount_off=(_amount_off); end
sig { params(amount_off: Integer).void }
def initialize(amount_off: nil); end
end
class Script < Stripe::RequestParams
# The configuration values of the script. The keys and values are specific to the script implementation.
sig { returns(T::Hash[String, T.untyped]) }
def configuration; end
sig {
params(_configuration: T::Hash[String, T.untyped]).returns(T::Hash[String, T.untyped])
}
def configuration=(_configuration); end
# The script implementation ID for this coupon.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
sig { params(configuration: T::Hash[String, T.untyped], id: String).void }
def initialize(configuration: nil, id: nil); end
end
# A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
sig { returns(T.nilable(Integer)) }
def amount_off; end
sig { params(_amount_off: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_off=(_amount_off); end
# A hash containing directions for what this Coupon will apply discounts to.
sig { returns(T.nilable(::Stripe::CouponService::CreateParams::AppliesTo)) }
def applies_to; end
sig {
params(_applies_to: T.nilable(::Stripe::CouponService::CreateParams::AppliesTo)).returns(T.nilable(::Stripe::CouponService::CreateParams::AppliesTo))
}
def applies_to=(_applies_to); end
# Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Coupons defined in each available currency option (only supported if `amount_off` is passed). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::CouponService::CreateParams::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::CouponService::CreateParams::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::CouponService::CreateParams::CurrencyOptions]))
}
def currency_options=(_currency_options); end
# Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
sig { returns(T.nilable(String)) }
def duration; end
sig { params(_duration: T.nilable(String)).returns(T.nilable(String)) }
def duration=(_duration); end
# Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
sig { returns(T.nilable(Integer)) }
def duration_in_months; end
sig { params(_duration_in_months: T.nilable(Integer)).returns(T.nilable(Integer)) }
def duration_in_months=(_duration_in_months); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.
sig { returns(T.nilable(Integer)) }
def max_redemptions; end
sig { params(_max_redemptions: T.nilable(Integer)).returns(T.nilable(Integer)) }
def max_redemptions=(_max_redemptions); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
sig { returns(T.nilable(Float)) }
def percent_off; end
sig { params(_percent_off: T.nilable(Float)).returns(T.nilable(Float)) }
def percent_off=(_percent_off); end
# Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.
sig { returns(T.nilable(Integer)) }
def redeem_by; end
sig { params(_redeem_by: T.nilable(Integer)).returns(T.nilable(Integer)) }
def redeem_by=(_redeem_by); end
# Configuration of the [script](https://docs.stripe.com/billing/subscriptions/script-coupons) used to calculate the discount.
sig { returns(T.nilable(::Stripe::CouponService::CreateParams::Script)) }
def script; end
sig {
params(_script: T.nilable(::Stripe::CouponService::CreateParams::Script)).returns(T.nilable(::Stripe::CouponService::CreateParams::Script))
}
def script=(_script); end
sig {
params(amount_off: T.nilable(Integer), applies_to: T.nilable(::Stripe::CouponService::CreateParams::AppliesTo), currency: T.nilable(String), currency_options: T.nilable(T::Hash[String, ::Stripe::CouponService::CreateParams::CurrencyOptions]), duration: T.nilable(String), duration_in_months: T.nilable(Integer), expand: T.nilable(T::Array[String]), id: T.nilable(String), max_redemptions: T.nilable(Integer), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String), percent_off: T.nilable(Float), redeem_by: T.nilable(Integer), script: T.nilable(::Stripe::CouponService::CreateParams::Script)).void
}
def initialize(
amount_off: nil,
applies_to: nil,
currency: nil,
currency_options: nil,
duration: nil,
duration_in_months: nil,
expand: nil,
id: nil,
max_redemptions: nil,
metadata: nil,
name: nil,
percent_off: nil,
redeem_by: nil,
script: nil
); end
end
# You can create coupons easily via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.
#
# A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice's subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.
sig {
params(params: T.any(::Stripe::CouponService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Coupon)
}
def create(params = {}, opts = {}); end
# You can delete coupons via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can't redeem the coupon. You can also delete coupons via the API.
sig {
params(coupon: String, params: T.any(::Stripe::CouponService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Coupon)
}
def delete(coupon, params = {}, opts = {}); end
# Returns a list of your coupons.
sig {
params(params: T.any(::Stripe::CouponService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the coupon with the given ID.
sig {
params(coupon: String, params: T.any(::Stripe::CouponService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Coupon)
}
def retrieve(coupon, params = {}, opts = {}); end
# Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
sig {
params(coupon: String, params: T.any(::Stripe::CouponService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Coupon)
}
def update(coupon, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class CreditNoteService < StripeService
attr_reader :line_items
attr_reader :preview_lines
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return credit notes that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::CreditNoteService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::CreditNoteService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::CreditNoteService::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return credit notes for the customer specified by this customer ID.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Only return credit notes for the account specified by this account ID.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Only return credit notes for the invoice specified by this invoice ID.
sig { returns(T.nilable(String)) }
def invoice; end
sig { params(_invoice: T.nilable(String)).returns(T.nilable(String)) }
def invoice=(_invoice); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::CreditNoteService::ListParams::Created, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: T.nilable(String), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
invoice: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Line < Stripe::RequestParams
class TaxAmount < Stripe::RequestParams
# The amount, in cents (or local equivalent), of the tax.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.
sig { returns(String) }
def tax_rate; end
sig { params(_tax_rate: String).returns(String) }
def tax_rate=(_tax_rate); end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(Integer) }
def taxable_amount; end
sig { params(_taxable_amount: Integer).returns(Integer) }
def taxable_amount=(_taxable_amount); end
sig { params(amount: Integer, tax_rate: String, taxable_amount: Integer).void }
def initialize(amount: nil, tax_rate: nil, taxable_amount: nil); end
end
# The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
sig { returns(T.nilable(String)) }
def invoice_line_item; end
sig { params(_invoice_line_item: T.nilable(String)).returns(T.nilable(String)) }
def invoice_line_item=(_invoice_line_item); end
# The line item quantity to credit.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNoteService::CreateParams::Line::TaxAmount])))
}
def tax_amounts; end
sig {
params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNoteService::CreateParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNoteService::CreateParams::Line::TaxAmount])))
}
def tax_amounts=(_tax_amounts); end
# The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(amount: T.nilable(Integer), description: T.nilable(String), invoice_line_item: T.nilable(String), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNoteService::CreateParams::Line::TaxAmount])), tax_rates: T.nilable(T.any(String, T::Array[String])), type: String, unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
amount: nil,
description: nil,
invoice_line_item: nil,
quantity: nil,
tax_amounts: nil,
tax_rates: nil,
type: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Refund < Stripe::RequestParams
# Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
sig { returns(T.nilable(Integer)) }
def amount_refunded; end
sig { params(_amount_refunded: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_refunded=(_amount_refunded); end
# ID of an existing refund to link this credit note to. Required when `type` is `refund`.
sig { returns(T.nilable(String)) }
def refund; end
sig { params(_refund: T.nilable(String)).returns(T.nilable(String)) }
def refund=(_refund); end
sig { params(amount_refunded: T.nilable(Integer), refund: T.nilable(String)).void }
def initialize(amount_refunded: nil, refund: nil); end
end
class ShippingCost < Stripe::RequestParams
# The ID of the shipping rate to use for this order.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
sig { params(shipping_rate: T.nilable(String)).void }
def initialize(shipping_rate: nil); end
end
# The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
sig { returns(T.nilable(Integer)) }
def credit_amount; end
sig { params(_credit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def credit_amount=(_credit_amount); end
# The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
sig { returns(T.nilable(Integer)) }
def effective_at; end
sig { params(_effective_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def effective_at=(_effective_at); end
# Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
sig { returns(T.nilable(String)) }
def email_type; end
sig { params(_email_type: T.nilable(String)).returns(T.nilable(String)) }
def email_type=(_email_type); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# ID of the invoice.
sig { returns(String) }
def invoice; end
sig { params(_invoice: String).returns(String) }
def invoice=(_invoice); end
# Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(T::Array[::Stripe::CreditNoteService::CreateParams::Line])) }
def lines; end
sig {
params(_lines: T.nilable(T::Array[::Stripe::CreditNoteService::CreateParams::Line])).returns(T.nilable(T::Array[::Stripe::CreditNoteService::CreateParams::Line]))
}
def lines=(_lines); end
# The credit note's memo appears on the credit note PDF.
sig { returns(T.nilable(String)) }
def memo; end
sig { params(_memo: T.nilable(String)).returns(T.nilable(String)) }
def memo=(_memo); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
sig { returns(T.nilable(Integer)) }
def out_of_band_amount; end
sig { params(_out_of_band_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def out_of_band_amount=(_out_of_band_amount); end
# Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
sig { returns(T.nilable(String)) }
def reason; end
sig { params(_reason: T.nilable(String)).returns(T.nilable(String)) }
def reason=(_reason); end
# The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
sig { returns(T.nilable(Integer)) }
def refund_amount; end
sig { params(_refund_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def refund_amount=(_refund_amount); end
# Refunds to link to this credit note.
sig { returns(T.nilable(T::Array[::Stripe::CreditNoteService::CreateParams::Refund])) }
def refunds; end
sig {
params(_refunds: T.nilable(T::Array[::Stripe::CreditNoteService::CreateParams::Refund])).returns(T.nilable(T::Array[::Stripe::CreditNoteService::CreateParams::Refund]))
}
def refunds=(_refunds); end
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(::Stripe::CreditNoteService::CreateParams::ShippingCost)) }
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(::Stripe::CreditNoteService::CreateParams::ShippingCost)).returns(T.nilable(::Stripe::CreditNoteService::CreateParams::ShippingCost))
}
def shipping_cost=(_shipping_cost); end
sig {
params(amount: T.nilable(Integer), credit_amount: T.nilable(Integer), effective_at: T.nilable(Integer), email_type: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: String, lines: T.nilable(T::Array[::Stripe::CreditNoteService::CreateParams::Line]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), out_of_band_amount: T.nilable(Integer), reason: T.nilable(String), refund_amount: T.nilable(Integer), refunds: T.nilable(T::Array[::Stripe::CreditNoteService::CreateParams::Refund]), shipping_cost: T.nilable(::Stripe::CreditNoteService::CreateParams::ShippingCost)).void
}
def initialize(
amount: nil,
credit_amount: nil,
effective_at: nil,
email_type: nil,
expand: nil,
invoice: nil,
lines: nil,
memo: nil,
metadata: nil,
out_of_band_amount: nil,
reason: nil,
refund_amount: nil,
refunds: nil,
shipping_cost: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Credit note memo.
sig { returns(T.nilable(String)) }
def memo; end
sig { params(_memo: T.nilable(String)).returns(T.nilable(String)) }
def memo=(_memo); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(expand: nil, memo: nil, metadata: nil); end
end
class PreviewParams < Stripe::RequestParams
class Line < Stripe::RequestParams
class TaxAmount < Stripe::RequestParams
# The amount, in cents (or local equivalent), of the tax.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.
sig { returns(String) }
def tax_rate; end
sig { params(_tax_rate: String).returns(String) }
def tax_rate=(_tax_rate); end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(Integer) }
def taxable_amount; end
sig { params(_taxable_amount: Integer).returns(Integer) }
def taxable_amount=(_taxable_amount); end
sig { params(amount: Integer, tax_rate: String, taxable_amount: Integer).void }
def initialize(amount: nil, tax_rate: nil, taxable_amount: nil); end
end
# The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
sig { returns(T.nilable(String)) }
def invoice_line_item; end
sig { params(_invoice_line_item: T.nilable(String)).returns(T.nilable(String)) }
def invoice_line_item=(_invoice_line_item); end
# The line item quantity to credit.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNoteService::PreviewParams::Line::TaxAmount])))
}
def tax_amounts; end
sig {
params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNoteService::PreviewParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNoteService::PreviewParams::Line::TaxAmount])))
}
def tax_amounts=(_tax_amounts); end
# The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(amount: T.nilable(Integer), description: T.nilable(String), invoice_line_item: T.nilable(String), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNoteService::PreviewParams::Line::TaxAmount])), tax_rates: T.nilable(T.any(String, T::Array[String])), type: String, unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
amount: nil,
description: nil,
invoice_line_item: nil,
quantity: nil,
tax_amounts: nil,
tax_rates: nil,
type: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Refund < Stripe::RequestParams
# Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
sig { returns(T.nilable(Integer)) }
def amount_refunded; end
sig { params(_amount_refunded: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_refunded=(_amount_refunded); end
# ID of an existing refund to link this credit note to. Required when `type` is `refund`.
sig { returns(T.nilable(String)) }
def refund; end
sig { params(_refund: T.nilable(String)).returns(T.nilable(String)) }
def refund=(_refund); end
sig { params(amount_refunded: T.nilable(Integer), refund: T.nilable(String)).void }
def initialize(amount_refunded: nil, refund: nil); end
end
class ShippingCost < Stripe::RequestParams
# The ID of the shipping rate to use for this order.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
sig { params(shipping_rate: T.nilable(String)).void }
def initialize(shipping_rate: nil); end
end
# The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
sig { returns(T.nilable(Integer)) }
def credit_amount; end
sig { params(_credit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def credit_amount=(_credit_amount); end
# The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
sig { returns(T.nilable(Integer)) }
def effective_at; end
sig { params(_effective_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def effective_at=(_effective_at); end
# Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
sig { returns(T.nilable(String)) }
def email_type; end
sig { params(_email_type: T.nilable(String)).returns(T.nilable(String)) }
def email_type=(_email_type); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# ID of the invoice.
sig { returns(String) }
def invoice; end
sig { params(_invoice: String).returns(String) }
def invoice=(_invoice); end
# Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(T::Array[::Stripe::CreditNoteService::PreviewParams::Line])) }
def lines; end
sig {
params(_lines: T.nilable(T::Array[::Stripe::CreditNoteService::PreviewParams::Line])).returns(T.nilable(T::Array[::Stripe::CreditNoteService::PreviewParams::Line]))
}
def lines=(_lines); end
# The credit note's memo appears on the credit note PDF.
sig { returns(T.nilable(String)) }
def memo; end
sig { params(_memo: T.nilable(String)).returns(T.nilable(String)) }
def memo=(_memo); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
sig { returns(T.nilable(Integer)) }
def out_of_band_amount; end
sig { params(_out_of_band_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def out_of_band_amount=(_out_of_band_amount); end
# Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
sig { returns(T.nilable(String)) }
def reason; end
sig { params(_reason: T.nilable(String)).returns(T.nilable(String)) }
def reason=(_reason); end
# The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
sig { returns(T.nilable(Integer)) }
def refund_amount; end
sig { params(_refund_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def refund_amount=(_refund_amount); end
# Refunds to link to this credit note.
sig { returns(T.nilable(T::Array[::Stripe::CreditNoteService::PreviewParams::Refund])) }
def refunds; end
sig {
params(_refunds: T.nilable(T::Array[::Stripe::CreditNoteService::PreviewParams::Refund])).returns(T.nilable(T::Array[::Stripe::CreditNoteService::PreviewParams::Refund]))
}
def refunds=(_refunds); end
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(::Stripe::CreditNoteService::PreviewParams::ShippingCost)) }
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(::Stripe::CreditNoteService::PreviewParams::ShippingCost)).returns(T.nilable(::Stripe::CreditNoteService::PreviewParams::ShippingCost))
}
def shipping_cost=(_shipping_cost); end
sig {
params(amount: T.nilable(Integer), credit_amount: T.nilable(Integer), effective_at: T.nilable(Integer), email_type: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: String, lines: T.nilable(T::Array[::Stripe::CreditNoteService::PreviewParams::Line]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), out_of_band_amount: T.nilable(Integer), reason: T.nilable(String), refund_amount: T.nilable(Integer), refunds: T.nilable(T::Array[::Stripe::CreditNoteService::PreviewParams::Refund]), shipping_cost: T.nilable(::Stripe::CreditNoteService::PreviewParams::ShippingCost)).void
}
def initialize(
amount: nil,
credit_amount: nil,
effective_at: nil,
email_type: nil,
expand: nil,
invoice: nil,
lines: nil,
memo: nil,
metadata: nil,
out_of_band_amount: nil,
reason: nil,
refund_amount: nil,
refunds: nil,
shipping_cost: nil
); end
end
class VoidCreditNoteParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
# This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
#
#
# Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
# Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
# Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
#
#
# The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
#
# You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
# post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
sig {
params(params: T.any(::Stripe::CreditNoteService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
}
def create(params = {}, opts = {}); end
# Returns a list of credit notes.
sig {
params(params: T.any(::Stripe::CreditNoteService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Get a preview of a credit note without creating it.
sig {
params(params: T.any(::Stripe::CreditNoteService::PreviewParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
}
def preview(params = {}, opts = {}); end
# Retrieves the credit note object with the given identifier.
sig {
params(id: String, params: T.any(::Stripe::CreditNoteService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
}
def retrieve(id, params = {}, opts = {}); end
# Updates an existing credit note.
sig {
params(id: String, params: T.any(::Stripe::CreditNoteService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
}
def update(id, params = {}, opts = {}); end
# Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding).
sig {
params(id: String, params: T.any(::Stripe::CreditNoteService::VoidCreditNoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
}
def void_credit_note(id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class CreditNoteLineItemService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# When retrieving a credit note, you'll get a lines property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
sig {
params(credit_note: String, params: T.any(::Stripe::CreditNoteLineItemService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(credit_note, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class CreditNotePreviewLinesService < StripeService
class ListParams < Stripe::RequestParams
class Line < Stripe::RequestParams
class TaxAmount < Stripe::RequestParams
# The amount, in cents (or local equivalent), of the tax.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.
sig { returns(String) }
def tax_rate; end
sig { params(_tax_rate: String).returns(String) }
def tax_rate=(_tax_rate); end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(Integer) }
def taxable_amount; end
sig { params(_taxable_amount: Integer).returns(Integer) }
def taxable_amount=(_taxable_amount); end
sig { params(amount: Integer, tax_rate: String, taxable_amount: Integer).void }
def initialize(amount: nil, tax_rate: nil, taxable_amount: nil); end
end
# The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
sig { returns(T.nilable(String)) }
def invoice_line_item; end
sig { params(_invoice_line_item: T.nilable(String)).returns(T.nilable(String)) }
def invoice_line_item=(_invoice_line_item); end
# The line item quantity to credit.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNotePreviewLinesService::ListParams::Line::TaxAmount])))
}
def tax_amounts; end
sig {
params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNotePreviewLinesService::ListParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNotePreviewLinesService::ListParams::Line::TaxAmount])))
}
def tax_amounts=(_tax_amounts); end
# The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(amount: T.nilable(Integer), description: T.nilable(String), invoice_line_item: T.nilable(String), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNotePreviewLinesService::ListParams::Line::TaxAmount])), tax_rates: T.nilable(T.any(String, T::Array[String])), type: String, unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
amount: nil,
description: nil,
invoice_line_item: nil,
quantity: nil,
tax_amounts: nil,
tax_rates: nil,
type: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Refund < Stripe::RequestParams
# Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
sig { returns(T.nilable(Integer)) }
def amount_refunded; end
sig { params(_amount_refunded: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_refunded=(_amount_refunded); end
# ID of an existing refund to link this credit note to. Required when `type` is `refund`.
sig { returns(T.nilable(String)) }
def refund; end
sig { params(_refund: T.nilable(String)).returns(T.nilable(String)) }
def refund=(_refund); end
sig { params(amount_refunded: T.nilable(Integer), refund: T.nilable(String)).void }
def initialize(amount_refunded: nil, refund: nil); end
end
class ShippingCost < Stripe::RequestParams
# The ID of the shipping rate to use for this order.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
sig { params(shipping_rate: T.nilable(String)).void }
def initialize(shipping_rate: nil); end
end
# The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
sig { returns(T.nilable(Integer)) }
def credit_amount; end
sig { params(_credit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def credit_amount=(_credit_amount); end
# The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
sig { returns(T.nilable(Integer)) }
def effective_at; end
sig { params(_effective_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def effective_at=(_effective_at); end
# Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
sig { returns(T.nilable(String)) }
def email_type; end
sig { params(_email_type: T.nilable(String)).returns(T.nilable(String)) }
def email_type=(_email_type); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# ID of the invoice.
sig { returns(String) }
def invoice; end
sig { params(_invoice: String).returns(String) }
def invoice=(_invoice); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig {
returns(T.nilable(T::Array[::Stripe::CreditNotePreviewLinesService::ListParams::Line]))
}
def lines; end
sig {
params(_lines: T.nilable(T::Array[::Stripe::CreditNotePreviewLinesService::ListParams::Line])).returns(T.nilable(T::Array[::Stripe::CreditNotePreviewLinesService::ListParams::Line]))
}
def lines=(_lines); end
# The credit note's memo appears on the credit note PDF.
sig { returns(T.nilable(String)) }
def memo; end
sig { params(_memo: T.nilable(String)).returns(T.nilable(String)) }
def memo=(_memo); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
sig { returns(T.nilable(Integer)) }
def out_of_band_amount; end
sig { params(_out_of_band_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def out_of_band_amount=(_out_of_band_amount); end
# Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
sig { returns(T.nilable(String)) }
def reason; end
sig { params(_reason: T.nilable(String)).returns(T.nilable(String)) }
def reason=(_reason); end
# The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
sig { returns(T.nilable(Integer)) }
def refund_amount; end
sig { params(_refund_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def refund_amount=(_refund_amount); end
# Refunds to link to this credit note.
sig {
returns(T.nilable(T::Array[::Stripe::CreditNotePreviewLinesService::ListParams::Refund]))
}
def refunds; end
sig {
params(_refunds: T.nilable(T::Array[::Stripe::CreditNotePreviewLinesService::ListParams::Refund])).returns(T.nilable(T::Array[::Stripe::CreditNotePreviewLinesService::ListParams::Refund]))
}
def refunds=(_refunds); end
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
sig { returns(T.nilable(::Stripe::CreditNotePreviewLinesService::ListParams::ShippingCost)) }
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(::Stripe::CreditNotePreviewLinesService::ListParams::ShippingCost)).returns(T.nilable(::Stripe::CreditNotePreviewLinesService::ListParams::ShippingCost))
}
def shipping_cost=(_shipping_cost); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(amount: T.nilable(Integer), credit_amount: T.nilable(Integer), effective_at: T.nilable(Integer), email_type: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: String, limit: T.nilable(Integer), lines: T.nilable(T::Array[::Stripe::CreditNotePreviewLinesService::ListParams::Line]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), out_of_band_amount: T.nilable(Integer), reason: T.nilable(String), refund_amount: T.nilable(Integer), refunds: T.nilable(T::Array[::Stripe::CreditNotePreviewLinesService::ListParams::Refund]), shipping_cost: T.nilable(::Stripe::CreditNotePreviewLinesService::ListParams::ShippingCost), starting_after: T.nilable(String)).void
}
def initialize(
amount: nil,
credit_amount: nil,
effective_at: nil,
email_type: nil,
ending_before: nil,
expand: nil,
invoice: nil,
limit: nil,
lines: nil,
memo: nil,
metadata: nil,
out_of_band_amount: nil,
reason: nil,
refund_amount: nil,
refunds: nil,
shipping_cost: nil,
starting_after: nil
); end
end
# When retrieving a credit note preview, you'll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.
sig {
params(params: T.any(::Stripe::CreditNotePreviewLinesService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class CustomerService < StripeService
attr_reader :balance_transactions
attr_reader :cash_balance
attr_reader :cash_balance_transactions
attr_reader :funding_instructions
attr_reader :payment_methods
attr_reader :payment_sources
attr_reader :tax_ids
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class CashBalance < Stripe::RequestParams
class Settings < Stripe::RequestParams
# Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
sig { returns(T.nilable(String)) }
def reconciliation_mode; end
sig { params(_reconciliation_mode: T.nilable(String)).returns(T.nilable(String)) }
def reconciliation_mode=(_reconciliation_mode); end
sig { params(reconciliation_mode: T.nilable(String)).void }
def initialize(reconciliation_mode: nil); end
end
# Settings controlling the behavior of the customer's cash balance,
# such as reconciliation of funds received.
sig { returns(T.nilable(::Stripe::CustomerService::UpdateParams::CashBalance::Settings)) }
def settings; end
sig {
params(_settings: T.nilable(::Stripe::CustomerService::UpdateParams::CashBalance::Settings)).returns(T.nilable(::Stripe::CustomerService::UpdateParams::CashBalance::Settings))
}
def settings=(_settings); end
sig {
params(settings: T.nilable(::Stripe::CustomerService::UpdateParams::CashBalance::Settings)).void
}
def initialize(settings: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class CustomField < Stripe::RequestParams
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The value of the custom field. This may be up to 140 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
class RenderingOptions < Stripe::RequestParams
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(T.any(String, String))) }
def amount_tax_display; end
sig {
params(_amount_tax_display: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def amount_tax_display=(_amount_tax_display); end
# ID of the invoice rendering template to use for future invoices.
sig { returns(T.nilable(String)) }
def template; end
sig { params(_template: T.nilable(String)).returns(T.nilable(String)) }
def template=(_template); end
sig {
params(amount_tax_display: T.nilable(T.any(String, String)), template: T.nilable(String)).void
}
def initialize(amount_tax_display: nil, template: nil); end
end
# The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::CustomerService::UpdateParams::InvoiceSettings::CustomField])))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T.any(String, T::Array[::Stripe::CustomerService::UpdateParams::InvoiceSettings::CustomField]))).returns(T.nilable(T.any(String, T::Array[::Stripe::CustomerService::UpdateParams::InvoiceSettings::CustomField])))
}
def custom_fields=(_custom_fields); end
# ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# Default footer to be displayed on invoices for this customer.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# Default options for invoice PDF rendering for this customer.
sig {
returns(T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::InvoiceSettings::RenderingOptions)))
}
def rendering_options; end
sig {
params(_rendering_options: T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::InvoiceSettings::RenderingOptions))).returns(T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::InvoiceSettings::RenderingOptions)))
}
def rendering_options=(_rendering_options); end
sig {
params(custom_fields: T.nilable(T.any(String, T::Array[::Stripe::CustomerService::UpdateParams::InvoiceSettings::CustomField])), default_payment_method: T.nilable(String), footer: T.nilable(String), rendering_options: T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::InvoiceSettings::RenderingOptions))).void
}
def initialize(
custom_fields: nil,
default_payment_method: nil,
footer: nil,
rendering_options: nil
); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Customer shipping address.
sig { returns(::Stripe::CustomerService::UpdateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::CustomerService::UpdateParams::Shipping::Address).returns(::Stripe::CustomerService::UpdateParams::Shipping::Address)
}
def address=(_address); end
# Customer name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Customer phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: ::Stripe::CustomerService::UpdateParams::Shipping::Address, name: String, phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
class Tax < Stripe::RequestParams
# A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# A flag that indicates when Stripe should validate the customer tax location. Defaults to `auto`.
sig { returns(T.nilable(String)) }
def validate_location; end
sig { params(_validate_location: T.nilable(String)).returns(T.nilable(String)) }
def validate_location=(_validate_location); end
sig { params(ip_address: T.nilable(String), validate_location: T.nilable(String)).void }
def initialize(ip_address: nil, validate_location: nil); end
end
# The customer's address.
sig { returns(T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::Address))) }
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::Address))).returns(T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::Address)))
}
def address=(_address); end
# An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
sig { returns(T.nilable(Integer)) }
def balance; end
sig { params(_balance: T.nilable(Integer)).returns(T.nilable(Integer)) }
def balance=(_balance); end
# The customer's business name. This may be up to *150 characters*.
sig { returns(T.nilable(String)) }
def business_name; end
sig { params(_business_name: T.nilable(String)).returns(T.nilable(String)) }
def business_name=(_business_name); end
# Balance information and default balance settings for this customer.
sig { returns(T.nilable(::Stripe::CustomerService::UpdateParams::CashBalance)) }
def cash_balance; end
sig {
params(_cash_balance: T.nilable(::Stripe::CustomerService::UpdateParams::CashBalance)).returns(T.nilable(::Stripe::CustomerService::UpdateParams::CashBalance))
}
def cash_balance=(_cash_balance); end
# If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter.
#
# Provide the ID of a payment source already attached to this customer to make it this customer's default payment source.
#
# If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property.
sig { returns(T.nilable(String)) }
def default_source; end
sig { params(_default_source: T.nilable(String)).returns(T.nilable(String)) }
def default_source=(_default_source); end
# An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The customer's full name. This may be up to *150 characters*.
sig { returns(T.nilable(String)) }
def individual_name; end
sig { params(_individual_name: T.nilable(String)).returns(T.nilable(String)) }
def individual_name=(_individual_name); end
# The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
sig { returns(T.nilable(String)) }
def invoice_prefix; end
sig { params(_invoice_prefix: T.nilable(String)).returns(T.nilable(String)) }
def invoice_prefix=(_invoice_prefix); end
# Default invoice settings for this customer.
sig { returns(T.nilable(::Stripe::CustomerService::UpdateParams::InvoiceSettings)) }
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::CustomerService::UpdateParams::InvoiceSettings)).returns(T.nilable(::Stripe::CustomerService::UpdateParams::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The customer's full name or business name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The sequence to be used on the customer's next invoice. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def next_invoice_sequence; end
sig { params(_next_invoice_sequence: T.nilable(Integer)).returns(T.nilable(Integer)) }
def next_invoice_sequence=(_next_invoice_sequence); end
# The customer's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Customer's preferred languages, ordered by preference.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
sig {
params(_preferred_locales: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def preferred_locales=(_preferred_locales); end
# The customer's shipping information. Appears on invoices emailed to this customer.
sig { returns(T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::Shipping))) }
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::Shipping))).returns(T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::Shipping)))
}
def shipping=(_shipping); end
# Attribute for param field source
sig { returns(T.nilable(String)) }
def source; end
sig { params(_source: T.nilable(String)).returns(T.nilable(String)) }
def source=(_source); end
# Tax details about the customer.
sig { returns(T.nilable(::Stripe::CustomerService::UpdateParams::Tax)) }
def tax; end
sig {
params(_tax: T.nilable(::Stripe::CustomerService::UpdateParams::Tax)).returns(T.nilable(::Stripe::CustomerService::UpdateParams::Tax))
}
def tax=(_tax); end
# The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
sig { returns(T.nilable(T.any(String, String))) }
def tax_exempt; end
sig {
params(_tax_exempt: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def tax_exempt=(_tax_exempt); end
# Attribute for param field validate
sig { returns(T.nilable(T::Boolean)) }
def validate; end
sig { params(_validate: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def validate=(_validate); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::Address)), balance: T.nilable(Integer), business_name: T.nilable(String), cash_balance: T.nilable(::Stripe::CustomerService::UpdateParams::CashBalance), default_source: T.nilable(String), description: T.nilable(String), email: T.nilable(String), expand: T.nilable(T::Array[String]), individual_name: T.nilable(String), invoice_prefix: T.nilable(String), invoice_settings: T.nilable(::Stripe::CustomerService::UpdateParams::InvoiceSettings), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String), next_invoice_sequence: T.nilable(Integer), phone: T.nilable(String), preferred_locales: T.nilable(T::Array[String]), shipping: T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::Shipping)), source: T.nilable(String), tax: T.nilable(::Stripe::CustomerService::UpdateParams::Tax), tax_exempt: T.nilable(T.any(String, String)), validate: T.nilable(T::Boolean)).void
}
def initialize(
address: nil,
balance: nil,
business_name: nil,
cash_balance: nil,
default_source: nil,
description: nil,
email: nil,
expand: nil,
individual_name: nil,
invoice_prefix: nil,
invoice_settings: nil,
metadata: nil,
name: nil,
next_invoice_sequence: nil,
phone: nil,
preferred_locales: nil,
shipping: nil,
source: nil,
tax: nil,
tax_exempt: nil,
validate: nil
); end
end
class DeleteDiscountParams < Stripe::RequestParams; end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return customers that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::CustomerService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::CustomerService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::CustomerService::ListParams::Created, Integer)))
}
def created=(_created); end
# A case-sensitive filter on the list based on the customer's `email` field. The value must be a string.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.
sig { returns(T.nilable(String)) }
def test_clock; end
sig { params(_test_clock: T.nilable(String)).returns(T.nilable(String)) }
def test_clock=(_test_clock); end
sig {
params(created: T.nilable(T.any(::Stripe::CustomerService::ListParams::Created, Integer)), email: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), test_clock: T.nilable(String)).void
}
def initialize(
created: nil,
email: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
test_clock: nil
); end
end
class CreateParams < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class CashBalance < Stripe::RequestParams
class Settings < Stripe::RequestParams
# Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
sig { returns(T.nilable(String)) }
def reconciliation_mode; end
sig { params(_reconciliation_mode: T.nilable(String)).returns(T.nilable(String)) }
def reconciliation_mode=(_reconciliation_mode); end
sig { params(reconciliation_mode: T.nilable(String)).void }
def initialize(reconciliation_mode: nil); end
end
# Settings controlling the behavior of the customer's cash balance,
# such as reconciliation of funds received.
sig { returns(T.nilable(::Stripe::CustomerService::CreateParams::CashBalance::Settings)) }
def settings; end
sig {
params(_settings: T.nilable(::Stripe::CustomerService::CreateParams::CashBalance::Settings)).returns(T.nilable(::Stripe::CustomerService::CreateParams::CashBalance::Settings))
}
def settings=(_settings); end
sig {
params(settings: T.nilable(::Stripe::CustomerService::CreateParams::CashBalance::Settings)).void
}
def initialize(settings: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class CustomField < Stripe::RequestParams
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The value of the custom field. This may be up to 140 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
class RenderingOptions < Stripe::RequestParams
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(T.any(String, String))) }
def amount_tax_display; end
sig {
params(_amount_tax_display: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def amount_tax_display=(_amount_tax_display); end
# ID of the invoice rendering template to use for future invoices.
sig { returns(T.nilable(String)) }
def template; end
sig { params(_template: T.nilable(String)).returns(T.nilable(String)) }
def template=(_template); end
sig {
params(amount_tax_display: T.nilable(T.any(String, String)), template: T.nilable(String)).void
}
def initialize(amount_tax_display: nil, template: nil); end
end
# The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::CustomerService::CreateParams::InvoiceSettings::CustomField])))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T.any(String, T::Array[::Stripe::CustomerService::CreateParams::InvoiceSettings::CustomField]))).returns(T.nilable(T.any(String, T::Array[::Stripe::CustomerService::CreateParams::InvoiceSettings::CustomField])))
}
def custom_fields=(_custom_fields); end
# ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# Default footer to be displayed on invoices for this customer.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# Default options for invoice PDF rendering for this customer.
sig {
returns(T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::InvoiceSettings::RenderingOptions)))
}
def rendering_options; end
sig {
params(_rendering_options: T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::InvoiceSettings::RenderingOptions))).returns(T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::InvoiceSettings::RenderingOptions)))
}
def rendering_options=(_rendering_options); end
sig {
params(custom_fields: T.nilable(T.any(String, T::Array[::Stripe::CustomerService::CreateParams::InvoiceSettings::CustomField])), default_payment_method: T.nilable(String), footer: T.nilable(String), rendering_options: T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::InvoiceSettings::RenderingOptions))).void
}
def initialize(
custom_fields: nil,
default_payment_method: nil,
footer: nil,
rendering_options: nil
); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Customer shipping address.
sig { returns(::Stripe::CustomerService::CreateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::CustomerService::CreateParams::Shipping::Address).returns(::Stripe::CustomerService::CreateParams::Shipping::Address)
}
def address=(_address); end
# Customer name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Customer phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: ::Stripe::CustomerService::CreateParams::Shipping::Address, name: String, phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
class Tax < Stripe::RequestParams
# A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`.
sig { returns(T.nilable(String)) }
def validate_location; end
sig { params(_validate_location: T.nilable(String)).returns(T.nilable(String)) }
def validate_location=(_validate_location); end
sig { params(ip_address: T.nilable(String), validate_location: T.nilable(String)).void }
def initialize(ip_address: nil, validate_location: nil); end
end
class TaxIdDatum < Stripe::RequestParams
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Value of the tax ID.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(type: String, value: String).void }
def initialize(type: nil, value: nil); end
end
# The customer's address.
sig { returns(T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::Address))) }
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::Address))).returns(T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::Address)))
}
def address=(_address); end
# An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
sig { returns(T.nilable(Integer)) }
def balance; end
sig { params(_balance: T.nilable(Integer)).returns(T.nilable(Integer)) }
def balance=(_balance); end
# The customer's business name. This may be up to *150 characters*.
sig { returns(T.nilable(String)) }
def business_name; end
sig { params(_business_name: T.nilable(String)).returns(T.nilable(String)) }
def business_name=(_business_name); end
# Balance information and default balance settings for this customer.
sig { returns(T.nilable(::Stripe::CustomerService::CreateParams::CashBalance)) }
def cash_balance; end
sig {
params(_cash_balance: T.nilable(::Stripe::CustomerService::CreateParams::CashBalance)).returns(T.nilable(::Stripe::CustomerService::CreateParams::CashBalance))
}
def cash_balance=(_cash_balance); end
# An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The customer's full name. This may be up to *150 characters*.
sig { returns(T.nilable(String)) }
def individual_name; end
sig { params(_individual_name: T.nilable(String)).returns(T.nilable(String)) }
def individual_name=(_individual_name); end
# The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
sig { returns(T.nilable(String)) }
def invoice_prefix; end
sig { params(_invoice_prefix: T.nilable(String)).returns(T.nilable(String)) }
def invoice_prefix=(_invoice_prefix); end
# Default invoice settings for this customer.
sig { returns(T.nilable(::Stripe::CustomerService::CreateParams::InvoiceSettings)) }
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::CustomerService::CreateParams::InvoiceSettings)).returns(T.nilable(::Stripe::CustomerService::CreateParams::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The customer's full name or business name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The sequence to be used on the customer's next invoice. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def next_invoice_sequence; end
sig { params(_next_invoice_sequence: T.nilable(Integer)).returns(T.nilable(Integer)) }
def next_invoice_sequence=(_next_invoice_sequence); end
# Attribute for param field payment_method
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The customer's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Customer's preferred languages, ordered by preference.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
sig {
params(_preferred_locales: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def preferred_locales=(_preferred_locales); end
# The customer's shipping information. Appears on invoices emailed to this customer.
sig { returns(T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::Shipping))) }
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::Shipping))).returns(T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::Shipping)))
}
def shipping=(_shipping); end
# Attribute for param field source
sig { returns(T.nilable(String)) }
def source; end
sig { params(_source: T.nilable(String)).returns(T.nilable(String)) }
def source=(_source); end
# Tax details about the customer.
sig { returns(T.nilable(::Stripe::CustomerService::CreateParams::Tax)) }
def tax; end
sig {
params(_tax: T.nilable(::Stripe::CustomerService::CreateParams::Tax)).returns(T.nilable(::Stripe::CustomerService::CreateParams::Tax))
}
def tax=(_tax); end
# The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
sig { returns(T.nilable(T.any(String, String))) }
def tax_exempt; end
sig {
params(_tax_exempt: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def tax_exempt=(_tax_exempt); end
# The customer's tax IDs.
sig { returns(T.nilable(T::Array[::Stripe::CustomerService::CreateParams::TaxIdDatum])) }
def tax_id_data; end
sig {
params(_tax_id_data: T.nilable(T::Array[::Stripe::CustomerService::CreateParams::TaxIdDatum])).returns(T.nilable(T::Array[::Stripe::CustomerService::CreateParams::TaxIdDatum]))
}
def tax_id_data=(_tax_id_data); end
# ID of the test clock to attach to the customer.
sig { returns(T.nilable(String)) }
def test_clock; end
sig { params(_test_clock: T.nilable(String)).returns(T.nilable(String)) }
def test_clock=(_test_clock); end
# Attribute for param field validate
sig { returns(T.nilable(T::Boolean)) }
def validate; end
sig { params(_validate: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def validate=(_validate); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::Address)), balance: T.nilable(Integer), business_name: T.nilable(String), cash_balance: T.nilable(::Stripe::CustomerService::CreateParams::CashBalance), description: T.nilable(String), email: T.nilable(String), expand: T.nilable(T::Array[String]), individual_name: T.nilable(String), invoice_prefix: T.nilable(String), invoice_settings: T.nilable(::Stripe::CustomerService::CreateParams::InvoiceSettings), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String), next_invoice_sequence: T.nilable(Integer), payment_method: T.nilable(String), phone: T.nilable(String), preferred_locales: T.nilable(T::Array[String]), shipping: T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::Shipping)), source: T.nilable(String), tax: T.nilable(::Stripe::CustomerService::CreateParams::Tax), tax_exempt: T.nilable(T.any(String, String)), tax_id_data: T.nilable(T::Array[::Stripe::CustomerService::CreateParams::TaxIdDatum]), test_clock: T.nilable(String), validate: T.nilable(T::Boolean)).void
}
def initialize(
address: nil,
balance: nil,
business_name: nil,
cash_balance: nil,
description: nil,
email: nil,
expand: nil,
individual_name: nil,
invoice_prefix: nil,
invoice_settings: nil,
metadata: nil,
name: nil,
next_invoice_sequence: nil,
payment_method: nil,
phone: nil,
preferred_locales: nil,
shipping: nil,
source: nil,
tax: nil,
tax_exempt: nil,
tax_id_data: nil,
test_clock: nil,
validate: nil
); end
end
class SearchParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
sig { returns(T.nilable(String)) }
def page; end
sig { params(_page: T.nilable(String)).returns(T.nilable(String)) }
def page=(_page); end
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers).
sig { returns(String) }
def query; end
sig { params(_query: String).returns(String) }
def query=(_query); end
sig {
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
}
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
end
# Creates a new customer object.
sig {
params(params: T.any(::Stripe::CustomerService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
}
def create(params = {}, opts = {}); end
# Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
sig {
params(customer: String, params: T.any(::Stripe::CustomerService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
}
def delete(customer, params = {}, opts = {}); end
# Removes the currently applied discount on a customer.
sig {
params(customer: String, params: T.any(::Stripe::CustomerService::DeleteDiscountParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Discount)
}
def delete_discount(customer, params = {}, opts = {}); end
# Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
sig {
params(params: T.any(::Stripe::CustomerService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a Customer object.
sig {
params(customer: String, params: T.any(::Stripe::CustomerService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
}
def retrieve(customer, params = {}, opts = {}); end
# Search for customers 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.
sig {
params(params: T.any(::Stripe::CustomerService::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
}
def search(params = {}, opts = {}); end
# Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer's active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer's current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.
#
# This request accepts mostly the same arguments as the customer creation call.
sig {
params(customer: String, params: T.any(::Stripe::CustomerService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
}
def update(customer, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class CustomerBalanceTransactionService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateParams < Stripe::RequestParams
# The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value.
sig { returns(String) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(amount: Integer, currency: String, description: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(amount: nil, currency: nil, description: nil, expand: nil, metadata: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(description: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(description: nil, expand: nil, metadata: nil); end
end
# Creates an immutable transaction that updates the customer's credit [balance](https://docs.stripe.com/docs/billing/customer/balance).
sig {
params(customer: String, params: T.any(::Stripe::CustomerBalanceTransactionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerBalanceTransaction)
}
def create(customer, params = {}, opts = {}); end
# Returns a list of transactions that updated the customer's [balances](https://docs.stripe.com/docs/billing/customer/balance).
sig {
params(customer: String, params: T.any(::Stripe::CustomerBalanceTransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(customer, params = {}, opts = {}); end
# Retrieves a specific customer balance transaction that updated the customer's [balances](https://docs.stripe.com/docs/billing/customer/balance).
sig {
params(customer: String, transaction: String, params: T.any(::Stripe::CustomerBalanceTransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerBalanceTransaction)
}
def retrieve(customer, transaction, params = {}, opts = {}); end
# Most credit balance transaction fields are immutable, but you may update its description and metadata.
sig {
params(customer: String, transaction: String, params: T.any(::Stripe::CustomerBalanceTransactionService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerBalanceTransaction)
}
def update(customer, transaction, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class CustomerCashBalanceService < StripeService
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Settings < Stripe::RequestParams
# Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
sig { returns(T.nilable(String)) }
def reconciliation_mode; end
sig { params(_reconciliation_mode: T.nilable(String)).returns(T.nilable(String)) }
def reconciliation_mode=(_reconciliation_mode); end
sig { params(reconciliation_mode: T.nilable(String)).void }
def initialize(reconciliation_mode: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A hash of settings for this cash balance.
sig { returns(T.nilable(::Stripe::CustomerCashBalanceService::UpdateParams::Settings)) }
def settings; end
sig {
params(_settings: T.nilable(::Stripe::CustomerCashBalanceService::UpdateParams::Settings)).returns(T.nilable(::Stripe::CustomerCashBalanceService::UpdateParams::Settings))
}
def settings=(_settings); end
sig {
params(expand: T.nilable(T::Array[String]), settings: T.nilable(::Stripe::CustomerCashBalanceService::UpdateParams::Settings)).void
}
def initialize(expand: nil, settings: nil); end
end
# Retrieves a customer's cash balance.
sig {
params(customer: String, params: T.any(::Stripe::CustomerCashBalanceService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CashBalance)
}
def retrieve(customer, params = {}, opts = {}); end
# Changes the settings on a customer's cash balance.
sig {
params(customer: String, params: T.any(::Stripe::CustomerCashBalanceService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CashBalance)
}
def update(customer, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class CustomerCashBalanceTransactionService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of transactions that modified the customer's [cash balance](https://docs.stripe.com/docs/payments/customer-balance).
sig {
params(customer: String, params: T.any(::Stripe::CustomerCashBalanceTransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(customer, params = {}, opts = {}); end
# Retrieves a specific cash balance transaction, which updated the customer's [cash balance](https://docs.stripe.com/docs/payments/customer-balance).
sig {
params(customer: String, transaction: String, params: T.any(::Stripe::CustomerCashBalanceTransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerCashBalanceTransaction)
}
def retrieve(customer, transaction, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class CustomerFundingInstructionsService < StripeService
class CreateParams < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::CustomerFundingInstructionsService::CreateParams::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::CustomerFundingInstructionsService::CreateParams::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::CustomerFundingInstructionsService::CreateParams::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
sig {
params(_requested_address_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested_address_types=(_requested_address_types); end
# The type of the `bank_transfer`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::CustomerFundingInstructionsService::CreateParams::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
}
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
end
# Additional parameters for `bank_transfer` funding types
sig { returns(::Stripe::CustomerFundingInstructionsService::CreateParams::BankTransfer) }
def bank_transfer; end
sig {
params(_bank_transfer: ::Stripe::CustomerFundingInstructionsService::CreateParams::BankTransfer).returns(::Stripe::CustomerFundingInstructionsService::CreateParams::BankTransfer)
}
def bank_transfer=(_bank_transfer); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The `funding_type` to get the instructions for.
sig { returns(String) }
def funding_type; end
sig { params(_funding_type: String).returns(String) }
def funding_type=(_funding_type); end
sig {
params(bank_transfer: ::Stripe::CustomerFundingInstructionsService::CreateParams::BankTransfer, currency: String, expand: T.nilable(T::Array[String]), funding_type: String).void
}
def initialize(bank_transfer: nil, currency: nil, expand: nil, funding_type: nil); end
end
# Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
# funding instructions will be created. If funding instructions have already been created for a given customer, the same
# funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
sig {
params(customer: String, params: T.any(::Stripe::CustomerFundingInstructionsService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FundingInstructions)
}
def create(customer, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class CustomerPaymentMethodService < StripeService
class ListParams < Stripe::RequestParams
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(allow_redisplay: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
allow_redisplay: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
type: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of PaymentMethods for a given Customer
sig {
params(customer: String, params: T.any(::Stripe::CustomerPaymentMethodService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(customer, params = {}, opts = {}); end
# Retrieves a PaymentMethod object for a given Customer.
sig {
params(customer: String, payment_method: String, params: T.any(::Stripe::CustomerPaymentMethodService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
}
def retrieve(customer, payment_method, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class CustomerPaymentSourceService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Filter sources according to a particular object type.
sig { returns(T.nilable(String)) }
def object; end
sig { params(_object: T.nilable(String)).returns(T.nilable(String)) }
def object=(_object); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), object: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
object: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Please refer to full [documentation](https://stripe.com/docs/api) instead.
sig { returns(String) }
def source; end
sig { params(_source: String).returns(String) }
def source=(_source); end
# Attribute for param field validate
sig { returns(T.nilable(T::Boolean)) }
def validate; end
sig { params(_validate: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def validate=(_validate); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), source: String, validate: T.nilable(T::Boolean)).void
}
def initialize(expand: nil, metadata: nil, source: nil, validate: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Owner < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Owner's address.
sig {
returns(T.nilable(::Stripe::CustomerPaymentSourceService::UpdateParams::Owner::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::CustomerPaymentSourceService::UpdateParams::Owner::Address)).returns(T.nilable(::Stripe::CustomerPaymentSourceService::UpdateParams::Owner::Address))
}
def address=(_address); end
# Owner's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Owner's full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Owner's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::CustomerPaymentSourceService::UpdateParams::Owner::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil); end
end
# The name of the person or business that owns the bank account.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The type of entity that holds the account. This can be either `individual` or `company`.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# City/District/Suburb/Town/Village.
sig { returns(T.nilable(String)) }
def address_city; end
sig { params(_address_city: T.nilable(String)).returns(T.nilable(String)) }
def address_city=(_address_city); end
# Billing address country, if provided when creating card.
sig { returns(T.nilable(String)) }
def address_country; end
sig { params(_address_country: T.nilable(String)).returns(T.nilable(String)) }
def address_country=(_address_country); end
# Address line 1 (Street address/PO Box/Company name).
sig { returns(T.nilable(String)) }
def address_line1; end
sig { params(_address_line1: T.nilable(String)).returns(T.nilable(String)) }
def address_line1=(_address_line1); end
# Address line 2 (Apartment/Suite/Unit/Building).
sig { returns(T.nilable(String)) }
def address_line2; end
sig { params(_address_line2: T.nilable(String)).returns(T.nilable(String)) }
def address_line2=(_address_line2); end
# State/County/Province/Region.
sig { returns(T.nilable(String)) }
def address_state; end
sig { params(_address_state: T.nilable(String)).returns(T.nilable(String)) }
def address_state=(_address_state); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def address_zip; end
sig { params(_address_zip: T.nilable(String)).returns(T.nilable(String)) }
def address_zip=(_address_zip); end
# Two digit number representing the card’s expiration month.
sig { returns(T.nilable(String)) }
def exp_month; end
sig { params(_exp_month: T.nilable(String)).returns(T.nilable(String)) }
def exp_month=(_exp_month); end
# Four digit number representing the card’s expiration year.
sig { returns(T.nilable(String)) }
def exp_year; end
sig { params(_exp_year: T.nilable(String)).returns(T.nilable(String)) }
def exp_year=(_exp_year); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Cardholder name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Attribute for param field owner
sig { returns(T.nilable(::Stripe::CustomerPaymentSourceService::UpdateParams::Owner)) }
def owner; end
sig {
params(_owner: T.nilable(::Stripe::CustomerPaymentSourceService::UpdateParams::Owner)).returns(T.nilable(::Stripe::CustomerPaymentSourceService::UpdateParams::Owner))
}
def owner=(_owner); end
sig {
params(account_holder_name: T.nilable(String), account_holder_type: T.nilable(String), address_city: T.nilable(String), address_country: T.nilable(String), address_line1: T.nilable(String), address_line2: T.nilable(String), address_state: T.nilable(String), address_zip: T.nilable(String), exp_month: T.nilable(String), exp_year: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String), owner: T.nilable(::Stripe::CustomerPaymentSourceService::UpdateParams::Owner)).void
}
def initialize(
account_holder_name: nil,
account_holder_type: nil,
address_city: nil,
address_country: nil,
address_line1: nil,
address_line2: nil,
address_state: nil,
address_zip: nil,
exp_month: nil,
exp_year: nil,
expand: nil,
metadata: nil,
name: nil,
owner: nil
); end
end
class DeleteParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class VerifyParams < Stripe::RequestParams
# Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.
sig { returns(T.nilable(T::Array[Integer])) }
def amounts; end
sig { params(_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer])) }
def amounts=(_amounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(amounts: T.nilable(T::Array[Integer]), expand: T.nilable(T::Array[String])).void
}
def initialize(amounts: nil, expand: nil); end
end
# When you create a new credit card, you must specify a customer or recipient on which to create it.
#
# If the card's owner has no default card, then the new card will become the default.
# However, if the owner already has a default, then it will not change.
# To change the default, you should [update the customer](https://docs.stripe.com/docs/api#update_customer) to have a new default_source.
sig {
params(customer: String, params: T.any(::Stripe::CustomerPaymentSourceService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source))
}
def create(customer, params = {}, opts = {}); end
# Delete a specified source for a given customer.
sig {
params(customer: String, id: String, params: T.any(::Stripe::CustomerPaymentSourceService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source))
}
def delete(customer, id, params = {}, opts = {}); end
# List sources for a specified customer.
sig {
params(customer: String, params: T.any(::Stripe::CustomerPaymentSourceService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(customer, params = {}, opts = {}); end
# Retrieve a specified source for a given customer.
sig {
params(customer: String, id: String, params: T.any(::Stripe::CustomerPaymentSourceService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source))
}
def retrieve(customer, id, params = {}, opts = {}); end
# Update a specified source for a given customer.
sig {
params(customer: String, id: String, params: T.any(::Stripe::CustomerPaymentSourceService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source))
}
def update(customer, id, params = {}, opts = {}); end
# Verify a specified bank account for a given customer.
sig {
params(customer: String, id: String, params: T.any(::Stripe::CustomerPaymentSourceService::VerifyParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BankAccount)
}
def verify(customer, id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class CustomerTaxIdService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Value of the tax ID.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(expand: T.nilable(T::Array[String]), type: String, value: String).void }
def initialize(expand: nil, type: nil, value: nil); end
end
# Creates a new tax_id object for a customer.
sig {
params(customer: String, params: T.any(::Stripe::CustomerTaxIdService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TaxId)
}
def create(customer, params = {}, opts = {}); end
# Deletes an existing tax_id object.
sig {
params(customer: String, id: String, params: T.any(::Stripe::CustomerTaxIdService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TaxId)
}
def delete(customer, id, params = {}, opts = {}); end
# Returns a list of tax IDs for a customer.
sig {
params(customer: String, params: T.any(::Stripe::CustomerTaxIdService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(customer, params = {}, opts = {}); end
# Retrieves the tax_id object with the given identifier.
sig {
params(customer: String, id: String, params: T.any(::Stripe::CustomerTaxIdService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TaxId)
}
def retrieve(customer, id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class CustomerSessionService < StripeService
class CreateParams < Stripe::RequestParams
class Components < Stripe::RequestParams
class BuyButton < Stripe::RequestParams
# Whether the buy button is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
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.nilable(T::Array[String])) }
def payment_method_allow_redisplay_filters; end
sig {
params(_payment_method_allow_redisplay_filters: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_allow_redisplay_filters=(
_payment_method_allow_redisplay_filters
); end
# Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.
sig { returns(T.nilable(String)) }
def payment_method_redisplay; end
sig { params(_payment_method_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_redisplay=(_payment_method_redisplay); end
# Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. The maximum redisplay limit is `10`.
sig { returns(T.nilable(Integer)) }
def payment_method_redisplay_limit; end
sig {
params(_payment_method_redisplay_limit: T.nilable(Integer)).returns(T.nilable(Integer))
}
def payment_method_redisplay_limit=(_payment_method_redisplay_limit); end
# 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(T.nilable(String)) }
def payment_method_remove; end
sig { params(_payment_method_remove: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_remove=(_payment_method_remove); end
# 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(T.nilable(String)) }
def payment_method_save; end
sig { params(_payment_method_save: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_save=(_payment_method_save); end
# 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)) }
def payment_method_save_usage; end
sig { params(_payment_method_save_usage: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_save_usage=(_payment_method_save_usage); end
sig {
params(payment_method_allow_redisplay_filters: T.nilable(T::Array[String]), payment_method_redisplay: T.nilable(String), payment_method_redisplay_limit: T.nilable(Integer), payment_method_remove: T.nilable(String), payment_method_save: T.nilable(String), payment_method_save_usage: T.nilable(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) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# This hash defines whether the Payment Element supports certain features.
sig {
returns(T.nilable(::Stripe::CustomerSessionService::CreateParams::Components::PaymentElement::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::CustomerSessionService::CreateParams::Components::PaymentElement::Features)).returns(T.nilable(::Stripe::CustomerSessionService::CreateParams::Components::PaymentElement::Features))
}
def features=(_features); end
sig {
params(enabled: T::Boolean, features: T.nilable(::Stripe::CustomerSessionService::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) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
# Configuration for buy button.
sig {
returns(T.nilable(::Stripe::CustomerSessionService::CreateParams::Components::BuyButton))
}
def buy_button; end
sig {
params(_buy_button: T.nilable(::Stripe::CustomerSessionService::CreateParams::Components::BuyButton)).returns(T.nilable(::Stripe::CustomerSessionService::CreateParams::Components::BuyButton))
}
def buy_button=(_buy_button); end
# Configuration for the Payment Element.
sig {
returns(T.nilable(::Stripe::CustomerSessionService::CreateParams::Components::PaymentElement))
}
def payment_element; end
sig {
params(_payment_element: T.nilable(::Stripe::CustomerSessionService::CreateParams::Components::PaymentElement)).returns(T.nilable(::Stripe::CustomerSessionService::CreateParams::Components::PaymentElement))
}
def payment_element=(_payment_element); end
# Configuration for the pricing table.
sig {
returns(T.nilable(::Stripe::CustomerSessionService::CreateParams::Components::PricingTable))
}
def pricing_table; end
sig {
params(_pricing_table: T.nilable(::Stripe::CustomerSessionService::CreateParams::Components::PricingTable)).returns(T.nilable(::Stripe::CustomerSessionService::CreateParams::Components::PricingTable))
}
def pricing_table=(_pricing_table); end
sig {
params(buy_button: T.nilable(::Stripe::CustomerSessionService::CreateParams::Components::BuyButton), payment_element: T.nilable(::Stripe::CustomerSessionService::CreateParams::Components::PaymentElement), pricing_table: T.nilable(::Stripe::CustomerSessionService::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::CustomerSessionService::CreateParams::Components) }
def components; end
sig {
params(_components: ::Stripe::CustomerSessionService::CreateParams::Components).returns(::Stripe::CustomerSessionService::CreateParams::Components)
}
def components=(_components); end
# The ID of an existing customer for which to create the Customer Session.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The ID of an existing Account for which to create the Customer Session.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(components: ::Stripe::CustomerSessionService::CreateParams::Components, customer: T.nilable(String), customer_account: T.nilable(String), expand: T.nilable(T::Array[String])).void
}
def initialize(components: nil, customer: nil, customer_account: 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::CustomerSessionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerSession)
}
def create(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class DisputeService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return disputes associated to the charge specified by this charge ID.
sig { returns(T.nilable(String)) }
def charge; end
sig { params(_charge: T.nilable(String)).returns(T.nilable(String)) }
def charge=(_charge); end
# Only return disputes that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::DisputeService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::DisputeService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::DisputeService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(charge: T.nilable(String), created: T.nilable(T.any(::Stripe::DisputeService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_intent: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
charge: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
payment_intent: nil,
starting_after: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Evidence < Stripe::RequestParams
class EnhancedEvidence < Stripe::RequestParams
class VisaCompellingEvidence3 < Stripe::RequestParams
class DisputedTransaction < Stripe::RequestParams
class ShippingAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# User Account ID used to log into business platform. Must be recognizable by the user.
sig { returns(T.nilable(String)) }
def customer_account_id; end
sig { params(_customer_account_id: T.nilable(String)).returns(T.nilable(String)) }
def customer_account_id=(_customer_account_id); end
# Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.
sig { returns(T.nilable(String)) }
def customer_device_fingerprint; end
sig {
params(_customer_device_fingerprint: T.nilable(String)).returns(T.nilable(String))
}
def customer_device_fingerprint=(_customer_device_fingerprint); end
# Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.
sig { returns(T.nilable(String)) }
def customer_device_id; end
sig { params(_customer_device_id: T.nilable(String)).returns(T.nilable(String)) }
def customer_device_id=(_customer_device_id); end
# The email address of the customer.
sig { returns(T.nilable(String)) }
def customer_email_address; end
sig { params(_customer_email_address: T.nilable(String)).returns(T.nilable(String)) }
def customer_email_address=(_customer_email_address); end
# The IP address that the customer used when making the purchase.
sig { returns(T.nilable(String)) }
def customer_purchase_ip; end
sig { params(_customer_purchase_ip: T.nilable(String)).returns(T.nilable(String)) }
def customer_purchase_ip=(_customer_purchase_ip); end
# Categorization of disputed payment.
sig { returns(T.nilable(String)) }
def merchandise_or_services; end
sig { params(_merchandise_or_services: T.nilable(String)).returns(T.nilable(String)) }
def merchandise_or_services=(_merchandise_or_services); end
# A description of the product or service that was sold.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.
sig {
returns(T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::DisputedTransaction::ShippingAddress))
}
def shipping_address; end
sig {
params(_shipping_address: T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::DisputedTransaction::ShippingAddress)).returns(T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::DisputedTransaction::ShippingAddress))
}
def shipping_address=(_shipping_address); end
sig {
params(customer_account_id: T.nilable(String), customer_device_fingerprint: T.nilable(String), customer_device_id: T.nilable(String), customer_email_address: T.nilable(String), customer_purchase_ip: T.nilable(String), merchandise_or_services: T.nilable(String), product_description: T.nilable(String), shipping_address: T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::DisputedTransaction::ShippingAddress)).void
}
def initialize(
customer_account_id: nil,
customer_device_fingerprint: nil,
customer_device_id: nil,
customer_email_address: nil,
customer_purchase_ip: nil,
merchandise_or_services: nil,
product_description: nil,
shipping_address: nil
); end
end
class PriorUndisputedTransaction < Stripe::RequestParams
class ShippingAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge.
sig { returns(String) }
def charge; end
sig { params(_charge: String).returns(String) }
def charge=(_charge); end
# User Account ID used to log into business platform. Must be recognizable by the user.
sig { returns(T.nilable(String)) }
def customer_account_id; end
sig { params(_customer_account_id: T.nilable(String)).returns(T.nilable(String)) }
def customer_account_id=(_customer_account_id); end
# Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.
sig { returns(T.nilable(String)) }
def customer_device_fingerprint; end
sig {
params(_customer_device_fingerprint: T.nilable(String)).returns(T.nilable(String))
}
def customer_device_fingerprint=(_customer_device_fingerprint); end
# Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.
sig { returns(T.nilable(String)) }
def customer_device_id; end
sig { params(_customer_device_id: T.nilable(String)).returns(T.nilable(String)) }
def customer_device_id=(_customer_device_id); end
# The email address of the customer.
sig { returns(T.nilable(String)) }
def customer_email_address; end
sig { params(_customer_email_address: T.nilable(String)).returns(T.nilable(String)) }
def customer_email_address=(_customer_email_address); end
# The IP address that the customer used when making the purchase.
sig { returns(T.nilable(String)) }
def customer_purchase_ip; end
sig { params(_customer_purchase_ip: T.nilable(String)).returns(T.nilable(String)) }
def customer_purchase_ip=(_customer_purchase_ip); end
# A description of the product or service that was sold.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.
sig {
returns(T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::PriorUndisputedTransaction::ShippingAddress))
}
def shipping_address; end
sig {
params(_shipping_address: T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::PriorUndisputedTransaction::ShippingAddress)).returns(T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::PriorUndisputedTransaction::ShippingAddress))
}
def shipping_address=(_shipping_address); end
sig {
params(charge: String, customer_account_id: T.nilable(String), customer_device_fingerprint: T.nilable(String), customer_device_id: T.nilable(String), customer_email_address: T.nilable(String), customer_purchase_ip: T.nilable(String), product_description: T.nilable(String), shipping_address: T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::PriorUndisputedTransaction::ShippingAddress)).void
}
def initialize(
charge: nil,
customer_account_id: nil,
customer_device_fingerprint: nil,
customer_device_id: nil,
customer_email_address: nil,
customer_purchase_ip: nil,
product_description: nil,
shipping_address: nil
); end
end
# Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission.
sig {
returns(T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::DisputedTransaction))
}
def disputed_transaction; end
sig {
params(_disputed_transaction: T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::DisputedTransaction)).returns(T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::DisputedTransaction))
}
def disputed_transaction=(_disputed_transaction); end
# List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission.
sig {
returns(T.nilable(T::Array[::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::PriorUndisputedTransaction]))
}
def prior_undisputed_transactions; end
sig {
params(_prior_undisputed_transactions: T.nilable(T::Array[::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::PriorUndisputedTransaction])).returns(T.nilable(T::Array[::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::PriorUndisputedTransaction]))
}
def prior_undisputed_transactions=(_prior_undisputed_transactions); end
sig {
params(disputed_transaction: T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::DisputedTransaction), prior_undisputed_transactions: T.nilable(T::Array[::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3::PriorUndisputedTransaction])).void
}
def initialize(disputed_transaction: nil, prior_undisputed_transactions: nil); end
end
class VisaCompliance < Stripe::RequestParams
# A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Stripe refunds the 500 USD network fee if you win the dispute.
sig { returns(T.nilable(T::Boolean)) }
def fee_acknowledged; end
sig { params(_fee_acknowledged: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def fee_acknowledged=(_fee_acknowledged); end
sig { params(fee_acknowledged: T.nilable(T::Boolean)).void }
def initialize(fee_acknowledged: nil); end
end
# Evidence provided for Visa Compelling Evidence 3.0 evidence submission.
sig {
returns(T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3))
}
def visa_compelling_evidence_3; end
sig {
params(_visa_compelling_evidence_3: T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3)).returns(T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3))
}
def visa_compelling_evidence_3=(_visa_compelling_evidence_3); end
# Evidence provided for Visa compliance evidence submission.
sig {
returns(T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompliance))
}
def visa_compliance; end
sig {
params(_visa_compliance: T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompliance)).returns(T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompliance))
}
def visa_compliance=(_visa_compliance); end
sig {
params(visa_compelling_evidence_3: T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompellingEvidence3), visa_compliance: T.nilable(::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence::VisaCompliance)).void
}
def initialize(visa_compelling_evidence_3: nil, visa_compliance: nil); end
end
# Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. Has a maximum character count of 20,000.
sig { returns(T.nilable(String)) }
def access_activity_log; end
sig { params(_access_activity_log: T.nilable(String)).returns(T.nilable(String)) }
def access_activity_log=(_access_activity_log); end
# The billing address provided by the customer.
sig { returns(T.nilable(String)) }
def billing_address; end
sig { params(_billing_address: T.nilable(String)).returns(T.nilable(String)) }
def billing_address=(_billing_address); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer.
sig { returns(T.nilable(String)) }
def cancellation_policy; end
sig { params(_cancellation_policy: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_policy=(_cancellation_policy); end
# An explanation of how and when the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000.
sig { returns(T.nilable(String)) }
def cancellation_policy_disclosure; end
sig {
params(_cancellation_policy_disclosure: T.nilable(String)).returns(T.nilable(String))
}
def cancellation_policy_disclosure=(_cancellation_policy_disclosure); end
# A justification for why the customer's subscription was not canceled. Has a maximum character count of 20,000.
sig { returns(T.nilable(String)) }
def cancellation_rebuttal; end
sig { params(_cancellation_rebuttal: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_rebuttal=(_cancellation_rebuttal); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.
sig { returns(T.nilable(String)) }
def customer_communication; end
sig { params(_customer_communication: T.nilable(String)).returns(T.nilable(String)) }
def customer_communication=(_customer_communication); end
# The email address of the customer.
sig { returns(T.nilable(String)) }
def customer_email_address; end
sig { params(_customer_email_address: T.nilable(String)).returns(T.nilable(String)) }
def customer_email_address=(_customer_email_address); end
# The name of the customer.
sig { returns(T.nilable(String)) }
def customer_name; end
sig { params(_customer_name: T.nilable(String)).returns(T.nilable(String)) }
def customer_name=(_customer_name); end
# The IP address that the customer used when making the purchase.
sig { returns(T.nilable(String)) }
def customer_purchase_ip; end
sig { params(_customer_purchase_ip: T.nilable(String)).returns(T.nilable(String)) }
def customer_purchase_ip=(_customer_purchase_ip); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature.
sig { returns(T.nilable(String)) }
def customer_signature; end
sig { params(_customer_signature: T.nilable(String)).returns(T.nilable(String)) }
def customer_signature=(_customer_signature); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.
sig { returns(T.nilable(String)) }
def duplicate_charge_documentation; end
sig {
params(_duplicate_charge_documentation: T.nilable(String)).returns(T.nilable(String))
}
def duplicate_charge_documentation=(_duplicate_charge_documentation); end
# An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. Has a maximum character count of 20,000.
sig { returns(T.nilable(String)) }
def duplicate_charge_explanation; end
sig { params(_duplicate_charge_explanation: T.nilable(String)).returns(T.nilable(String)) }
def duplicate_charge_explanation=(_duplicate_charge_explanation); end
# The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.
sig { returns(T.nilable(String)) }
def duplicate_charge_id; end
sig { params(_duplicate_charge_id: T.nilable(String)).returns(T.nilable(String)) }
def duplicate_charge_id=(_duplicate_charge_id); end
# Additional evidence for qualifying evidence programs.
sig {
returns(T.nilable(T.any(String, ::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence)))
}
def enhanced_evidence; end
sig {
params(_enhanced_evidence: T.nilable(T.any(String, ::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence))).returns(T.nilable(T.any(String, ::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence)))
}
def enhanced_evidence=(_enhanced_evidence); end
# A description of the product or service that was sold. Has a maximum character count of 20,000.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge.
sig { returns(T.nilable(String)) }
def receipt; end
sig { params(_receipt: T.nilable(String)).returns(T.nilable(String)) }
def receipt=(_receipt); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer.
sig { returns(T.nilable(String)) }
def refund_policy; end
sig { params(_refund_policy: T.nilable(String)).returns(T.nilable(String)) }
def refund_policy=(_refund_policy); end
# Documentation demonstrating that the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000.
sig { returns(T.nilable(String)) }
def refund_policy_disclosure; end
sig { params(_refund_policy_disclosure: T.nilable(String)).returns(T.nilable(String)) }
def refund_policy_disclosure=(_refund_policy_disclosure); end
# A justification for why the customer is not entitled to a refund. Has a maximum character count of 20,000.
sig { returns(T.nilable(String)) }
def refund_refusal_explanation; end
sig { params(_refund_refusal_explanation: T.nilable(String)).returns(T.nilable(String)) }
def refund_refusal_explanation=(_refund_refusal_explanation); end
# The date on which the customer received or began receiving the purchased service, in a clear human-readable format.
sig { returns(T.nilable(String)) }
def service_date; end
sig { params(_service_date: T.nilable(String)).returns(T.nilable(String)) }
def service_date=(_service_date); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.
sig { returns(T.nilable(String)) }
def service_documentation; end
sig { params(_service_documentation: T.nilable(String)).returns(T.nilable(String)) }
def service_documentation=(_service_documentation); end
# The address to which a physical product was shipped. You should try to include as complete address information as possible.
sig { returns(T.nilable(String)) }
def shipping_address; end
sig { params(_shipping_address: T.nilable(String)).returns(T.nilable(String)) }
def shipping_address=(_shipping_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def shipping_carrier; end
sig { params(_shipping_carrier: T.nilable(String)).returns(T.nilable(String)) }
def shipping_carrier=(_shipping_carrier); end
# The date on which a physical product began its route to the shipping address, in a clear human-readable format.
sig { returns(T.nilable(String)) }
def shipping_date; end
sig { params(_shipping_date: T.nilable(String)).returns(T.nilable(String)) }
def shipping_date=(_shipping_date); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible.
sig { returns(T.nilable(String)) }
def shipping_documentation; end
sig { params(_shipping_documentation: T.nilable(String)).returns(T.nilable(String)) }
def shipping_documentation=(_shipping_documentation); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def shipping_tracking_number; end
sig { params(_shipping_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def shipping_tracking_number=(_shipping_tracking_number); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements.
sig { returns(T.nilable(String)) }
def uncategorized_file; end
sig { params(_uncategorized_file: T.nilable(String)).returns(T.nilable(String)) }
def uncategorized_file=(_uncategorized_file); end
# Any additional evidence or statements. Has a maximum character count of 20,000.
sig { returns(T.nilable(String)) }
def uncategorized_text; end
sig { params(_uncategorized_text: T.nilable(String)).returns(T.nilable(String)) }
def uncategorized_text=(_uncategorized_text); end
sig {
params(access_activity_log: T.nilable(String), billing_address: T.nilable(String), cancellation_policy: T.nilable(String), cancellation_policy_disclosure: T.nilable(String), cancellation_rebuttal: T.nilable(String), customer_communication: T.nilable(String), customer_email_address: T.nilable(String), customer_name: T.nilable(String), customer_purchase_ip: T.nilable(String), customer_signature: T.nilable(String), duplicate_charge_documentation: T.nilable(String), duplicate_charge_explanation: T.nilable(String), duplicate_charge_id: T.nilable(String), enhanced_evidence: T.nilable(T.any(String, ::Stripe::DisputeService::UpdateParams::Evidence::EnhancedEvidence)), product_description: T.nilable(String), receipt: T.nilable(String), refund_policy: T.nilable(String), refund_policy_disclosure: T.nilable(String), refund_refusal_explanation: T.nilable(String), service_date: T.nilable(String), service_documentation: T.nilable(String), shipping_address: T.nilable(String), shipping_carrier: T.nilable(String), shipping_date: T.nilable(String), shipping_documentation: T.nilable(String), shipping_tracking_number: T.nilable(String), uncategorized_file: T.nilable(String), uncategorized_text: T.nilable(String)).void
}
def initialize(
access_activity_log: nil,
billing_address: nil,
cancellation_policy: nil,
cancellation_policy_disclosure: nil,
cancellation_rebuttal: nil,
customer_communication: nil,
customer_email_address: nil,
customer_name: nil,
customer_purchase_ip: nil,
customer_signature: nil,
duplicate_charge_documentation: nil,
duplicate_charge_explanation: nil,
duplicate_charge_id: nil,
enhanced_evidence: nil,
product_description: nil,
receipt: nil,
refund_policy: nil,
refund_policy_disclosure: nil,
refund_refusal_explanation: nil,
service_date: nil,
service_documentation: nil,
shipping_address: nil,
shipping_carrier: nil,
shipping_date: nil,
shipping_documentation: nil,
shipping_tracking_number: nil,
uncategorized_file: nil,
uncategorized_text: nil
); end
end
# Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.
sig { returns(T.nilable(::Stripe::DisputeService::UpdateParams::Evidence)) }
def evidence; end
sig {
params(_evidence: T.nilable(::Stripe::DisputeService::UpdateParams::Evidence)).returns(T.nilable(::Stripe::DisputeService::UpdateParams::Evidence))
}
def evidence=(_evidence); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Intended submission method for the dispute.
sig { returns(T.nilable(String)) }
def intended_submission_method; end
sig { params(_intended_submission_method: T.nilable(String)).returns(T.nilable(String)) }
def intended_submission_method=(_intended_submission_method); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default).
sig { returns(T.nilable(T::Boolean)) }
def submit; end
sig { params(_submit: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def submit=(_submit); end
sig {
params(evidence: T.nilable(::Stripe::DisputeService::UpdateParams::Evidence), expand: T.nilable(T::Array[String]), intended_submission_method: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), submit: T.nilable(T::Boolean)).void
}
def initialize(
evidence: nil,
expand: nil,
intended_submission_method: nil,
metadata: nil,
submit: nil
); end
end
class CloseParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.
#
# The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.
sig {
params(dispute: String, params: T.any(::Stripe::DisputeService::CloseParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Dispute)
}
def close(dispute, params = {}, opts = {}); end
# Returns a list of your disputes.
sig {
params(params: T.any(::Stripe::DisputeService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the dispute with the given ID.
sig {
params(dispute: String, params: T.any(::Stripe::DisputeService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Dispute)
}
def retrieve(dispute, params = {}, opts = {}); end
# When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your [dashboard](https://dashboard.stripe.com/disputes), but if you prefer, you can use the API to submit evidence programmatically.
#
# Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://docs.stripe.com/docs/disputes/categories).
sig {
params(dispute: String, params: T.any(::Stripe::DisputeService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Dispute)
}
def update(dispute, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class EntitlementsService < StripeService
attr_reader :active_entitlements
attr_reader :features
end
end
# typed: true
module Stripe
module Entitlements
class ActiveEntitlementService < StripeService
class ListParams < Stripe::RequestParams
# The ID of the customer.
sig { returns(String) }
def customer; end
sig { params(_customer: String).returns(String) }
def customer=(_customer); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(customer: String, ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
customer: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Retrieve a list of active entitlements for a customer
sig {
params(params: T.any(::Stripe::Entitlements::ActiveEntitlementService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieve an active entitlement
sig {
params(id: String, params: T.any(::Stripe::Entitlements::ActiveEntitlementService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Entitlements::ActiveEntitlement)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Entitlements
class FeatureService < StripeService
class ListParams < Stripe::RequestParams
# If set, filter results to only include features with the given archive status.
sig { returns(T.nilable(T::Boolean)) }
def archived; end
sig { params(_archived: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def archived=(_archived); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# If set, filter results to only include features with the given lookup_key.
sig { returns(T.nilable(String)) }
def lookup_key; end
sig { params(_lookup_key: T.nilable(String)).returns(T.nilable(String)) }
def lookup_key=(_lookup_key); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(archived: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), lookup_key: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
archived: nil,
ending_before: nil,
expand: nil,
limit: nil,
lookup_key: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A unique key you provide as your own system identifier. This may be up to 80 characters.
sig { returns(String) }
def lookup_key; end
sig { params(_lookup_key: String).returns(String) }
def lookup_key=(_lookup_key); end
# Set of key-value pairs 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The feature's name, for your own purpose, not meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(expand: T.nilable(T::Array[String]), lookup_key: String, metadata: T.nilable(T::Hash[String, String]), name: String).void
}
def initialize(expand: nil, lookup_key: nil, metadata: nil, name: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Set of key-value pairs 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.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The feature's name, for your own purpose, not meant to be displayable to the customer.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(active: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String)).void
}
def initialize(active: nil, expand: nil, metadata: nil, name: nil); end
end
# Creates a feature
sig {
params(params: T.any(::Stripe::Entitlements::FeatureService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Entitlements::Feature)
}
def create(params = {}, opts = {}); end
# Retrieve a list of features
sig {
params(params: T.any(::Stripe::Entitlements::FeatureService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a feature
sig {
params(id: String, params: T.any(::Stripe::Entitlements::FeatureService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Entitlements::Feature)
}
def retrieve(id, params = {}, opts = {}); end
# Update a feature's metadata or permanently deactivate it.
sig {
params(id: String, params: T.any(::Stripe::Entitlements::FeatureService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Entitlements::Feature)
}
def update(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class EphemeralKeyService < StripeService
class DeleteParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class CreateParams < Stripe::RequestParams
# The ID of the Customer you'd like to modify using the resulting ephemeral key.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The ID of the Issuing Card you'd like to access using the resulting ephemeral key.
sig { returns(T.nilable(String)) }
def issuing_card; end
sig { params(_issuing_card: T.nilable(String)).returns(T.nilable(String)) }
def issuing_card=(_issuing_card); end
# A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information.
sig { returns(T.nilable(String)) }
def nonce; end
sig { params(_nonce: T.nilable(String)).returns(T.nilable(String)) }
def nonce=(_nonce); end
# The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key
sig { returns(T.nilable(String)) }
def verification_session; end
sig { params(_verification_session: T.nilable(String)).returns(T.nilable(String)) }
def verification_session=(_verification_session); end
sig {
params(customer: T.nilable(String), expand: T.nilable(T::Array[String]), issuing_card: T.nilable(String), nonce: T.nilable(String), verification_session: T.nilable(String)).void
}
def initialize(
customer: nil,
expand: nil,
issuing_card: nil,
nonce: nil,
verification_session: nil
); end
end
# Creates a short-lived API key for a given resource.
sig {
params(params: T.any(::Stripe::EphemeralKeyService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::EphemeralKey)
}
def create(params = {}, opts = {}); end
# Invalidates a short-lived API key for a given resource.
sig {
params(key: String, params: T.any(::Stripe::EphemeralKeyService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::EphemeralKey)
}
def delete(key, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class EventService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return events that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::EventService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::EventService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::EventService::ListParams::Created, Integer)))
}
def created=(_created); end
# Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.
sig { returns(T.nilable(T::Boolean)) }
def delivery_success; end
sig { params(_delivery_success: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def delivery_success=(_delivery_success); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both.
sig { returns(T.nilable(T::Array[String])) }
def types; end
sig { params(_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def types=(_types); end
sig {
params(created: T.nilable(T.any(::Stripe::EventService::ListParams::Created, Integer)), delivery_success: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), type: T.nilable(String), types: T.nilable(T::Array[String])).void
}
def initialize(
created: nil,
delivery_success: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
type: nil,
types: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header).
sig {
params(params: T.any(::Stripe::EventService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.
sig {
params(id: String, params: T.any(::Stripe::EventService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Event)
}
def retrieve(id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class ExchangeRateService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.
sig {
params(params: T.any(::Stripe::ExchangeRateService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the exchange rates from the given currency to every supported currency.
sig {
params(rate_id: String, params: T.any(::Stripe::ExchangeRateService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ExchangeRate)
}
def retrieve(rate_id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class ExternalAccountService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Documents < Stripe::RequestParams
class BankAccountOwnershipVerification < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
# One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check.
sig {
returns(T.nilable(::Stripe::ExternalAccountService::UpdateParams::Documents::BankAccountOwnershipVerification))
}
def bank_account_ownership_verification; end
sig {
params(_bank_account_ownership_verification: T.nilable(::Stripe::ExternalAccountService::UpdateParams::Documents::BankAccountOwnershipVerification)).returns(T.nilable(::Stripe::ExternalAccountService::UpdateParams::Documents::BankAccountOwnershipVerification))
}
def bank_account_ownership_verification=(_bank_account_ownership_verification); end
sig {
params(bank_account_ownership_verification: T.nilable(::Stripe::ExternalAccountService::UpdateParams::Documents::BankAccountOwnershipVerification)).void
}
def initialize(bank_account_ownership_verification: nil); end
end
# The name of the person or business that owns the bank account.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The type of entity that holds the account. This can be either `individual` or `company`.
sig { returns(T.nilable(T.any(String, String))) }
def account_holder_type; end
sig {
params(_account_holder_type: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def account_holder_type=(_account_holder_type); end
# The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# City/District/Suburb/Town/Village.
sig { returns(T.nilable(String)) }
def address_city; end
sig { params(_address_city: T.nilable(String)).returns(T.nilable(String)) }
def address_city=(_address_city); end
# Billing address country, if provided when creating card.
sig { returns(T.nilable(String)) }
def address_country; end
sig { params(_address_country: T.nilable(String)).returns(T.nilable(String)) }
def address_country=(_address_country); end
# Address line 1 (Street address/PO Box/Company name).
sig { returns(T.nilable(String)) }
def address_line1; end
sig { params(_address_line1: T.nilable(String)).returns(T.nilable(String)) }
def address_line1=(_address_line1); end
# Address line 2 (Apartment/Suite/Unit/Building).
sig { returns(T.nilable(String)) }
def address_line2; end
sig { params(_address_line2: T.nilable(String)).returns(T.nilable(String)) }
def address_line2=(_address_line2); end
# State/County/Province/Region.
sig { returns(T.nilable(String)) }
def address_state; end
sig { params(_address_state: T.nilable(String)).returns(T.nilable(String)) }
def address_state=(_address_state); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def address_zip; end
sig { params(_address_zip: T.nilable(String)).returns(T.nilable(String)) }
def address_zip=(_address_zip); end
# When set to true, this becomes the default external account for its currency.
sig { returns(T.nilable(T::Boolean)) }
def default_for_currency; end
sig { params(_default_for_currency: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def default_for_currency=(_default_for_currency); end
# Documents that may be submitted to satisfy various informational requests.
sig { returns(T.nilable(::Stripe::ExternalAccountService::UpdateParams::Documents)) }
def documents; end
sig {
params(_documents: T.nilable(::Stripe::ExternalAccountService::UpdateParams::Documents)).returns(T.nilable(::Stripe::ExternalAccountService::UpdateParams::Documents))
}
def documents=(_documents); end
# Two digit number representing the card’s expiration month.
sig { returns(T.nilable(String)) }
def exp_month; end
sig { params(_exp_month: T.nilable(String)).returns(T.nilable(String)) }
def exp_month=(_exp_month); end
# Four digit number representing the card’s expiration year.
sig { returns(T.nilable(String)) }
def exp_year; end
sig { params(_exp_year: T.nilable(String)).returns(T.nilable(String)) }
def exp_year=(_exp_year); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Cardholder name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(account_holder_name: T.nilable(String), account_holder_type: T.nilable(T.any(String, String)), account_type: T.nilable(String), address_city: T.nilable(String), address_country: T.nilable(String), address_line1: T.nilable(String), address_line2: T.nilable(String), address_state: T.nilable(String), address_zip: T.nilable(String), default_for_currency: T.nilable(T::Boolean), documents: T.nilable(::Stripe::ExternalAccountService::UpdateParams::Documents), exp_month: T.nilable(String), exp_year: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String)).void
}
def initialize(
account_holder_name: nil,
account_holder_type: nil,
account_type: nil,
address_city: nil,
address_country: nil,
address_line1: nil,
address_line2: nil,
address_state: nil,
address_zip: nil,
default_for_currency: nil,
documents: nil,
exp_month: nil,
exp_year: nil,
expand: nil,
metadata: nil,
name: nil
); end
end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Filter external accounts according to a particular object type.
sig { returns(T.nilable(String)) }
def object; end
sig { params(_object: T.nilable(String)).returns(T.nilable(String)) }
def object=(_object); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), object: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
object: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class BankAccount < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The account number for the bank account, in string form. Must be a checking account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The country in which the bank account is located.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts)
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(object: String, account_holder_name: T.nilable(String), account_holder_type: T.nilable(String), account_number: String, country: String, currency: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
object: nil,
account_holder_name: nil,
account_holder_type: nil,
account_number: nil,
country: nil,
currency: nil,
routing_number: nil
); end
end
class Card < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# Attribute for param field address_city
sig { returns(T.nilable(String)) }
def address_city; end
sig { params(_address_city: T.nilable(String)).returns(T.nilable(String)) }
def address_city=(_address_city); end
# Attribute for param field address_country
sig { returns(T.nilable(String)) }
def address_country; end
sig { params(_address_country: T.nilable(String)).returns(T.nilable(String)) }
def address_country=(_address_country); end
# Attribute for param field address_line1
sig { returns(T.nilable(String)) }
def address_line1; end
sig { params(_address_line1: T.nilable(String)).returns(T.nilable(String)) }
def address_line1=(_address_line1); end
# Attribute for param field address_line2
sig { returns(T.nilable(String)) }
def address_line2; end
sig { params(_address_line2: T.nilable(String)).returns(T.nilable(String)) }
def address_line2=(_address_line2); end
# Attribute for param field address_state
sig { returns(T.nilable(String)) }
def address_state; end
sig { params(_address_state: T.nilable(String)).returns(T.nilable(String)) }
def address_state=(_address_state); end
# Attribute for param field address_zip
sig { returns(T.nilable(String)) }
def address_zip; end
sig { params(_address_zip: T.nilable(String)).returns(T.nilable(String)) }
def address_zip=(_address_zip); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Attribute for param field cvc
sig { returns(T.nilable(String)) }
def cvc; end
sig { params(_cvc: T.nilable(String)).returns(T.nilable(String)) }
def cvc=(_cvc); end
# Attribute for param field exp_month
sig { returns(Integer) }
def exp_month; end
sig { params(_exp_month: Integer).returns(Integer) }
def exp_month=(_exp_month); end
# Attribute for param field exp_year
sig { returns(Integer) }
def exp_year; end
sig { params(_exp_year: Integer).returns(Integer) }
def exp_year=(_exp_year); end
# Attribute for param field name
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Attribute for param field number
sig { returns(String) }
def number; end
sig { params(_number: String).returns(String) }
def number=(_number); end
# 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(object: String, address_city: T.nilable(String), address_country: T.nilable(String), address_line1: T.nilable(String), address_line2: T.nilable(String), address_state: T.nilable(String), address_zip: T.nilable(String), currency: T.nilable(String), cvc: T.nilable(String), exp_month: Integer, exp_year: Integer, name: T.nilable(String), number: String, metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(
object: nil,
address_city: nil,
address_country: nil,
address_line1: nil,
address_line2: nil,
address_state: nil,
address_zip: nil,
currency: nil,
cvc: nil,
exp_month: nil,
exp_year: nil,
name: nil,
number: nil,
metadata: nil
); end
end
class CardToken < Stripe::RequestParams
# Attribute for param field object
sig { returns(String) }
def object; end
sig { params(_object: String).returns(String) }
def object=(_object); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Attribute for param field token
sig { returns(String) }
def token; end
sig { params(_token: String).returns(String) }
def token=(_token); end
sig { params(object: String, currency: T.nilable(String), token: String).void }
def initialize(object: nil, currency: nil, token: nil); end
end
# When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
sig { returns(T.nilable(T::Boolean)) }
def default_for_currency; end
sig { params(_default_for_currency: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def default_for_currency=(_default_for_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user’s external account details (with the options shown below).
sig {
returns(T.any(String, ::Stripe::ExternalAccountService::CreateParams::Card, ::Stripe::ExternalAccountService::CreateParams::BankAccount, ::Stripe::ExternalAccountService::CreateParams::CardToken))
}
def external_account; end
sig {
params(_external_account: T.any(String, ::Stripe::ExternalAccountService::CreateParams::Card, ::Stripe::ExternalAccountService::CreateParams::BankAccount, ::Stripe::ExternalAccountService::CreateParams::CardToken)).returns(T.any(String, ::Stripe::ExternalAccountService::CreateParams::Card, ::Stripe::ExternalAccountService::CreateParams::BankAccount, ::Stripe::ExternalAccountService::CreateParams::CardToken))
}
def external_account=(_external_account); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(default_for_currency: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), external_account: T.any(String, ::Stripe::ExternalAccountService::CreateParams::Card, ::Stripe::ExternalAccountService::CreateParams::BankAccount, ::Stripe::ExternalAccountService::CreateParams::CardToken), metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(
default_for_currency: nil,
expand: nil,
external_account: nil,
metadata: nil
); end
end
# Create an external account for a given connected account.
sig {
params(params: T.any(::Stripe::ExternalAccountService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.any(Stripe::BankAccount, Stripe::Card))
}
def create(params = {}, opts = {}); end
# Delete a specified external account for a given account.
sig {
params(id: String, params: T.any(::Stripe::ExternalAccountService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.any(Stripe::BankAccount, Stripe::Card))
}
def delete(id, params = {}, opts = {}); end
# List external accounts for an account.
sig {
params(params: T.any(::Stripe::ExternalAccountService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieve a specified external account for a given account.
sig {
params(id: String, params: T.any(::Stripe::ExternalAccountService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.any(Stripe::BankAccount, Stripe::Card))
}
def retrieve(id, params = {}, opts = {}); end
# Updates the metadata, account holder name, account holder type of a bank account belonging to
# a connected account and optionally sets it as the default for its currency. Other bank account
# details are not editable by design.
#
# You can only update bank accounts when [account.controller.requirement_collection is application, which includes Custom accounts](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection).
#
# You can re-enable a disabled bank account by performing an update call without providing any
# arguments or changes.
sig {
params(id: String, params: T.any(::Stripe::ExternalAccountService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.any(Stripe::BankAccount, Stripe::Card))
}
def update(id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class FileService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return files that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::FileService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::FileService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::FileService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.
sig { returns(T.nilable(String)) }
def purpose; end
sig { params(_purpose: T.nilable(String)).returns(T.nilable(String)) }
def purpose=(_purpose); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::FileService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), purpose: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
purpose: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class FileLinkData < Stripe::RequestParams
# Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `issuing_regulatory_reporting`, `pci_document`, `tax_document_user_upload`, `terminal_android_apk`, or `terminal_reader_splashscreen`.
sig { returns(T::Boolean) }
def create; end
sig { params(_create: T::Boolean).returns(T::Boolean) }
def create=(_create); end
# The link isn't available after this future timestamp.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(create: T::Boolean, expires_at: T.nilable(Integer), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(create: nil, expires_at: nil, metadata: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol.
sig { returns(T.untyped) }
def file; end
sig { params(_file: T.untyped).returns(T.untyped) }
def file=(_file); end
# Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.
sig { returns(T.nilable(::Stripe::FileService::CreateParams::FileLinkData)) }
def file_link_data; end
sig {
params(_file_link_data: T.nilable(::Stripe::FileService::CreateParams::FileLinkData)).returns(T.nilable(::Stripe::FileService::CreateParams::FileLinkData))
}
def file_link_data=(_file_link_data); end
# The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
sig { returns(String) }
def purpose; end
sig { params(_purpose: String).returns(String) }
def purpose=(_purpose); end
sig {
params(expand: T.nilable(T::Array[String]), file: T.untyped, file_link_data: T.nilable(::Stripe::FileService::CreateParams::FileLinkData), purpose: String).void
}
def initialize(expand: nil, file: nil, file_link_data: nil, purpose: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.
#
# All of Stripe's officially supported Client libraries support sending multipart/form-data.
sig {
params(params: T.any(::Stripe::FileService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::File)
}
def create(params = {}, opts = {}); end
# Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
sig {
params(params: T.any(::Stripe::FileService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to [access file contents](https://docs.stripe.com/docs/file-upload#download-file-contents).
sig {
params(file: String, params: T.any(::Stripe::FileService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::File)
}
def retrieve(file, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class FileLinkService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return links that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::FileLinkService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::FileLinkService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::FileLinkService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Filter links by their expiration status. By default, Stripe returns all links.
sig { returns(T.nilable(T::Boolean)) }
def expired; end
sig { params(_expired: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def expired=(_expired); end
# Only return links for the given file.
sig { returns(T.nilable(String)) }
def file; end
sig { params(_file: T.nilable(String)).returns(T.nilable(String)) }
def file=(_file); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::FileLinkService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), expired: T.nilable(T::Boolean), file: T.nilable(String), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
expired: nil,
file: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The link isn't usable after this future timestamp.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `financial_account_statement`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, `terminal_android_apk`, or `terminal_reader_splashscreen`.
sig { returns(String) }
def file; end
sig { params(_file: String).returns(String) }
def file=(_file); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), file: String, metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, expires_at: nil, file: nil, metadata: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately.
sig { returns(T.nilable(T.any(String, T.any(String, Integer)))) }
def expires_at; end
sig {
params(_expires_at: T.nilable(T.any(String, T.any(String, Integer)))).returns(T.nilable(T.any(String, T.any(String, Integer))))
}
def expires_at=(_expires_at); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), expires_at: T.nilable(T.any(String, T.any(String, Integer))), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, expires_at: nil, metadata: nil); end
end
# Creates a new file link object.
sig {
params(params: T.any(::Stripe::FileLinkService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FileLink)
}
def create(params = {}, opts = {}); end
# Returns a list of file links.
sig {
params(params: T.any(::Stripe::FileLinkService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the file link with the given ID.
sig {
params(link: String, params: T.any(::Stripe::FileLinkService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FileLink)
}
def retrieve(link, params = {}, opts = {}); end
# Updates an existing file link object. Expired links can no longer be updated.
sig {
params(link: String, params: T.any(::Stripe::FileLinkService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FileLink)
}
def update(link, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class FinancialConnectionsService < StripeService
attr_reader :accounts
attr_reader :institutions
attr_reader :sessions
attr_reader :transactions
end
end
# typed: true
module Stripe
module FinancialConnections
class AccountService < StripeService
attr_reader :inferred_balances
attr_reader :owners
class ListParams < Stripe::RequestParams
class AccountHolder < Stripe::RequestParams
# The ID of the Stripe account whose accounts will be retrieved.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The ID of the Stripe customer whose accounts will be retrieved.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The Account ID of the Stripe customer whose accounts will be retrieved.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
sig {
params(account: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String)).void
}
def initialize(account: nil, customer: nil, customer_account: nil); end
end
# If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.
sig {
returns(T.nilable(::Stripe::FinancialConnections::AccountService::ListParams::AccountHolder))
}
def account_holder; end
sig {
params(_account_holder: T.nilable(::Stripe::FinancialConnections::AccountService::ListParams::AccountHolder)).returns(T.nilable(::Stripe::FinancialConnections::AccountService::ListParams::AccountHolder))
}
def account_holder=(_account_holder); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# If present, only return accounts that were collected as part of the given session.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(account_holder: T.nilable(::Stripe::FinancialConnections::AccountService::ListParams::AccountHolder), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), session: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
account_holder: nil,
ending_before: nil,
expand: nil,
limit: nil,
session: nil,
starting_after: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class DisconnectParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class RefreshParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The list of account features that you would like to refresh.
sig { returns(T::Array[String]) }
def features; end
sig { params(_features: T::Array[String]).returns(T::Array[String]) }
def features=(_features); end
sig { params(expand: T.nilable(T::Array[String]), features: T::Array[String]).void }
def initialize(expand: nil, features: nil); end
end
class SubscribeParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The list of account features to which you would like to subscribe.
sig { returns(T::Array[String]) }
def features; end
sig { params(_features: T::Array[String]).returns(T::Array[String]) }
def features=(_features); end
sig { params(expand: T.nilable(T::Array[String]), features: T::Array[String]).void }
def initialize(expand: nil, features: nil); end
end
class UnsubscribeParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The list of account features from which you would like to unsubscribe.
sig { returns(T::Array[String]) }
def features; end
sig { params(_features: T::Array[String]).returns(T::Array[String]) }
def features=(_features); end
sig { params(expand: T.nilable(T::Array[String]), features: T::Array[String]).void }
def initialize(expand: nil, features: nil); end
end
# Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
sig {
params(account: String, params: T.any(::Stripe::FinancialConnections::AccountService::DisconnectParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Account)
}
def disconnect(account, params = {}, opts = {}); end
# Returns a list of Financial Connections Account objects.
sig {
params(params: T.any(::Stripe::FinancialConnections::AccountService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Refreshes the data associated with a Financial Connections Account.
sig {
params(account: String, params: T.any(::Stripe::FinancialConnections::AccountService::RefreshParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Account)
}
def refresh(account, params = {}, opts = {}); end
# Retrieves the details of an Financial Connections Account.
sig {
params(account: String, params: T.any(::Stripe::FinancialConnections::AccountService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Account)
}
def retrieve(account, params = {}, opts = {}); end
# Subscribes to periodic refreshes of data associated with a Financial Connections Account.
sig {
params(account: String, params: T.any(::Stripe::FinancialConnections::AccountService::SubscribeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Account)
}
def subscribe(account, params = {}, opts = {}); end
# Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
sig {
params(account: String, params: T.any(::Stripe::FinancialConnections::AccountService::UnsubscribeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Account)
}
def unsubscribe(account, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module FinancialConnections
class AccountInferredBalanceService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Lists the recorded inferred balances for a Financial Connections Account.
sig {
params(account: String, params: T.any(::Stripe::FinancialConnections::AccountInferredBalanceService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(account, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module FinancialConnections
class AccountOwnerService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The ID of the ownership object to fetch owners from.
sig { returns(String) }
def ownership; end
sig { params(_ownership: String).returns(String) }
def ownership=(_ownership); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), ownership: String, starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
ownership: nil,
starting_after: nil
); end
end
# Lists all owners for a given Account
sig {
params(account: String, params: T.any(::Stripe::FinancialConnections::AccountOwnerService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(account, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module FinancialConnections
class InstitutionService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of Financial Connections Institution objects.
sig {
params(params: T.any(::Stripe::FinancialConnections::InstitutionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of a Financial Connections Institution.
sig {
params(institution: String, params: T.any(::Stripe::FinancialConnections::InstitutionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Institution)
}
def retrieve(institution, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module FinancialConnections
class SessionService < StripeService
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class CreateParams < Stripe::RequestParams
class AccountHolder < Stripe::RequestParams
# The ID of the Stripe account whose accounts will be retrieved. Should only be present if `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The ID of the Stripe customer whose accounts will be retrieved. Should only be present if `type` is `customer`.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The ID of the Stripe customer Account whose accounts will be retrieved. Should only be present if `type` is `customer`.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Type of account holder to collect accounts for.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(account: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), type: String).void
}
def initialize(account: nil, customer: nil, customer_account: nil, type: nil); end
end
class Filters < Stripe::RequestParams
# Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# List of countries from which to collect accounts.
sig { returns(T.nilable(T::Array[String])) }
def countries; end
sig {
params(_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def countries=(_countries); end
# Stripe ID of the institution with which the customer should be directed to log in.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), countries: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, countries: nil, institution: nil); end
end
class Limits < Stripe::RequestParams
# The number of accounts that can be linked in this Session.
sig { returns(Integer) }
def accounts; end
sig { params(_accounts: Integer).returns(Integer) }
def accounts=(_accounts); end
sig { params(accounts: Integer).void }
def initialize(accounts: nil); end
end
class ManualEntry < Stripe::RequestParams
# Whether manual entry will be handled by Stripe during the Session.
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
sig { params(mode: T.nilable(String)).void }
def initialize(mode: nil); end
end
# The account holder to link accounts for.
sig { returns(::Stripe::FinancialConnections::SessionService::CreateParams::AccountHolder) }
def account_holder; end
sig {
params(_account_holder: ::Stripe::FinancialConnections::SessionService::CreateParams::AccountHolder).returns(::Stripe::FinancialConnections::SessionService::CreateParams::AccountHolder)
}
def account_holder=(_account_holder); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Filters to restrict the kinds of accounts to collect.
sig {
returns(T.nilable(::Stripe::FinancialConnections::SessionService::CreateParams::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::FinancialConnections::SessionService::CreateParams::Filters)).returns(T.nilable(::Stripe::FinancialConnections::SessionService::CreateParams::Filters))
}
def filters=(_filters); end
# Settings for configuring Session-specific limits.
sig {
returns(T.nilable(::Stripe::FinancialConnections::SessionService::CreateParams::Limits))
}
def limits; end
sig {
params(_limits: T.nilable(::Stripe::FinancialConnections::SessionService::CreateParams::Limits)).returns(T.nilable(::Stripe::FinancialConnections::SessionService::CreateParams::Limits))
}
def limits=(_limits); end
# Customize manual entry behavior
sig {
returns(T.nilable(::Stripe::FinancialConnections::SessionService::CreateParams::ManualEntry))
}
def manual_entry; end
sig {
params(_manual_entry: T.nilable(::Stripe::FinancialConnections::SessionService::CreateParams::ManualEntry)).returns(T.nilable(::Stripe::FinancialConnections::SessionService::CreateParams::ManualEntry))
}
def manual_entry=(_manual_entry); end
# List of data features that you would like to request access to.
#
# Possible values are `balances`, `transactions`, `ownership`, and `payment_method`.
sig { returns(T::Array[String]) }
def permissions; end
sig { params(_permissions: T::Array[String]).returns(T::Array[String]) }
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig { params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def prefetch=(_prefetch); end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(account_holder: ::Stripe::FinancialConnections::SessionService::CreateParams::AccountHolder, expand: T.nilable(T::Array[String]), filters: T.nilable(::Stripe::FinancialConnections::SessionService::CreateParams::Filters), limits: T.nilable(::Stripe::FinancialConnections::SessionService::CreateParams::Limits), manual_entry: T.nilable(::Stripe::FinancialConnections::SessionService::CreateParams::ManualEntry), permissions: T::Array[String], prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
}
def initialize(
account_holder: nil,
expand: nil,
filters: nil,
limits: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
); end
end
# To launch the Financial Connections authorization flow, create a Session. The session's client_secret can be used to launch the flow using Stripe.js.
sig {
params(params: T.any(::Stripe::FinancialConnections::SessionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Session)
}
def create(params = {}, opts = {}); end
# Retrieves the details of a Financial Connections Session
sig {
params(session: String, params: T.any(::Stripe::FinancialConnections::SessionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Session)
}
def retrieve(session, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module FinancialConnections
class TransactionService < StripeService
class ListParams < Stripe::RequestParams
class TransactedAt < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class TransactionRefresh < Stripe::RequestParams
# Return results where the transactions were created or updated by a refresh that took place after this refresh (non-inclusive).
sig { returns(String) }
def after; end
sig { params(_after: String).returns(String) }
def after=(_after); end
sig { params(after: String).void }
def initialize(after: nil); end
end
# The ID of the Financial Connections Account whose transactions will be retrieved.
sig { returns(String) }
def account; end
sig { params(_account: String).returns(String) }
def account=(_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# A filter on the list based on the object `transacted_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:
sig {
returns(T.nilable(T.any(::Stripe::FinancialConnections::TransactionService::ListParams::TransactedAt, Integer)))
}
def transacted_at; end
sig {
params(_transacted_at: T.nilable(T.any(::Stripe::FinancialConnections::TransactionService::ListParams::TransactedAt, Integer))).returns(T.nilable(T.any(::Stripe::FinancialConnections::TransactionService::ListParams::TransactedAt, Integer)))
}
def transacted_at=(_transacted_at); end
# A filter on the list based on the object `transaction_refresh` field. The value can be a dictionary with the following options:
sig {
returns(T.nilable(::Stripe::FinancialConnections::TransactionService::ListParams::TransactionRefresh))
}
def transaction_refresh; end
sig {
params(_transaction_refresh: T.nilable(::Stripe::FinancialConnections::TransactionService::ListParams::TransactionRefresh)).returns(T.nilable(::Stripe::FinancialConnections::TransactionService::ListParams::TransactionRefresh))
}
def transaction_refresh=(_transaction_refresh); end
sig {
params(account: String, ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), transacted_at: T.nilable(T.any(::Stripe::FinancialConnections::TransactionService::ListParams::TransactedAt, Integer)), transaction_refresh: T.nilable(::Stripe::FinancialConnections::TransactionService::ListParams::TransactionRefresh)).void
}
def initialize(
account: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
transacted_at: nil,
transaction_refresh: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of Financial Connections Transaction objects.
sig {
params(params: T.any(::Stripe::FinancialConnections::TransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of a Financial Connections Transaction
sig {
params(transaction: String, params: T.any(::Stripe::FinancialConnections::TransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FinancialConnections::Transaction)
}
def retrieve(transaction, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class ForwardingService < StripeService
attr_reader :requests
end
end
# typed: true
module Stripe
module Forwarding
class RequestService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Return results where the `created` field is greater than this value.
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Return results where the `created` field is greater than or equal to this value.
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Return results where the `created` field is less than this value.
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Return results where the `created` field is less than or equal to this value.
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.
sig { returns(T.nilable(::Stripe::Forwarding::RequestService::ListParams::Created)) }
def created; end
sig {
params(_created: T.nilable(::Stripe::Forwarding::RequestService::ListParams::Created)).returns(T.nilable(::Stripe::Forwarding::RequestService::ListParams::Created))
}
def created=(_created); end
# A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(::Stripe::Forwarding::RequestService::ListParams::Created), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Request < Stripe::RequestParams
class Header < Stripe::RequestParams
# The header name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The header value.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
# The body payload to send to the destination endpoint.
sig { returns(T.nilable(String)) }
def body; end
sig { params(_body: T.nilable(String)).returns(T.nilable(String)) }
def body=(_body); end
# The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.
sig {
returns(T.nilable(T::Array[::Stripe::Forwarding::RequestService::CreateParams::Request::Header]))
}
def headers; end
sig {
params(_headers: T.nilable(T::Array[::Stripe::Forwarding::RequestService::CreateParams::Request::Header])).returns(T.nilable(T::Array[::Stripe::Forwarding::RequestService::CreateParams::Request::Header]))
}
def headers=(_headers); end
sig {
params(body: T.nilable(String), headers: T.nilable(T::Array[::Stripe::Forwarding::RequestService::CreateParams::Request::Header])).void
}
def initialize(body: nil, headers: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
sig { returns(String) }
def payment_method; end
sig { params(_payment_method: String).returns(String) }
def payment_method=(_payment_method); end
# The field kinds to be replaced in the forwarded request.
sig { returns(T::Array[String]) }
def replacements; end
sig { params(_replacements: T::Array[String]).returns(T::Array[String]) }
def replacements=(_replacements); end
# The request body and headers to be sent to the destination endpoint.
sig { returns(::Stripe::Forwarding::RequestService::CreateParams::Request) }
def request; end
sig {
params(_request: ::Stripe::Forwarding::RequestService::CreateParams::Request).returns(::Stripe::Forwarding::RequestService::CreateParams::Request)
}
def request=(_request); end
# The destination URL for the forwarded request. Must be supported by the config.
sig { returns(String) }
def url; end
sig { params(_url: String).returns(String) }
def url=(_url); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), payment_method: String, replacements: T::Array[String], request: ::Stripe::Forwarding::RequestService::CreateParams::Request, url: String).void
}
def initialize(
expand: nil,
metadata: nil,
payment_method: nil,
replacements: nil,
request: nil,
url: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Creates a ForwardingRequest object.
sig {
params(params: T.any(::Stripe::Forwarding::RequestService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Forwarding::Request)
}
def create(params = {}, opts = {}); end
# Lists all ForwardingRequest objects.
sig {
params(params: T.any(::Stripe::Forwarding::RequestService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a ForwardingRequest object.
sig {
params(id: String, params: T.any(::Stripe::Forwarding::RequestService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Forwarding::Request)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class FxQuoteService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateParams < Stripe::RequestParams
class Usage < Stripe::RequestParams
class Payment < Stripe::RequestParams
# The Stripe account ID that the funds will be transferred to.
#
# This field should match the account ID that would be used in the PaymentIntent’s transfer_data[destination] field.
sig { returns(T.nilable(String)) }
def destination; end
sig { params(_destination: T.nilable(String)).returns(T.nilable(String)) }
def destination=(_destination); end
# The Stripe account ID that these funds are intended for.
#
# This field should match the account ID that would be used in the PaymentIntent’s on_behalf_of field.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
sig { params(destination: T.nilable(String), on_behalf_of: T.nilable(String)).void }
def initialize(destination: nil, on_behalf_of: nil); end
end
class Transfer < Stripe::RequestParams
# The Stripe account ID that the funds will be transferred to.
#
# This field should match the account ID that would be used in the Transfer’s destination field.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(destination: String).void }
def initialize(destination: nil); end
end
# The payment transaction details that are intended for the FX Quote.
sig { returns(T.nilable(::Stripe::FxQuoteService::CreateParams::Usage::Payment)) }
def payment; end
sig {
params(_payment: T.nilable(::Stripe::FxQuoteService::CreateParams::Usage::Payment)).returns(T.nilable(::Stripe::FxQuoteService::CreateParams::Usage::Payment))
}
def payment=(_payment); end
# The transfer transaction details that are intended for the FX Quote.
sig { returns(T.nilable(::Stripe::FxQuoteService::CreateParams::Usage::Transfer)) }
def transfer; end
sig {
params(_transfer: T.nilable(::Stripe::FxQuoteService::CreateParams::Usage::Transfer)).returns(T.nilable(::Stripe::FxQuoteService::CreateParams::Usage::Transfer))
}
def transfer=(_transfer); end
# Which transaction the FX Quote will be used for
#
# Can be “payment” | “transfer”
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(payment: T.nilable(::Stripe::FxQuoteService::CreateParams::Usage::Payment), transfer: T.nilable(::Stripe::FxQuoteService::CreateParams::Usage::Transfer), type: String).void
}
def initialize(payment: nil, transfer: nil, type: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A list of three letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be [supported currencies](https://stripe.com/docs/currencies).
sig { returns(T::Array[String]) }
def from_currencies; end
sig { params(_from_currencies: T::Array[String]).returns(T::Array[String]) }
def from_currencies=(_from_currencies); end
# The duration that you wish the quote to be locked for. The quote will be usable for the duration specified. The default is `none`. The maximum is 1 day.
sig { returns(String) }
def lock_duration; end
sig { params(_lock_duration: String).returns(String) }
def lock_duration=(_lock_duration); end
# 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) }
def to_currency; end
sig { params(_to_currency: String).returns(String) }
def to_currency=(_to_currency); end
# The usage specific information for the quote.
sig { returns(T.nilable(::Stripe::FxQuoteService::CreateParams::Usage)) }
def usage; end
sig {
params(_usage: T.nilable(::Stripe::FxQuoteService::CreateParams::Usage)).returns(T.nilable(::Stripe::FxQuoteService::CreateParams::Usage))
}
def usage=(_usage); end
sig {
params(expand: T.nilable(T::Array[String]), from_currencies: T::Array[String], lock_duration: String, to_currency: String, usage: T.nilable(::Stripe::FxQuoteService::CreateParams::Usage)).void
}
def initialize(
expand: nil,
from_currencies: nil,
lock_duration: nil,
to_currency: nil,
usage: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Creates an FX Quote object
sig {
params(params: T.any(::Stripe::FxQuoteService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FxQuote)
}
def create(params = {}, opts = {}); end
# Returns a list of FX quotes that have been issued. The FX quotes are returned in sorted order, with the most recent FX quotes appearing first.
sig {
params(params: T.any(::Stripe::FxQuoteService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieve an FX Quote object
sig {
params(id: String, params: T.any(::Stripe::FxQuoteService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FxQuote)
}
def retrieve(id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class IdentityService < StripeService
attr_reader :verification_reports
attr_reader :verification_sessions
end
end
# typed: true
module Stripe
module Identity
class VerificationReportService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
sig { returns(T.nilable(String)) }
def client_reference_id; end
sig { params(_client_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def client_reference_id=(_client_reference_id); end
# Only return VerificationReports that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Identity::VerificationReportService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Identity::VerificationReportService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Identity::VerificationReportService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return VerificationReports of this type
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.
sig { returns(T.nilable(String)) }
def verification_session; end
sig { params(_verification_session: T.nilable(String)).returns(T.nilable(String)) }
def verification_session=(_verification_session); end
sig {
params(client_reference_id: T.nilable(String), created: T.nilable(T.any(::Stripe::Identity::VerificationReportService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), type: T.nilable(String), verification_session: T.nilable(String)).void
}
def initialize(
client_reference_id: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
type: nil,
verification_session: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# List all verification reports.
sig {
params(params: T.any(::Stripe::Identity::VerificationReportService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves an existing VerificationReport
sig {
params(report: String, params: T.any(::Stripe::Identity::VerificationReportService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationReport)
}
def retrieve(report, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Identity
class VerificationSessionService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
sig { returns(T.nilable(String)) }
def client_reference_id; end
sig { params(_client_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def client_reference_id=(_client_reference_id); end
# Only return VerificationSessions that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Identity::VerificationSessionService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Identity::VerificationSessionService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Identity::VerificationSessionService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Attribute for param field related_customer
sig { returns(T.nilable(String)) }
def related_customer; end
sig { params(_related_customer: T.nilable(String)).returns(T.nilable(String)) }
def related_customer=(_related_customer); end
# Attribute for param field related_customer_account
sig { returns(T.nilable(String)) }
def related_customer_account; end
sig { params(_related_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def related_customer_account=(_related_customer_account); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(client_reference_id: T.nilable(String), created: T.nilable(T.any(::Stripe::Identity::VerificationSessionService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), related_customer: T.nilable(String), related_customer_account: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
client_reference_id: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
related_customer: nil,
related_customer_account: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class Options < Stripe::RequestParams
class Document < Stripe::RequestParams
# Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
sig { returns(T.nilable(T::Array[String])) }
def allowed_types; end
sig {
params(_allowed_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_types=(_allowed_types); end
# Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
sig { returns(T.nilable(T::Boolean)) }
def require_id_number; end
sig { params(_require_id_number: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def require_id_number=(_require_id_number); end
# Disable image uploads, identity document images have to be captured using the device’s camera.
sig { returns(T.nilable(T::Boolean)) }
def require_live_capture; end
sig {
params(_require_live_capture: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def require_live_capture=(_require_live_capture); end
# Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).
sig { returns(T.nilable(T::Boolean)) }
def require_matching_selfie; end
sig {
params(_require_matching_selfie: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def require_matching_selfie=(_require_matching_selfie); end
sig {
params(allowed_types: T.nilable(T::Array[String]), require_id_number: T.nilable(T::Boolean), require_live_capture: T.nilable(T::Boolean), require_matching_selfie: T.nilable(T::Boolean)).void
}
def initialize(
allowed_types: nil,
require_id_number: nil,
require_live_capture: nil,
require_matching_selfie: nil
); end
end
# Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document).
sig {
returns(T.nilable(T.any(String, ::Stripe::Identity::VerificationSessionService::CreateParams::Options::Document)))
}
def document; end
sig {
params(_document: T.nilable(T.any(String, ::Stripe::Identity::VerificationSessionService::CreateParams::Options::Document))).returns(T.nilable(T.any(String, ::Stripe::Identity::VerificationSessionService::CreateParams::Options::Document)))
}
def document=(_document); end
sig {
params(document: T.nilable(T.any(String, ::Stripe::Identity::VerificationSessionService::CreateParams::Options::Document))).void
}
def initialize(document: nil); end
end
class ProvidedDetails < Stripe::RequestParams
# Email of user being verified
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Phone number of user being verified
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig { params(email: T.nilable(String), phone: T.nilable(String)).void }
def initialize(email: nil, phone: nil); end
end
class RelatedPerson < Stripe::RequestParams
# A token representing a connected account. If provided, the person parameter is also required and must be associated with the account.
sig { returns(String) }
def account; end
sig { params(_account: String).returns(String) }
def account=(_account); end
# A token referencing a Person resource that this verification is being used to verify.
sig { returns(String) }
def person; end
sig { params(_person: String).returns(String) }
def person=(_person); end
sig { params(account: String, person: String).void }
def initialize(account: nil, person: nil); end
end
# A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
sig { returns(T.nilable(String)) }
def client_reference_id; end
sig { params(_client_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def client_reference_id=(_client_reference_id); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# A set of options for the session’s verification checks.
sig {
returns(T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::Options))
}
def options; end
sig {
params(_options: T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::Options)).returns(T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::Options))
}
def options=(_options); end
# Details provided about the user being verified. These details may be shown to the user.
sig {
returns(T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::ProvidedDetails))
}
def provided_details; end
sig {
params(_provided_details: T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::ProvidedDetails)).returns(T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::ProvidedDetails))
}
def provided_details=(_provided_details); end
# Customer ID
sig { returns(T.nilable(String)) }
def related_customer; end
sig { params(_related_customer: T.nilable(String)).returns(T.nilable(String)) }
def related_customer=(_related_customer); end
# Token referencing a Customer Account resource.
sig { returns(T.nilable(String)) }
def related_customer_account; end
sig { params(_related_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def related_customer_account=(_related_customer_account); end
# Tokens referencing a Person resource and it's associated account.
sig {
returns(T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::RelatedPerson))
}
def related_person; end
sig {
params(_related_person: T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::RelatedPerson)).returns(T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::RelatedPerson))
}
def related_person=(_related_person); end
# The URL that the user will be redirected to upon completing the verification flow.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.
sig { returns(T.nilable(String)) }
def verification_flow; end
sig { params(_verification_flow: T.nilable(String)).returns(T.nilable(String)) }
def verification_flow=(_verification_flow); end
sig {
params(client_reference_id: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), options: T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::Options), provided_details: T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::ProvidedDetails), related_customer: T.nilable(String), related_customer_account: T.nilable(String), related_person: T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::RelatedPerson), return_url: T.nilable(String), type: T.nilable(String), verification_flow: T.nilable(String)).void
}
def initialize(
client_reference_id: nil,
expand: nil,
metadata: nil,
options: nil,
provided_details: nil,
related_customer: nil,
related_customer_account: nil,
related_person: nil,
return_url: nil,
type: nil,
verification_flow: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Options < Stripe::RequestParams
class Document < Stripe::RequestParams
# Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
sig { returns(T.nilable(T::Array[String])) }
def allowed_types; end
sig {
params(_allowed_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_types=(_allowed_types); end
# Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
sig { returns(T.nilable(T::Boolean)) }
def require_id_number; end
sig { params(_require_id_number: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def require_id_number=(_require_id_number); end
# Disable image uploads, identity document images have to be captured using the device’s camera.
sig { returns(T.nilable(T::Boolean)) }
def require_live_capture; end
sig {
params(_require_live_capture: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def require_live_capture=(_require_live_capture); end
# Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).
sig { returns(T.nilable(T::Boolean)) }
def require_matching_selfie; end
sig {
params(_require_matching_selfie: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def require_matching_selfie=(_require_matching_selfie); end
sig {
params(allowed_types: T.nilable(T::Array[String]), require_id_number: T.nilable(T::Boolean), require_live_capture: T.nilable(T::Boolean), require_matching_selfie: T.nilable(T::Boolean)).void
}
def initialize(
allowed_types: nil,
require_id_number: nil,
require_live_capture: nil,
require_matching_selfie: nil
); end
end
# Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document).
sig {
returns(T.nilable(T.any(String, ::Stripe::Identity::VerificationSessionService::UpdateParams::Options::Document)))
}
def document; end
sig {
params(_document: T.nilable(T.any(String, ::Stripe::Identity::VerificationSessionService::UpdateParams::Options::Document))).returns(T.nilable(T.any(String, ::Stripe::Identity::VerificationSessionService::UpdateParams::Options::Document)))
}
def document=(_document); end
sig {
params(document: T.nilable(T.any(String, ::Stripe::Identity::VerificationSessionService::UpdateParams::Options::Document))).void
}
def initialize(document: nil); end
end
class ProvidedDetails < Stripe::RequestParams
# Email of user being verified
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Phone number of user being verified
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig { params(email: T.nilable(String), phone: T.nilable(String)).void }
def initialize(email: nil, phone: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# A set of options for the session’s verification checks.
sig {
returns(T.nilable(::Stripe::Identity::VerificationSessionService::UpdateParams::Options))
}
def options; end
sig {
params(_options: T.nilable(::Stripe::Identity::VerificationSessionService::UpdateParams::Options)).returns(T.nilable(::Stripe::Identity::VerificationSessionService::UpdateParams::Options))
}
def options=(_options); end
# Details provided about the user being verified. These details may be shown to the user.
sig {
returns(T.nilable(::Stripe::Identity::VerificationSessionService::UpdateParams::ProvidedDetails))
}
def provided_details; end
sig {
params(_provided_details: T.nilable(::Stripe::Identity::VerificationSessionService::UpdateParams::ProvidedDetails)).returns(T.nilable(::Stripe::Identity::VerificationSessionService::UpdateParams::ProvidedDetails))
}
def provided_details=(_provided_details); end
# The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), options: T.nilable(::Stripe::Identity::VerificationSessionService::UpdateParams::Options), provided_details: T.nilable(::Stripe::Identity::VerificationSessionService::UpdateParams::ProvidedDetails), type: T.nilable(String)).void
}
def initialize(
expand: nil,
metadata: nil,
options: nil,
provided_details: nil,
type: nil
); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class RedactParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
#
# Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
sig {
params(session: String, params: T.any(::Stripe::Identity::VerificationSessionService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
}
def cancel(session, params = {}, opts = {}); end
# Creates a VerificationSession object.
#
# After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session's url.
#
# If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode.
#
# Related guide: [Verify your users' identity documents](https://docs.stripe.com/docs/identity/verify-identity-documents)
sig {
params(params: T.any(::Stripe::Identity::VerificationSessionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
}
def create(params = {}, opts = {}); end
# Returns a list of VerificationSessions
sig {
params(params: T.any(::Stripe::Identity::VerificationSessionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Redact a VerificationSession to remove all collected information from Stripe. This will redact
# the VerificationSession and all objects related to it, including VerificationReports, Events,
# request logs, etc.
#
# A VerificationSession object can be redacted when it is in requires_input or verified
# [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
# state will automatically cancel it.
#
# The redaction process may take up to four days. When the redaction process is in progress, the
# VerificationSession's redaction.status field will be set to processing; when the process is
# finished, it will change to redacted and an identity.verification_session.redacted event
# will be emitted.
#
# Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the
# fields that contain personal data will be replaced by the string [redacted] or a similar
# placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
# used for any purpose.
#
# [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact).
sig {
params(session: String, params: T.any(::Stripe::Identity::VerificationSessionService::RedactParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
}
def redact(session, params = {}, opts = {}); end
# Retrieves the details of a VerificationSession that was previously created.
#
# When the session status is requires_input, you can use this method to retrieve a valid
# client_secret or url to allow re-submission.
sig {
params(session: String, params: T.any(::Stripe::Identity::VerificationSessionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
}
def retrieve(session, params = {}, opts = {}); end
# Updates a VerificationSession object.
#
# When the session status is requires_input, you can use this method to update the
# verification check and options.
sig {
params(session: String, params: T.any(::Stripe::Identity::VerificationSessionService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
}
def update(session, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class InvoiceService < StripeService
attr_reader :line_items
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class AmountsDue < Stripe::RequestParams
# The amount in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Number of days from when invoice is finalized until the payment is due.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(String) }
def description; end
sig { params(_description: String).returns(String) }
def description=(_description); end
# Date on which a payment plan’s payment is due.
sig { returns(T.nilable(Integer)) }
def due_date; end
sig { params(_due_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def due_date=(_due_date); end
sig {
params(amount: Integer, days_until_due: T.nilable(Integer), description: String, due_date: T.nilable(Integer)).void
}
def initialize(amount: nil, days_until_due: nil, description: nil, due_date: nil); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(::Stripe::InvoiceService::UpdateParams::AutomaticTax::Liability)) }
def liability; end
sig {
params(_liability: T.nilable(::Stripe::InvoiceService::UpdateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::InvoiceService::UpdateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class CustomField < Stripe::RequestParams
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The value of the custom field. This may be up to 140 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceService::UpdateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceService::UpdateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::InvoiceService::UpdateParams::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceService::UpdateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceService::UpdateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
class PaymentSettings < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig { params(transaction_type: T.nilable(String)).void }
def initialize(transaction_type: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
}
def initialize(mandate_options: nil, verification_method: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
sig { params(preferred_language: T.nilable(String)).void }
def initialize(preferred_language: nil); end
end
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
class Plan < Stripe::RequestParams
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
sig { returns(T.nilable(Integer)) }
def count; end
sig { params(_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def count=(_count); end
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
# One of `month`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(count: T.nilable(Integer), interval: T.nilable(String), type: String).void
}
def initialize(count: nil, interval: nil, type: nil); end
end
# Setting to true enables installments for this invoice.
# Setting to false will prevent any selected plan from applying to a payment.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# The selected installment plan to use for this invoice.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan; end
sig {
params(_plan: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::Installments::Plan))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan=(_plan); end
sig {
params(enabled: T.nilable(T::Boolean), plan: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::Installments::Plan))).void
}
def initialize(enabled: nil, plan: nil); end
end
# Installment configuration for payments attempted on this invoice.
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::Installments))
}
def installments; end
sig {
params(_installments: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::Installments)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::Installments))
}
def installments=(_installments); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
sig {
params(installments: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::Installments), request_three_d_secure: T.nilable(String)).void
}
def initialize(installments: nil, request_three_d_secure: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), type: T.nilable(String)).void
}
def initialize(eu_bank_transfer: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
sig {
params(bank_transfer: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil); end
end
class IdBankTransfer < Stripe::RequestParams; end
class Konbini < Stripe::RequestParams; end
class Pix < Stripe::RequestParams
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
sig { params(amount_includes_iof: T.nilable(String)).void }
def initialize(amount_includes_iof: nil); end
end
class SepaDebit < Stripe::RequestParams; end
class Upi < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), description: T.nilable(String), end_date: T.nilable(Integer)).void
}
def initialize(amount: nil, amount_type: nil, description: nil, end_date: nil); end
end
# Configuration options for setting up an eMandate
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
sig {
params(filters: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String])).void
}
def initialize(filters: nil, permissions: nil, prefetch: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections), verification_method: T.nilable(String)).void
}
def initialize(financial_connections: nil, verification_method: nil); end
end
# If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit=(_acss_debit); end
# If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact)))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact)))
}
def bancontact=(_bancontact); end
# If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card)))
}
def card; end
sig {
params(_card: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card)))
}
def card=(_card); end
# If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance=(_customer_balance); end
# If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer=(_id_bank_transfer); end
# If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini)))
}
def konbini; end
sig {
params(_konbini: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini)))
}
def konbini=(_konbini); end
# If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix)))
}
def pix; end
sig {
params(_pix: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix)))
}
def pix=(_pix); end
# If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit=(_sepa_debit); end
# If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi)))
}
def upi; end
sig {
params(_upi: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi)))
}
def upi=(_upi); end
# If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
sig {
params(acss_debit: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)), bancontact: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact)), card: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card)), customer_balance: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)), id_bank_transfer: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)), konbini: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini)), pix: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix)), sepa_debit: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)), upi: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi)), us_bank_account: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))).void
}
def initialize(
acss_debit: nil,
bancontact: nil,
card: nil,
customer_balance: nil,
id_bank_transfer: nil,
konbini: nil,
pix: nil,
sepa_debit: nil,
upi: nil,
us_bank_account: nil
); end
end
# ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.
sig { returns(T.nilable(String)) }
def default_mandate; end
sig { params(_default_mandate: T.nilable(String)).returns(T.nilable(String)) }
def default_mandate=(_default_mandate); end
# Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def payment_method_types=(_payment_method_types); end
sig {
params(default_mandate: T.nilable(String), payment_method_options: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings::PaymentMethodOptions), payment_method_types: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
default_mandate: nil,
payment_method_options: nil,
payment_method_types: nil
); end
end
class Rendering < Stripe::RequestParams
class Pdf < Stripe::RequestParams
# Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`.
# If set to `auto`, invoice PDF page size defaults to `a4` for customers with
# Japanese locale and `letter` for customers with other locales.
sig { returns(T.nilable(String)) }
def page_size; end
sig { params(_page_size: T.nilable(String)).returns(T.nilable(String)) }
def page_size=(_page_size); end
sig { params(page_size: T.nilable(String)).void }
def initialize(page_size: nil); end
end
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(T.any(String, String))) }
def amount_tax_display; end
sig {
params(_amount_tax_display: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def amount_tax_display=(_amount_tax_display); end
# Invoice pdf rendering options
sig { returns(T.nilable(::Stripe::InvoiceService::UpdateParams::Rendering::Pdf)) }
def pdf; end
sig {
params(_pdf: T.nilable(::Stripe::InvoiceService::UpdateParams::Rendering::Pdf)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::Rendering::Pdf))
}
def pdf=(_pdf); end
# ID of the invoice rendering template to use for this invoice.
sig { returns(T.nilable(String)) }
def template; end
sig { params(_template: T.nilable(String)).returns(T.nilable(String)) }
def template=(_template); end
# The specific version of invoice rendering template to use for this invoice.
sig { returns(T.nilable(T.any(String, Integer))) }
def template_version; end
sig {
params(_template_version: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def template_version=(_template_version); end
sig {
params(amount_tax_display: T.nilable(T.any(String, String)), pdf: T.nilable(::Stripe::InvoiceService::UpdateParams::Rendering::Pdf), template: T.nilable(String), template_version: T.nilable(T.any(String, Integer))).void
}
def initialize(amount_tax_display: nil, pdf: nil, template: nil, template_version: nil); end
end
class ShippingCost < Stripe::RequestParams
class ShippingRateData < Stripe::RequestParams
class DeliveryEstimate < Stripe::RequestParams
class Maximum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
class Minimum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum; end
sig {
params(_maximum: T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum=(_maximum); end
# The lower bound of the estimated range. If empty, represents no lower bound.
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum; end
sig {
params(_minimum: T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum=(_minimum); end
sig {
params(maximum: T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum), minimum: T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum)).void
}
def initialize(maximum: nil, minimum: nil); end
end
class FixedAmount < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig { params(amount: Integer, tax_behavior: T.nilable(String)).void }
def initialize(amount: nil, tax_behavior: nil); end
end
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(amount: Integer, currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions])).void
}
def initialize(amount: nil, currency: nil, currency_options: nil); end
end
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate; end
sig {
params(_delivery_estimate: T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate=(_delivery_estimate); end
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::FixedAmount))
}
def fixed_amount; end
sig {
params(_fixed_amount: T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::FixedAmount)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::FixedAmount))
}
def fixed_amount=(_fixed_amount); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The type of calculation to use on the shipping rate.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(delivery_estimate: T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate), display_name: String, fixed_amount: T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData::FixedAmount), metadata: T.nilable(T::Hash[String, String]), tax_behavior: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
delivery_estimate: nil,
display_name: nil,
fixed_amount: nil,
metadata: nil,
tax_behavior: nil,
tax_code: nil,
type: nil
); end
end
# The ID of the shipping rate to use for this order.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
# Parameters to create a new ad-hoc shipping rate for this order.
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData))
}
def shipping_rate_data; end
sig {
params(_shipping_rate_data: T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData))
}
def shipping_rate_data=(_shipping_rate_data); end
sig {
params(shipping_rate: T.nilable(String), shipping_rate_data: T.nilable(::Stripe::InvoiceService::UpdateParams::ShippingCost::ShippingRateData)).void
}
def initialize(shipping_rate: nil, shipping_rate_data: nil); end
end
class ShippingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address
sig { returns(::Stripe::InvoiceService::UpdateParams::ShippingDetails::Address) }
def address; end
sig {
params(_address: ::Stripe::InvoiceService::UpdateParams::ShippingDetails::Address).returns(::Stripe::InvoiceService::UpdateParams::ShippingDetails::Address)
}
def address=(_address); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension)
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: ::Stripe::InvoiceService::UpdateParams::ShippingDetails::Address, name: String, phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateParams::AmountsDue])))
}
def amounts_due; end
sig {
params(_amounts_due: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateParams::AmountsDue]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateParams::AmountsDue])))
}
def amounts_due=(_amounts_due); end
# A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice.
sig { returns(T.nilable(T::Boolean)) }
def auto_advance; end
sig { params(_auto_advance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_advance=(_auto_advance); end
# Settings for automatic tax lookup for this invoice.
sig { returns(T.nilable(::Stripe::InvoiceService::UpdateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::InvoiceService::UpdateParams::AutomaticTax)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state. To turn off automatic finalization, set `auto_advance` to false.
sig { returns(T.nilable(Integer)) }
def automatically_finalizes_at; end
sig { params(_automatically_finalizes_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def automatically_finalizes_at=(_automatically_finalizes_at); end
# Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateParams::CustomField])))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateParams::CustomField]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateParams::CustomField])))
}
def custom_fields=(_custom_fields); end
# The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_margins; end
sig {
params(_default_margins: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_margins=(_default_margins); end
# ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
sig { returns(T.nilable(String)) }
def default_source; end
sig { params(_default_source: T.nilable(String)).returns(T.nilable(String)) }
def default_source=(_default_source); end
# The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateParams::Discount])))
}
def discounts=(_discounts); end
# The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.
sig { returns(T.nilable(Integer)) }
def due_date; end
sig { params(_due_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def due_date=(_due_date); end
# The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
sig { returns(T.nilable(T.any(String, Integer))) }
def effective_at; end
sig {
params(_effective_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def effective_at=(_effective_at); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Footer to be displayed on the invoice.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig { returns(T.nilable(::Stripe::InvoiceService::UpdateParams::Issuer)) }
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::InvoiceService::UpdateParams::Issuer)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::Issuer))
}
def issuer=(_issuer); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.
sig { returns(T.nilable(String)) }
def number; end
sig { params(_number: T.nilable(String)).returns(T.nilable(String)) }
def number=(_number); end
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
sig { returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings)) }
def payment_settings; end
sig {
params(_payment_settings: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings))
}
def payment_settings=(_payment_settings); end
# The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
sig { returns(T.nilable(::Stripe::InvoiceService::UpdateParams::Rendering)) }
def rendering; end
sig {
params(_rendering: T.nilable(::Stripe::InvoiceService::UpdateParams::Rendering)).returns(T.nilable(::Stripe::InvoiceService::UpdateParams::Rendering))
}
def rendering=(_rendering); end
# Settings for the cost of shipping for this invoice.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::ShippingCost)))
}
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::ShippingCost))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::ShippingCost)))
}
def shipping_cost=(_shipping_cost); end
# Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::ShippingDetails)))
}
def shipping_details; end
sig {
params(_shipping_details: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::ShippingDetails))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::ShippingDetails)))
}
def shipping_details=(_shipping_details); end
# Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::TransferData)))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::TransferData))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::TransferData)))
}
def transfer_data=(_transfer_data); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), amounts_due: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateParams::AmountsDue])), application_fee_amount: T.nilable(Integer), auto_advance: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::InvoiceService::UpdateParams::AutomaticTax), automatically_finalizes_at: T.nilable(Integer), collection_method: T.nilable(String), custom_fields: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateParams::CustomField])), days_until_due: T.nilable(Integer), default_margins: T.nilable(T.any(String, T::Array[String])), default_payment_method: T.nilable(String), default_source: T.nilable(String), default_tax_rates: T.nilable(T.any(String, T::Array[String])), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateParams::Discount])), due_date: T.nilable(Integer), effective_at: T.nilable(T.any(String, Integer)), expand: T.nilable(T::Array[String]), footer: T.nilable(String), issuer: T.nilable(::Stripe::InvoiceService::UpdateParams::Issuer), metadata: T.nilable(T.any(String, T::Hash[String, String])), number: T.nilable(String), on_behalf_of: T.nilable(String), payment_settings: T.nilable(::Stripe::InvoiceService::UpdateParams::PaymentSettings), rendering: T.nilable(::Stripe::InvoiceService::UpdateParams::Rendering), shipping_cost: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::ShippingCost)), shipping_details: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::ShippingDetails)), statement_descriptor: T.nilable(String), transfer_data: T.nilable(T.any(String, ::Stripe::InvoiceService::UpdateParams::TransferData))).void
}
def initialize(
account_tax_ids: nil,
amounts_due: nil,
application_fee_amount: nil,
auto_advance: nil,
automatic_tax: nil,
automatically_finalizes_at: nil,
collection_method: nil,
custom_fields: nil,
days_until_due: nil,
default_margins: nil,
default_payment_method: nil,
default_source: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
due_date: nil,
effective_at: nil,
expand: nil,
footer: nil,
issuer: nil,
metadata: nil,
number: nil,
on_behalf_of: nil,
payment_settings: nil,
rendering: nil,
shipping_cost: nil,
shipping_details: nil,
statement_descriptor: nil,
transfer_data: nil
); end
end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class DueDate < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# Only return invoices that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::InvoiceService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::InvoiceService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::InvoiceService::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return invoices for the customer specified by this customer ID.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Only return invoices for the account specified by this account ID.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Attribute for param field due_date
sig { returns(T.nilable(T.any(::Stripe::InvoiceService::ListParams::DueDate, Integer))) }
def due_date; end
sig {
params(_due_date: T.nilable(T.any(::Stripe::InvoiceService::ListParams::DueDate, Integer))).returns(T.nilable(T.any(::Stripe::InvoiceService::ListParams::DueDate, Integer)))
}
def due_date=(_due_date); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# Only return invoices for the subscription specified by this subscription ID.
sig { returns(T.nilable(String)) }
def subscription; end
sig { params(_subscription: T.nilable(String)).returns(T.nilable(String)) }
def subscription=(_subscription); end
sig {
params(collection_method: T.nilable(String), created: T.nilable(T.any(::Stripe::InvoiceService::ListParams::Created, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), due_date: T.nilable(T.any(::Stripe::InvoiceService::ListParams::DueDate, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String), subscription: T.nilable(String)).void
}
def initialize(
collection_method: nil,
created: nil,
customer: nil,
customer_account: nil,
due_date: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil,
subscription: nil
); end
end
class CreateParams < Stripe::RequestParams
class AmountsDue < Stripe::RequestParams
# The amount in cents (or local equivalent).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Number of days from when invoice is finalized until the payment is due.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(String) }
def description; end
sig { params(_description: String).returns(String) }
def description=(_description); end
# Date on which a payment plan’s payment is due.
sig { returns(T.nilable(Integer)) }
def due_date; end
sig { params(_due_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def due_date=(_due_date); end
sig {
params(amount: Integer, days_until_due: T.nilable(Integer), description: String, due_date: T.nilable(Integer)).void
}
def initialize(amount: nil, days_until_due: nil, description: nil, due_date: nil); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(::Stripe::InvoiceService::CreateParams::AutomaticTax::Liability)) }
def liability; end
sig {
params(_liability: T.nilable(::Stripe::InvoiceService::CreateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::InvoiceService::CreateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class CustomField < Stripe::RequestParams
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The value of the custom field. This may be up to 140 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceService::CreateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceService::CreateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::InvoiceService::CreateParams::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceService::CreateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceService::CreateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class FromInvoice < Stripe::RequestParams
# The relation between the new invoice and the original invoice. Currently, only 'revision' is permitted
sig { returns(String) }
def action; end
sig { params(_action: String).returns(String) }
def action=(_action); end
# The `id` of the invoice that will be cloned.
sig { returns(String) }
def invoice; end
sig { params(_invoice: String).returns(String) }
def invoice=(_invoice); end
sig { params(action: String, invoice: String).void }
def initialize(action: nil, invoice: nil); end
end
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
class PaymentSettings < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig { params(transaction_type: T.nilable(String)).void }
def initialize(transaction_type: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
}
def initialize(mandate_options: nil, verification_method: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
sig { params(preferred_language: T.nilable(String)).void }
def initialize(preferred_language: nil); end
end
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
class Plan < Stripe::RequestParams
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
sig { returns(T.nilable(Integer)) }
def count; end
sig { params(_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def count=(_count); end
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
# One of `month`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(count: T.nilable(Integer), interval: T.nilable(String), type: String).void
}
def initialize(count: nil, interval: nil, type: nil); end
end
# Setting to true enables installments for this invoice.
# Setting to false will prevent any selected plan from applying to a payment.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# The selected installment plan to use for this invoice.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan; end
sig {
params(_plan: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Card::Installments::Plan))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan=(_plan); end
sig {
params(enabled: T.nilable(T::Boolean), plan: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Card::Installments::Plan))).void
}
def initialize(enabled: nil, plan: nil); end
end
# Installment configuration for payments attempted on this invoice.
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
sig {
returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Card::Installments))
}
def installments; end
sig {
params(_installments: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Card::Installments)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Card::Installments))
}
def installments=(_installments); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
sig {
params(installments: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Card::Installments), request_three_d_secure: T.nilable(String)).void
}
def initialize(installments: nil, request_three_d_secure: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), type: T.nilable(String)).void
}
def initialize(eu_bank_transfer: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
sig {
params(bank_transfer: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil); end
end
class IdBankTransfer < Stripe::RequestParams; end
class Konbini < Stripe::RequestParams; end
class Pix < Stripe::RequestParams
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
sig { params(amount_includes_iof: T.nilable(String)).void }
def initialize(amount_includes_iof: nil); end
end
class SepaDebit < Stripe::RequestParams; end
class Upi < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), description: T.nilable(String), end_date: T.nilable(Integer)).void
}
def initialize(amount: nil, amount_type: nil, description: nil, end_date: nil); end
end
# Configuration options for setting up an eMandate
sig {
returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
sig {
params(filters: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String])).void
}
def initialize(filters: nil, permissions: nil, prefetch: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections), verification_method: T.nilable(String)).void
}
def initialize(financial_connections: nil, verification_method: nil); end
end
# If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit=(_acss_debit); end
# If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact)))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact)))
}
def bancontact=(_bancontact); end
# If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Card)))
}
def card; end
sig {
params(_card: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Card))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Card)))
}
def card=(_card); end
# If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance=(_customer_balance); end
# If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer=(_id_bank_transfer); end
# If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini)))
}
def konbini; end
sig {
params(_konbini: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini)))
}
def konbini=(_konbini); end
# If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Pix)))
}
def pix; end
sig {
params(_pix: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Pix))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Pix)))
}
def pix=(_pix); end
# If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit=(_sepa_debit); end
# If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Upi)))
}
def upi; end
sig {
params(_upi: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Upi))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Upi)))
}
def upi=(_upi); end
# If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
sig {
params(acss_debit: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)), bancontact: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact)), card: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Card)), customer_balance: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)), id_bank_transfer: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)), konbini: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini)), pix: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Pix)), sepa_debit: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)), upi: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::Upi)), us_bank_account: T.nilable(T.any(String, ::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))).void
}
def initialize(
acss_debit: nil,
bancontact: nil,
card: nil,
customer_balance: nil,
id_bank_transfer: nil,
konbini: nil,
pix: nil,
sepa_debit: nil,
upi: nil,
us_bank_account: nil
); end
end
# ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.
sig { returns(T.nilable(String)) }
def default_mandate; end
sig { params(_default_mandate: T.nilable(String)).returns(T.nilable(String)) }
def default_mandate=(_default_mandate); end
# Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def payment_method_types=(_payment_method_types); end
sig {
params(default_mandate: T.nilable(String), payment_method_options: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings::PaymentMethodOptions), payment_method_types: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
default_mandate: nil,
payment_method_options: nil,
payment_method_types: nil
); end
end
class Rendering < Stripe::RequestParams
class Pdf < Stripe::RequestParams
# Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`.
# If set to `auto`, invoice PDF page size defaults to `a4` for customers with
# Japanese locale and `letter` for customers with other locales.
sig { returns(T.nilable(String)) }
def page_size; end
sig { params(_page_size: T.nilable(String)).returns(T.nilable(String)) }
def page_size=(_page_size); end
sig { params(page_size: T.nilable(String)).void }
def initialize(page_size: nil); end
end
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(T.any(String, String))) }
def amount_tax_display; end
sig {
params(_amount_tax_display: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def amount_tax_display=(_amount_tax_display); end
# Invoice pdf rendering options
sig { returns(T.nilable(::Stripe::InvoiceService::CreateParams::Rendering::Pdf)) }
def pdf; end
sig {
params(_pdf: T.nilable(::Stripe::InvoiceService::CreateParams::Rendering::Pdf)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::Rendering::Pdf))
}
def pdf=(_pdf); end
# ID of the invoice rendering template to use for this invoice.
sig { returns(T.nilable(String)) }
def template; end
sig { params(_template: T.nilable(String)).returns(T.nilable(String)) }
def template=(_template); end
# The specific version of invoice rendering template to use for this invoice.
sig { returns(T.nilable(T.any(String, Integer))) }
def template_version; end
sig {
params(_template_version: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def template_version=(_template_version); end
sig {
params(amount_tax_display: T.nilable(T.any(String, String)), pdf: T.nilable(::Stripe::InvoiceService::CreateParams::Rendering::Pdf), template: T.nilable(String), template_version: T.nilable(T.any(String, Integer))).void
}
def initialize(amount_tax_display: nil, pdf: nil, template: nil, template_version: nil); end
end
class ShippingCost < Stripe::RequestParams
class ShippingRateData < Stripe::RequestParams
class DeliveryEstimate < Stripe::RequestParams
class Maximum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
class Minimum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum; end
sig {
params(_maximum: T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum=(_maximum); end
# The lower bound of the estimated range. If empty, represents no lower bound.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum; end
sig {
params(_minimum: T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum=(_minimum); end
sig {
params(maximum: T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum), minimum: T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum)).void
}
def initialize(maximum: nil, minimum: nil); end
end
class FixedAmount < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig { params(amount: Integer, tax_behavior: T.nilable(String)).void }
def initialize(amount: nil, tax_behavior: nil); end
end
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(amount: Integer, currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions])).void
}
def initialize(amount: nil, currency: nil, currency_options: nil); end
end
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate; end
sig {
params(_delivery_estimate: T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate=(_delivery_estimate); end
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::FixedAmount))
}
def fixed_amount; end
sig {
params(_fixed_amount: T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::FixedAmount)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::FixedAmount))
}
def fixed_amount=(_fixed_amount); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The type of calculation to use on the shipping rate.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(delivery_estimate: T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate), display_name: String, fixed_amount: T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData::FixedAmount), metadata: T.nilable(T::Hash[String, String]), tax_behavior: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
delivery_estimate: nil,
display_name: nil,
fixed_amount: nil,
metadata: nil,
tax_behavior: nil,
tax_code: nil,
type: nil
); end
end
# The ID of the shipping rate to use for this order.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
# Parameters to create a new ad-hoc shipping rate for this order.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData))
}
def shipping_rate_data; end
sig {
params(_shipping_rate_data: T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData))
}
def shipping_rate_data=(_shipping_rate_data); end
sig {
params(shipping_rate: T.nilable(String), shipping_rate_data: T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost::ShippingRateData)).void
}
def initialize(shipping_rate: nil, shipping_rate_data: nil); end
end
class ShippingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address
sig { returns(::Stripe::InvoiceService::CreateParams::ShippingDetails::Address) }
def address; end
sig {
params(_address: ::Stripe::InvoiceService::CreateParams::ShippingDetails::Address).returns(::Stripe::InvoiceService::CreateParams::ShippingDetails::Address)
}
def address=(_address); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension)
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: ::Stripe::InvoiceService::CreateParams::ShippingDetails::Address, name: String, phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreateParams::AmountsDue])))
}
def amounts_due; end
sig {
params(_amounts_due: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreateParams::AmountsDue]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreateParams::AmountsDue])))
}
def amounts_due=(_amounts_due); end
# A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# 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. Defaults to false.
sig { returns(T.nilable(T::Boolean)) }
def auto_advance; end
sig { params(_auto_advance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_advance=(_auto_advance); end
# Settings for automatic tax lookup for this invoice.
sig { returns(T.nilable(::Stripe::InvoiceService::CreateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::InvoiceService::CreateParams::AutomaticTax)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state.
sig { returns(T.nilable(Integer)) }
def automatically_finalizes_at; end
sig { params(_automatically_finalizes_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def automatically_finalizes_at=(_automatically_finalizes_at); end
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# The currency to create this invoice in. Defaults to that of `customer` if not specified.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# A list of up to 4 custom fields to be displayed on the invoice.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreateParams::CustomField])))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreateParams::CustomField]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreateParams::CustomField])))
}
def custom_fields=(_custom_fields); end
# The ID of the customer who will be billed.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The ID of the account who will be billed.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
sig { returns(T.nilable(T::Array[String])) }
def default_margins; end
sig {
params(_default_margins: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def default_margins=(_default_margins); end
# ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
sig { returns(T.nilable(String)) }
def default_source; end
sig { params(_default_source: T.nilable(String)).returns(T.nilable(String)) }
def default_source=(_default_source); end
# The tax rates that will apply to any line item that does not have `tax_rates` set.
sig { returns(T.nilable(T::Array[String])) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def default_tax_rates=(_default_tax_rates); end
# An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The coupons and promotion codes to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreateParams::Discount])))
}
def discounts=(_discounts); end
# The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`.
sig { returns(T.nilable(Integer)) }
def due_date; end
sig { params(_due_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def due_date=(_due_date); end
# The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
sig { returns(T.nilable(Integer)) }
def effective_at; end
sig { params(_effective_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def effective_at=(_effective_at); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Footer to be displayed on the invoice.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.
sig { returns(T.nilable(::Stripe::InvoiceService::CreateParams::FromInvoice)) }
def from_invoice; end
sig {
params(_from_invoice: T.nilable(::Stripe::InvoiceService::CreateParams::FromInvoice)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::FromInvoice))
}
def from_invoice=(_from_invoice); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig { returns(T.nilable(::Stripe::InvoiceService::CreateParams::Issuer)) }
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::InvoiceService::CreateParams::Issuer)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::Issuer))
}
def issuer=(_issuer); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.
sig { returns(T.nilable(String)) }
def number; end
sig { params(_number: T.nilable(String)).returns(T.nilable(String)) }
def number=(_number); end
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
sig { returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings)) }
def payment_settings; end
sig {
params(_payment_settings: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings))
}
def payment_settings=(_payment_settings); end
# How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.
sig { returns(T.nilable(String)) }
def pending_invoice_items_behavior; end
sig { params(_pending_invoice_items_behavior: T.nilable(String)).returns(T.nilable(String)) }
def pending_invoice_items_behavior=(_pending_invoice_items_behavior); end
# The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
sig { returns(T.nilable(::Stripe::InvoiceService::CreateParams::Rendering)) }
def rendering; end
sig {
params(_rendering: T.nilable(::Stripe::InvoiceService::CreateParams::Rendering)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::Rendering))
}
def rendering=(_rendering); end
# Settings for the cost of shipping for this invoice.
sig { returns(T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost)) }
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost))
}
def shipping_cost=(_shipping_cost); end
# Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.
sig { returns(T.nilable(::Stripe::InvoiceService::CreateParams::ShippingDetails)) }
def shipping_details; end
sig {
params(_shipping_details: T.nilable(::Stripe::InvoiceService::CreateParams::ShippingDetails)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::ShippingDetails))
}
def shipping_details=(_shipping_details); end
# Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription's billing cycle and regular subscription events won't be affected.
sig { returns(T.nilable(String)) }
def subscription; end
sig { params(_subscription: T.nilable(String)).returns(T.nilable(String)) }
def subscription=(_subscription); end
# If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
sig { returns(T.nilable(::Stripe::InvoiceService::CreateParams::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::InvoiceService::CreateParams::TransferData)).returns(T.nilable(::Stripe::InvoiceService::CreateParams::TransferData))
}
def transfer_data=(_transfer_data); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), amounts_due: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreateParams::AmountsDue])), application_fee_amount: T.nilable(Integer), auto_advance: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::InvoiceService::CreateParams::AutomaticTax), automatically_finalizes_at: T.nilable(Integer), collection_method: T.nilable(String), currency: T.nilable(String), custom_fields: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreateParams::CustomField])), customer: T.nilable(String), customer_account: T.nilable(String), days_until_due: T.nilable(Integer), default_margins: T.nilable(T::Array[String]), default_payment_method: T.nilable(String), default_source: T.nilable(String), default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreateParams::Discount])), due_date: T.nilable(Integer), effective_at: T.nilable(Integer), expand: T.nilable(T::Array[String]), footer: T.nilable(String), from_invoice: T.nilable(::Stripe::InvoiceService::CreateParams::FromInvoice), issuer: T.nilable(::Stripe::InvoiceService::CreateParams::Issuer), metadata: T.nilable(T.any(String, T::Hash[String, String])), number: T.nilable(String), on_behalf_of: T.nilable(String), payment_settings: T.nilable(::Stripe::InvoiceService::CreateParams::PaymentSettings), pending_invoice_items_behavior: T.nilable(String), rendering: T.nilable(::Stripe::InvoiceService::CreateParams::Rendering), shipping_cost: T.nilable(::Stripe::InvoiceService::CreateParams::ShippingCost), shipping_details: T.nilable(::Stripe::InvoiceService::CreateParams::ShippingDetails), statement_descriptor: T.nilable(String), subscription: T.nilable(String), transfer_data: T.nilable(::Stripe::InvoiceService::CreateParams::TransferData)).void
}
def initialize(
account_tax_ids: nil,
amounts_due: nil,
application_fee_amount: nil,
auto_advance: nil,
automatic_tax: nil,
automatically_finalizes_at: nil,
collection_method: nil,
currency: nil,
custom_fields: nil,
customer: nil,
customer_account: nil,
days_until_due: nil,
default_margins: nil,
default_payment_method: nil,
default_source: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
due_date: nil,
effective_at: nil,
expand: nil,
footer: nil,
from_invoice: nil,
issuer: nil,
metadata: nil,
number: nil,
on_behalf_of: nil,
payment_settings: nil,
pending_invoice_items_behavior: nil,
rendering: nil,
shipping_cost: nil,
shipping_details: nil,
statement_descriptor: nil,
subscription: nil,
transfer_data: nil
); end
end
class SearchParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
sig { returns(T.nilable(String)) }
def page; end
sig { params(_page: T.nilable(String)).returns(T.nilable(String)) }
def page=(_page); end
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices).
sig { returns(String) }
def query; end
sig { params(_query: String).returns(String) }
def query=(_query); end
sig {
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
}
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
end
class AddLinesParams < Stripe::RequestParams
class Line < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
sig { returns(Integer) }
def end; end
sig { params(_end: Integer).returns(Integer) }
def end=(_end); end
# The start of the period. This value is inclusive.
sig { returns(Integer) }
def start; end
sig { params(_start: Integer).returns(Integer) }
def start=(_start); end
sig { params(end_: Integer, start: Integer).void }
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
class ProductData < Stripe::RequestParams
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T::Array[String])) }
def images; end
sig {
params(_images: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def images=(_images); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
sig {
params(description: T.nilable(String), images: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: String, tax_code: T.nilable(String), unit_label: T.nilable(String)).void
}
def initialize(
description: nil,
images: nil,
metadata: nil,
name: nil,
tax_code: nil,
unit_label: nil
); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
sig {
returns(T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::PriceData::ProductData))
}
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::PriceData::ProductData)).returns(T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::PriceData::ProductData))
}
def product_data=(_product_data); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: T.nilable(String), product_data: T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::PriceData::ProductData), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
product_data: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Pricing < Stripe::RequestParams
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
sig { params(price: T.nilable(String)).void }
def initialize(price: nil); end
end
class TaxAmount < Stripe::RequestParams
class TaxRateData < Stripe::RequestParams
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The display name of the tax rate, which will be shown to users.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# This specifies if the tax rate is inclusive or exclusive.
sig { returns(T::Boolean) }
def inclusive; end
sig { params(_inclusive: T::Boolean).returns(T::Boolean) }
def inclusive=(_inclusive); end
# The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
sig { returns(T.nilable(String)) }
def jurisdiction; end
sig { params(_jurisdiction: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction=(_jurisdiction); end
# The level of the jurisdiction that imposes this tax rate.
sig { returns(T.nilable(String)) }
def jurisdiction_level; end
sig { params(_jurisdiction_level: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction_level=(_jurisdiction_level); end
# The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.
sig { returns(Float) }
def percentage; end
sig { params(_percentage: Float).returns(Float) }
def percentage=(_percentage); end
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# The high-level tax type, such as `vat` or `sales_tax`.
sig { returns(T.nilable(String)) }
def tax_type; end
sig { params(_tax_type: T.nilable(String)).returns(T.nilable(String)) }
def tax_type=(_tax_type); end
sig {
params(country: T.nilable(String), description: T.nilable(String), display_name: String, inclusive: T::Boolean, jurisdiction: T.nilable(String), jurisdiction_level: T.nilable(String), percentage: Float, state: T.nilable(String), tax_type: T.nilable(String)).void
}
def initialize(
country: nil,
description: nil,
display_name: nil,
inclusive: nil,
jurisdiction: nil,
jurisdiction_level: nil,
percentage: nil,
state: nil,
tax_type: nil
); end
end
# The amount, in cents (or local equivalent), of the tax.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Data to find or create a TaxRate object.
#
# Stripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.
sig { returns(::Stripe::InvoiceService::AddLinesParams::Line::TaxAmount::TaxRateData) }
def tax_rate_data; end
sig {
params(_tax_rate_data: ::Stripe::InvoiceService::AddLinesParams::Line::TaxAmount::TaxRateData).returns(::Stripe::InvoiceService::AddLinesParams::Line::TaxAmount::TaxRateData)
}
def tax_rate_data=(_tax_rate_data); end
# The reasoning behind this tax, for example, if the product is tax exempt.
sig { returns(T.nilable(String)) }
def taxability_reason; end
sig { params(_taxability_reason: T.nilable(String)).returns(T.nilable(String)) }
def taxability_reason=(_taxability_reason); end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(Integer) }
def taxable_amount; end
sig { params(_taxable_amount: Integer).returns(Integer) }
def taxable_amount=(_taxable_amount); end
sig {
params(amount: Integer, tax_rate_data: ::Stripe::InvoiceService::AddLinesParams::Line::TaxAmount::TaxRateData, taxability_reason: T.nilable(String), taxable_amount: Integer).void
}
def initialize(
amount: nil,
tax_rate_data: nil,
taxability_reason: nil,
taxable_amount: nil
); end
end
# The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
sig { returns(T.nilable(T::Boolean)) }
def discountable; end
sig { params(_discountable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def discountable=(_discountable); end
# The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::AddLinesParams::Line::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::AddLinesParams::Line::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::AddLinesParams::Line::Discount])))
}
def discounts=(_discounts); end
# ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.
sig { returns(T.nilable(String)) }
def invoice_item; end
sig { params(_invoice_item: T.nilable(String)).returns(T.nilable(String)) }
def invoice_item=(_invoice_item); end
# The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def margins; end
sig {
params(_margins: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def margins=(_margins); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
sig { returns(T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::Period)) }
def period; end
sig {
params(_period: T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::Period)).returns(T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::Period))
}
def period=(_period); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig { returns(T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::PriceData)).returns(T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::PriceData))
}
def price_data=(_price_data); end
# The pricing information for the invoice item.
sig { returns(T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::Pricing)) }
def pricing; end
sig {
params(_pricing: T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::Pricing)).returns(T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::Pricing))
}
def pricing=(_pricing); end
# Non-negative integer. The quantity of units for the line item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::AddLinesParams::Line::TaxAmount])))
}
def tax_amounts; end
sig {
params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::AddLinesParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::AddLinesParams::Line::TaxAmount])))
}
def tax_amounts=(_tax_amounts); end
# The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(amount: T.nilable(Integer), description: T.nilable(String), discountable: T.nilable(T::Boolean), discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::AddLinesParams::Line::Discount])), invoice_item: T.nilable(String), margins: T.nilable(T.any(String, T::Array[String])), metadata: T.nilable(T.any(String, T::Hash[String, String])), period: T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::Period), price_data: T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::PriceData), pricing: T.nilable(::Stripe::InvoiceService::AddLinesParams::Line::Pricing), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::AddLinesParams::Line::TaxAmount])), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
amount: nil,
description: nil,
discountable: nil,
discounts: nil,
invoice_item: nil,
margins: nil,
metadata: nil,
period: nil,
price_data: nil,
pricing: nil,
quantity: nil,
tax_amounts: nil,
tax_rates: nil
); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def invoice_metadata; end
sig {
params(_invoice_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def invoice_metadata=(_invoice_metadata); end
# The line items to add.
sig { returns(T::Array[::Stripe::InvoiceService::AddLinesParams::Line]) }
def lines; end
sig {
params(_lines: T::Array[::Stripe::InvoiceService::AddLinesParams::Line]).returns(T::Array[::Stripe::InvoiceService::AddLinesParams::Line])
}
def lines=(_lines); end
sig {
params(expand: T.nilable(T::Array[String]), invoice_metadata: T.nilable(T.any(String, T::Hash[String, String])), lines: T::Array[::Stripe::InvoiceService::AddLinesParams::Line]).void
}
def initialize(expand: nil, invoice_metadata: nil, lines: nil); end
end
class AttachPaymentParams < Stripe::RequestParams
class PaymentRecordData < Stripe::RequestParams
# The amount that was paid out of band.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The currency that was paid out of band.
sig { returns(String) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The type of money movement for this out of band payment record.
sig { returns(String) }
def money_movement_type; end
sig { params(_money_movement_type: String).returns(String) }
def money_movement_type=(_money_movement_type); end
# The timestamp when this out of band payment was paid.
sig { returns(T.nilable(Integer)) }
def paid_at; end
sig { params(_paid_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def paid_at=(_paid_at); end
# The reference for this out of band payment record.
sig { returns(T.nilable(String)) }
def payment_reference; end
sig { params(_payment_reference: T.nilable(String)).returns(T.nilable(String)) }
def payment_reference=(_payment_reference); end
sig {
params(amount: Integer, currency: String, metadata: T.nilable(T.any(String, T::Hash[String, String])), money_movement_type: String, paid_at: T.nilable(Integer), payment_reference: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
metadata: nil,
money_movement_type: nil,
paid_at: nil,
payment_reference: nil
); end
end
# The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount.
sig { returns(T.nilable(Integer)) }
def amount_requested; end
sig { params(_amount_requested: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_requested=(_amount_requested); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The ID of the PaymentIntent to attach to the invoice.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# The ID of the PaymentRecord to attach to the invoice.
sig { returns(T.nilable(String)) }
def payment_record; end
sig { params(_payment_record: T.nilable(String)).returns(T.nilable(String)) }
def payment_record=(_payment_record); end
# The PaymentRecord data for attaching an out of band payment to the invoice.
sig { returns(T.nilable(::Stripe::InvoiceService::AttachPaymentParams::PaymentRecordData)) }
def payment_record_data; end
sig {
params(_payment_record_data: T.nilable(::Stripe::InvoiceService::AttachPaymentParams::PaymentRecordData)).returns(T.nilable(::Stripe::InvoiceService::AttachPaymentParams::PaymentRecordData))
}
def payment_record_data=(_payment_record_data); end
sig {
params(amount_requested: T.nilable(Integer), expand: T.nilable(T::Array[String]), payment_intent: T.nilable(String), payment_record: T.nilable(String), payment_record_data: T.nilable(::Stripe::InvoiceService::AttachPaymentParams::PaymentRecordData)).void
}
def initialize(
amount_requested: nil,
expand: nil,
payment_intent: nil,
payment_record: nil,
payment_record_data: nil
); 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.
sig { returns(T.nilable(T::Boolean)) }
def auto_advance; end
sig { params(_auto_advance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_advance=(_auto_advance); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(auto_advance: T.nilable(T::Boolean), expand: T.nilable(T::Array[String])).void }
def initialize(auto_advance: nil, expand: nil); end
end
class MarkUncollectibleParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class PayParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due.
#
# Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def forgive; end
sig { params(_forgive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def forgive=(_forgive); end
# ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set.
sig { returns(T.nilable(String)) }
def mandate; end
sig { params(_mandate: T.nilable(String)).returns(T.nilable(String)) }
def mandate=(_mandate); end
# Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session).
sig { returns(T.nilable(T::Boolean)) }
def off_session; end
sig { params(_off_session: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def off_session=(_off_session); end
# Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def paid_out_of_band; end
sig { params(_paid_out_of_band: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def paid_out_of_band=(_paid_out_of_band); end
# A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.
sig { returns(T.nilable(String)) }
def source; end
sig { params(_source: T.nilable(String)).returns(T.nilable(String)) }
def source=(_source); end
sig {
params(expand: T.nilable(T::Array[String]), forgive: T.nilable(T::Boolean), mandate: T.nilable(String), off_session: T.nilable(T::Boolean), paid_out_of_band: T.nilable(T::Boolean), payment_method: T.nilable(String), source: T.nilable(String)).void
}
def initialize(
expand: nil,
forgive: nil,
mandate: nil,
off_session: nil,
paid_out_of_band: nil,
payment_method: nil,
source: nil
); end
end
class RemoveLinesParams < Stripe::RequestParams
class Line < Stripe::RequestParams
# Either `delete` or `unassign`. Deleted line items are permanently deleted. Unassigned line items can be reassigned to an invoice.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
# ID of an existing line item to remove from this invoice.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
sig { params(behavior: String, id: String).void }
def initialize(behavior: nil, id: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def invoice_metadata; end
sig {
params(_invoice_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def invoice_metadata=(_invoice_metadata); end
# The line items to remove.
sig { returns(T::Array[::Stripe::InvoiceService::RemoveLinesParams::Line]) }
def lines; end
sig {
params(_lines: T::Array[::Stripe::InvoiceService::RemoveLinesParams::Line]).returns(T::Array[::Stripe::InvoiceService::RemoveLinesParams::Line])
}
def lines=(_lines); end
sig {
params(expand: T.nilable(T::Array[String]), invoice_metadata: T.nilable(T.any(String, T::Hash[String, String])), lines: T::Array[::Stripe::InvoiceService::RemoveLinesParams::Line]).void
}
def initialize(expand: nil, invoice_metadata: nil, lines: nil); end
end
class SendInvoiceParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateLinesParams < Stripe::RequestParams
class Line < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
sig { returns(Integer) }
def end; end
sig { params(_end: Integer).returns(Integer) }
def end=(_end); end
# The start of the period. This value is inclusive.
sig { returns(Integer) }
def start; end
sig { params(_start: Integer).returns(Integer) }
def start=(_start); end
sig { params(end_: Integer, start: Integer).void }
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
class ProductData < Stripe::RequestParams
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T::Array[String])) }
def images; end
sig {
params(_images: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def images=(_images); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
sig {
params(description: T.nilable(String), images: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: String, tax_code: T.nilable(String), unit_label: T.nilable(String)).void
}
def initialize(
description: nil,
images: nil,
metadata: nil,
name: nil,
tax_code: nil,
unit_label: nil
); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
sig {
returns(T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::PriceData::ProductData))
}
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::PriceData::ProductData)).returns(T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::PriceData::ProductData))
}
def product_data=(_product_data); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: T.nilable(String), product_data: T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::PriceData::ProductData), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
product_data: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Pricing < Stripe::RequestParams
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
sig { params(price: T.nilable(String)).void }
def initialize(price: nil); end
end
class TaxAmount < Stripe::RequestParams
class TaxRateData < Stripe::RequestParams
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The display name of the tax rate, which will be shown to users.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# This specifies if the tax rate is inclusive or exclusive.
sig { returns(T::Boolean) }
def inclusive; end
sig { params(_inclusive: T::Boolean).returns(T::Boolean) }
def inclusive=(_inclusive); end
# The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
sig { returns(T.nilable(String)) }
def jurisdiction; end
sig { params(_jurisdiction: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction=(_jurisdiction); end
# The level of the jurisdiction that imposes this tax rate.
sig { returns(T.nilable(String)) }
def jurisdiction_level; end
sig { params(_jurisdiction_level: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction_level=(_jurisdiction_level); end
# The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.
sig { returns(Float) }
def percentage; end
sig { params(_percentage: Float).returns(Float) }
def percentage=(_percentage); end
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# The high-level tax type, such as `vat` or `sales_tax`.
sig { returns(T.nilable(String)) }
def tax_type; end
sig { params(_tax_type: T.nilable(String)).returns(T.nilable(String)) }
def tax_type=(_tax_type); end
sig {
params(country: T.nilable(String), description: T.nilable(String), display_name: String, inclusive: T::Boolean, jurisdiction: T.nilable(String), jurisdiction_level: T.nilable(String), percentage: Float, state: T.nilable(String), tax_type: T.nilable(String)).void
}
def initialize(
country: nil,
description: nil,
display_name: nil,
inclusive: nil,
jurisdiction: nil,
jurisdiction_level: nil,
percentage: nil,
state: nil,
tax_type: nil
); end
end
# The amount, in cents (or local equivalent), of the tax.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Data to find or create a TaxRate object.
#
# Stripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.
sig { returns(::Stripe::InvoiceService::UpdateLinesParams::Line::TaxAmount::TaxRateData) }
def tax_rate_data; end
sig {
params(_tax_rate_data: ::Stripe::InvoiceService::UpdateLinesParams::Line::TaxAmount::TaxRateData).returns(::Stripe::InvoiceService::UpdateLinesParams::Line::TaxAmount::TaxRateData)
}
def tax_rate_data=(_tax_rate_data); end
# The reasoning behind this tax, for example, if the product is tax exempt.
sig { returns(T.nilable(String)) }
def taxability_reason; end
sig { params(_taxability_reason: T.nilable(String)).returns(T.nilable(String)) }
def taxability_reason=(_taxability_reason); end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(Integer) }
def taxable_amount; end
sig { params(_taxable_amount: Integer).returns(Integer) }
def taxable_amount=(_taxable_amount); end
sig {
params(amount: Integer, tax_rate_data: ::Stripe::InvoiceService::UpdateLinesParams::Line::TaxAmount::TaxRateData, taxability_reason: T.nilable(String), taxable_amount: Integer).void
}
def initialize(
amount: nil,
tax_rate_data: nil,
taxability_reason: nil,
taxable_amount: nil
); end
end
# The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
sig { returns(T.nilable(T::Boolean)) }
def discountable; end
sig { params(_discountable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def discountable=(_discountable); end
# The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateLinesParams::Line::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateLinesParams::Line::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateLinesParams::Line::Discount])))
}
def discounts=(_discounts); end
# ID of an existing line item on the invoice.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
# The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def margins; end
sig {
params(_margins: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def margins=(_margins); end
# 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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
sig { returns(T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::Period)) }
def period; end
sig {
params(_period: T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::Period)).returns(T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::Period))
}
def period=(_period); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig { returns(T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::PriceData)).returns(T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::PriceData))
}
def price_data=(_price_data); end
# The pricing information for the invoice item.
sig { returns(T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::Pricing)) }
def pricing; end
sig {
params(_pricing: T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::Pricing)).returns(T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::Pricing))
}
def pricing=(_pricing); end
# Non-negative integer. The quantity of units for the line item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateLinesParams::Line::TaxAmount])))
}
def tax_amounts; end
sig {
params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateLinesParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateLinesParams::Line::TaxAmount])))
}
def tax_amounts=(_tax_amounts); end
# The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(amount: T.nilable(Integer), description: T.nilable(String), discountable: T.nilable(T::Boolean), discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateLinesParams::Line::Discount])), id: String, margins: T.nilable(T.any(String, T::Array[String])), metadata: T.nilable(T.any(String, T::Hash[String, String])), period: T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::Period), price_data: T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::PriceData), pricing: T.nilable(::Stripe::InvoiceService::UpdateLinesParams::Line::Pricing), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::UpdateLinesParams::Line::TaxAmount])), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
amount: nil,
description: nil,
discountable: nil,
discounts: nil,
id: nil,
margins: nil,
metadata: nil,
period: nil,
price_data: nil,
pricing: nil,
quantity: nil,
tax_amounts: nil,
tax_rates: nil
); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def invoice_metadata; end
sig {
params(_invoice_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def invoice_metadata=(_invoice_metadata); end
# The line items to update.
sig { returns(T::Array[::Stripe::InvoiceService::UpdateLinesParams::Line]) }
def lines; end
sig {
params(_lines: T::Array[::Stripe::InvoiceService::UpdateLinesParams::Line]).returns(T::Array[::Stripe::InvoiceService::UpdateLinesParams::Line])
}
def lines=(_lines); end
sig {
params(expand: T.nilable(T::Array[String]), invoice_metadata: T.nilable(T.any(String, T::Hash[String, String])), lines: T::Array[::Stripe::InvoiceService::UpdateLinesParams::Line]).void
}
def initialize(expand: nil, invoice_metadata: nil, lines: nil); end
end
class VoidInvoiceParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class CreatePreviewParams < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class CustomerDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Customer shipping address.
sig {
returns(::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::Shipping::Address)
}
def address; end
sig {
params(_address: ::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::Shipping::Address).returns(::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::Shipping::Address)
}
def address=(_address); end
# Customer name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Customer phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: ::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::Shipping::Address, name: String, phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
class Tax < Stripe::RequestParams
# A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
sig { params(ip_address: T.nilable(String)).void }
def initialize(ip_address: nil); end
end
class TaxId < Stripe::RequestParams
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Value of the tax ID.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(type: String, value: String).void }
def initialize(type: nil, value: nil); end
end
# The customer's address.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::Address)))
}
def address=(_address); end
# The customer's shipping information. Appears on invoices emailed to this customer.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::Shipping)))
}
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::Shipping))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::Shipping)))
}
def shipping=(_shipping); end
# Tax details about the customer.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::Tax)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::Tax))
}
def tax=(_tax); end
# The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
sig { returns(T.nilable(T.any(String, String))) }
def tax_exempt; end
sig {
params(_tax_exempt: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def tax_exempt=(_tax_exempt); end
# The customer's tax IDs.
sig {
returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::TaxId]))
}
def tax_ids; end
sig {
params(_tax_ids: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::TaxId])).returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::TaxId]))
}
def tax_ids=(_tax_ids); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::Address)), shipping: T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::Shipping)), tax: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::Tax), tax_exempt: T.nilable(T.any(String, String)), tax_ids: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails::TaxId])).void
}
def initialize(address: nil, shipping: nil, tax: nil, tax_exempt: nil, tax_ids: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class InvoiceItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
sig { returns(Integer) }
def end; end
sig { params(_end: Integer).returns(Integer) }
def end=(_end); end
# The start of the period. This value is inclusive.
sig { returns(Integer) }
def start; end
sig { params(_start: Integer).returns(Integer) }
def start=(_start); end
sig { params(end_: Integer, start: Integer).void }
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# The integer amount in cents (or local equivalent) of previewed invoice item.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# 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). Only applicable to new invoice items.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.
sig { returns(T.nilable(T::Boolean)) }
def discountable; end
sig { params(_discountable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def discountable=(_discountable); end
# The coupons to redeem into discounts for the invoice item in the preview.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::Discount])))
}
def discounts=(_discounts); end
# The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.
sig { returns(T.nilable(String)) }
def invoiceitem; end
sig { params(_invoiceitem: T.nilable(String)).returns(T.nilable(String)) }
def invoiceitem=(_invoiceitem); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::Period))
}
def period; end
sig {
params(_period: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::Period)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::Period))
}
def period=(_period); end
# The ID of the price object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::PriceData)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::PriceData))
}
def price_data=(_price_data); end
# Non-negative integer. The quantity of units for the invoice item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(amount: T.nilable(Integer), currency: T.nilable(String), description: T.nilable(String), discountable: T.nilable(T::Boolean), discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::Discount])), invoiceitem: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), period: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::Period), price: T.nilable(String), price_data: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem::PriceData), quantity: T.nilable(Integer), tax_behavior: T.nilable(String), tax_code: T.nilable(String), tax_rates: T.nilable(T.any(String, T::Array[String])), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
discountable: nil,
discounts: nil,
invoiceitem: nil,
metadata: nil,
period: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_behavior: nil,
tax_code: nil,
tax_rates: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
class ScheduleDetails < Stripe::RequestParams
class Amendment < Stripe::RequestParams
class AmendmentEnd < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
sig { returns(String) }
def discount; end
sig { params(_discount: String).returns(String) }
def discount=(_discount); end
sig { params(discount: String).void }
def initialize(discount: nil); end
end
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Use the `end` time of a given discount.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd::DiscountEnd))
}
def discount_end=(_discount_end); end
# Time span for the amendment starting from the `amendment_start`.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd::Duration)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select one of three ways to pass the `amendment_end`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd::DiscountEnd), duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(discount_end: nil, duration: nil, timestamp: nil, type: nil); end
end
class AmendmentStart < Stripe::RequestParams
class AmendmentEnd < Stripe::RequestParams
# The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array.
sig { returns(Integer) }
def index; end
sig { params(_index: Integer).returns(Integer) }
def index=(_index); end
sig { params(index: Integer).void }
def initialize(index: nil); end
end
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
sig { returns(String) }
def discount; end
sig { params(_discount: String).returns(String) }
def discount=(_discount); end
sig { params(discount: String).void }
def initialize(discount: nil); end
end
# Details of another amendment in the same array, immediately after which this amendment should begin.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart::AmendmentEnd))
}
def amendment_end; end
sig {
params(_amendment_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart::AmendmentEnd)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart::AmendmentEnd))
}
def amendment_end=(_amendment_end); end
# Use the `end` time of a given discount.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart::DiscountEnd))
}
def discount_end=(_discount_end); end
# A precise Unix timestamp for the amendment to start.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select one of three ways to pass the `amendment_start`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(amendment_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart::AmendmentEnd), discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart::DiscountEnd), timestamp: T.nilable(Integer), type: String).void
}
def initialize(amendment_end: nil, discount_end: nil, timestamp: nil, type: nil); end
end
class DiscountAction < Stripe::RequestParams
class Add < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
# The coupon code to redeem.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# An ID of an existing discount for a coupon that was already redeemed.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Add::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Add::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Add::DiscountEnd))
}
def discount_end=(_discount_end); end
# The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
# The promotion code to redeem.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Add::DiscountEnd), index: T.nilable(Integer), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
index: nil,
promotion_code: nil
); end
end
class Remove < Stripe::RequestParams
# The coupon code to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# The ID of a discount to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# The ID of a promotion code to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
class Set < Stripe::RequestParams
# The coupon code to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# An ID of an existing discount to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# An ID of an existing promotion code to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
# Details of the discount to add.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Add))
}
def add; end
sig {
params(_add: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Add)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Add))
}
def add=(_add); end
# Details of the discount to remove.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Remove))
}
def remove; end
sig {
params(_remove: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Remove)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Remove))
}
def remove=(_remove); end
# Details of the discount to replace the existing discounts with.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Set))
}
def set; end
sig {
params(_set: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Set)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Set))
}
def set=(_set); end
# Determines the type of discount action.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(add: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Add), remove: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Remove), set: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction::Set), type: String).void
}
def initialize(add: nil, remove: nil, set: nil, type: nil); end
end
class ItemAction < Stripe::RequestParams
class Add < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); end
end
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
sig {
returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount])).returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# Quantity for this item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
# Options that configure the trial on the subscription item.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Trial)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Trial))
}
def trial=(_trial); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Discount]), metadata: T.nilable(T::Hash[String, String]), price: String, quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String]), trial: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add::Trial)).void
}
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
class Remove < Stripe::RequestParams
# ID of a price to remove.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
sig { params(price: String).void }
def initialize(price: nil); end
end
class Set < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); end
end
# If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.
sig {
returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount])).returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount]))
}
def discounts=(_discounts); end
# If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
# If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Trial)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Trial))
}
def trial=(_trial); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Discount]), metadata: T.nilable(T::Hash[String, String]), price: String, quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String]), trial: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set::Trial)).void
}
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
# Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add))
}
def add; end
sig {
params(_add: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add))
}
def add=(_add); end
# Details of the subscription item to remove.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Remove))
}
def remove; end
sig {
params(_remove: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Remove)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Remove))
}
def remove=(_remove); end
# Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set))
}
def set; end
sig {
params(_set: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set))
}
def set=(_set); end
# Determines the type of item action.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(add: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Add), remove: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Remove), set: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction::Set), type: String).void
}
def initialize(add: nil, remove: nil, set: nil, type: nil); end
end
class MetadataAction < Stripe::RequestParams
# Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
sig { returns(T.nilable(T::Hash[String, String])) }
def add; end
sig {
params(_add: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def add=(_add); end
# Keys to remove from schedule phase metadata.
sig { returns(T.nilable(T::Array[String])) }
def remove; end
sig {
params(_remove: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def remove=(_remove); end
# Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def set; end
sig {
params(_set: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def set=(_set); end
# Select one of three ways to update phase-level `metadata` on subscription schedules.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(add: T.nilable(T::Hash[String, String]), remove: T.nilable(T::Array[String]), set: T.nilable(T.any(String, T::Hash[String, String])), type: String).void
}
def initialize(add: nil, remove: nil, set: nil, type: nil); end
end
class SetPauseCollection < Stripe::RequestParams
class Set < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(behavior: String).void }
def initialize(behavior: nil); end
end
# Details of the pause_collection behavior to apply to the amendment.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::SetPauseCollection::Set))
}
def set; end
sig {
params(_set: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::SetPauseCollection::Set)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::SetPauseCollection::Set))
}
def set=(_set); end
# Determines the type of the pause_collection amendment.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(set: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::SetPauseCollection::Set), type: String).void
}
def initialize(set: nil, type: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
sig { params(_prorate_up_front: T.nilable(String)).returns(T.nilable(String)) }
def prorate_up_front=(_prorate_up_front); end
sig { params(prorate_up_front: T.nilable(String)).void }
def initialize(prorate_up_front: nil); end
end
# Defines how the subscription should behave when a trial ends.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::TrialSettings::EndBehavior))
}
def end_behavior; end
sig {
params(_end_behavior: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::TrialSettings::EndBehavior)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::TrialSettings::EndBehavior))
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::TrialSettings::EndBehavior)).void
}
def initialize(end_behavior: nil); end
end
# Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd))
}
def amendment_end; end
sig {
params(_amendment_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd))
}
def amendment_end=(_amendment_end); end
# Details to identify the earliest timestamp where the proposed change should take effect.
sig {
returns(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart)
}
def amendment_start; end
sig {
params(_amendment_start: ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart).returns(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart)
}
def amendment_start=(_amendment_start); end
# For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# Changes to the coupons being redeemed or discounts being applied during the amendment time span.
sig {
returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction]))
}
def discount_actions; end
sig {
params(_discount_actions: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction])).returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction]))
}
def discount_actions=(_discount_actions); end
# Changes to the subscription items during the amendment time span.
sig {
returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction]))
}
def item_actions; end
sig {
params(_item_actions: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction])).returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction]))
}
def item_actions=(_item_actions); end
# Instructions for how to modify phase metadata
sig {
returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::MetadataAction]))
}
def metadata_actions; end
sig {
params(_metadata_actions: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::MetadataAction])).returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::MetadataAction]))
}
def metadata_actions=(_metadata_actions); end
# Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::SetPauseCollection))
}
def set_pause_collection; end
sig {
params(_set_pause_collection: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::SetPauseCollection)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::SetPauseCollection))
}
def set_pause_collection=(_set_pause_collection); end
# Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
sig { returns(T.nilable(String)) }
def set_schedule_end; end
sig { params(_set_schedule_end: T.nilable(String)).returns(T.nilable(String)) }
def set_schedule_end=(_set_schedule_end); end
# Settings related to subscription trials.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::TrialSettings))
}
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::TrialSettings)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(amendment_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentEnd), amendment_start: ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::AmendmentStart, billing_cycle_anchor: T.nilable(String), discount_actions: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::DiscountAction]), item_actions: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::ItemAction]), metadata_actions: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::MetadataAction]), proration_behavior: T.nilable(String), set_pause_collection: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::SetPauseCollection), set_schedule_end: T.nilable(String), trial_settings: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment::TrialSettings)).void
}
def initialize(
amendment_end: nil,
amendment_start: nil,
billing_cycle_anchor: nil,
discount_actions: nil,
item_actions: nil,
metadata_actions: nil,
proration_behavior: nil,
set_pause_collection: nil,
set_schedule_end: nil,
trial_settings: nil
); end
end
class BillingMode < Stripe::RequestParams
class Flexible < Stripe::RequestParams
# Set to `true` to display gross amounts, net amounts, and discount amounts consistently between prorations and non-proration items on invoices, line items, and invoice items. Once set to `true`, you can't change it back to `false`.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
sig {
params(_consistent_proration_discount_amounts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consistent_proration_discount_amounts=(_consistent_proration_discount_amounts); end
sig { params(consistent_proration_discount_amounts: T.nilable(T::Boolean)).void }
def initialize(consistent_proration_discount_amounts: nil); end
end
# Configure behavior for flexible billing mode.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::BillingMode::Flexible))
}
def flexible; end
sig {
params(_flexible: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::BillingMode::Flexible)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::BillingMode::Flexible))
}
def flexible=(_flexible); end
# Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(flexible: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::BillingMode::Flexible), type: String).void
}
def initialize(flexible: nil, type: nil); end
end
class Phase < Stripe::RequestParams
class AddInvoiceItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Period < Stripe::RequestParams
class End < Stripe::RequestParams
# A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the end of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
class Start < Stripe::RequestParams
# A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the start of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
# End of the invoice item period.
sig {
returns(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period::End)
}
def end; end
sig {
params(_end: ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period::End).returns(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period::End)
}
def end=(_end); end
# Start of the invoice item period.
sig {
returns(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period::Start)
}
def start; end
sig {
params(_start: ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period::Start).returns(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period::Start)
}
def start=(_start); end
sig {
params(end_: ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period::End, start: ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period::Start).void
}
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# The coupons to redeem into discounts for the item.
sig {
returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount])).returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period))
}
def period; end
sig {
params(_period: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period))
}
def period=(_period); end
# The ID of the price object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::PriceData)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::PriceData))
}
def price_data=(_price_data); end
# Quantity for this item. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Discount]), metadata: T.nilable(T::Hash[String, String]), period: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::Period), price: T.nilable(String), price_data: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
discounts: nil,
metadata: nil,
period: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax::Liability)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class BillingThresholds < Stripe::RequestParams
# Monetary threshold that triggers the subscription to advance to a new billing period
sig { returns(T.nilable(Integer)) }
def amount_gte; end
sig { params(_amount_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_gte=(_amount_gte); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
sig {
params(_reset_billing_cycle_anchor: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def reset_billing_cycle_anchor=(_reset_billing_cycle_anchor); end
sig {
params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
}
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Duration < Stripe::RequestParams
# Specifies phase duration. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The multiplier applied to the interval.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings::Issuer)).void
}
def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end
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))
sig { returns(Integer) }
def usage_gte; end
sig { params(_usage_gte: Integer).returns(Integer) }
def usage_gte=(_usage_gte); end
sig { params(usage_gte: Integer).void }
def initialize(usage_gte: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData::Recurring)
}
def recurring; end
sig {
params(_recurring: ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData::Recurring).returns(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData::Recurring)
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# The coupons to redeem into discounts for the subscription item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount])))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData))
}
def price_data=(_price_data); end
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# Options that configure the trial on the subscription item.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Trial)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Trial))
}
def trial=(_trial); end
sig {
params(billing_thresholds: T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::BillingThresholds)), discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount])), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String])), trial: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Trial)).void
}
def initialize(
billing_thresholds: nil,
discounts: nil,
metadata: nil,
plan: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
class PauseCollection < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(behavior: String).void }
def initialize(behavior: nil); end
end
class TransferData < Stripe::RequestParams
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount_percent: T.nilable(Float), destination: String).void }
def initialize(amount_percent: nil, destination: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
sig { params(_prorate_up_front: T.nilable(String)).returns(T.nilable(String)) }
def prorate_up_front=(_prorate_up_front); end
sig { params(prorate_up_front: T.nilable(String)).void }
def initialize(prorate_up_front: nil); end
end
# Defines how the subscription should behave when a trial ends.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::TrialSettings::EndBehavior))
}
def end_behavior; end
sig {
params(_end_behavior: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::TrialSettings::EndBehavior)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::TrialSettings::EndBehavior))
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::TrialSettings::EndBehavior)).void
}
def initialize(end_behavior: nil); end
end
# A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
sig {
returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem]))
}
def add_invoice_items; end
sig {
params(_add_invoice_items: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem])).returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem]))
}
def add_invoice_items=(_add_invoice_items); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
sig { params(_application_fee_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def application_fee_percent=(_application_fee_percent); end
# Automatic tax settings for this phase.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax))
}
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# 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).
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Discount])))
}
def discounts=(_discounts); end
# The number of intervals the phase should last. If set, `end_date` must not be set.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Duration)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Duration))
}
def duration=(_duration); end
# The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
sig { returns(T.nilable(T.any(Integer, String))) }
def end_date; end
sig {
params(_end_date: T.nilable(T.any(Integer, String))).returns(T.nilable(T.any(Integer, String)))
}
def end_date=(_end_date); end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
sig {
returns(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item])
}
def items; end
sig {
params(_items: T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item]).returns(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item])
}
def items=(_items); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The account on behalf of which to charge, for each of the associated subscription's invoices.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::PauseCollection))
}
def pause_collection; end
sig {
params(_pause_collection: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::PauseCollection)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::PauseCollection))
}
def pause_collection=(_pause_collection); end
# 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.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
sig { returns(T.nilable(T.any(Integer, String))) }
def start_date; end
sig {
params(_start_date: T.nilable(T.any(Integer, String))).returns(T.nilable(T.any(Integer, String)))
}
def start_date=(_start_date); end
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::TransferData))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::TransferData)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::TransferData))
}
def transfer_data=(_transfer_data); end
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
sig { returns(T.nilable(T::Boolean)) }
def trial; end
sig { params(_trial: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def trial=(_trial); end
# Specify trial behavior when crossing phase boundaries
sig { returns(T.nilable(String)) }
def trial_continuation; end
sig { params(_trial_continuation: T.nilable(String)).returns(T.nilable(String)) }
def trial_continuation=(_trial_continuation); end
# Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
sig { returns(T.nilable(T.any(Integer, String))) }
def trial_end; end
sig {
params(_trial_end: T.nilable(T.any(Integer, String))).returns(T.nilable(T.any(Integer, String)))
}
def trial_end=(_trial_end); end
# Settings related to subscription trials.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::TrialSettings))
}
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::TrialSettings)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(add_invoice_items: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::BillingThresholds)), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.any(String, T::Array[String])), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Discount])), duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Duration), end_date: T.nilable(T.any(Integer, String)), invoice_settings: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings), items: T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item], metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), pause_collection: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::PauseCollection), proration_behavior: T.nilable(String), start_date: T.nilable(T.any(Integer, String)), transfer_data: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::TransferData), trial: T.nilable(T::Boolean), trial_continuation: T.nilable(String), trial_end: T.nilable(T.any(Integer, String)), trial_settings: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::TrialSettings)).void
}
def initialize(
add_invoice_items: nil,
application_fee_percent: nil,
automatic_tax: nil,
billing_cycle_anchor: nil,
billing_thresholds: nil,
collection_method: nil,
currency: nil,
default_payment_method: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
duration: nil,
end_date: nil,
invoice_settings: nil,
items: nil,
metadata: nil,
on_behalf_of: nil,
pause_collection: nil,
proration_behavior: nil,
start_date: nil,
transfer_data: nil,
trial: nil,
trial_continuation: nil,
trial_end: nil,
trial_settings: nil
); end
end
class Prebilling < Stripe::RequestParams
class BillUntil < Stripe::RequestParams
class AmendmentEnd < Stripe::RequestParams
# The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments.
sig { returns(Integer) }
def index; end
sig { params(_index: Integer).returns(Integer) }
def index=(_index); end
sig { params(index: Integer).void }
def initialize(index: nil); end
end
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# End the prebilled period when a specified amendment ends.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil::AmendmentEnd))
}
def amendment_end; end
sig {
params(_amendment_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil::AmendmentEnd)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil::AmendmentEnd))
}
def amendment_end=(_amendment_end); end
# Time span for prebilling, starting from `bill_from`.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil::Duration)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil::Duration))
}
def duration=(_duration); end
# End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select one of several ways to pass the `bill_until` value.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(amendment_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil::AmendmentEnd), duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(amendment_end: nil, duration: nil, timestamp: nil, type: nil); end
end
# The end of the prebilled time period.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil))
}
def bill_until; end
sig {
params(_bill_until: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil))
}
def bill_until=(_bill_until); end
# This is used to determine the number of billing cycles to prebill.
sig { returns(T.nilable(Integer)) }
def iterations; end
sig { params(_iterations: T.nilable(Integer)).returns(T.nilable(Integer)) }
def iterations=(_iterations); end
sig {
params(bill_until: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Prebilling::BillUntil), iterations: T.nilable(Integer)).void
}
def initialize(bill_until: nil, iterations: nil); end
end
# Changes to apply to the phases of the subscription schedule, in the order provided.
sig {
returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment]))
}
def amendments; end
sig {
params(_amendments: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment])).returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment]))
}
def amendments=(_amendments); end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
sig { params(_billing_behavior: T.nilable(String)).returns(T.nilable(String)) }
def billing_behavior=(_billing_behavior); end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::BillingMode))
}
def billing_mode; end
sig {
params(_billing_mode: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::BillingMode)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::BillingMode))
}
def billing_mode=(_billing_mode); end
# Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
sig { returns(T.nilable(String)) }
def end_behavior; end
sig { params(_end_behavior: T.nilable(String)).returns(T.nilable(String)) }
def end_behavior=(_end_behavior); end
# List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
sig {
returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase]))
}
def phases; end
sig {
params(_phases: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase])).returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase]))
}
def phases=(_phases); end
# Provide any time periods to bill in advance.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Prebilling])))
}
def prebilling; end
sig {
params(_prebilling: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Prebilling]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Prebilling])))
}
def prebilling=(_prebilling); end
# In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
sig {
params(amendments: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Amendment]), billing_behavior: T.nilable(String), billing_mode: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::BillingMode), end_behavior: T.nilable(String), phases: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase]), prebilling: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Prebilling])), proration_behavior: T.nilable(String)).void
}
def initialize(
amendments: nil,
billing_behavior: nil,
billing_mode: nil,
end_behavior: nil,
phases: nil,
prebilling: nil,
proration_behavior: nil
); end
end
class SubscriptionDetails < Stripe::RequestParams
class BillingMode < Stripe::RequestParams
class Flexible < Stripe::RequestParams
# Set to `true` to display gross amounts, net amounts, and discount amounts consistently between prorations and non-proration items on invoices, line items, and invoice items. Once set to `true`, you can't change it back to `false`.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
sig {
params(_consistent_proration_discount_amounts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consistent_proration_discount_amounts=(_consistent_proration_discount_amounts); end
sig { params(consistent_proration_discount_amounts: T.nilable(T::Boolean)).void }
def initialize(consistent_proration_discount_amounts: nil); end
end
# Configure behavior for flexible billing mode.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::BillingMode::Flexible))
}
def flexible; end
sig {
params(_flexible: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::BillingMode::Flexible)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::BillingMode::Flexible))
}
def flexible=(_flexible); end
# Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(flexible: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::BillingMode::Flexible), type: String).void
}
def initialize(flexible: nil, type: nil); end
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))
sig { returns(Integer) }
def usage_gte; end
sig { params(_usage_gte: Integer).returns(Integer) }
def usage_gte=(_usage_gte); end
sig { params(usage_gte: Integer).void }
def initialize(usage_gte: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::PriceData::Recurring)
}
def recurring; end
sig {
params(_recurring: ::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::PriceData::Recurring).returns(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::PriceData::Recurring)
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: ::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def clear_usage; end
sig { params(_clear_usage: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def clear_usage=(_clear_usage); end
# A flag that, if set to `true`, will delete the specified item.
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
sig { params(_deleted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def deleted=(_deleted); end
# The coupons to redeem into discounts for the subscription item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::Discount])))
}
def discounts=(_discounts); end
# Subscription item to update.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Plan ID for this item, as a string.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::PriceData)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::PriceData))
}
def price_data=(_price_data); end
# Quantity for this item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(billing_thresholds: T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::BillingThresholds)), clear_usage: T.nilable(T::Boolean), deleted: T.nilable(T::Boolean), discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::Discount])), id: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
billing_thresholds: nil,
clear_usage: nil,
deleted: nil,
discounts: nil,
id: nil,
metadata: nil,
plan: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class Prebilling < Stripe::RequestParams
# This is used to determine the number of billing cycles to prebill.
sig { returns(Integer) }
def iterations; end
sig { params(_iterations: Integer).returns(Integer) }
def iterations=(_iterations); end
sig { params(iterations: Integer).void }
def initialize(iterations: nil); end
end
# For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.
sig { returns(T.nilable(T.any(String, Integer))) }
def billing_cycle_anchor; end
sig {
params(_billing_cycle_anchor: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def billing_cycle_anchor=(_billing_cycle_anchor); end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::BillingMode))
}
def billing_mode; end
sig {
params(_billing_mode: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::BillingMode)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::BillingMode))
}
def billing_mode=(_billing_mode); end
# 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.
sig { returns(T.nilable(T.any(String, T.any(Integer, String)))) }
def cancel_at; end
sig {
params(_cancel_at: T.nilable(T.any(String, T.any(Integer, String)))).returns(T.nilable(T.any(String, T.any(Integer, String))))
}
def cancel_at=(_cancel_at); end
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def cancel_at_period_end; end
sig { params(_cancel_at_period_end: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def cancel_at_period_end=(_cancel_at_period_end); end
# This simulates the subscription being canceled or expired immediately.
sig { returns(T.nilable(T::Boolean)) }
def cancel_now; end
sig { params(_cancel_now: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def cancel_now=(_cancel_now); end
# If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# A list of up to 20 subscription items, each with an attached price.
sig {
returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item]))
}
def items; end
sig {
params(_items: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item])).returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item]))
}
def items=(_items); end
# The pre-billing to apply to the subscription as a preview.
sig {
returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Prebilling))
}
def prebilling; end
sig {
params(_prebilling: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Prebilling)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Prebilling))
}
def prebilling=(_prebilling); end
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.
sig { returns(T.nilable(Integer)) }
def proration_date; end
sig { params(_proration_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def proration_date=(_proration_date); end
# For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.
sig { returns(T.nilable(String)) }
def resume_at; end
sig { params(_resume_at: T.nilable(String)).returns(T.nilable(String)) }
def resume_at=(_resume_at); end
# Date a subscription is intended to start (can be future or past).
sig { returns(T.nilable(Integer)) }
def start_date; end
sig { params(_start_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def start_date=(_start_date); end
# If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required.
sig { returns(T.nilable(T.any(String, Integer))) }
def trial_end; end
sig {
params(_trial_end: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def trial_end=(_trial_end); end
sig {
params(billing_cycle_anchor: T.nilable(T.any(String, Integer)), billing_mode: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::BillingMode), cancel_at: T.nilable(T.any(String, T.any(Integer, String))), cancel_at_period_end: T.nilable(T::Boolean), cancel_now: T.nilable(T::Boolean), default_tax_rates: T.nilable(T.any(String, T::Array[String])), items: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item]), prebilling: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Prebilling), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), resume_at: T.nilable(String), start_date: T.nilable(Integer), trial_end: T.nilable(T.any(String, Integer))).void
}
def initialize(
billing_cycle_anchor: nil,
billing_mode: nil,
cancel_at: nil,
cancel_at_period_end: nil,
cancel_now: nil,
default_tax_rates: nil,
items: nil,
prebilling: nil,
proration_behavior: nil,
proration_date: nil,
resume_at: nil,
start_date: nil,
trial_end: nil
); end
end
# Settings for automatic tax lookup for this invoice preview.
sig { returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::AutomaticTax)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# The currency to preview this invoice in. Defaults to that of `customer` if not specified.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The identifier of the account whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_account`, `customer_details`, `subscription`, or `schedule` must be set.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
sig { returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails)) }
def customer_details; end
sig {
params(_customer_details: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails))
}
def customer_details=(_customer_details); end
# The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# List of invoice items to add or update in the upcoming invoice preview (up to 250).
sig {
returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem]))
}
def invoice_items; end
sig {
params(_invoice_items: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem])).returns(T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem]))
}
def invoice_items=(_invoice_items); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig { returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::Issuer)) }
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::Issuer)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::Issuer))
}
def issuer=(_issuer); end
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.
sig { returns(T.nilable(String)) }
def preview_mode; end
sig { params(_preview_mode: T.nilable(String)).returns(T.nilable(String)) }
def preview_mode=(_preview_mode); end
# The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.
sig { returns(T.nilable(String)) }
def schedule; end
sig { params(_schedule: T.nilable(String)).returns(T.nilable(String)) }
def schedule=(_schedule); end
# The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.
sig { returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails)) }
def schedule_details; end
sig {
params(_schedule_details: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails))
}
def schedule_details=(_schedule_details); end
# The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.
sig { returns(T.nilable(String)) }
def subscription; end
sig { params(_subscription: T.nilable(String)).returns(T.nilable(String)) }
def subscription=(_subscription); end
# The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.
sig { returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails)) }
def subscription_details; end
sig {
params(_subscription_details: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails)).returns(T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails))
}
def subscription_details=(_subscription_details); end
sig {
params(automatic_tax: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::AutomaticTax), currency: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), customer_details: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::CustomerDetails), discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::Discount])), expand: T.nilable(T::Array[String]), invoice_items: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::InvoiceItem]), issuer: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::Issuer), on_behalf_of: T.nilable(String), preview_mode: T.nilable(String), schedule: T.nilable(String), schedule_details: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails), subscription: T.nilable(String), subscription_details: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails)).void
}
def initialize(
automatic_tax: nil,
currency: nil,
customer: nil,
customer_account: nil,
customer_details: nil,
discounts: nil,
expand: nil,
invoice_items: nil,
issuer: nil,
on_behalf_of: nil,
preview_mode: nil,
schedule: nil,
schedule_details: nil,
subscription: nil,
subscription_details: nil
); end
end
# Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
sig {
params(invoice: String, params: T.any(::Stripe::InvoiceService::AddLinesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def add_lines(invoice, params = {}, opts = {}); end
# 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.
sig {
params(invoice: String, params: T.any(::Stripe::InvoiceService::AttachPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def attach_payment(invoice, params = {}, opts = {}); 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 send](https://docs.stripe.com/api#finalize_invoice) the invoice to your customers.
sig {
params(params: T.any(::Stripe::InvoiceService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def create(params = {}, opts = {}); 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.
#
# 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.
#
# 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)
sig {
params(params: T.any(::Stripe::InvoiceService::CreatePreviewParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def create_preview(params = {}, opts = {}); 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://docs.stripe.com/api#void_invoice).
sig {
params(invoice: String, params: T.any(::Stripe::InvoiceService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def delete(invoice, params = {}, opts = {}); end
# Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you'd like to finalize a draft invoice manually, you can do so using this method.
sig {
params(invoice: String, params: T.any(::Stripe::InvoiceService::FinalizeInvoiceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def finalize_invoice(invoice, params = {}, opts = {}); end
# You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.
sig {
params(params: T.any(::Stripe::InvoiceService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
sig {
params(invoice: String, params: T.any(::Stripe::InvoiceService::MarkUncollectibleParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def mark_uncollectible(invoice, params = {}, opts = {}); end
# Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your [subscriptions settings](https://dashboard.stripe.com/account/billing/automatic). However, if you'd like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.
sig {
params(invoice: String, params: T.any(::Stripe::InvoiceService::PayParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def pay(invoice, params = {}, opts = {}); end
# Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.
sig {
params(invoice: String, params: T.any(::Stripe::InvoiceService::RemoveLinesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def remove_lines(invoice, params = {}, opts = {}); end
# Retrieves the invoice with the given ID.
sig {
params(invoice: String, params: T.any(::Stripe::InvoiceService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def retrieve(invoice, params = {}, opts = {}); end
# 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.
sig {
params(params: T.any(::Stripe::InvoiceService::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
}
def search(params = {}, opts = {}); end
# Stripe will automatically send invoices to customers according to your [subscriptions settings](https://dashboard.stripe.com/account/billing/automatic). However, if you'd like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.
#
# Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.
sig {
params(invoice: String, params: T.any(::Stripe::InvoiceService::SendInvoiceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def send_invoice(invoice, params = {}, opts = {}); end
# 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://docs.stripe.com/docs/billing/invoices/reconciliation) invoices, pass
# auto_advance=false.
sig {
params(invoice: String, params: T.any(::Stripe::InvoiceService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def update(invoice, params = {}, opts = {}); end
# Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.
sig {
params(invoice: String, params: T.any(::Stripe::InvoiceService::UpdateLinesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def update_lines(invoice, params = {}, opts = {}); end
# 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 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.
sig {
params(invoice: String, params: T.any(::Stripe::InvoiceService::VoidInvoiceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
}
def void_invoice(invoice, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class InvoiceLineItemService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class UpdateParams < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
sig { returns(Integer) }
def end; end
sig { params(_end: Integer).returns(Integer) }
def end=(_end); end
# The start of the period. This value is inclusive.
sig { returns(Integer) }
def start; end
sig { params(_start: Integer).returns(Integer) }
def start=(_start); end
sig { params(end_: Integer, start: Integer).void }
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
class ProductData < Stripe::RequestParams
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T::Array[String])) }
def images; end
sig { params(_images: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def images=(_images); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
sig {
params(description: T.nilable(String), images: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: String, tax_code: T.nilable(String), unit_label: T.nilable(String)).void
}
def initialize(
description: nil,
images: nil,
metadata: nil,
name: nil,
tax_code: nil,
unit_label: nil
); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
sig {
returns(T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::PriceData::ProductData))
}
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::PriceData::ProductData)).returns(T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::PriceData::ProductData))
}
def product_data=(_product_data); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: T.nilable(String), product_data: T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::PriceData::ProductData), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
product_data: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Pricing < Stripe::RequestParams
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
sig { params(price: T.nilable(String)).void }
def initialize(price: nil); end
end
class TaxAmount < Stripe::RequestParams
class TaxRateData < Stripe::RequestParams
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The display name of the tax rate, which will be shown to users.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# This specifies if the tax rate is inclusive or exclusive.
sig { returns(T::Boolean) }
def inclusive; end
sig { params(_inclusive: T::Boolean).returns(T::Boolean) }
def inclusive=(_inclusive); end
# The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
sig { returns(T.nilable(String)) }
def jurisdiction; end
sig { params(_jurisdiction: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction=(_jurisdiction); end
# The level of the jurisdiction that imposes this tax rate.
sig { returns(T.nilable(String)) }
def jurisdiction_level; end
sig { params(_jurisdiction_level: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction_level=(_jurisdiction_level); end
# The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.
sig { returns(Float) }
def percentage; end
sig { params(_percentage: Float).returns(Float) }
def percentage=(_percentage); end
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# The high-level tax type, such as `vat` or `sales_tax`.
sig { returns(T.nilable(String)) }
def tax_type; end
sig { params(_tax_type: T.nilable(String)).returns(T.nilable(String)) }
def tax_type=(_tax_type); end
sig {
params(country: T.nilable(String), description: T.nilable(String), display_name: String, inclusive: T::Boolean, jurisdiction: T.nilable(String), jurisdiction_level: T.nilable(String), percentage: Float, state: T.nilable(String), tax_type: T.nilable(String)).void
}
def initialize(
country: nil,
description: nil,
display_name: nil,
inclusive: nil,
jurisdiction: nil,
jurisdiction_level: nil,
percentage: nil,
state: nil,
tax_type: nil
); end
end
# The amount, in cents (or local equivalent), of the tax.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Data to find or create a TaxRate object.
#
# Stripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.
sig { returns(::Stripe::InvoiceLineItemService::UpdateParams::TaxAmount::TaxRateData) }
def tax_rate_data; end
sig {
params(_tax_rate_data: ::Stripe::InvoiceLineItemService::UpdateParams::TaxAmount::TaxRateData).returns(::Stripe::InvoiceLineItemService::UpdateParams::TaxAmount::TaxRateData)
}
def tax_rate_data=(_tax_rate_data); end
# The reasoning behind this tax, for example, if the product is tax exempt.
sig { returns(T.nilable(String)) }
def taxability_reason; end
sig { params(_taxability_reason: T.nilable(String)).returns(T.nilable(String)) }
def taxability_reason=(_taxability_reason); end
# The amount on which tax is calculated, in cents (or local equivalent).
sig { returns(Integer) }
def taxable_amount; end
sig { params(_taxable_amount: Integer).returns(Integer) }
def taxable_amount=(_taxable_amount); end
sig {
params(amount: Integer, tax_rate_data: ::Stripe::InvoiceLineItemService::UpdateParams::TaxAmount::TaxRateData, taxability_reason: T.nilable(String), taxable_amount: Integer).void
}
def initialize(
amount: nil,
tax_rate_data: nil,
taxability_reason: nil,
taxable_amount: nil
); end
end
# The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
sig { returns(T.nilable(T::Boolean)) }
def discountable; end
sig { params(_discountable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def discountable=(_discountable); end
# The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItemService::UpdateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItemService::UpdateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItemService::UpdateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def margins; end
sig {
params(_margins: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def margins=(_margins); end
# 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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
sig { returns(T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::Period)) }
def period; end
sig {
params(_period: T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::Period)).returns(T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::Period))
}
def period=(_period); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig { returns(T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::PriceData)).returns(T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::PriceData))
}
def price_data=(_price_data); end
# The pricing information for the invoice item.
sig { returns(T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::Pricing)) }
def pricing; end
sig {
params(_pricing: T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::Pricing)).returns(T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::Pricing))
}
def pricing=(_pricing); end
# Non-negative integer. The quantity of units for the line item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItemService::UpdateParams::TaxAmount])))
}
def tax_amounts; end
sig {
params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItemService::UpdateParams::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItemService::UpdateParams::TaxAmount])))
}
def tax_amounts=(_tax_amounts); end
# The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(amount: T.nilable(Integer), description: T.nilable(String), discountable: T.nilable(T::Boolean), discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItemService::UpdateParams::Discount])), expand: T.nilable(T::Array[String]), margins: T.nilable(T.any(String, T::Array[String])), metadata: T.nilable(T.any(String, T::Hash[String, String])), period: T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::Period), price_data: T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::PriceData), pricing: T.nilable(::Stripe::InvoiceLineItemService::UpdateParams::Pricing), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItemService::UpdateParams::TaxAmount])), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
amount: nil,
description: nil,
discountable: nil,
discounts: nil,
expand: nil,
margins: nil,
metadata: nil,
period: nil,
price_data: nil,
pricing: nil,
quantity: nil,
tax_amounts: nil,
tax_rates: nil
); end
end
# When retrieving an 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.
sig {
params(invoice: String, params: T.any(::Stripe::InvoiceLineItemService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(invoice, params = {}, opts = {}); end
# Updates an invoice's line item. Some fields, such as tax_amounts, only live on the invoice line item,
# so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice
# item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.
# Updating an invoice's line item is only possible before the invoice is finalized.
sig {
params(invoice: String, line_item_id: String, params: T.any(::Stripe::InvoiceLineItemService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceLineItem)
}
def update(invoice, line_item_id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class InvoiceItemService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceItemService::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceItemService::UpdateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceItemService::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceItemService::UpdateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::InvoiceItemService::UpdateParams::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceItemService::UpdateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceItemService::UpdateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceItemService::UpdateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
sig { returns(Integer) }
def end; end
sig { params(_end: Integer).returns(Integer) }
def end=(_end); end
# The start of the period. This value is inclusive.
sig { returns(Integer) }
def start; end
sig { params(_start: Integer).returns(Integer) }
def start=(_start); end
sig { params(end_: Integer, start: Integer).void }
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Pricing < Stripe::RequestParams
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
sig { params(price: T.nilable(String)).void }
def initialize(price: nil); end
end
# The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations.
sig { returns(T.nilable(T::Boolean)) }
def discountable; end
sig { params(_discountable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def discountable=(_discountable); end
# The coupons, promotion codes & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceItemService::UpdateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceItemService::UpdateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceItemService::UpdateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def margins; end
sig {
params(_margins: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def margins=(_margins); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
sig { returns(T.nilable(::Stripe::InvoiceItemService::UpdateParams::Period)) }
def period; end
sig {
params(_period: T.nilable(::Stripe::InvoiceItemService::UpdateParams::Period)).returns(T.nilable(::Stripe::InvoiceItemService::UpdateParams::Period))
}
def period=(_period); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig { returns(T.nilable(::Stripe::InvoiceItemService::UpdateParams::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::InvoiceItemService::UpdateParams::PriceData)).returns(T.nilable(::Stripe::InvoiceItemService::UpdateParams::PriceData))
}
def price_data=(_price_data); end
# The pricing information for the invoice item.
sig { returns(T.nilable(::Stripe::InvoiceItemService::UpdateParams::Pricing)) }
def pricing; end
sig {
params(_pricing: T.nilable(::Stripe::InvoiceItemService::UpdateParams::Pricing)).returns(T.nilable(::Stripe::InvoiceItemService::UpdateParams::Pricing))
}
def pricing=(_pricing); end
# Non-negative integer. The quantity of units for the invoice item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(amount: T.nilable(Integer), description: T.nilable(String), discountable: T.nilable(T::Boolean), discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceItemService::UpdateParams::Discount])), expand: T.nilable(T::Array[String]), margins: T.nilable(T.any(String, T::Array[String])), metadata: T.nilable(T.any(String, T::Hash[String, String])), period: T.nilable(::Stripe::InvoiceItemService::UpdateParams::Period), price_data: T.nilable(::Stripe::InvoiceItemService::UpdateParams::PriceData), pricing: T.nilable(::Stripe::InvoiceItemService::UpdateParams::Pricing), quantity: T.nilable(Integer), tax_behavior: T.nilable(String), tax_code: T.nilable(String), tax_rates: T.nilable(T.any(String, T::Array[String])), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
amount: nil,
description: nil,
discountable: nil,
discounts: nil,
expand: nil,
margins: nil,
metadata: nil,
period: nil,
price_data: nil,
pricing: nil,
quantity: nil,
tax_behavior: nil,
tax_code: nil,
tax_rates: nil,
unit_amount_decimal: nil
); end
end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return invoice items that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::InvoiceItemService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::InvoiceItemService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::InvoiceItemService::ListParams::Created, Integer)))
}
def created=(_created); end
# The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The identifier of the account whose invoice items to return. If none is provided, all invoice items will be returned.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.
sig { returns(T.nilable(String)) }
def invoice; end
sig { params(_invoice: T.nilable(String)).returns(T.nilable(String)) }
def invoice=(_invoice); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Set to `true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied.
sig { returns(T.nilable(T::Boolean)) }
def pending; end
sig { params(_pending: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def pending=(_pending); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::InvoiceItemService::ListParams::Created, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: T.nilable(String), limit: T.nilable(Integer), pending: T.nilable(T::Boolean), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
invoice: nil,
limit: nil,
pending: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::InvoiceItemService::CreateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::InvoiceItemService::CreateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::InvoiceItemService::CreateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::InvoiceItemService::CreateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::InvoiceItemService::CreateParams::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::InvoiceItemService::CreateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::InvoiceItemService::CreateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::InvoiceItemService::CreateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
sig { returns(Integer) }
def end; end
sig { params(_end: Integer).returns(Integer) }
def end=(_end); end
# The start of the period. This value is inclusive.
sig { returns(Integer) }
def start; end
sig { params(_start: Integer).returns(Integer) }
def start=(_start); end
sig { params(end_: Integer, start: Integer).void }
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Pricing < Stripe::RequestParams
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
sig { params(price: T.nilable(String)).void }
def initialize(price: nil); end
end
# The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The ID of the customer who will be billed when this invoice item is billed.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The ID of the account who will be billed when this invoice item is billed.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.
sig { returns(T.nilable(T::Boolean)) }
def discountable; end
sig { params(_discountable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def discountable=(_discountable); end
# The coupons and promotion codes to redeem into discounts for the invoice item or invoice line item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceItemService::CreateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceItemService::CreateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::InvoiceItemService::CreateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The ID of an existing invoice to add this invoice item to. For subscription invoices, when left blank, the invoice item will be added to the next upcoming scheduled invoice. For standalone invoices, the invoice item won't be automatically added unless you pass `pending_invoice_item_behavior: 'include'` when creating the invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.
sig { returns(T.nilable(String)) }
def invoice; end
sig { params(_invoice: T.nilable(String)).returns(T.nilable(String)) }
def invoice=(_invoice); end
# The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
sig { returns(T.nilable(T::Array[String])) }
def margins; end
sig { params(_margins: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def margins=(_margins); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
sig { returns(T.nilable(::Stripe::InvoiceItemService::CreateParams::Period)) }
def period; end
sig {
params(_period: T.nilable(::Stripe::InvoiceItemService::CreateParams::Period)).returns(T.nilable(::Stripe::InvoiceItemService::CreateParams::Period))
}
def period=(_period); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig { returns(T.nilable(::Stripe::InvoiceItemService::CreateParams::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::InvoiceItemService::CreateParams::PriceData)).returns(T.nilable(::Stripe::InvoiceItemService::CreateParams::PriceData))
}
def price_data=(_price_data); end
# The pricing information for the invoice item.
sig { returns(T.nilable(::Stripe::InvoiceItemService::CreateParams::Pricing)) }
def pricing; end
sig {
params(_pricing: T.nilable(::Stripe::InvoiceItemService::CreateParams::Pricing)).returns(T.nilable(::Stripe::InvoiceItemService::CreateParams::Pricing))
}
def pricing=(_pricing); end
# Non-negative integer. The quantity of units for the invoice item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
sig { returns(T.nilable(String)) }
def subscription; end
sig { params(_subscription: T.nilable(String)).returns(T.nilable(String)) }
def subscription=(_subscription); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig { params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def tax_rates=(_tax_rates); end
# The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(amount: T.nilable(Integer), currency: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), description: T.nilable(String), discountable: T.nilable(T::Boolean), discounts: T.nilable(T.any(String, T::Array[::Stripe::InvoiceItemService::CreateParams::Discount])), expand: T.nilable(T::Array[String]), invoice: T.nilable(String), margins: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), period: T.nilable(::Stripe::InvoiceItemService::CreateParams::Period), price_data: T.nilable(::Stripe::InvoiceItemService::CreateParams::PriceData), pricing: T.nilable(::Stripe::InvoiceItemService::CreateParams::Pricing), quantity: T.nilable(Integer), subscription: T.nilable(String), tax_behavior: T.nilable(String), tax_code: T.nilable(String), tax_rates: T.nilable(T::Array[String]), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
customer: nil,
customer_account: nil,
description: nil,
discountable: nil,
discounts: nil,
expand: nil,
invoice: nil,
margins: nil,
metadata: nil,
period: nil,
price_data: nil,
pricing: nil,
quantity: nil,
subscription: nil,
tax_behavior: nil,
tax_code: nil,
tax_rates: nil,
unit_amount_decimal: nil
); end
end
# Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.
sig {
params(params: T.any(::Stripe::InvoiceItemService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceItem)
}
def create(params = {}, opts = {}); end
# Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they're not attached to invoices, or if it's attached to a draft invoice.
sig {
params(invoiceitem: String, params: T.any(::Stripe::InvoiceItemService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceItem)
}
def delete(invoiceitem, params = {}, opts = {}); end
# Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.
sig {
params(params: T.any(::Stripe::InvoiceItemService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the invoice item with the given ID.
sig {
params(invoiceitem: String, params: T.any(::Stripe::InvoiceItemService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceItem)
}
def retrieve(invoiceitem, params = {}, opts = {}); end
# Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it's attached to is closed.
sig {
params(invoiceitem: String, params: T.any(::Stripe::InvoiceItemService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceItem)
}
def update(invoiceitem, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class InvoicePaymentService < StripeService
class ListParams < Stripe::RequestParams
class Payment < Stripe::RequestParams
# Only return invoice payments associated by this payment intent ID.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# Only return invoice payments associated by this payment record ID.
sig { returns(T.nilable(String)) }
def payment_record; end
sig { params(_payment_record: T.nilable(String)).returns(T.nilable(String)) }
def payment_record=(_payment_record); end
# Only return invoice payments associated by this payment type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(payment_intent: T.nilable(String), payment_record: T.nilable(String), type: String).void
}
def initialize(payment_intent: nil, payment_record: nil, type: nil); end
end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The identifier of the invoice whose payments to return.
sig { returns(T.nilable(String)) }
def invoice; end
sig { params(_invoice: T.nilable(String)).returns(T.nilable(String)) }
def invoice=(_invoice); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The payment details of the invoice payments to return.
sig { returns(T.nilable(::Stripe::InvoicePaymentService::ListParams::Payment)) }
def payment; end
sig {
params(_payment: T.nilable(::Stripe::InvoicePaymentService::ListParams::Payment)).returns(T.nilable(::Stripe::InvoicePaymentService::ListParams::Payment))
}
def payment=(_payment); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# The status of the invoice payments to return.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: T.nilable(String), limit: T.nilable(Integer), payment: T.nilable(::Stripe::InvoicePaymentService::ListParams::Payment), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
invoice: nil,
limit: nil,
payment: nil,
starting_after: nil,
status: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
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.
sig {
params(params: T.any(::Stripe::InvoicePaymentService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the invoice payment with the given ID.
sig {
params(invoice_payment: String, params: T.any(::Stripe::InvoicePaymentService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoicePayment)
}
def retrieve(invoice_payment, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class InvoiceRenderingTemplateService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Attribute for param field status
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Attribute for param field version
sig { returns(T.nilable(Integer)) }
def version; end
sig { params(_version: T.nilable(Integer)).returns(T.nilable(Integer)) }
def version=(_version); end
sig { params(expand: T.nilable(T::Array[String]), version: T.nilable(Integer)).void }
def initialize(expand: nil, version: nil); end
end
class ArchiveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UnarchiveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Updates the status of an invoice rendering template to ‘archived' so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.
sig {
params(template: String, params: T.any(::Stripe::InvoiceRenderingTemplateService::ArchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceRenderingTemplate)
}
def archive(template, params = {}, opts = {}); end
# List all templates, ordered by creation date, with the most recently created template appearing first.
sig {
params(params: T.any(::Stripe::InvoiceRenderingTemplateService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.
sig {
params(template: String, params: T.any(::Stripe::InvoiceRenderingTemplateService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceRenderingTemplate)
}
def retrieve(template, params = {}, opts = {}); end
# Unarchive an invoice rendering template so it can be used on new Stripe objects again.
sig {
params(template: String, params: T.any(::Stripe::InvoiceRenderingTemplateService::UnarchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceRenderingTemplate)
}
def unarchive(template, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class IssuingService < StripeService
attr_reader :authorizations
attr_reader :cards
attr_reader :cardholders
attr_reader :credit_underwriting_records
attr_reader :disputes
attr_reader :dispute_settlement_details
attr_reader :fraud_liability_debits
attr_reader :personalization_designs
attr_reader :physical_bundles
attr_reader :tokens
attr_reader :transactions
end
end
# typed: true
module Stripe
module Issuing
class AuthorizationService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return authorizations that belong to the given card.
sig { returns(T.nilable(String)) }
def card; end
sig { params(_card: T.nilable(String)).returns(T.nilable(String)) }
def card=(_card); end
# Only return authorizations that belong to the given cardholder.
sig { returns(T.nilable(String)) }
def cardholder; end
sig { params(_cardholder: T.nilable(String)).returns(T.nilable(String)) }
def cardholder=(_cardholder); end
# Only return authorizations that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Issuing::AuthorizationService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Issuing::AuthorizationService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Issuing::AuthorizationService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(card: T.nilable(String), cardholder: T.nilable(String), created: T.nilable(T.any(::Stripe::Issuing::AuthorizationService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
card: nil,
cardholder: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, metadata: nil); end
end
class ApproveParams < Stripe::RequestParams
# If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request).
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(amount: T.nilable(Integer), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(amount: nil, expand: nil, metadata: nil); end
end
class DeclineParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, metadata: nil); end
end
# [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).
sig {
params(authorization: String, params: T.any(::Stripe::Issuing::AuthorizationService::ApproveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
}
def approve(authorization, params = {}, opts = {}); end
# [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).
sig {
params(authorization: String, params: T.any(::Stripe::Issuing::AuthorizationService::DeclineParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
}
def decline(authorization, params = {}, opts = {}); end
# Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::AuthorizationService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves an Issuing Authorization object.
sig {
params(authorization: String, params: T.any(::Stripe::Issuing::AuthorizationService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
}
def retrieve(authorization, params = {}, opts = {}); end
# Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(authorization: String, params: T.any(::Stripe::Issuing::AuthorizationService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
}
def update(authorization, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
class CardService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return cards belonging to the Cardholder with the provided ID.
sig { returns(T.nilable(String)) }
def cardholder; end
sig { params(_cardholder: T.nilable(String)).returns(T.nilable(String)) }
def cardholder=(_cardholder); end
# Only return cards that were issued during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Issuing::CardService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Issuing::CardService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Issuing::CardService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Only return cards that have the given expiration month.
sig { returns(T.nilable(Integer)) }
def exp_month; end
sig { params(_exp_month: T.nilable(Integer)).returns(T.nilable(Integer)) }
def exp_month=(_exp_month); end
# Only return cards that have the given expiration year.
sig { returns(T.nilable(Integer)) }
def exp_year; end
sig { params(_exp_year: T.nilable(Integer)).returns(T.nilable(Integer)) }
def exp_year=(_exp_year); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Only return cards that have the given last four digits.
sig { returns(T.nilable(String)) }
def last4; end
sig { params(_last4: T.nilable(String)).returns(T.nilable(String)) }
def last4=(_last4); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Attribute for param field personalization_design
sig { returns(T.nilable(String)) }
def personalization_design; end
sig { params(_personalization_design: T.nilable(String)).returns(T.nilable(String)) }
def personalization_design=(_personalization_design); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return cards that have the given status. One of `active`, `inactive`, or `canceled`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# Only return cards that have the given type. One of `virtual` or `physical`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(cardholder: T.nilable(String), created: T.nilable(T.any(::Stripe::Issuing::CardService::ListParams::Created, Integer)), ending_before: T.nilable(String), exp_month: T.nilable(Integer), exp_year: T.nilable(Integer), expand: T.nilable(T::Array[String]), last4: T.nilable(String), limit: T.nilable(Integer), personalization_design: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
cardholder: nil,
created: nil,
ending_before: nil,
exp_month: nil,
exp_year: nil,
expand: nil,
last4: nil,
limit: nil,
personalization_design: nil,
starting_after: nil,
status: nil,
type: nil
); end
end
class CreateParams < Stripe::RequestParams
class Pin < Stripe::RequestParams
# The card's desired new PIN, encrypted under Stripe's public key.
sig { returns(T.nilable(String)) }
def encrypted_number; end
sig { params(_encrypted_number: T.nilable(String)).returns(T.nilable(String)) }
def encrypted_number=(_encrypted_number); end
sig { params(encrypted_number: T.nilable(String)).void }
def initialize(encrypted_number: nil); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(String) }
def city; end
sig { params(_city: String).returns(String) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(String) }
def line1; end
sig { params(_line1: String).returns(String) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(String) }
def postal_code; end
sig { params(_postal_code: String).returns(String) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: String, country: String, line1: String, line2: T.nilable(String), postal_code: String, state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressValidation < Stripe::RequestParams
# The address validation capabilities to use.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
sig { params(mode: String).void }
def initialize(mode: nil); end
end
class Customs < Stripe::RequestParams
# The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.
sig { returns(T.nilable(String)) }
def eori_number; end
sig { params(_eori_number: T.nilable(String)).returns(T.nilable(String)) }
def eori_number=(_eori_number); end
sig { params(eori_number: T.nilable(String)).void }
def initialize(eori_number: nil); end
end
# The address that the card is shipped to.
sig { returns(::Stripe::Issuing::CardService::CreateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::Issuing::CardService::CreateParams::Shipping::Address).returns(::Stripe::Issuing::CardService::CreateParams::Shipping::Address)
}
def address=(_address); end
# Address validation settings.
sig {
returns(T.nilable(::Stripe::Issuing::CardService::CreateParams::Shipping::AddressValidation))
}
def address_validation; end
sig {
params(_address_validation: T.nilable(::Stripe::Issuing::CardService::CreateParams::Shipping::AddressValidation)).returns(T.nilable(::Stripe::Issuing::CardService::CreateParams::Shipping::AddressValidation))
}
def address_validation=(_address_validation); end
# Customs information for the shipment.
sig {
returns(T.nilable(::Stripe::Issuing::CardService::CreateParams::Shipping::Customs))
}
def customs; end
sig {
params(_customs: T.nilable(::Stripe::Issuing::CardService::CreateParams::Shipping::Customs)).returns(T.nilable(::Stripe::Issuing::CardService::CreateParams::Shipping::Customs))
}
def customs=(_customs); end
# The name printed on the shipping label when shipping the card.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Phone number of the recipient of the shipment.
sig { returns(T.nilable(String)) }
def phone_number; end
sig { params(_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def phone_number=(_phone_number); end
# Whether a signature is required for card delivery.
sig { returns(T.nilable(T::Boolean)) }
def require_signature; end
sig { params(_require_signature: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def require_signature=(_require_signature); end
# Shipment service.
sig { returns(T.nilable(String)) }
def service; end
sig { params(_service: T.nilable(String)).returns(T.nilable(String)) }
def service=(_service); end
# Packaging options.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(address: ::Stripe::Issuing::CardService::CreateParams::Shipping::Address, address_validation: T.nilable(::Stripe::Issuing::CardService::CreateParams::Shipping::AddressValidation), customs: T.nilable(::Stripe::Issuing::CardService::CreateParams::Shipping::Customs), name: String, phone_number: T.nilable(String), require_signature: T.nilable(T::Boolean), service: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
address: nil,
address_validation: nil,
customs: nil,
name: nil,
phone_number: nil,
require_signature: nil,
service: nil,
type: nil
); end
end
class SpendingControls < Stripe::RequestParams
class SpendingLimit < Stripe::RequestParams
# Maximum amount allowed to spend per interval.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
sig { returns(T.nilable(T::Array[String])) }
def categories; end
sig {
params(_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def categories=(_categories); end
# Interval (or event) to which the amount applies.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig {
params(amount: Integer, categories: T.nilable(T::Array[String]), interval: String).void
}
def initialize(amount: nil, categories: nil, interval: nil); end
end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
sig { returns(T.nilable(T::Array[String])) }
def allowed_categories; end
sig {
params(_allowed_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_categories=(_allowed_categories); end
# Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def allowed_merchant_countries; end
sig {
params(_allowed_merchant_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_merchant_countries=(_allowed_merchant_countries); end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
sig { returns(T.nilable(T::Array[String])) }
def blocked_categories; end
sig {
params(_blocked_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def blocked_categories=(_blocked_categories); end
# Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def blocked_merchant_countries; end
sig {
params(_blocked_merchant_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def blocked_merchant_countries=(_blocked_merchant_countries); end
# Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).
sig {
returns(T.nilable(T::Array[::Stripe::Issuing::CardService::CreateParams::SpendingControls::SpendingLimit]))
}
def spending_limits; end
sig {
params(_spending_limits: T.nilable(T::Array[::Stripe::Issuing::CardService::CreateParams::SpendingControls::SpendingLimit])).returns(T.nilable(T::Array[::Stripe::Issuing::CardService::CreateParams::SpendingControls::SpendingLimit]))
}
def spending_limits=(_spending_limits); end
sig {
params(allowed_categories: T.nilable(T::Array[String]), allowed_merchant_countries: T.nilable(T::Array[String]), blocked_categories: T.nilable(T::Array[String]), blocked_merchant_countries: T.nilable(T::Array[String]), spending_limits: T.nilable(T::Array[::Stripe::Issuing::CardService::CreateParams::SpendingControls::SpendingLimit])).void
}
def initialize(
allowed_categories: nil,
allowed_merchant_countries: nil,
blocked_categories: nil,
blocked_merchant_countries: nil,
spending_limits: nil
); end
end
# The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated.
sig { returns(T.nilable(String)) }
def cardholder; end
sig { params(_cardholder: T.nilable(String)).returns(T.nilable(String)) }
def cardholder=(_cardholder); end
# The currency for the card.
sig { returns(String) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The desired expiration month (1-12) for this card if [specifying a custom expiration date](/issuing/cards/virtual/issue-cards?testing-method=with-code#exp-dates).
sig { returns(T.nilable(Integer)) }
def exp_month; end
sig { params(_exp_month: T.nilable(Integer)).returns(T.nilable(Integer)) }
def exp_month=(_exp_month); end
# The desired 4-digit expiration year for this card if [specifying a custom expiration date](/issuing/cards/virtual/issue-cards?testing-method=with-code#exp-dates).
sig { returns(T.nilable(Integer)) }
def exp_year; end
sig { params(_exp_year: T.nilable(Integer)).returns(T.nilable(Integer)) }
def exp_year=(_exp_year); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The new financial account ID the card will be associated with. This field allows a card to be reassigned to a different financial account.
sig { returns(T.nilable(String)) }
def financial_account; end
sig { params(_financial_account: T.nilable(String)).returns(T.nilable(String)) }
def financial_account=(_financial_account); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The personalization design object belonging to this card.
sig { returns(T.nilable(String)) }
def personalization_design; end
sig { params(_personalization_design: T.nilable(String)).returns(T.nilable(String)) }
def personalization_design=(_personalization_design); end
# The desired PIN for this card.
sig { returns(T.nilable(::Stripe::Issuing::CardService::CreateParams::Pin)) }
def pin; end
sig {
params(_pin: T.nilable(::Stripe::Issuing::CardService::CreateParams::Pin)).returns(T.nilable(::Stripe::Issuing::CardService::CreateParams::Pin))
}
def pin=(_pin); end
# The card this is meant to be a replacement for (if any).
sig { returns(T.nilable(String)) }
def replacement_for; end
sig { params(_replacement_for: T.nilable(String)).returns(T.nilable(String)) }
def replacement_for=(_replacement_for); end
# If `replacement_for` is specified, this should indicate why that card is being replaced.
sig { returns(T.nilable(String)) }
def replacement_reason; end
sig { params(_replacement_reason: T.nilable(String)).returns(T.nilable(String)) }
def replacement_reason=(_replacement_reason); end
# The second line to print on the card. Max length: 24 characters.
sig { returns(T.nilable(String)) }
def second_line; end
sig { params(_second_line: T.nilable(String)).returns(T.nilable(String)) }
def second_line=(_second_line); end
# The address where the card will be shipped.
sig { returns(T.nilable(::Stripe::Issuing::CardService::CreateParams::Shipping)) }
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::Issuing::CardService::CreateParams::Shipping)).returns(T.nilable(::Stripe::Issuing::CardService::CreateParams::Shipping))
}
def shipping=(_shipping); end
# Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
sig { returns(T.nilable(::Stripe::Issuing::CardService::CreateParams::SpendingControls)) }
def spending_controls; end
sig {
params(_spending_controls: T.nilable(::Stripe::Issuing::CardService::CreateParams::SpendingControls)).returns(T.nilable(::Stripe::Issuing::CardService::CreateParams::SpendingControls))
}
def spending_controls=(_spending_controls); end
# Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# The type of card to issue. Possible values are `physical` or `virtual`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(cardholder: T.nilable(String), currency: String, exp_month: T.nilable(Integer), exp_year: T.nilable(Integer), expand: T.nilable(T::Array[String]), financial_account: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), personalization_design: T.nilable(String), pin: T.nilable(::Stripe::Issuing::CardService::CreateParams::Pin), replacement_for: T.nilable(String), replacement_reason: T.nilable(String), second_line: T.nilable(String), shipping: T.nilable(::Stripe::Issuing::CardService::CreateParams::Shipping), spending_controls: T.nilable(::Stripe::Issuing::CardService::CreateParams::SpendingControls), status: T.nilable(String), type: String).void
}
def initialize(
cardholder: nil,
currency: nil,
exp_month: nil,
exp_year: nil,
expand: nil,
financial_account: nil,
metadata: nil,
personalization_design: nil,
pin: nil,
replacement_for: nil,
replacement_reason: nil,
second_line: nil,
shipping: nil,
spending_controls: nil,
status: nil,
type: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Pin < Stripe::RequestParams
# The card's desired new PIN, encrypted under Stripe's public key.
sig { returns(T.nilable(String)) }
def encrypted_number; end
sig { params(_encrypted_number: T.nilable(String)).returns(T.nilable(String)) }
def encrypted_number=(_encrypted_number); end
sig { params(encrypted_number: T.nilable(String)).void }
def initialize(encrypted_number: nil); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(String) }
def city; end
sig { params(_city: String).returns(String) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(String) }
def line1; end
sig { params(_line1: String).returns(String) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(String) }
def postal_code; end
sig { params(_postal_code: String).returns(String) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: String, country: String, line1: String, line2: T.nilable(String), postal_code: String, state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressValidation < Stripe::RequestParams
# The address validation capabilities to use.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
sig { params(mode: String).void }
def initialize(mode: nil); end
end
class Customs < Stripe::RequestParams
# The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.
sig { returns(T.nilable(String)) }
def eori_number; end
sig { params(_eori_number: T.nilable(String)).returns(T.nilable(String)) }
def eori_number=(_eori_number); end
sig { params(eori_number: T.nilable(String)).void }
def initialize(eori_number: nil); end
end
# The address that the card is shipped to.
sig { returns(::Stripe::Issuing::CardService::UpdateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::Issuing::CardService::UpdateParams::Shipping::Address).returns(::Stripe::Issuing::CardService::UpdateParams::Shipping::Address)
}
def address=(_address); end
# Address validation settings.
sig {
returns(T.nilable(::Stripe::Issuing::CardService::UpdateParams::Shipping::AddressValidation))
}
def address_validation; end
sig {
params(_address_validation: T.nilable(::Stripe::Issuing::CardService::UpdateParams::Shipping::AddressValidation)).returns(T.nilable(::Stripe::Issuing::CardService::UpdateParams::Shipping::AddressValidation))
}
def address_validation=(_address_validation); end
# Customs information for the shipment.
sig {
returns(T.nilable(::Stripe::Issuing::CardService::UpdateParams::Shipping::Customs))
}
def customs; end
sig {
params(_customs: T.nilable(::Stripe::Issuing::CardService::UpdateParams::Shipping::Customs)).returns(T.nilable(::Stripe::Issuing::CardService::UpdateParams::Shipping::Customs))
}
def customs=(_customs); end
# The name printed on the shipping label when shipping the card.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Phone number of the recipient of the shipment.
sig { returns(T.nilable(String)) }
def phone_number; end
sig { params(_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def phone_number=(_phone_number); end
# Whether a signature is required for card delivery.
sig { returns(T.nilable(T::Boolean)) }
def require_signature; end
sig { params(_require_signature: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def require_signature=(_require_signature); end
# Shipment service.
sig { returns(T.nilable(String)) }
def service; end
sig { params(_service: T.nilable(String)).returns(T.nilable(String)) }
def service=(_service); end
# Packaging options.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(address: ::Stripe::Issuing::CardService::UpdateParams::Shipping::Address, address_validation: T.nilable(::Stripe::Issuing::CardService::UpdateParams::Shipping::AddressValidation), customs: T.nilable(::Stripe::Issuing::CardService::UpdateParams::Shipping::Customs), name: String, phone_number: T.nilable(String), require_signature: T.nilable(T::Boolean), service: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
address: nil,
address_validation: nil,
customs: nil,
name: nil,
phone_number: nil,
require_signature: nil,
service: nil,
type: nil
); end
end
class SpendingControls < Stripe::RequestParams
class SpendingLimit < Stripe::RequestParams
# Maximum amount allowed to spend per interval.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
sig { returns(T.nilable(T::Array[String])) }
def categories; end
sig {
params(_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def categories=(_categories); end
# Interval (or event) to which the amount applies.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig {
params(amount: Integer, categories: T.nilable(T::Array[String]), interval: String).void
}
def initialize(amount: nil, categories: nil, interval: nil); end
end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
sig { returns(T.nilable(T::Array[String])) }
def allowed_categories; end
sig {
params(_allowed_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_categories=(_allowed_categories); end
# Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def allowed_merchant_countries; end
sig {
params(_allowed_merchant_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_merchant_countries=(_allowed_merchant_countries); end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
sig { returns(T.nilable(T::Array[String])) }
def blocked_categories; end
sig {
params(_blocked_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def blocked_categories=(_blocked_categories); end
# Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def blocked_merchant_countries; end
sig {
params(_blocked_merchant_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def blocked_merchant_countries=(_blocked_merchant_countries); end
# Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).
sig {
returns(T.nilable(T::Array[::Stripe::Issuing::CardService::UpdateParams::SpendingControls::SpendingLimit]))
}
def spending_limits; end
sig {
params(_spending_limits: T.nilable(T::Array[::Stripe::Issuing::CardService::UpdateParams::SpendingControls::SpendingLimit])).returns(T.nilable(T::Array[::Stripe::Issuing::CardService::UpdateParams::SpendingControls::SpendingLimit]))
}
def spending_limits=(_spending_limits); end
sig {
params(allowed_categories: T.nilable(T::Array[String]), allowed_merchant_countries: T.nilable(T::Array[String]), blocked_categories: T.nilable(T::Array[String]), blocked_merchant_countries: T.nilable(T::Array[String]), spending_limits: T.nilable(T::Array[::Stripe::Issuing::CardService::UpdateParams::SpendingControls::SpendingLimit])).void
}
def initialize(
allowed_categories: nil,
allowed_merchant_countries: nil,
blocked_categories: nil,
blocked_merchant_countries: nil,
spending_limits: nil
); end
end
# Reason why the `status` of this card is `canceled`.
sig { returns(T.nilable(String)) }
def cancellation_reason; end
sig { params(_cancellation_reason: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_reason=(_cancellation_reason); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Attribute for param field personalization_design
sig { returns(T.nilable(String)) }
def personalization_design; end
sig { params(_personalization_design: T.nilable(String)).returns(T.nilable(String)) }
def personalization_design=(_personalization_design); end
# The desired new PIN for this card.
sig { returns(T.nilable(::Stripe::Issuing::CardService::UpdateParams::Pin)) }
def pin; end
sig {
params(_pin: T.nilable(::Stripe::Issuing::CardService::UpdateParams::Pin)).returns(T.nilable(::Stripe::Issuing::CardService::UpdateParams::Pin))
}
def pin=(_pin); end
# Updated shipping information for the card.
sig { returns(T.nilable(::Stripe::Issuing::CardService::UpdateParams::Shipping)) }
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::Issuing::CardService::UpdateParams::Shipping)).returns(T.nilable(::Stripe::Issuing::CardService::UpdateParams::Shipping))
}
def shipping=(_shipping); end
# Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
sig { returns(T.nilable(::Stripe::Issuing::CardService::UpdateParams::SpendingControls)) }
def spending_controls; end
sig {
params(_spending_controls: T.nilable(::Stripe::Issuing::CardService::UpdateParams::SpendingControls)).returns(T.nilable(::Stripe::Issuing::CardService::UpdateParams::SpendingControls))
}
def spending_controls=(_spending_controls); end
# Dictates whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(cancellation_reason: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), personalization_design: T.nilable(String), pin: T.nilable(::Stripe::Issuing::CardService::UpdateParams::Pin), shipping: T.nilable(::Stripe::Issuing::CardService::UpdateParams::Shipping), spending_controls: T.nilable(::Stripe::Issuing::CardService::UpdateParams::SpendingControls), status: T.nilable(String)).void
}
def initialize(
cancellation_reason: nil,
expand: nil,
metadata: nil,
personalization_design: nil,
pin: nil,
shipping: nil,
spending_controls: nil,
status: nil
); end
end
# Creates an Issuing Card object.
sig {
params(params: T.any(::Stripe::Issuing::CardService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Card)
}
def create(params = {}, opts = {}); end
# Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::CardService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves an Issuing Card object.
sig {
params(card: String, params: T.any(::Stripe::Issuing::CardService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Card)
}
def retrieve(card, params = {}, opts = {}); end
# Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(card: String, params: T.any(::Stripe::Issuing::CardService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Card)
}
def update(card, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
class CardholderService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return cardholders that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Issuing::CardholderService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Issuing::CardholderService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Issuing::CardholderService::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return cardholders that have the given email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return cardholders that have the given phone number.
sig { returns(T.nilable(String)) }
def phone_number; end
sig { params(_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def phone_number=(_phone_number); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# Only return cardholders that have the given type. One of `individual` or `company`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(created: T.nilable(T.any(::Stripe::Issuing::CardholderService::ListParams::Created, Integer)), email: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), phone_number: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
created: nil,
email: nil,
ending_before: nil,
expand: nil,
limit: nil,
phone_number: nil,
starting_after: nil,
status: nil,
type: nil
); end
end
class CreateParams < Stripe::RequestParams
class Billing < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(String) }
def city; end
sig { params(_city: String).returns(String) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(String) }
def line1; end
sig { params(_line1: String).returns(String) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(String) }
def postal_code; end
sig { params(_postal_code: String).returns(String) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: String, country: String, line1: String, line2: T.nilable(String), postal_code: String, state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The cardholder’s billing address.
sig { returns(::Stripe::Issuing::CardholderService::CreateParams::Billing::Address) }
def address; end
sig {
params(_address: ::Stripe::Issuing::CardholderService::CreateParams::Billing::Address).returns(::Stripe::Issuing::CardholderService::CreateParams::Billing::Address)
}
def address=(_address); end
sig {
params(address: ::Stripe::Issuing::CardholderService::CreateParams::Billing::Address).void
}
def initialize(address: nil); end
end
class Company < Stripe::RequestParams
# The entity's business ID number.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig { params(tax_id: T.nilable(String)).void }
def initialize(tax_id: nil); end
end
class Individual < Stripe::RequestParams
class CardIssuing < Stripe::RequestParams
class UserTermsAcceptance < Stripe::RequestParams
# The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the cardholder accepted the Authorized User Terms.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program.
sig {
returns(T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::CardIssuing::UserTermsAcceptance))
}
def user_terms_acceptance; end
sig {
params(_user_terms_acceptance: T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::CardIssuing::UserTermsAcceptance)).returns(T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::CardIssuing::UserTermsAcceptance))
}
def user_terms_acceptance=(_user_terms_acceptance); end
sig {
params(user_terms_acceptance: T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::CardIssuing::UserTermsAcceptance)).void
}
def initialize(user_terms_acceptance: nil); end
end
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Verification < Stripe::RequestParams
class Document < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# An identifying document, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::Verification::Document)).returns(T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::Verification::Document))
}
def document=(_document); end
sig {
params(document: T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::Verification::Document)).void
}
def initialize(document: nil); end
end
# Information related to the card_issuing program for this cardholder.
sig {
returns(T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::CardIssuing))
}
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::CardIssuing)).returns(T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::CardIssuing))
}
def card_issuing=(_card_issuing); end
# The date of birth of this cardholder. Cardholders must be older than 13 years old.
sig {
returns(T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::Dob))
}
def dob; end
sig {
params(_dob: T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::Dob)).returns(T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::Dob))
}
def dob=(_dob); end
# The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
sig { returns(T.nilable(String)) }
def first_name; end
sig { params(_first_name: T.nilable(String)).returns(T.nilable(String)) }
def first_name=(_first_name); end
# The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
sig { returns(T.nilable(String)) }
def last_name; end
sig { params(_last_name: T.nilable(String)).returns(T.nilable(String)) }
def last_name=(_last_name); end
# Government-issued ID document for this cardholder.
sig {
returns(T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::Verification))
}
def verification; end
sig {
params(_verification: T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::Verification)).returns(T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::Verification))
}
def verification=(_verification); end
sig {
params(card_issuing: T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::CardIssuing), dob: T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::Dob), first_name: T.nilable(String), last_name: T.nilable(String), verification: T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual::Verification)).void
}
def initialize(
card_issuing: nil,
dob: nil,
first_name: nil,
last_name: nil,
verification: nil
); end
end
class SpendingControls < Stripe::RequestParams
class SpendingLimit < Stripe::RequestParams
# Maximum amount allowed to spend per interval.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
sig { returns(T.nilable(T::Array[String])) }
def categories; end
sig {
params(_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def categories=(_categories); end
# Interval (or event) to which the amount applies.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig {
params(amount: Integer, categories: T.nilable(T::Array[String]), interval: String).void
}
def initialize(amount: nil, categories: nil, interval: nil); end
end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
sig { returns(T.nilable(T::Array[String])) }
def allowed_categories; end
sig {
params(_allowed_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_categories=(_allowed_categories); end
# Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def allowed_merchant_countries; end
sig {
params(_allowed_merchant_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_merchant_countries=(_allowed_merchant_countries); end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
sig { returns(T.nilable(T::Array[String])) }
def blocked_categories; end
sig {
params(_blocked_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def blocked_categories=(_blocked_categories); end
# Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def blocked_merchant_countries; end
sig {
params(_blocked_merchant_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def blocked_merchant_countries=(_blocked_merchant_countries); end
# Limit spending with amount-based rules that apply across this cardholder's cards.
sig {
returns(T.nilable(T::Array[::Stripe::Issuing::CardholderService::CreateParams::SpendingControls::SpendingLimit]))
}
def spending_limits; end
sig {
params(_spending_limits: T.nilable(T::Array[::Stripe::Issuing::CardholderService::CreateParams::SpendingControls::SpendingLimit])).returns(T.nilable(T::Array[::Stripe::Issuing::CardholderService::CreateParams::SpendingControls::SpendingLimit]))
}
def spending_limits=(_spending_limits); end
# Currency of amounts within `spending_limits`. Defaults to your merchant country's currency.
sig { returns(T.nilable(String)) }
def spending_limits_currency; end
sig { params(_spending_limits_currency: T.nilable(String)).returns(T.nilable(String)) }
def spending_limits_currency=(_spending_limits_currency); end
sig {
params(allowed_categories: T.nilable(T::Array[String]), allowed_merchant_countries: T.nilable(T::Array[String]), blocked_categories: T.nilable(T::Array[String]), blocked_merchant_countries: T.nilable(T::Array[String]), spending_limits: T.nilable(T::Array[::Stripe::Issuing::CardholderService::CreateParams::SpendingControls::SpendingLimit]), spending_limits_currency: T.nilable(String)).void
}
def initialize(
allowed_categories: nil,
allowed_merchant_countries: nil,
blocked_categories: nil,
blocked_merchant_countries: nil,
spending_limits: nil,
spending_limits_currency: nil
); end
end
# The cardholder's billing address.
sig { returns(::Stripe::Issuing::CardholderService::CreateParams::Billing) }
def billing; end
sig {
params(_billing: ::Stripe::Issuing::CardholderService::CreateParams::Billing).returns(::Stripe::Issuing::CardholderService::CreateParams::Billing)
}
def billing=(_billing); end
# Additional information about a `company` cardholder.
sig { returns(T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Company)) }
def company; end
sig {
params(_company: T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Company)).returns(T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Company))
}
def company=(_company); end
# The cardholder's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Additional information about an `individual` cardholder.
sig { returns(T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual)) }
def individual; end
sig {
params(_individual: T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual)).returns(T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual))
}
def individual=(_individual); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards.
# While phone number is optional if the cardholder will not be creating EU cards, note that this cardholder will not be eligible for 3DS without a phone number. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.
sig { returns(T.nilable(String)) }
def phone_number; end
sig { params(_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def phone_number=(_phone_number); end
# The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.
# This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
sig {
params(_preferred_locales: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def preferred_locales=(_preferred_locales); end
# Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
sig {
returns(T.nilable(::Stripe::Issuing::CardholderService::CreateParams::SpendingControls))
}
def spending_controls; end
sig {
params(_spending_controls: T.nilable(::Stripe::Issuing::CardholderService::CreateParams::SpendingControls)).returns(T.nilable(::Stripe::Issuing::CardholderService::CreateParams::SpendingControls))
}
def spending_controls=(_spending_controls); end
# Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(billing: ::Stripe::Issuing::CardholderService::CreateParams::Billing, company: T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Company), email: T.nilable(String), expand: T.nilable(T::Array[String]), individual: T.nilable(::Stripe::Issuing::CardholderService::CreateParams::Individual), metadata: T.nilable(T::Hash[String, String]), name: String, phone_number: T.nilable(String), preferred_locales: T.nilable(T::Array[String]), spending_controls: T.nilable(::Stripe::Issuing::CardholderService::CreateParams::SpendingControls), status: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
billing: nil,
company: nil,
email: nil,
expand: nil,
individual: nil,
metadata: nil,
name: nil,
phone_number: nil,
preferred_locales: nil,
spending_controls: nil,
status: nil,
type: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Billing < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(String) }
def city; end
sig { params(_city: String).returns(String) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(String) }
def line1; end
sig { params(_line1: String).returns(String) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(String) }
def postal_code; end
sig { params(_postal_code: String).returns(String) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: String, country: String, line1: String, line2: T.nilable(String), postal_code: String, state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The cardholder’s billing address.
sig { returns(::Stripe::Issuing::CardholderService::UpdateParams::Billing::Address) }
def address; end
sig {
params(_address: ::Stripe::Issuing::CardholderService::UpdateParams::Billing::Address).returns(::Stripe::Issuing::CardholderService::UpdateParams::Billing::Address)
}
def address=(_address); end
sig {
params(address: ::Stripe::Issuing::CardholderService::UpdateParams::Billing::Address).void
}
def initialize(address: nil); end
end
class Company < Stripe::RequestParams
# The entity's business ID number.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig { params(tax_id: T.nilable(String)).void }
def initialize(tax_id: nil); end
end
class Individual < Stripe::RequestParams
class CardIssuing < Stripe::RequestParams
class UserTermsAcceptance < Stripe::RequestParams
# The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the cardholder accepted the Authorized User Terms.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program.
sig {
returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::CardIssuing::UserTermsAcceptance))
}
def user_terms_acceptance; end
sig {
params(_user_terms_acceptance: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::CardIssuing::UserTermsAcceptance)).returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::CardIssuing::UserTermsAcceptance))
}
def user_terms_acceptance=(_user_terms_acceptance); end
sig {
params(user_terms_acceptance: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::CardIssuing::UserTermsAcceptance)).void
}
def initialize(user_terms_acceptance: nil); end
end
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Verification < Stripe::RequestParams
class Document < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# An identifying document, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::Verification::Document)).returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::Verification::Document))
}
def document=(_document); end
sig {
params(document: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::Verification::Document)).void
}
def initialize(document: nil); end
end
# Information related to the card_issuing program for this cardholder.
sig {
returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::CardIssuing))
}
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::CardIssuing)).returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::CardIssuing))
}
def card_issuing=(_card_issuing); end
# The date of birth of this cardholder. Cardholders must be older than 13 years old.
sig {
returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::Dob))
}
def dob; end
sig {
params(_dob: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::Dob)).returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::Dob))
}
def dob=(_dob); end
# The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
sig { returns(T.nilable(String)) }
def first_name; end
sig { params(_first_name: T.nilable(String)).returns(T.nilable(String)) }
def first_name=(_first_name); end
# The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
sig { returns(T.nilable(String)) }
def last_name; end
sig { params(_last_name: T.nilable(String)).returns(T.nilable(String)) }
def last_name=(_last_name); end
# Government-issued ID document for this cardholder.
sig {
returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::Verification))
}
def verification; end
sig {
params(_verification: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::Verification)).returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::Verification))
}
def verification=(_verification); end
sig {
params(card_issuing: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::CardIssuing), dob: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::Dob), first_name: T.nilable(String), last_name: T.nilable(String), verification: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual::Verification)).void
}
def initialize(
card_issuing: nil,
dob: nil,
first_name: nil,
last_name: nil,
verification: nil
); end
end
class SpendingControls < Stripe::RequestParams
class SpendingLimit < Stripe::RequestParams
# Maximum amount allowed to spend per interval.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
sig { returns(T.nilable(T::Array[String])) }
def categories; end
sig {
params(_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def categories=(_categories); end
# Interval (or event) to which the amount applies.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig {
params(amount: Integer, categories: T.nilable(T::Array[String]), interval: String).void
}
def initialize(amount: nil, categories: nil, interval: nil); end
end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
sig { returns(T.nilable(T::Array[String])) }
def allowed_categories; end
sig {
params(_allowed_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_categories=(_allowed_categories); end
# Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def allowed_merchant_countries; end
sig {
params(_allowed_merchant_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def allowed_merchant_countries=(_allowed_merchant_countries); end
# Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
sig { returns(T.nilable(T::Array[String])) }
def blocked_categories; end
sig {
params(_blocked_categories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def blocked_categories=(_blocked_categories); end
# Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.
sig { returns(T.nilable(T::Array[String])) }
def blocked_merchant_countries; end
sig {
params(_blocked_merchant_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def blocked_merchant_countries=(_blocked_merchant_countries); end
# Limit spending with amount-based rules that apply across this cardholder's cards.
sig {
returns(T.nilable(T::Array[::Stripe::Issuing::CardholderService::UpdateParams::SpendingControls::SpendingLimit]))
}
def spending_limits; end
sig {
params(_spending_limits: T.nilable(T::Array[::Stripe::Issuing::CardholderService::UpdateParams::SpendingControls::SpendingLimit])).returns(T.nilable(T::Array[::Stripe::Issuing::CardholderService::UpdateParams::SpendingControls::SpendingLimit]))
}
def spending_limits=(_spending_limits); end
# Currency of amounts within `spending_limits`. Defaults to your merchant country's currency.
sig { returns(T.nilable(String)) }
def spending_limits_currency; end
sig { params(_spending_limits_currency: T.nilable(String)).returns(T.nilable(String)) }
def spending_limits_currency=(_spending_limits_currency); end
sig {
params(allowed_categories: T.nilable(T::Array[String]), allowed_merchant_countries: T.nilable(T::Array[String]), blocked_categories: T.nilable(T::Array[String]), blocked_merchant_countries: T.nilable(T::Array[String]), spending_limits: T.nilable(T::Array[::Stripe::Issuing::CardholderService::UpdateParams::SpendingControls::SpendingLimit]), spending_limits_currency: T.nilable(String)).void
}
def initialize(
allowed_categories: nil,
allowed_merchant_countries: nil,
blocked_categories: nil,
blocked_merchant_countries: nil,
spending_limits: nil,
spending_limits_currency: nil
); end
end
# The cardholder's billing address.
sig { returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Billing)) }
def billing; end
sig {
params(_billing: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Billing)).returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Billing))
}
def billing=(_billing); end
# Additional information about a `company` cardholder.
sig { returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Company)) }
def company; end
sig {
params(_company: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Company)).returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Company))
}
def company=(_company); end
# The cardholder's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Additional information about an `individual` cardholder.
sig { returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual)) }
def individual; end
sig {
params(_individual: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual)).returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual))
}
def individual=(_individual); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure) for more details.
sig { returns(T.nilable(String)) }
def phone_number; end
sig { params(_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def phone_number=(_phone_number); end
# The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.
# This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.
sig { returns(T.nilable(T::Array[String])) }
def preferred_locales; end
sig {
params(_preferred_locales: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def preferred_locales=(_preferred_locales); end
# Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
sig {
returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::SpendingControls))
}
def spending_controls; end
sig {
params(_spending_controls: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::SpendingControls)).returns(T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::SpendingControls))
}
def spending_controls=(_spending_controls); end
# Specifies whether to permit authorizations on this cardholder's cards.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(billing: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Billing), company: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Company), email: T.nilable(String), expand: T.nilable(T::Array[String]), individual: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::Individual), metadata: T.nilable(T::Hash[String, String]), phone_number: T.nilable(String), preferred_locales: T.nilable(T::Array[String]), spending_controls: T.nilable(::Stripe::Issuing::CardholderService::UpdateParams::SpendingControls), status: T.nilable(String)).void
}
def initialize(
billing: nil,
company: nil,
email: nil,
expand: nil,
individual: nil,
metadata: nil,
phone_number: nil,
preferred_locales: nil,
spending_controls: nil,
status: nil
); end
end
# Creates a new Issuing Cardholder object that can be issued cards.
sig {
params(params: T.any(::Stripe::Issuing::CardholderService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Cardholder)
}
def create(params = {}, opts = {}); end
# Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::CardholderService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves an Issuing Cardholder object.
sig {
params(cardholder: String, params: T.any(::Stripe::Issuing::CardholderService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Cardholder)
}
def retrieve(cardholder, params = {}, opts = {}); end
# Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(cardholder: String, params: T.any(::Stripe::Issuing::CardholderService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Cardholder)
}
def update(cardholder, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
class CreditUnderwritingRecordService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class CorrectParams < Stripe::RequestParams
class Application < Stripe::RequestParams
# The channel through which the applicant has submitted their application. Defaults to `online`.
sig { returns(T.nilable(String)) }
def application_method; end
sig { params(_application_method: T.nilable(String)).returns(T.nilable(String)) }
def application_method=(_application_method); end
# Scope of demand made by the applicant.
sig { returns(String) }
def purpose; end
sig { params(_purpose: String).returns(String) }
def purpose=(_purpose); end
# Date when the applicant submitted their application.
sig { returns(Integer) }
def submitted_at; end
sig { params(_submitted_at: Integer).returns(Integer) }
def submitted_at=(_submitted_at); end
sig {
params(application_method: T.nilable(String), purpose: String, submitted_at: Integer).void
}
def initialize(application_method: nil, purpose: nil, submitted_at: nil); end
end
class CreditUser < Stripe::RequestParams
# Email of the applicant or accountholder.
sig { returns(String) }
def email; end
sig { params(_email: String).returns(String) }
def email=(_email); end
# Full name of the company or person.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(email: String, name: String).void }
def initialize(email: nil, name: nil); end
end
class Decision < Stripe::RequestParams
class ApplicationRejected < Stripe::RequestParams
# Details about the `reasons.other` when present.
sig { returns(T.nilable(String)) }
def reason_other_explanation; end
sig { params(_reason_other_explanation: T.nilable(String)).returns(T.nilable(String)) }
def reason_other_explanation=(_reason_other_explanation); end
# List of reasons why the application was rejected, up to 4 reasons, in order of importance.
sig { returns(T::Array[String]) }
def reasons; end
sig { params(_reasons: T::Array[String]).returns(T::Array[String]) }
def reasons=(_reasons); end
sig {
params(reason_other_explanation: T.nilable(String), reasons: T::Array[String]).void
}
def initialize(reason_other_explanation: nil, reasons: nil); end
end
class CreditLimitApproved < Stripe::RequestParams
# The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The currency of the credit approved, will default to the Account's Issuing currency.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
sig { params(amount: Integer, currency: T.nilable(String)).void }
def initialize(amount: nil, currency: nil); end
end
class CreditLimitDecreased < Stripe::RequestParams
# The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The currency of the credit approved, will default to the Account's Issuing currency.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Details about the `reasons.other` when present.
sig { returns(T.nilable(String)) }
def reason_other_explanation; end
sig { params(_reason_other_explanation: T.nilable(String)).returns(T.nilable(String)) }
def reason_other_explanation=(_reason_other_explanation); end
# List of reasons why the existing credit was decreased, up to 4 reasons, in order of importance.
sig { returns(T::Array[String]) }
def reasons; end
sig { params(_reasons: T::Array[String]).returns(T::Array[String]) }
def reasons=(_reasons); end
sig {
params(amount: Integer, currency: T.nilable(String), reason_other_explanation: T.nilable(String), reasons: T::Array[String]).void
}
def initialize(
amount: nil,
currency: nil,
reason_other_explanation: nil,
reasons: nil
); end
end
class CreditLineClosed < Stripe::RequestParams
# Details about the `reasons.other` when present.
sig { returns(T.nilable(String)) }
def reason_other_explanation; end
sig { params(_reason_other_explanation: T.nilable(String)).returns(T.nilable(String)) }
def reason_other_explanation=(_reason_other_explanation); end
# List of reasons why the credit line was closed, up to 4 reasons, in order of importance.
sig { returns(T::Array[String]) }
def reasons; end
sig { params(_reasons: T::Array[String]).returns(T::Array[String]) }
def reasons=(_reasons); end
sig {
params(reason_other_explanation: T.nilable(String), reasons: T::Array[String]).void
}
def initialize(reason_other_explanation: nil, reasons: nil); end
end
# Details about the application rejection.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision::ApplicationRejected))
}
def application_rejected; end
sig {
params(_application_rejected: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision::ApplicationRejected)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision::ApplicationRejected))
}
def application_rejected=(_application_rejected); end
# Details about the credit limit approved. An approved credit limit is required before you can set a `credit_limit_amount` in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy/)
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision::CreditLimitApproved))
}
def credit_limit_approved; end
sig {
params(_credit_limit_approved: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision::CreditLimitApproved)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision::CreditLimitApproved))
}
def credit_limit_approved=(_credit_limit_approved); end
# Details about the credit limit decreased.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision::CreditLimitDecreased))
}
def credit_limit_decreased; end
sig {
params(_credit_limit_decreased: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision::CreditLimitDecreased)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision::CreditLimitDecreased))
}
def credit_limit_decreased=(_credit_limit_decreased); end
# Details about the credit line closed.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision::CreditLineClosed))
}
def credit_line_closed; end
sig {
params(_credit_line_closed: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision::CreditLineClosed)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision::CreditLineClosed))
}
def credit_line_closed=(_credit_line_closed); end
# Outcome of the decision.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(application_rejected: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision::ApplicationRejected), credit_limit_approved: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision::CreditLimitApproved), credit_limit_decreased: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision::CreditLimitDecreased), credit_line_closed: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision::CreditLineClosed), type: String).void
}
def initialize(
application_rejected: nil,
credit_limit_approved: nil,
credit_limit_decreased: nil,
credit_line_closed: nil,
type: nil
); end
end
class UnderwritingException < Stripe::RequestParams
# Written explanation for the exception.
sig { returns(String) }
def explanation; end
sig { params(_explanation: String).returns(String) }
def explanation=(_explanation); end
# The decision before the exception was applied.
sig { returns(String) }
def original_decision_type; end
sig { params(_original_decision_type: String).returns(String) }
def original_decision_type=(_original_decision_type); end
sig { params(explanation: String, original_decision_type: String).void }
def initialize(explanation: nil, original_decision_type: nil); end
end
# Details about the application submission.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Application))
}
def application; end
sig {
params(_application: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Application)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Application))
}
def application=(_application); end
# Information about the company or person applying or holding the account.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::CreditUser))
}
def credit_user; end
sig {
params(_credit_user: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::CreditUser)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::CreditUser))
}
def credit_user=(_credit_user); end
# Date when a decision was made.
sig { returns(T.nilable(Integer)) }
def decided_at; end
sig { params(_decided_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def decided_at=(_decided_at); end
# Details about the decision.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision))
}
def decision; end
sig {
params(_decision: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision))
}
def decision=(_decision); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions). Optional if previously provided and no changes are needed.
sig { returns(T.nilable(String)) }
def regulatory_reporting_file; end
sig { params(_regulatory_reporting_file: T.nilable(String)).returns(T.nilable(String)) }
def regulatory_reporting_file=(_regulatory_reporting_file); end
# If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::UnderwritingException))
}
def underwriting_exception; end
sig {
params(_underwriting_exception: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::UnderwritingException)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::UnderwritingException))
}
def underwriting_exception=(_underwriting_exception); end
sig {
params(application: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Application), credit_user: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::CreditUser), decided_at: T.nilable(Integer), decision: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::Decision), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), regulatory_reporting_file: T.nilable(String), underwriting_exception: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams::UnderwritingException)).void
}
def initialize(
application: nil,
credit_user: nil,
decided_at: nil,
decision: nil,
expand: nil,
metadata: nil,
regulatory_reporting_file: nil,
underwriting_exception: nil
); end
end
class ReportDecisionParams < Stripe::RequestParams
class Decision < Stripe::RequestParams
class ApplicationRejected < Stripe::RequestParams
# Details about the `reasons.other` when present.
sig { returns(T.nilable(String)) }
def reason_other_explanation; end
sig { params(_reason_other_explanation: T.nilable(String)).returns(T.nilable(String)) }
def reason_other_explanation=(_reason_other_explanation); end
# List of reasons why the application was rejected, up to 4 reasons, in order of importance.
sig { returns(T::Array[String]) }
def reasons; end
sig { params(_reasons: T::Array[String]).returns(T::Array[String]) }
def reasons=(_reasons); end
sig {
params(reason_other_explanation: T.nilable(String), reasons: T::Array[String]).void
}
def initialize(reason_other_explanation: nil, reasons: nil); end
end
class CreditLimitApproved < Stripe::RequestParams
# The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The currency of the credit approved, will default to the Account's Issuing currency.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
sig { params(amount: Integer, currency: T.nilable(String)).void }
def initialize(amount: nil, currency: nil); end
end
# Details about the application rejection.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams::Decision::ApplicationRejected))
}
def application_rejected; end
sig {
params(_application_rejected: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams::Decision::ApplicationRejected)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams::Decision::ApplicationRejected))
}
def application_rejected=(_application_rejected); end
# Details about the credit limit approved. An approved credit limit is required before you can set a `credit_limit_amount` in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy/)
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams::Decision::CreditLimitApproved))
}
def credit_limit_approved; end
sig {
params(_credit_limit_approved: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams::Decision::CreditLimitApproved)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams::Decision::CreditLimitApproved))
}
def credit_limit_approved=(_credit_limit_approved); end
# Outcome of the decision.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(application_rejected: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams::Decision::ApplicationRejected), credit_limit_approved: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams::Decision::CreditLimitApproved), type: String).void
}
def initialize(application_rejected: nil, credit_limit_approved: nil, type: nil); end
end
class UnderwritingException < Stripe::RequestParams
# Written explanation for the exception.
sig { returns(String) }
def explanation; end
sig { params(_explanation: String).returns(String) }
def explanation=(_explanation); end
# The decision before the exception was applied.
sig { returns(String) }
def original_decision_type; end
sig { params(_original_decision_type: String).returns(String) }
def original_decision_type=(_original_decision_type); end
sig { params(explanation: String, original_decision_type: String).void }
def initialize(explanation: nil, original_decision_type: nil); end
end
# Date when a decision was made.
sig { returns(Integer) }
def decided_at; end
sig { params(_decided_at: Integer).returns(Integer) }
def decided_at=(_decided_at); end
# Details about the decision.
sig {
returns(::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams::Decision)
}
def decision; end
sig {
params(_decision: ::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams::Decision).returns(::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams::Decision)
}
def decision=(_decision); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).
sig { returns(T.nilable(String)) }
def regulatory_reporting_file; end
sig { params(_regulatory_reporting_file: T.nilable(String)).returns(T.nilable(String)) }
def regulatory_reporting_file=(_regulatory_reporting_file); end
# If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams::UnderwritingException))
}
def underwriting_exception; end
sig {
params(_underwriting_exception: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams::UnderwritingException)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams::UnderwritingException))
}
def underwriting_exception=(_underwriting_exception); end
sig {
params(decided_at: Integer, decision: ::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams::Decision, expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), regulatory_reporting_file: T.nilable(String), underwriting_exception: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams::UnderwritingException)).void
}
def initialize(
decided_at: nil,
decision: nil,
expand: nil,
metadata: nil,
regulatory_reporting_file: nil,
underwriting_exception: nil
); end
end
class CreateFromApplicationParams < Stripe::RequestParams
class Application < Stripe::RequestParams
# The channel through which the applicant has submitted their application. Defaults to `online`.
sig { returns(T.nilable(String)) }
def application_method; end
sig { params(_application_method: T.nilable(String)).returns(T.nilable(String)) }
def application_method=(_application_method); end
# Scope of demand made by the applicant.
sig { returns(String) }
def purpose; end
sig { params(_purpose: String).returns(String) }
def purpose=(_purpose); end
# Date when the applicant submitted their application.
sig { returns(Integer) }
def submitted_at; end
sig { params(_submitted_at: Integer).returns(Integer) }
def submitted_at=(_submitted_at); end
sig {
params(application_method: T.nilable(String), purpose: String, submitted_at: Integer).void
}
def initialize(application_method: nil, purpose: nil, submitted_at: nil); end
end
class CreditUser < Stripe::RequestParams
# Email of the applicant or accountholder.
sig { returns(String) }
def email; end
sig { params(_email: String).returns(String) }
def email=(_email); end
# Full name of the company or person.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(email: String, name: String).void }
def initialize(email: nil, name: nil); end
end
# Details about the application submission.
sig {
returns(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromApplicationParams::Application)
}
def application; end
sig {
params(_application: ::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromApplicationParams::Application).returns(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromApplicationParams::Application)
}
def application=(_application); end
# Information about the company or person applying or holding the account.
sig {
returns(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromApplicationParams::CreditUser)
}
def credit_user; end
sig {
params(_credit_user: ::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromApplicationParams::CreditUser).returns(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromApplicationParams::CreditUser)
}
def credit_user=(_credit_user); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(application: ::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromApplicationParams::Application, credit_user: ::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromApplicationParams::CreditUser, expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(application: nil, credit_user: nil, expand: nil, metadata: nil); end
end
class CreateFromProactiveReviewParams < Stripe::RequestParams
class CreditUser < Stripe::RequestParams
# Email of the applicant or accountholder.
sig { returns(String) }
def email; end
sig { params(_email: String).returns(String) }
def email=(_email); end
# Full name of the company or person.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(email: String, name: String).void }
def initialize(email: nil, name: nil); end
end
class Decision < Stripe::RequestParams
class CreditLimitApproved < Stripe::RequestParams
# The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The currency of the credit approved, will default to the Account's Issuing currency.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
sig { params(amount: Integer, currency: T.nilable(String)).void }
def initialize(amount: nil, currency: nil); end
end
class CreditLimitDecreased < Stripe::RequestParams
# The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The currency of the credit approved, will default to the Account's Issuing currency.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Details about the `reasons.other` when present.
sig { returns(T.nilable(String)) }
def reason_other_explanation; end
sig { params(_reason_other_explanation: T.nilable(String)).returns(T.nilable(String)) }
def reason_other_explanation=(_reason_other_explanation); end
# List of reasons why the existing credit was decreased, up to 4 reasons, in order of importance.
sig { returns(T::Array[String]) }
def reasons; end
sig { params(_reasons: T::Array[String]).returns(T::Array[String]) }
def reasons=(_reasons); end
sig {
params(amount: Integer, currency: T.nilable(String), reason_other_explanation: T.nilable(String), reasons: T::Array[String]).void
}
def initialize(
amount: nil,
currency: nil,
reason_other_explanation: nil,
reasons: nil
); end
end
class CreditLineClosed < Stripe::RequestParams
# Details about the `reasons.other` when present.
sig { returns(T.nilable(String)) }
def reason_other_explanation; end
sig { params(_reason_other_explanation: T.nilable(String)).returns(T.nilable(String)) }
def reason_other_explanation=(_reason_other_explanation); end
# List of reasons why the credit line was closed, up to 4 reasons, in order of importance.
sig { returns(T::Array[String]) }
def reasons; end
sig { params(_reasons: T::Array[String]).returns(T::Array[String]) }
def reasons=(_reasons); end
sig {
params(reason_other_explanation: T.nilable(String), reasons: T::Array[String]).void
}
def initialize(reason_other_explanation: nil, reasons: nil); end
end
# Details about the credit limit approved. An approved credit limit is required before you can set a `credit_limit_amount` in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy/)
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::Decision::CreditLimitApproved))
}
def credit_limit_approved; end
sig {
params(_credit_limit_approved: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::Decision::CreditLimitApproved)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::Decision::CreditLimitApproved))
}
def credit_limit_approved=(_credit_limit_approved); end
# Details about the credit limit decreased.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::Decision::CreditLimitDecreased))
}
def credit_limit_decreased; end
sig {
params(_credit_limit_decreased: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::Decision::CreditLimitDecreased)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::Decision::CreditLimitDecreased))
}
def credit_limit_decreased=(_credit_limit_decreased); end
# Details about the credit line closed.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::Decision::CreditLineClosed))
}
def credit_line_closed; end
sig {
params(_credit_line_closed: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::Decision::CreditLineClosed)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::Decision::CreditLineClosed))
}
def credit_line_closed=(_credit_line_closed); end
# Outcome of the decision.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(credit_limit_approved: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::Decision::CreditLimitApproved), credit_limit_decreased: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::Decision::CreditLimitDecreased), credit_line_closed: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::Decision::CreditLineClosed), type: String).void
}
def initialize(
credit_limit_approved: nil,
credit_limit_decreased: nil,
credit_line_closed: nil,
type: nil
); end
end
class UnderwritingException < Stripe::RequestParams
# Written explanation for the exception.
sig { returns(String) }
def explanation; end
sig { params(_explanation: String).returns(String) }
def explanation=(_explanation); end
# The decision before the exception was applied.
sig { returns(String) }
def original_decision_type; end
sig { params(_original_decision_type: String).returns(String) }
def original_decision_type=(_original_decision_type); end
sig { params(explanation: String, original_decision_type: String).void }
def initialize(explanation: nil, original_decision_type: nil); end
end
# Information about the company or person applying or holding the account.
sig {
returns(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::CreditUser)
}
def credit_user; end
sig {
params(_credit_user: ::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::CreditUser).returns(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::CreditUser)
}
def credit_user=(_credit_user); end
# Date when a decision was made.
sig { returns(Integer) }
def decided_at; end
sig { params(_decided_at: Integer).returns(Integer) }
def decided_at=(_decided_at); end
# Details about the decision.
sig {
returns(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::Decision)
}
def decision; end
sig {
params(_decision: ::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::Decision).returns(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::Decision)
}
def decision=(_decision); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).
sig { returns(T.nilable(String)) }
def regulatory_reporting_file; end
sig { params(_regulatory_reporting_file: T.nilable(String)).returns(T.nilable(String)) }
def regulatory_reporting_file=(_regulatory_reporting_file); end
# If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.
sig {
returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::UnderwritingException))
}
def underwriting_exception; end
sig {
params(_underwriting_exception: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::UnderwritingException)).returns(T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::UnderwritingException))
}
def underwriting_exception=(_underwriting_exception); end
sig {
params(credit_user: ::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::CreditUser, decided_at: Integer, decision: ::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::Decision, expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), regulatory_reporting_file: T.nilable(String), underwriting_exception: T.nilable(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams::UnderwritingException)).void
}
def initialize(
credit_user: nil,
decided_at: nil,
decision: nil,
expand: nil,
metadata: nil,
regulatory_reporting_file: nil,
underwriting_exception: nil
); end
end
# Update a CreditUnderwritingRecord object to correct mistakes.
sig {
params(credit_underwriting_record: String, params: T.any(::Stripe::Issuing::CreditUnderwritingRecordService::CorrectParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::CreditUnderwritingRecord)
}
def correct(credit_underwriting_record, params = {}, opts = {}); end
# Creates a CreditUnderwritingRecord object with information about a credit application submission.
sig {
params(params: T.any(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromApplicationParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::CreditUnderwritingRecord)
}
def create_from_application(params = {}, opts = {}); end
# Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.
sig {
params(params: T.any(::Stripe::Issuing::CreditUnderwritingRecordService::CreateFromProactiveReviewParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::CreditUnderwritingRecord)
}
def create_from_proactive_review(params = {}, opts = {}); end
# Retrieves a list of CreditUnderwritingRecord objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::CreditUnderwritingRecordService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Update a CreditUnderwritingRecord object from a decision made on a credit application.
sig {
params(credit_underwriting_record: String, params: T.any(::Stripe::Issuing::CreditUnderwritingRecordService::ReportDecisionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::CreditUnderwritingRecord)
}
def report_decision(credit_underwriting_record, params = {}, opts = {}); end
# Retrieves a CreditUnderwritingRecord object.
sig {
params(credit_underwriting_record: String, params: T.any(::Stripe::Issuing::CreditUnderwritingRecordService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::CreditUnderwritingRecord)
}
def retrieve(credit_underwriting_record, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
class DisputeService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return Issuing disputes that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Issuing::DisputeService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Issuing::DisputeService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Issuing::DisputeService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Select Issuing disputes with the given status.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# Select the Issuing dispute for the given transaction.
sig { returns(T.nilable(String)) }
def transaction; end
sig { params(_transaction: T.nilable(String)).returns(T.nilable(String)) }
def transaction=(_transaction); end
sig {
params(created: T.nilable(T.any(::Stripe::Issuing::DisputeService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String), transaction: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil,
transaction: nil
); end
end
class CreateParams < Stripe::RequestParams
class Evidence < Stripe::RequestParams
class Canceled < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Date when order was canceled.
sig { returns(T.nilable(T.any(String, Integer))) }
def canceled_at; end
sig {
params(_canceled_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def canceled_at=(_canceled_at); end
# Whether the cardholder was provided with a cancellation policy.
sig { returns(T.nilable(T.any(String, T::Boolean))) }
def cancellation_policy_provided; end
sig {
params(_cancellation_policy_provided: T.nilable(T.any(String, T::Boolean))).returns(T.nilable(T.any(String, T::Boolean)))
}
def cancellation_policy_provided=(_cancellation_policy_provided); end
# Reason for canceling the order.
sig { returns(T.nilable(String)) }
def cancellation_reason; end
sig { params(_cancellation_reason: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_reason=(_cancellation_reason); end
# Date when the cardholder expected to receive the product.
sig { returns(T.nilable(T.any(String, Integer))) }
def expected_at; end
sig {
params(_expected_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expected_at=(_expected_at); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Description of the merchandise or service that was purchased.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Whether the product was a merchandise or service.
sig { returns(T.nilable(T.any(String, String))) }
def product_type; end
sig {
params(_product_type: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def product_type=(_product_type); end
# Result of cardholder's attempt to return the product.
sig { returns(T.nilable(T.any(String, String))) }
def return_status; end
sig {
params(_return_status: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def return_status=(_return_status); end
# Date when the product was returned or attempted to be returned.
sig { returns(T.nilable(T.any(String, Integer))) }
def returned_at; end
sig {
params(_returned_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def returned_at=(_returned_at); end
sig {
params(additional_documentation: T.nilable(String), canceled_at: T.nilable(T.any(String, Integer)), cancellation_policy_provided: T.nilable(T.any(String, T::Boolean)), cancellation_reason: T.nilable(String), expected_at: T.nilable(T.any(String, Integer)), explanation: T.nilable(String), product_description: T.nilable(String), product_type: T.nilable(T.any(String, String)), return_status: T.nilable(T.any(String, String)), returned_at: T.nilable(T.any(String, Integer))).void
}
def initialize(
additional_documentation: nil,
canceled_at: nil,
cancellation_policy_provided: nil,
cancellation_reason: nil,
expected_at: nil,
explanation: nil,
product_description: nil,
product_type: nil,
return_status: nil,
returned_at: nil
); end
end
class Duplicate < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.
sig { returns(T.nilable(String)) }
def card_statement; end
sig { params(_card_statement: T.nilable(String)).returns(T.nilable(String)) }
def card_statement=(_card_statement); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.
sig { returns(T.nilable(String)) }
def cash_receipt; end
sig { params(_cash_receipt: T.nilable(String)).returns(T.nilable(String)) }
def cash_receipt=(_cash_receipt); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.
sig { returns(T.nilable(String)) }
def check_image; end
sig { params(_check_image: T.nilable(String)).returns(T.nilable(String)) }
def check_image=(_check_image); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.
sig { returns(T.nilable(String)) }
def original_transaction; end
sig { params(_original_transaction: T.nilable(String)).returns(T.nilable(String)) }
def original_transaction=(_original_transaction); end
sig {
params(additional_documentation: T.nilable(String), card_statement: T.nilable(String), cash_receipt: T.nilable(String), check_image: T.nilable(String), explanation: T.nilable(String), original_transaction: T.nilable(String)).void
}
def initialize(
additional_documentation: nil,
card_statement: nil,
cash_receipt: nil,
check_image: nil,
explanation: nil,
original_transaction: nil
); end
end
class Fraudulent < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
sig {
params(additional_documentation: T.nilable(String), explanation: T.nilable(String)).void
}
def initialize(additional_documentation: nil, explanation: nil); end
end
class MerchandiseNotAsDescribed < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Date when the product was received.
sig { returns(T.nilable(T.any(String, Integer))) }
def received_at; end
sig {
params(_received_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def received_at=(_received_at); end
# Description of the cardholder's attempt to return the product.
sig { returns(T.nilable(String)) }
def return_description; end
sig { params(_return_description: T.nilable(String)).returns(T.nilable(String)) }
def return_description=(_return_description); end
# Result of cardholder's attempt to return the product.
sig { returns(T.nilable(T.any(String, String))) }
def return_status; end
sig {
params(_return_status: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def return_status=(_return_status); end
# Date when the product was returned or attempted to be returned.
sig { returns(T.nilable(T.any(String, Integer))) }
def returned_at; end
sig {
params(_returned_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def returned_at=(_returned_at); end
sig {
params(additional_documentation: T.nilable(String), explanation: T.nilable(String), received_at: T.nilable(T.any(String, Integer)), return_description: T.nilable(String), return_status: T.nilable(T.any(String, String)), returned_at: T.nilable(T.any(String, Integer))).void
}
def initialize(
additional_documentation: nil,
explanation: nil,
received_at: nil,
return_description: nil,
return_status: nil,
returned_at: nil
); end
end
class NoValidAuthorization < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
sig {
params(additional_documentation: T.nilable(String), explanation: T.nilable(String)).void
}
def initialize(additional_documentation: nil, explanation: nil); end
end
class NotReceived < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Date when the cardholder expected to receive the product.
sig { returns(T.nilable(T.any(String, Integer))) }
def expected_at; end
sig {
params(_expected_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expected_at=(_expected_at); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Description of the merchandise or service that was purchased.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Whether the product was a merchandise or service.
sig { returns(T.nilable(T.any(String, String))) }
def product_type; end
sig {
params(_product_type: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def product_type=(_product_type); end
sig {
params(additional_documentation: T.nilable(String), expected_at: T.nilable(T.any(String, Integer)), explanation: T.nilable(String), product_description: T.nilable(String), product_type: T.nilable(T.any(String, String))).void
}
def initialize(
additional_documentation: nil,
expected_at: nil,
explanation: nil,
product_description: nil,
product_type: nil
); end
end
class Other < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Description of the merchandise or service that was purchased.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Whether the product was a merchandise or service.
sig { returns(T.nilable(T.any(String, String))) }
def product_type; end
sig {
params(_product_type: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def product_type=(_product_type); end
sig {
params(additional_documentation: T.nilable(String), explanation: T.nilable(String), product_description: T.nilable(String), product_type: T.nilable(T.any(String, String))).void
}
def initialize(
additional_documentation: nil,
explanation: nil,
product_description: nil,
product_type: nil
); end
end
class ServiceNotAsDescribed < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Date when order was canceled.
sig { returns(T.nilable(T.any(String, Integer))) }
def canceled_at; end
sig {
params(_canceled_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def canceled_at=(_canceled_at); end
# Reason for canceling the order.
sig { returns(T.nilable(String)) }
def cancellation_reason; end
sig { params(_cancellation_reason: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_reason=(_cancellation_reason); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Date when the product was received.
sig { returns(T.nilable(T.any(String, Integer))) }
def received_at; end
sig {
params(_received_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def received_at=(_received_at); end
sig {
params(additional_documentation: T.nilable(String), canceled_at: T.nilable(T.any(String, Integer)), cancellation_reason: T.nilable(String), explanation: T.nilable(String), received_at: T.nilable(T.any(String, Integer))).void
}
def initialize(
additional_documentation: nil,
canceled_at: nil,
cancellation_reason: nil,
explanation: nil,
received_at: nil
); end
end
# Evidence provided when `reason` is 'canceled'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::Canceled)))
}
def canceled; end
sig {
params(_canceled: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::Canceled))).returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::Canceled)))
}
def canceled=(_canceled); end
# Evidence provided when `reason` is 'duplicate'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::Duplicate)))
}
def duplicate; end
sig {
params(_duplicate: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::Duplicate))).returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::Duplicate)))
}
def duplicate=(_duplicate); end
# Evidence provided when `reason` is 'fraudulent'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::Fraudulent)))
}
def fraudulent; end
sig {
params(_fraudulent: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::Fraudulent))).returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::Fraudulent)))
}
def fraudulent=(_fraudulent); end
# Evidence provided when `reason` is 'merchandise_not_as_described'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::MerchandiseNotAsDescribed)))
}
def merchandise_not_as_described; end
sig {
params(_merchandise_not_as_described: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::MerchandiseNotAsDescribed))).returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::MerchandiseNotAsDescribed)))
}
def merchandise_not_as_described=(_merchandise_not_as_described); end
# Evidence provided when `reason` is 'no_valid_authorization'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::NoValidAuthorization)))
}
def no_valid_authorization; end
sig {
params(_no_valid_authorization: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::NoValidAuthorization))).returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::NoValidAuthorization)))
}
def no_valid_authorization=(_no_valid_authorization); end
# Evidence provided when `reason` is 'not_received'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::NotReceived)))
}
def not_received; end
sig {
params(_not_received: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::NotReceived))).returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::NotReceived)))
}
def not_received=(_not_received); end
# Evidence provided when `reason` is 'other'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::Other)))
}
def other; end
sig {
params(_other: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::Other))).returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::Other)))
}
def other=(_other); end
# The reason for filing the dispute. The evidence should be submitted in the field of the same name.
sig { returns(T.nilable(String)) }
def reason; end
sig { params(_reason: T.nilable(String)).returns(T.nilable(String)) }
def reason=(_reason); end
# Evidence provided when `reason` is 'service_not_as_described'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::ServiceNotAsDescribed)))
}
def service_not_as_described; end
sig {
params(_service_not_as_described: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::ServiceNotAsDescribed))).returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::ServiceNotAsDescribed)))
}
def service_not_as_described=(_service_not_as_described); end
sig {
params(canceled: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::Canceled)), duplicate: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::Duplicate)), fraudulent: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::Fraudulent)), merchandise_not_as_described: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::MerchandiseNotAsDescribed)), no_valid_authorization: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::NoValidAuthorization)), not_received: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::NotReceived)), other: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::Other)), reason: T.nilable(String), service_not_as_described: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::CreateParams::Evidence::ServiceNotAsDescribed))).void
}
def initialize(
canceled: nil,
duplicate: nil,
fraudulent: nil,
merchandise_not_as_described: nil,
no_valid_authorization: nil,
not_received: nil,
other: nil,
reason: nil,
service_not_as_described: nil
); end
end
class Treasury < Stripe::RequestParams
# The ID of the ReceivedDebit to initiate an Issuings dispute for.
sig { returns(String) }
def received_debit; end
sig { params(_received_debit: String).returns(String) }
def received_debit=(_received_debit); end
sig { params(received_debit: String).void }
def initialize(received_debit: nil); end
end
# The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If not set, defaults to the full transaction amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Evidence provided for the dispute.
sig { returns(T.nilable(::Stripe::Issuing::DisputeService::CreateParams::Evidence)) }
def evidence; end
sig {
params(_evidence: T.nilable(::Stripe::Issuing::DisputeService::CreateParams::Evidence)).returns(T.nilable(::Stripe::Issuing::DisputeService::CreateParams::Evidence))
}
def evidence=(_evidence); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`.
sig { returns(T.nilable(String)) }
def transaction; end
sig { params(_transaction: T.nilable(String)).returns(T.nilable(String)) }
def transaction=(_transaction); end
# Params for disputes related to Treasury FinancialAccounts
sig { returns(T.nilable(::Stripe::Issuing::DisputeService::CreateParams::Treasury)) }
def treasury; end
sig {
params(_treasury: T.nilable(::Stripe::Issuing::DisputeService::CreateParams::Treasury)).returns(T.nilable(::Stripe::Issuing::DisputeService::CreateParams::Treasury))
}
def treasury=(_treasury); end
sig {
params(amount: T.nilable(Integer), evidence: T.nilable(::Stripe::Issuing::DisputeService::CreateParams::Evidence), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), transaction: T.nilable(String), treasury: T.nilable(::Stripe::Issuing::DisputeService::CreateParams::Treasury)).void
}
def initialize(
amount: nil,
evidence: nil,
expand: nil,
metadata: nil,
transaction: nil,
treasury: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Evidence < Stripe::RequestParams
class Canceled < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Date when order was canceled.
sig { returns(T.nilable(T.any(String, Integer))) }
def canceled_at; end
sig {
params(_canceled_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def canceled_at=(_canceled_at); end
# Whether the cardholder was provided with a cancellation policy.
sig { returns(T.nilable(T.any(String, T::Boolean))) }
def cancellation_policy_provided; end
sig {
params(_cancellation_policy_provided: T.nilable(T.any(String, T::Boolean))).returns(T.nilable(T.any(String, T::Boolean)))
}
def cancellation_policy_provided=(_cancellation_policy_provided); end
# Reason for canceling the order.
sig { returns(T.nilable(String)) }
def cancellation_reason; end
sig { params(_cancellation_reason: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_reason=(_cancellation_reason); end
# Date when the cardholder expected to receive the product.
sig { returns(T.nilable(T.any(String, Integer))) }
def expected_at; end
sig {
params(_expected_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expected_at=(_expected_at); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Description of the merchandise or service that was purchased.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Whether the product was a merchandise or service.
sig { returns(T.nilable(T.any(String, String))) }
def product_type; end
sig {
params(_product_type: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def product_type=(_product_type); end
# Result of cardholder's attempt to return the product.
sig { returns(T.nilable(T.any(String, String))) }
def return_status; end
sig {
params(_return_status: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def return_status=(_return_status); end
# Date when the product was returned or attempted to be returned.
sig { returns(T.nilable(T.any(String, Integer))) }
def returned_at; end
sig {
params(_returned_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def returned_at=(_returned_at); end
sig {
params(additional_documentation: T.nilable(String), canceled_at: T.nilable(T.any(String, Integer)), cancellation_policy_provided: T.nilable(T.any(String, T::Boolean)), cancellation_reason: T.nilable(String), expected_at: T.nilable(T.any(String, Integer)), explanation: T.nilable(String), product_description: T.nilable(String), product_type: T.nilable(T.any(String, String)), return_status: T.nilable(T.any(String, String)), returned_at: T.nilable(T.any(String, Integer))).void
}
def initialize(
additional_documentation: nil,
canceled_at: nil,
cancellation_policy_provided: nil,
cancellation_reason: nil,
expected_at: nil,
explanation: nil,
product_description: nil,
product_type: nil,
return_status: nil,
returned_at: nil
); end
end
class Duplicate < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.
sig { returns(T.nilable(String)) }
def card_statement; end
sig { params(_card_statement: T.nilable(String)).returns(T.nilable(String)) }
def card_statement=(_card_statement); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.
sig { returns(T.nilable(String)) }
def cash_receipt; end
sig { params(_cash_receipt: T.nilable(String)).returns(T.nilable(String)) }
def cash_receipt=(_cash_receipt); end
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.
sig { returns(T.nilable(String)) }
def check_image; end
sig { params(_check_image: T.nilable(String)).returns(T.nilable(String)) }
def check_image=(_check_image); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.
sig { returns(T.nilable(String)) }
def original_transaction; end
sig { params(_original_transaction: T.nilable(String)).returns(T.nilable(String)) }
def original_transaction=(_original_transaction); end
sig {
params(additional_documentation: T.nilable(String), card_statement: T.nilable(String), cash_receipt: T.nilable(String), check_image: T.nilable(String), explanation: T.nilable(String), original_transaction: T.nilable(String)).void
}
def initialize(
additional_documentation: nil,
card_statement: nil,
cash_receipt: nil,
check_image: nil,
explanation: nil,
original_transaction: nil
); end
end
class Fraudulent < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
sig {
params(additional_documentation: T.nilable(String), explanation: T.nilable(String)).void
}
def initialize(additional_documentation: nil, explanation: nil); end
end
class MerchandiseNotAsDescribed < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Date when the product was received.
sig { returns(T.nilable(T.any(String, Integer))) }
def received_at; end
sig {
params(_received_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def received_at=(_received_at); end
# Description of the cardholder's attempt to return the product.
sig { returns(T.nilable(String)) }
def return_description; end
sig { params(_return_description: T.nilable(String)).returns(T.nilable(String)) }
def return_description=(_return_description); end
# Result of cardholder's attempt to return the product.
sig { returns(T.nilable(T.any(String, String))) }
def return_status; end
sig {
params(_return_status: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def return_status=(_return_status); end
# Date when the product was returned or attempted to be returned.
sig { returns(T.nilable(T.any(String, Integer))) }
def returned_at; end
sig {
params(_returned_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def returned_at=(_returned_at); end
sig {
params(additional_documentation: T.nilable(String), explanation: T.nilable(String), received_at: T.nilable(T.any(String, Integer)), return_description: T.nilable(String), return_status: T.nilable(T.any(String, String)), returned_at: T.nilable(T.any(String, Integer))).void
}
def initialize(
additional_documentation: nil,
explanation: nil,
received_at: nil,
return_description: nil,
return_status: nil,
returned_at: nil
); end
end
class NoValidAuthorization < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
sig {
params(additional_documentation: T.nilable(String), explanation: T.nilable(String)).void
}
def initialize(additional_documentation: nil, explanation: nil); end
end
class NotReceived < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Date when the cardholder expected to receive the product.
sig { returns(T.nilable(T.any(String, Integer))) }
def expected_at; end
sig {
params(_expected_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expected_at=(_expected_at); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Description of the merchandise or service that was purchased.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Whether the product was a merchandise or service.
sig { returns(T.nilable(T.any(String, String))) }
def product_type; end
sig {
params(_product_type: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def product_type=(_product_type); end
sig {
params(additional_documentation: T.nilable(String), expected_at: T.nilable(T.any(String, Integer)), explanation: T.nilable(String), product_description: T.nilable(String), product_type: T.nilable(T.any(String, String))).void
}
def initialize(
additional_documentation: nil,
expected_at: nil,
explanation: nil,
product_description: nil,
product_type: nil
); end
end
class Other < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Description of the merchandise or service that was purchased.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Whether the product was a merchandise or service.
sig { returns(T.nilable(T.any(String, String))) }
def product_type; end
sig {
params(_product_type: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def product_type=(_product_type); end
sig {
params(additional_documentation: T.nilable(String), explanation: T.nilable(String), product_description: T.nilable(String), product_type: T.nilable(T.any(String, String))).void
}
def initialize(
additional_documentation: nil,
explanation: nil,
product_description: nil,
product_type: nil
); end
end
class ServiceNotAsDescribed < Stripe::RequestParams
# (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
sig { returns(T.nilable(String)) }
def additional_documentation; end
sig { params(_additional_documentation: T.nilable(String)).returns(T.nilable(String)) }
def additional_documentation=(_additional_documentation); end
# Date when order was canceled.
sig { returns(T.nilable(T.any(String, Integer))) }
def canceled_at; end
sig {
params(_canceled_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def canceled_at=(_canceled_at); end
# Reason for canceling the order.
sig { returns(T.nilable(String)) }
def cancellation_reason; end
sig { params(_cancellation_reason: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_reason=(_cancellation_reason); end
# Explanation of why the cardholder is disputing this transaction.
sig { returns(T.nilable(String)) }
def explanation; end
sig { params(_explanation: T.nilable(String)).returns(T.nilable(String)) }
def explanation=(_explanation); end
# Date when the product was received.
sig { returns(T.nilable(T.any(String, Integer))) }
def received_at; end
sig {
params(_received_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def received_at=(_received_at); end
sig {
params(additional_documentation: T.nilable(String), canceled_at: T.nilable(T.any(String, Integer)), cancellation_reason: T.nilable(String), explanation: T.nilable(String), received_at: T.nilable(T.any(String, Integer))).void
}
def initialize(
additional_documentation: nil,
canceled_at: nil,
cancellation_reason: nil,
explanation: nil,
received_at: nil
); end
end
# Evidence provided when `reason` is 'canceled'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::Canceled)))
}
def canceled; end
sig {
params(_canceled: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::Canceled))).returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::Canceled)))
}
def canceled=(_canceled); end
# Evidence provided when `reason` is 'duplicate'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::Duplicate)))
}
def duplicate; end
sig {
params(_duplicate: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::Duplicate))).returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::Duplicate)))
}
def duplicate=(_duplicate); end
# Evidence provided when `reason` is 'fraudulent'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::Fraudulent)))
}
def fraudulent; end
sig {
params(_fraudulent: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::Fraudulent))).returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::Fraudulent)))
}
def fraudulent=(_fraudulent); end
# Evidence provided when `reason` is 'merchandise_not_as_described'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::MerchandiseNotAsDescribed)))
}
def merchandise_not_as_described; end
sig {
params(_merchandise_not_as_described: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::MerchandiseNotAsDescribed))).returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::MerchandiseNotAsDescribed)))
}
def merchandise_not_as_described=(_merchandise_not_as_described); end
# Evidence provided when `reason` is 'no_valid_authorization'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::NoValidAuthorization)))
}
def no_valid_authorization; end
sig {
params(_no_valid_authorization: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::NoValidAuthorization))).returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::NoValidAuthorization)))
}
def no_valid_authorization=(_no_valid_authorization); end
# Evidence provided when `reason` is 'not_received'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::NotReceived)))
}
def not_received; end
sig {
params(_not_received: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::NotReceived))).returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::NotReceived)))
}
def not_received=(_not_received); end
# Evidence provided when `reason` is 'other'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::Other)))
}
def other; end
sig {
params(_other: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::Other))).returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::Other)))
}
def other=(_other); end
# The reason for filing the dispute. The evidence should be submitted in the field of the same name.
sig { returns(T.nilable(String)) }
def reason; end
sig { params(_reason: T.nilable(String)).returns(T.nilable(String)) }
def reason=(_reason); end
# Evidence provided when `reason` is 'service_not_as_described'.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::ServiceNotAsDescribed)))
}
def service_not_as_described; end
sig {
params(_service_not_as_described: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::ServiceNotAsDescribed))).returns(T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::ServiceNotAsDescribed)))
}
def service_not_as_described=(_service_not_as_described); end
sig {
params(canceled: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::Canceled)), duplicate: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::Duplicate)), fraudulent: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::Fraudulent)), merchandise_not_as_described: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::MerchandiseNotAsDescribed)), no_valid_authorization: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::NoValidAuthorization)), not_received: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::NotReceived)), other: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::Other)), reason: T.nilable(String), service_not_as_described: T.nilable(T.any(String, ::Stripe::Issuing::DisputeService::UpdateParams::Evidence::ServiceNotAsDescribed))).void
}
def initialize(
canceled: nil,
duplicate: nil,
fraudulent: nil,
merchandise_not_as_described: nil,
no_valid_authorization: nil,
not_received: nil,
other: nil,
reason: nil,
service_not_as_described: nil
); end
end
# The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Evidence provided for the dispute.
sig { returns(T.nilable(::Stripe::Issuing::DisputeService::UpdateParams::Evidence)) }
def evidence; end
sig {
params(_evidence: T.nilable(::Stripe::Issuing::DisputeService::UpdateParams::Evidence)).returns(T.nilable(::Stripe::Issuing::DisputeService::UpdateParams::Evidence))
}
def evidence=(_evidence); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(amount: T.nilable(Integer), evidence: T.nilable(::Stripe::Issuing::DisputeService::UpdateParams::Evidence), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(amount: nil, evidence: nil, expand: nil, metadata: nil); end
end
class SubmitParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, metadata: nil); 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://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements.
sig {
params(params: T.any(::Stripe::Issuing::DisputeService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Dispute)
}
def create(params = {}, opts = {}); end
# Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::DisputeService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves an Issuing Dispute object.
sig {
params(dispute: String, params: T.any(::Stripe::Issuing::DisputeService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Dispute)
}
def retrieve(dispute, params = {}, opts = {}); 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://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence).
sig {
params(dispute: String, params: T.any(::Stripe::Issuing::DisputeService::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Dispute)
}
def submit(dispute, params = {}, opts = {}); end
# Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.
sig {
params(dispute: String, params: T.any(::Stripe::Issuing::DisputeService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Dispute)
}
def update(dispute, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
class DisputeSettlementDetailService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Select the Issuing dispute settlement details for the given settlement.
sig { returns(T.nilable(String)) }
def settlement; end
sig { params(_settlement: T.nilable(String)).returns(T.nilable(String)) }
def settlement=(_settlement); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), settlement: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
settlement: nil,
starting_after: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of Issuing DisputeSettlementDetail objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::DisputeSettlementDetailService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves an Issuing DisputeSettlementDetail object.
sig {
params(dispute_settlement_detail: String, params: T.any(::Stripe::Issuing::DisputeSettlementDetailService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::DisputeSettlementDetail)
}
def retrieve(dispute_settlement_detail, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
class FraudLiabilityDebitService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return Issuing Fraud Liability Debits that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Issuing::FraudLiabilityDebitService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Issuing::FraudLiabilityDebitService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Issuing::FraudLiabilityDebitService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::Issuing::FraudLiabilityDebitService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of Issuing FraudLiabilityDebit objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::FraudLiabilityDebitService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves an Issuing FraudLiabilityDebit object.
sig {
params(fraud_liability_debit: String, params: T.any(::Stripe::Issuing::FraudLiabilityDebitService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::FraudLiabilityDebit)
}
def retrieve(fraud_liability_debit, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
class PersonalizationDesignService < StripeService
class ListParams < Stripe::RequestParams
class Preferences < Stripe::RequestParams
# Only return the personalization design that's set as the default. A connected account uses the Connect platform's default design if no personalization design is set as the default.
sig { returns(T.nilable(T::Boolean)) }
def is_default; end
sig { params(_is_default: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def is_default=(_is_default); end
# Only return the personalization design that is set as the Connect platform's default. This parameter is only applicable to connected accounts.
sig { returns(T.nilable(T::Boolean)) }
def is_platform_default; end
sig { params(_is_platform_default: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def is_platform_default=(_is_platform_default); end
sig {
params(is_default: T.nilable(T::Boolean), is_platform_default: T.nilable(T::Boolean)).void
}
def initialize(is_default: nil, is_platform_default: nil); end
end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return personalization designs with the given lookup keys.
sig { returns(T.nilable(T::Array[String])) }
def lookup_keys; end
sig {
params(_lookup_keys: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def lookup_keys=(_lookup_keys); end
# Only return personalization designs with the given preferences.
sig {
returns(T.nilable(::Stripe::Issuing::PersonalizationDesignService::ListParams::Preferences))
}
def preferences; end
sig {
params(_preferences: T.nilable(::Stripe::Issuing::PersonalizationDesignService::ListParams::Preferences)).returns(T.nilable(::Stripe::Issuing::PersonalizationDesignService::ListParams::Preferences))
}
def preferences=(_preferences); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return personalization designs with the given status.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), lookup_keys: T.nilable(T::Array[String]), preferences: T.nilable(::Stripe::Issuing::PersonalizationDesignService::ListParams::Preferences), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
lookup_keys: nil,
preferences: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class CarrierText < Stripe::RequestParams
# The footer body text of the carrier letter.
sig { returns(T.nilable(String)) }
def footer_body; end
sig { params(_footer_body: T.nilable(String)).returns(T.nilable(String)) }
def footer_body=(_footer_body); end
# The footer title text of the carrier letter.
sig { returns(T.nilable(String)) }
def footer_title; end
sig { params(_footer_title: T.nilable(String)).returns(T.nilable(String)) }
def footer_title=(_footer_title); end
# The header body text of the carrier letter.
sig { returns(T.nilable(String)) }
def header_body; end
sig { params(_header_body: T.nilable(String)).returns(T.nilable(String)) }
def header_body=(_header_body); end
# The header title text of the carrier letter.
sig { returns(T.nilable(String)) }
def header_title; end
sig { params(_header_title: T.nilable(String)).returns(T.nilable(String)) }
def header_title=(_header_title); end
sig {
params(footer_body: T.nilable(String), footer_title: T.nilable(String), header_body: T.nilable(String), header_title: T.nilable(String)).void
}
def initialize(
footer_body: nil,
footer_title: nil,
header_body: nil,
header_title: nil
); end
end
class Preferences < Stripe::RequestParams
# Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
sig { returns(T::Boolean) }
def is_default; end
sig { params(_is_default: T::Boolean).returns(T::Boolean) }
def is_default=(_is_default); end
sig { params(is_default: T::Boolean).void }
def initialize(is_default: nil); end
end
# The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
sig { returns(T.nilable(String)) }
def card_logo; end
sig { params(_card_logo: T.nilable(String)).returns(T.nilable(String)) }
def card_logo=(_card_logo); end
# Hash containing carrier text, for use with physical bundles that support carrier text.
sig {
returns(T.nilable(::Stripe::Issuing::PersonalizationDesignService::CreateParams::CarrierText))
}
def carrier_text; end
sig {
params(_carrier_text: T.nilable(::Stripe::Issuing::PersonalizationDesignService::CreateParams::CarrierText)).returns(T.nilable(::Stripe::Issuing::PersonalizationDesignService::CreateParams::CarrierText))
}
def carrier_text=(_carrier_text); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
sig { returns(T.nilable(String)) }
def lookup_key; end
sig { params(_lookup_key: T.nilable(String)).returns(T.nilable(String)) }
def lookup_key=(_lookup_key); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Friendly display name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The physical bundle object belonging to this personalization design.
sig { returns(String) }
def physical_bundle; end
sig { params(_physical_bundle: String).returns(String) }
def physical_bundle=(_physical_bundle); end
# Information on whether this personalization design is used to create cards when one is not specified.
sig {
returns(T.nilable(::Stripe::Issuing::PersonalizationDesignService::CreateParams::Preferences))
}
def preferences; end
sig {
params(_preferences: T.nilable(::Stripe::Issuing::PersonalizationDesignService::CreateParams::Preferences)).returns(T.nilable(::Stripe::Issuing::PersonalizationDesignService::CreateParams::Preferences))
}
def preferences=(_preferences); end
# If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
sig { returns(T.nilable(T::Boolean)) }
def transfer_lookup_key; end
sig { params(_transfer_lookup_key: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def transfer_lookup_key=(_transfer_lookup_key); end
sig {
params(card_logo: T.nilable(String), carrier_text: T.nilable(::Stripe::Issuing::PersonalizationDesignService::CreateParams::CarrierText), expand: T.nilable(T::Array[String]), lookup_key: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), name: T.nilable(String), physical_bundle: String, preferences: T.nilable(::Stripe::Issuing::PersonalizationDesignService::CreateParams::Preferences), transfer_lookup_key: T.nilable(T::Boolean)).void
}
def initialize(
card_logo: nil,
carrier_text: nil,
expand: nil,
lookup_key: nil,
metadata: nil,
name: nil,
physical_bundle: nil,
preferences: nil,
transfer_lookup_key: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class CarrierText < Stripe::RequestParams
# The footer body text of the carrier letter.
sig { returns(T.nilable(String)) }
def footer_body; end
sig { params(_footer_body: T.nilable(String)).returns(T.nilable(String)) }
def footer_body=(_footer_body); end
# The footer title text of the carrier letter.
sig { returns(T.nilable(String)) }
def footer_title; end
sig { params(_footer_title: T.nilable(String)).returns(T.nilable(String)) }
def footer_title=(_footer_title); end
# The header body text of the carrier letter.
sig { returns(T.nilable(String)) }
def header_body; end
sig { params(_header_body: T.nilable(String)).returns(T.nilable(String)) }
def header_body=(_header_body); end
# The header title text of the carrier letter.
sig { returns(T.nilable(String)) }
def header_title; end
sig { params(_header_title: T.nilable(String)).returns(T.nilable(String)) }
def header_title=(_header_title); end
sig {
params(footer_body: T.nilable(String), footer_title: T.nilable(String), header_body: T.nilable(String), header_title: T.nilable(String)).void
}
def initialize(
footer_body: nil,
footer_title: nil,
header_body: nil,
header_title: nil
); end
end
class Preferences < Stripe::RequestParams
# Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
sig { returns(T::Boolean) }
def is_default; end
sig { params(_is_default: T::Boolean).returns(T::Boolean) }
def is_default=(_is_default); end
sig { params(is_default: T::Boolean).void }
def initialize(is_default: nil); end
end
# The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
sig { returns(T.nilable(String)) }
def card_logo; end
sig { params(_card_logo: T.nilable(String)).returns(T.nilable(String)) }
def card_logo=(_card_logo); end
# Hash containing carrier text, for use with physical bundles that support carrier text.
sig {
returns(T.nilable(T.any(String, ::Stripe::Issuing::PersonalizationDesignService::UpdateParams::CarrierText)))
}
def carrier_text; end
sig {
params(_carrier_text: T.nilable(T.any(String, ::Stripe::Issuing::PersonalizationDesignService::UpdateParams::CarrierText))).returns(T.nilable(T.any(String, ::Stripe::Issuing::PersonalizationDesignService::UpdateParams::CarrierText)))
}
def carrier_text=(_carrier_text); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
sig { returns(T.nilable(String)) }
def lookup_key; end
sig { params(_lookup_key: T.nilable(String)).returns(T.nilable(String)) }
def lookup_key=(_lookup_key); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Friendly display name. Providing an empty string will set the field to null.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The physical bundle object belonging to this personalization design.
sig { returns(T.nilable(String)) }
def physical_bundle; end
sig { params(_physical_bundle: T.nilable(String)).returns(T.nilable(String)) }
def physical_bundle=(_physical_bundle); end
# Information on whether this personalization design is used to create cards when one is not specified.
sig {
returns(T.nilable(::Stripe::Issuing::PersonalizationDesignService::UpdateParams::Preferences))
}
def preferences; end
sig {
params(_preferences: T.nilable(::Stripe::Issuing::PersonalizationDesignService::UpdateParams::Preferences)).returns(T.nilable(::Stripe::Issuing::PersonalizationDesignService::UpdateParams::Preferences))
}
def preferences=(_preferences); end
# If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
sig { returns(T.nilable(T::Boolean)) }
def transfer_lookup_key; end
sig { params(_transfer_lookup_key: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def transfer_lookup_key=(_transfer_lookup_key); end
sig {
params(card_logo: T.nilable(String), carrier_text: T.nilable(T.any(String, ::Stripe::Issuing::PersonalizationDesignService::UpdateParams::CarrierText)), expand: T.nilable(T::Array[String]), lookup_key: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), name: T.nilable(String), physical_bundle: T.nilable(String), preferences: T.nilable(::Stripe::Issuing::PersonalizationDesignService::UpdateParams::Preferences), transfer_lookup_key: T.nilable(T::Boolean)).void
}
def initialize(
card_logo: nil,
carrier_text: nil,
expand: nil,
lookup_key: nil,
metadata: nil,
name: nil,
physical_bundle: nil,
preferences: nil,
transfer_lookup_key: nil
); end
end
# Creates a personalization design object.
sig {
params(params: T.any(::Stripe::Issuing::PersonalizationDesignService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::PersonalizationDesign)
}
def create(params = {}, opts = {}); end
# Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::PersonalizationDesignService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a personalization design object.
sig {
params(personalization_design: String, params: T.any(::Stripe::Issuing::PersonalizationDesignService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::PersonalizationDesign)
}
def retrieve(personalization_design, params = {}, opts = {}); end
# Updates a card personalization object.
sig {
params(personalization_design: String, params: T.any(::Stripe::Issuing::PersonalizationDesignService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::PersonalizationDesign)
}
def update(personalization_design, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
class PhysicalBundleService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return physical bundles with the given status.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# Only return physical bundles with the given type.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil,
type: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::PhysicalBundleService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a physical bundle object.
sig {
params(physical_bundle: String, params: T.any(::Stripe::Issuing::PhysicalBundleService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::PhysicalBundle)
}
def retrieve(physical_bundle, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
class TokenService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# The Issuing card identifier to list tokens for.
sig { returns(String) }
def card; end
sig { params(_card: String).returns(String) }
def card=(_card); end
# Only return Issuing tokens that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Issuing::TokenService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Issuing::TokenService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Issuing::TokenService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Select Issuing tokens with the given status.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(card: String, created: T.nilable(T.any(::Stripe::Issuing::TokenService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
card: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Specifies which status the token should be updated to.
sig { returns(String) }
def status; end
sig { params(_status: String).returns(String) }
def status=(_status); end
sig { params(expand: T.nilable(T::Array[String]), status: String).void }
def initialize(expand: nil, status: nil); end
end
# Lists all Issuing Token objects for a given card.
sig {
params(params: T.any(::Stripe::Issuing::TokenService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves an Issuing Token object.
sig {
params(token: String, params: T.any(::Stripe::Issuing::TokenService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Token)
}
def retrieve(token, params = {}, opts = {}); end
# Attempts to update the specified Issuing Token object to the status specified.
sig {
params(token: String, params: T.any(::Stripe::Issuing::TokenService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Token)
}
def update(token, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Issuing
class TransactionService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return transactions that belong to the given card.
sig { returns(T.nilable(String)) }
def card; end
sig { params(_card: T.nilable(String)).returns(T.nilable(String)) }
def card=(_card); end
# Only return transactions that belong to the given cardholder.
sig { returns(T.nilable(String)) }
def cardholder; end
sig { params(_cardholder: T.nilable(String)).returns(T.nilable(String)) }
def cardholder=(_cardholder); end
# Only return transactions that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Issuing::TransactionService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Issuing::TransactionService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Issuing::TransactionService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return transactions that are associated with the given settlement.
sig { returns(T.nilable(String)) }
def settlement; end
sig { params(_settlement: T.nilable(String)).returns(T.nilable(String)) }
def settlement=(_settlement); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return transactions that have the given type. One of `capture` or `refund`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(card: T.nilable(String), cardholder: T.nilable(String), created: T.nilable(T.any(::Stripe::Issuing::TransactionService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), settlement: T.nilable(String), starting_after: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
card: nil,
cardholder: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
settlement: nil,
starting_after: nil,
type: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, metadata: nil); end
end
# Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Issuing::TransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves an Issuing Transaction object.
sig {
params(transaction: String, params: T.any(::Stripe::Issuing::TransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Transaction)
}
def retrieve(transaction, params = {}, opts = {}); end
# Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(transaction: String, params: T.any(::Stripe::Issuing::TransactionService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Transaction)
}
def update(transaction, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class MandateService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The Stripe account ID that the mandates are intended for. Learn more about the [use case for connected accounts payments](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Attribute for param field payment_method
sig { returns(String) }
def payment_method; end
sig { params(_payment_method: String).returns(String) }
def payment_method=(_payment_method); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# The status of the mandates to retrieve. Status indicates whether or not you can use it to initiate a payment, and can have a value of `active`, `pending`, or `inactive`.
sig { returns(String) }
def status; end
sig { params(_status: String).returns(String) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), on_behalf_of: T.nilable(String), payment_method: String, starting_after: T.nilable(String), status: String).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
on_behalf_of: nil,
payment_method: nil,
starting_after: nil,
status: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Retrieves a list of Mandates for a given PaymentMethod.
sig {
params(params: T.any(::Stripe::MandateService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a Mandate object.
sig {
params(mandate: String, params: T.any(::Stripe::MandateService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Mandate)
}
def retrieve(mandate, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class MarginService < StripeService
class ListParams < Stripe::RequestParams
# Only return margins that are active or inactive. For example, pass `true` to only list active margins.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(active: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
active: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# Whether the margin can be applied to invoices, invoice items, or invoice line items or not. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Name of the margin, which is displayed to customers, such as on invoices.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.
sig { returns(Float) }
def percent_off; end
sig { params(_percent_off: Float).returns(Float) }
def percent_off=(_percent_off); end
sig {
params(active: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: T.nilable(String), percent_off: Float).void
}
def initialize(active: nil, expand: nil, metadata: nil, name: nil, percent_off: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Whether the margin can be applied to invoices, invoice items, or invoice line items or not.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Name of the margin, which is displayed to customers, such as on invoices.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(active: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: T.nilable(String)).void
}
def initialize(active: nil, expand: nil, metadata: nil, name: nil); end
end
# Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount. A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer. Calculation of prorations do not include any partner margins applied on the original invoice item.
sig {
params(params: T.any(::Stripe::MarginService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Margin)
}
def create(params = {}, opts = {}); end
# Retrieve a list of your margins.
sig {
params(params: T.any(::Stripe::MarginService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieve a margin object with the given ID.
sig {
params(margin: String, params: T.any(::Stripe::MarginService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Margin)
}
def retrieve(margin, params = {}, opts = {}); end
# Update the specified margin object. Certain fields of the margin object are not editable.
sig {
params(margin: String, params: T.any(::Stripe::MarginService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Margin)
}
def update(margin, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class OrderService < StripeService
attr_reader :line_items
class ListParams < Stripe::RequestParams
# Only return orders for the given customer.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
customer: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
# Enable automatic tax calculation which will automatically compute tax rates on this order.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The billing address provided by the customer.
sig { returns(T.nilable(::Stripe::OrderService::CreateParams::BillingDetails::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::OrderService::CreateParams::BillingDetails::Address)).returns(T.nilable(::Stripe::OrderService::CreateParams::BillingDetails::Address))
}
def address=(_address); end
# The billing email provided by the customer.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The billing name provided by the customer.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The billing phone number provided by the customer.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::OrderService::CreateParams::BillingDetails::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil); end
end
class Discount < Stripe::RequestParams
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
class LineItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
sig { params(coupon: T.nilable(String), discount: T.nilable(String)).void }
def initialize(coupon: nil, discount: nil); end
end
class PriceData < Stripe::RequestParams
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# ID of the [Product](https://docs.stripe.com/api/products) this [Price](https://docs.stripe.com/api/prices) belongs to.
#
# Use this to implement a variable-pricing model in your integration. This is required if `product_data` is not specified.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: T.nilable(String), product: T.nilable(String), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class ProductData < Stripe::RequestParams
class PackageDimensions < Stripe::RequestParams
# Height, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def height; end
sig { params(_height: Float).returns(Float) }
def height=(_height); end
# Length, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def length; end
sig { params(_length: Float).returns(Float) }
def length=(_length); end
# Weight, in ounces. Maximum precision is 2 decimal places.
sig { returns(Float) }
def weight; end
sig { params(_weight: Float).returns(Float) }
def weight=(_weight); end
# Width, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def width; end
sig { params(_width: Float).returns(Float) }
def width=(_width); end
sig { params(height: Float, length: Float, weight: Float, width: Float).void }
def initialize(height: nil, length: nil, weight: nil, width: nil); end
end
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# A unique identifier for this product.
#
# `product_data` automatically creates a Product with this ID. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates. If any of the fields in the existing Product are different from the values in `product_data`, `product_data` updates the existing Product with the new information. So set `product_data[id]` to the same string every time you sell the same product, but don't re-use the same string for different products.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def images; end
sig {
params(_images: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def images=(_images); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The dimensions of this product for shipping purposes.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::CreateParams::LineItem::ProductData::PackageDimensions)))
}
def package_dimensions; end
sig {
params(_package_dimensions: T.nilable(T.any(String, ::Stripe::OrderService::CreateParams::LineItem::ProductData::PackageDimensions))).returns(T.nilable(T.any(String, ::Stripe::OrderService::CreateParams::LineItem::ProductData::PackageDimensions)))
}
def package_dimensions=(_package_dimensions); end
# Whether this product is shipped (i.e., physical goods).
sig { returns(T.nilable(T::Boolean)) }
def shippable; end
sig { params(_shippable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def shippable=(_shippable); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A URL of a publicly-accessible webpage for this product.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(description: T.nilable(String), id: String, images: T.nilable(T.any(String, T::Array[String])), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: String, package_dimensions: T.nilable(T.any(String, ::Stripe::OrderService::CreateParams::LineItem::ProductData::PackageDimensions)), shippable: T.nilable(T::Boolean), tax_code: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
description: nil,
id: nil,
images: nil,
metadata: nil,
name: nil,
package_dimensions: nil,
shippable: nil,
tax_code: nil,
url: nil
); end
end
# The description for the line item. Will default to the name of the associated product.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The discounts applied to this line item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::OrderService::CreateParams::LineItem::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::OrderService::CreateParams::LineItem::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::OrderService::CreateParams::LineItem::Discount])))
}
def discounts=(_discounts); end
# The ID of a [Price](https://docs.stripe.com/api/prices) to add to the Order.
#
# The `price` parameter is an alternative to using the `product` parameter. If each of your products are sold at a single price, you can set `Product.default_price` and then pass the `product` parameter when creating a line item. If your products are sold at several possible prices, use the `price` parameter to explicitly specify which one to use.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new Price object inline.
#
# The `price_data` parameter is an alternative to using the `product` or `price` parameters. If you create a Product upfront and configure a `Product.default_price`, pass the `product` parameter when creating a line item. If you prefer not to define Products upfront, or if you charge variable prices, pass the `price_data` parameter to describe the price for this line item.
#
# Each time you pass `price_data` we create a Price for the Product. This Price is hidden in both the Dashboard and API lists and cannot be reused.
sig { returns(T.nilable(::Stripe::OrderService::CreateParams::LineItem::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::OrderService::CreateParams::LineItem::PriceData)).returns(T.nilable(::Stripe::OrderService::CreateParams::LineItem::PriceData))
}
def price_data=(_price_data); end
# The ID of a [Product](https://docs.stripe.com/api/products) to add to the Order.
#
# The Product must have a `default_price` specified. Otherwise, specify the price by passing the `price` or `price_data` parameter.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Defines a [Product](https://docs.stripe.com/api/products) inline and adds it to the Order.
#
# `product_data` is an alternative to the `product` parameter. If you created a Product upfront, use the `product` parameter to refer to the existing Product. But if you prefer not to create Products upfront, pass the `product_data` parameter to define a Product inline as part of configuring the Order.
#
# `product_data` automatically creates a Product, just as if you had manually created the Product. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates.
sig { returns(T.nilable(::Stripe::OrderService::CreateParams::LineItem::ProductData)) }
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::OrderService::CreateParams::LineItem::ProductData)).returns(T.nilable(::Stripe::OrderService::CreateParams::LineItem::ProductData))
}
def product_data=(_product_data); end
# The quantity of the line item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates applied to this line item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::OrderService::CreateParams::LineItem::Discount])), price: T.nilable(String), price_data: T.nilable(::Stripe::OrderService::CreateParams::LineItem::PriceData), product: T.nilable(String), product_data: T.nilable(::Stripe::OrderService::CreateParams::LineItem::ProductData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
description: nil,
discounts: nil,
price: nil,
price_data: nil,
product: nil,
product_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class Payment < Stripe::RequestParams
class Settings < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
mandate_options: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class AfterpayClearpay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# An internal identifier or reference this payment corresponds to. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Indicates that you intend to make future payments with the payment method.
#
# Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
#
# When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
#
# If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), reference: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, reference: nil, setup_future_usage: nil); end
end
class Alipay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class Card < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with the payment method.
#
# Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
#
# When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
#
# If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for the eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
sig {
params(_requested_address_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested_address_types=(_requested_address_types); end
# The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
}
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(bank_transfer: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
end
class Ideal < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Klarna < Stripe::RequestParams
class OnDemand < Stripe::RequestParams
# Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def average_amount; end
sig { params(_average_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def average_amount=(_average_amount); end
# The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def maximum_amount; end
sig { params(_maximum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_amount=(_maximum_amount); end
# The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Interval at which the customer is making purchases
sig { returns(T.nilable(String)) }
def purchase_interval; end
sig { params(_purchase_interval: T.nilable(String)).returns(T.nilable(String)) }
def purchase_interval=(_purchase_interval); end
# The number of `purchase_interval` between charges
sig { returns(T.nilable(Integer)) }
def purchase_interval_count; end
sig {
params(_purchase_interval_count: T.nilable(Integer)).returns(T.nilable(Integer))
}
def purchase_interval_count=(_purchase_interval_count); end
sig {
params(average_amount: T.nilable(Integer), maximum_amount: T.nilable(Integer), minimum_amount: T.nilable(Integer), purchase_interval: T.nilable(String), purchase_interval_count: T.nilable(Integer)).void
}
def initialize(
average_amount: nil,
maximum_amount: nil,
minimum_amount: nil,
purchase_interval: nil,
purchase_interval_count: nil
); end
end
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing; end
sig {
params(_next_billing: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription::NextBilling)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription::NextBilling), reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# On-demand details if setting up or charging an on-demand payment.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand; end
sig {
params(_on_demand: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::OnDemand)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand=(_on_demand); end
# Preferred language of the Klarna authorization page that the customer is redirected to
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Subscription details if setting up or charging a subscription.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(capture_method: T.nilable(String), on_demand: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::OnDemand), preferred_locale: T.nilable(String), setup_future_usage: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(
capture_method: nil,
on_demand: nil,
preferred_locale: nil,
setup_future_usage: nil,
subscriptions: nil
); end
end
class Link < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
sig { params(_persistent_token: T.nilable(String)).returns(T.nilable(String)) }
def persistent_token=(_persistent_token); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), persistent_token: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(
capture_method: nil,
persistent_token: nil,
setup_future_usage: nil
); end
end
class Oxxo < Stripe::RequestParams
# The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class P24 < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Confirm that the payer has accepted the P24 terms and conditions.
sig { returns(T.nilable(T::Boolean)) }
def tos_shown_and_accepted; end
sig {
params(_tos_shown_and_accepted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def tos_shown_and_accepted=(_tos_shown_and_accepted); end
sig {
params(setup_future_usage: T.nilable(String), tos_shown_and_accepted: T.nilable(T::Boolean)).void
}
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
end
class Paypal < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The tax for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The tax behavior for the line item.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(amount: Integer, behavior: String).void }
def initialize(amount: nil, behavior: nil); end
end
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Descriptive name of the line item.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Quantity of the line item. Must be a positive number.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Client facing stock keeping unit, article number or similar.
sig { returns(T.nilable(String)) }
def sku; end
sig { params(_sku: T.nilable(String)).returns(T.nilable(String)) }
def sku=(_sku); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
# The tax information for the line item.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem::Tax)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax=(_tax); end
# Price for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def unit_amount; end
sig { params(_unit_amount: Integer).returns(Integer) }
def unit_amount=(_unit_amount); end
sig {
params(category: T.nilable(String), description: T.nilable(String), name: String, quantity: Integer, sku: T.nilable(String), sold_by: T.nilable(String), tax: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem::Tax), unit_amount: Integer).void
}
def initialize(
category: nil,
description: nil,
name: nil,
quantity: nil,
sku: nil,
sold_by: nil,
tax: nil,
unit_amount: nil
); end
end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# The line items purchased by the customer.
sig {
returns(T.nilable(T::Array[::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem])).returns(T.nilable(T::Array[::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items=(_line_items); end
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference_id; end
sig { params(_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def reference_id=(_reference_id); end
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
sig { returns(T.nilable(String)) }
def risk_correlation_id; end
sig { params(_risk_correlation_id: T.nilable(String)).returns(T.nilable(String)) }
def risk_correlation_id=(_risk_correlation_id); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(capture_method: T.nilable(String), line_items: T.nilable(T::Array[::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem]), preferred_locale: T.nilable(String), reference: T.nilable(String), reference_id: T.nilable(String), risk_correlation_id: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String)), subsellers: T.nilable(T::Array[String])).void
}
def initialize(
capture_method: nil,
line_items: nil,
preferred_locale: nil,
reference: nil,
reference_id: nil,
risk_correlation_id: nil,
setup_future_usage: nil,
subsellers: nil
); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Sofort < Stripe::RequestParams
# Language shown to the payer on redirect.
sig { returns(T.nilable(T.any(String, String))) }
def preferred_language; end
sig {
params(_preferred_language: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(T.any(String, String)), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class WechatPay < Stripe::RequestParams
# The app ID registered with WeChat Pay. Only required when client is ios or android.
sig { returns(T.nilable(String)) }
def app_id; end
sig { params(_app_id: T.nilable(String)).returns(T.nilable(String)) }
def app_id=(_app_id); end
# The client type that the end customer will pay from
sig { returns(T.nilable(String)) }
def client; end
sig { params(_client: T.nilable(String)).returns(T.nilable(String)) }
def client=(_client); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(app_id: T.nilable(String), client: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
end
# If paying by `acss_debit`, this sub-hash contains details about the ACSS Debit payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If paying by `afterpay_clearpay`, this sub-hash contains details about the AfterpayClearpay payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::AfterpayClearpay)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If paying by `alipay`, this sub-hash contains details about the Alipay payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Alipay))
}
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Alipay)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Alipay))
}
def alipay=(_alipay); end
# If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Bancontact)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Bancontact))
}
def bancontact=(_bancontact); end
# If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Card))
}
def card=(_card); end
# If paying by `customer_balance`, this sub-hash contains details about the Customer Balance payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If paying by `ideal`, this sub-hash contains details about the iDEAL payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Ideal))
}
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Ideal)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Ideal))
}
def ideal=(_ideal); end
# If paying by `klarna`, this sub-hash contains details about the Klarna payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# If paying by `link`, this sub-hash contains details about the Link payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Link))
}
def link; end
sig {
params(_link: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Link)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Link))
}
def link=(_link); end
# If paying by `oxxo`, this sub-hash contains details about the OXXO payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Oxxo))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Oxxo)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Oxxo))
}
def oxxo=(_oxxo); end
# If paying by `p24`, this sub-hash contains details about the P24 payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::P24))
}
def p24; end
sig {
params(_p24: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::P24)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::P24))
}
def p24=(_p24); end
# If paying by `paypal`, this sub-hash contains details about the PayPal payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
# If paying by `sepa_debit`, this sub-hash contains details about the SEPA Debit payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If paying by `sofort`, this sub-hash contains details about the Sofort payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Sofort))
}
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Sofort)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Sofort))
}
def sofort=(_sofort); end
# If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::WechatPay)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::WechatPay))
}
def wechat_pay=(_wechat_pay); end
sig {
params(acss_debit: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit), afterpay_clearpay: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::AfterpayClearpay), alipay: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Alipay), bancontact: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Bancontact), card: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Card), customer_balance: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance), ideal: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Ideal), klarna: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Klarna), link: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Link), oxxo: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Oxxo), p24: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::P24), paypal: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Paypal), sepa_debit: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit), sofort: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::Sofort), wechat_pay: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::WechatPay)).void
}
def initialize(
acss_debit: nil,
afterpay_clearpay: nil,
alipay: nil,
bancontact: nil,
card: nil,
customer_balance: nil,
ideal: nil,
klarna: nil,
link: nil,
oxxo: nil,
p24: nil,
paypal: nil,
sepa_debit: nil,
sofort: nil,
wechat_pay: nil
); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when the order is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# ID of the Connected account receiving the transfer.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# PaymentMethod-specific configuration to provide to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
# The URL to redirect the customer to after they authenticate their payment.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# Provides configuration for completing a transfer for the order after it is paid.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::TransferData))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::TransferData)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::TransferData))
}
def transfer_data=(_transfer_data); end
sig {
params(application_fee_amount: T.nilable(Integer), payment_method_options: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), return_url: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::OrderService::CreateParams::Payment::Settings::TransferData)).void
}
def initialize(
application_fee_amount: nil,
payment_method_options: nil,
payment_method_types: nil,
return_url: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil
); end
end
# Settings describing how the order should configure generated PaymentIntents.
sig { returns(::Stripe::OrderService::CreateParams::Payment::Settings) }
def settings; end
sig {
params(_settings: ::Stripe::OrderService::CreateParams::Payment::Settings).returns(::Stripe::OrderService::CreateParams::Payment::Settings)
}
def settings=(_settings); end
sig { params(settings: ::Stripe::OrderService::CreateParams::Payment::Settings).void }
def initialize(settings: nil); end
end
class ShippingCost < Stripe::RequestParams
class ShippingRateData < Stripe::RequestParams
class DeliveryEstimate < Stripe::RequestParams
class Maximum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
class Minimum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum; end
sig {
params(_maximum: T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum)).returns(T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum=(_maximum); end
# The lower bound of the estimated range. If empty, represents no lower bound.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum; end
sig {
params(_minimum: T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum)).returns(T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum=(_minimum); end
sig {
params(maximum: T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum), minimum: T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum)).void
}
def initialize(maximum: nil, minimum: nil); end
end
class FixedAmount < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig { params(amount: Integer, tax_behavior: T.nilable(String)).void }
def initialize(amount: nil, tax_behavior: nil); end
end
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(amount: Integer, currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions])).void
}
def initialize(amount: nil, currency: nil, currency_options: nil); end
end
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate; end
sig {
params(_delivery_estimate: T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate)).returns(T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate=(_delivery_estimate); end
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::FixedAmount))
}
def fixed_amount; end
sig {
params(_fixed_amount: T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::FixedAmount)).returns(T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::FixedAmount))
}
def fixed_amount=(_fixed_amount); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The type of calculation to use on the shipping rate.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(delivery_estimate: T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::DeliveryEstimate), display_name: String, fixed_amount: T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData::FixedAmount), metadata: T.nilable(T::Hash[String, String]), tax_behavior: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
delivery_estimate: nil,
display_name: nil,
fixed_amount: nil,
metadata: nil,
tax_behavior: nil,
tax_code: nil,
type: nil
); end
end
# The ID of the shipping rate to use for this order.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
# Parameters to create a new ad-hoc shipping rate for this order.
sig {
returns(T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData))
}
def shipping_rate_data; end
sig {
params(_shipping_rate_data: T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData)).returns(T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData))
}
def shipping_rate_data=(_shipping_rate_data); end
sig {
params(shipping_rate: T.nilable(String), shipping_rate_data: T.nilable(::Stripe::OrderService::CreateParams::ShippingCost::ShippingRateData)).void
}
def initialize(shipping_rate: nil, shipping_rate_data: nil); end
end
class ShippingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The shipping address for the order.
sig { returns(::Stripe::OrderService::CreateParams::ShippingDetails::Address) }
def address; end
sig {
params(_address: ::Stripe::OrderService::CreateParams::ShippingDetails::Address).returns(::Stripe::OrderService::CreateParams::ShippingDetails::Address)
}
def address=(_address); end
# The name of the recipient of the order.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The phone number (including extension) for the recipient of the order.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: ::Stripe::OrderService::CreateParams::ShippingDetails::Address, name: String, phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
class TaxDetails < Stripe::RequestParams
class TaxId < Stripe::RequestParams
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Value of the tax ID.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(type: String, value: String).void }
def initialize(type: nil, value: nil); end
end
# The purchaser's tax exemption status. One of `none`, `exempt`, or `reverse`.
sig { returns(T.nilable(T.any(String, String))) }
def tax_exempt; end
sig {
params(_tax_exempt: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def tax_exempt=(_tax_exempt); end
# The purchaser's tax IDs to be used for this order.
sig {
returns(T.nilable(T::Array[::Stripe::OrderService::CreateParams::TaxDetails::TaxId]))
}
def tax_ids; end
sig {
params(_tax_ids: T.nilable(T::Array[::Stripe::OrderService::CreateParams::TaxDetails::TaxId])).returns(T.nilable(T::Array[::Stripe::OrderService::CreateParams::TaxDetails::TaxId]))
}
def tax_ids=(_tax_ids); end
sig {
params(tax_exempt: T.nilable(T.any(String, String)), tax_ids: T.nilable(T::Array[::Stripe::OrderService::CreateParams::TaxDetails::TaxId])).void
}
def initialize(tax_exempt: nil, tax_ids: nil); end
end
# Settings for automatic tax calculation for this order.
sig { returns(T.nilable(::Stripe::OrderService::CreateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::OrderService::CreateParams::AutomaticTax)).returns(T.nilable(::Stripe::OrderService::CreateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Billing details for the customer. If a customer is provided, this will be automatically populated with values from that customer if override values are not provided.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::CreateParams::BillingDetails)))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(T.any(String, ::Stripe::OrderService::CreateParams::BillingDetails))).returns(T.nilable(T.any(String, ::Stripe::OrderService::CreateParams::BillingDetails)))
}
def billing_details=(_billing_details); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The customer associated with this order.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The coupons, promotion codes, and/or discounts to apply to the order.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::OrderService::CreateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::OrderService::CreateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::OrderService::CreateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The IP address of the purchaser for this order.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost.
sig { returns(T::Array[::Stripe::OrderService::CreateParams::LineItem]) }
def line_items; end
sig {
params(_line_items: T::Array[::Stripe::OrderService::CreateParams::LineItem]).returns(T::Array[::Stripe::OrderService::CreateParams::LineItem])
}
def line_items=(_line_items); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Payment information associated with the order, including payment settings.
sig { returns(T.nilable(::Stripe::OrderService::CreateParams::Payment)) }
def payment; end
sig {
params(_payment: T.nilable(::Stripe::OrderService::CreateParams::Payment)).returns(T.nilable(::Stripe::OrderService::CreateParams::Payment))
}
def payment=(_payment); end
# Settings for the customer cost of shipping for this order.
sig { returns(T.nilable(T.any(String, ::Stripe::OrderService::CreateParams::ShippingCost))) }
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(T.any(String, ::Stripe::OrderService::CreateParams::ShippingCost))).returns(T.nilable(T.any(String, ::Stripe::OrderService::CreateParams::ShippingCost)))
}
def shipping_cost=(_shipping_cost); end
# Shipping details for the order.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::CreateParams::ShippingDetails)))
}
def shipping_details; end
sig {
params(_shipping_details: T.nilable(T.any(String, ::Stripe::OrderService::CreateParams::ShippingDetails))).returns(T.nilable(T.any(String, ::Stripe::OrderService::CreateParams::ShippingDetails)))
}
def shipping_details=(_shipping_details); end
# Additional tax details about the purchaser to be used for this order.
sig { returns(T.nilable(::Stripe::OrderService::CreateParams::TaxDetails)) }
def tax_details; end
sig {
params(_tax_details: T.nilable(::Stripe::OrderService::CreateParams::TaxDetails)).returns(T.nilable(::Stripe::OrderService::CreateParams::TaxDetails))
}
def tax_details=(_tax_details); end
sig {
params(automatic_tax: T.nilable(::Stripe::OrderService::CreateParams::AutomaticTax), billing_details: T.nilable(T.any(String, ::Stripe::OrderService::CreateParams::BillingDetails)), currency: String, customer: T.nilable(String), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::OrderService::CreateParams::Discount])), expand: T.nilable(T::Array[String]), ip_address: T.nilable(String), line_items: T::Array[::Stripe::OrderService::CreateParams::LineItem], metadata: T.nilable(T::Hash[String, String]), payment: T.nilable(::Stripe::OrderService::CreateParams::Payment), shipping_cost: T.nilable(T.any(String, ::Stripe::OrderService::CreateParams::ShippingCost)), shipping_details: T.nilable(T.any(String, ::Stripe::OrderService::CreateParams::ShippingDetails)), tax_details: T.nilable(::Stripe::OrderService::CreateParams::TaxDetails)).void
}
def initialize(
automatic_tax: nil,
billing_details: nil,
currency: nil,
customer: nil,
description: nil,
discounts: nil,
expand: nil,
ip_address: nil,
line_items: nil,
metadata: nil,
payment: nil,
shipping_cost: nil,
shipping_details: nil,
tax_details: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
# Enable automatic tax calculation which will automatically compute tax rates on this order.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The billing address provided by the customer.
sig { returns(T.nilable(::Stripe::OrderService::UpdateParams::BillingDetails::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::OrderService::UpdateParams::BillingDetails::Address)).returns(T.nilable(::Stripe::OrderService::UpdateParams::BillingDetails::Address))
}
def address=(_address); end
# The billing email provided by the customer.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The billing name provided by the customer.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The billing phone number provided by the customer.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::OrderService::UpdateParams::BillingDetails::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil); end
end
class Discount < Stripe::RequestParams
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
class LineItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
sig { params(coupon: T.nilable(String), discount: T.nilable(String)).void }
def initialize(coupon: nil, discount: nil); end
end
class PriceData < Stripe::RequestParams
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# ID of the [Product](https://docs.stripe.com/api/products) this [Price](https://docs.stripe.com/api/prices) belongs to.
#
# Use this to implement a variable-pricing model in your integration. This is required if `product_data` is not specified.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: T.nilable(String), product: T.nilable(String), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class ProductData < Stripe::RequestParams
class PackageDimensions < Stripe::RequestParams
# Height, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def height; end
sig { params(_height: Float).returns(Float) }
def height=(_height); end
# Length, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def length; end
sig { params(_length: Float).returns(Float) }
def length=(_length); end
# Weight, in ounces. Maximum precision is 2 decimal places.
sig { returns(Float) }
def weight; end
sig { params(_weight: Float).returns(Float) }
def weight=(_weight); end
# Width, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def width; end
sig { params(_width: Float).returns(Float) }
def width=(_width); end
sig { params(height: Float, length: Float, weight: Float, width: Float).void }
def initialize(height: nil, length: nil, weight: nil, width: nil); end
end
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# A unique identifier for this product.
#
# `product_data` automatically creates a Product with this ID. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates. If any of the fields in the existing Product are different from the values in `product_data`, `product_data` updates the existing Product with the new information. So set `product_data[id]` to the same string every time you sell the same product, but don't re-use the same string for different products.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def images; end
sig {
params(_images: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def images=(_images); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The dimensions of this product for shipping purposes.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::LineItem::ProductData::PackageDimensions)))
}
def package_dimensions; end
sig {
params(_package_dimensions: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::LineItem::ProductData::PackageDimensions))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::LineItem::ProductData::PackageDimensions)))
}
def package_dimensions=(_package_dimensions); end
# Whether this product is shipped (i.e., physical goods).
sig { returns(T.nilable(T::Boolean)) }
def shippable; end
sig { params(_shippable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def shippable=(_shippable); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A URL of a publicly-accessible webpage for this product.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(description: T.nilable(String), id: String, images: T.nilable(T.any(String, T::Array[String])), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: String, package_dimensions: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::LineItem::ProductData::PackageDimensions)), shippable: T.nilable(T::Boolean), tax_code: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
description: nil,
id: nil,
images: nil,
metadata: nil,
name: nil,
package_dimensions: nil,
shippable: nil,
tax_code: nil,
url: nil
); end
end
# The description for the line item. Will default to the name of the associated product.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The discounts applied to this line item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::OrderService::UpdateParams::LineItem::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::OrderService::UpdateParams::LineItem::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::OrderService::UpdateParams::LineItem::Discount])))
}
def discounts=(_discounts); end
# The ID of an existing line item on the order.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The ID of a [Price](https://docs.stripe.com/api/prices) to add to the Order.
#
# The `price` parameter is an alternative to using the `product` parameter. If each of your products are sold at a single price, you can set `Product.default_price` and then pass the `product` parameter when creating a line item. If your products are sold at several possible prices, use the `price` parameter to explicitly specify which one to use.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new Price object inline.
#
# The `price_data` parameter is an alternative to using the `product` or `price` parameters. If you create a Product upfront and configure a `Product.default_price`, pass the `product` parameter when creating a line item. If you prefer not to define Products upfront, or if you charge variable prices, pass the `price_data` parameter to describe the price for this line item.
#
# Each time you pass `price_data` we create a Price for the Product. This Price is hidden in both the Dashboard and API lists and cannot be reused.
sig { returns(T.nilable(::Stripe::OrderService::UpdateParams::LineItem::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::OrderService::UpdateParams::LineItem::PriceData)).returns(T.nilable(::Stripe::OrderService::UpdateParams::LineItem::PriceData))
}
def price_data=(_price_data); end
# The ID of a [Product](https://docs.stripe.com/api/products) to add to the Order.
#
# The Product must have a `default_price` specified. Otherwise, specify the price by passing the `price` or `price_data` parameter.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Defines a [Product](https://docs.stripe.com/api/products) inline and adds it to the Order.
#
# `product_data` is an alternative to the `product` parameter. If you created a Product upfront, use the `product` parameter to refer to the existing Product. But if you prefer not to create Products upfront, pass the `product_data` parameter to define a Product inline as part of configuring the Order.
#
# `product_data` automatically creates a Product, just as if you had manually created the Product. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates.
sig { returns(T.nilable(::Stripe::OrderService::UpdateParams::LineItem::ProductData)) }
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::OrderService::UpdateParams::LineItem::ProductData)).returns(T.nilable(::Stripe::OrderService::UpdateParams::LineItem::ProductData))
}
def product_data=(_product_data); end
# The quantity of the line item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates applied to this line item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::OrderService::UpdateParams::LineItem::Discount])), id: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::OrderService::UpdateParams::LineItem::PriceData), product: T.nilable(String), product_data: T.nilable(::Stripe::OrderService::UpdateParams::LineItem::ProductData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
description: nil,
discounts: nil,
id: nil,
price: nil,
price_data: nil,
product: nil,
product_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class Payment < Stripe::RequestParams
class Settings < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
mandate_options: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class AfterpayClearpay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# An internal identifier or reference this payment corresponds to. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Indicates that you intend to make future payments with the payment method.
#
# Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
#
# When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
#
# If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), reference: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, reference: nil, setup_future_usage: nil); end
end
class Alipay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class Card < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with the payment method.
#
# Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
#
# When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
#
# If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for the eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
sig {
params(_requested_address_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested_address_types=(_requested_address_types); end
# The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
}
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(bank_transfer: T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
end
class Ideal < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Klarna < Stripe::RequestParams
class OnDemand < Stripe::RequestParams
# Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def average_amount; end
sig { params(_average_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def average_amount=(_average_amount); end
# The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def maximum_amount; end
sig { params(_maximum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_amount=(_maximum_amount); end
# The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Interval at which the customer is making purchases
sig { returns(T.nilable(String)) }
def purchase_interval; end
sig { params(_purchase_interval: T.nilable(String)).returns(T.nilable(String)) }
def purchase_interval=(_purchase_interval); end
# The number of `purchase_interval` between charges
sig { returns(T.nilable(Integer)) }
def purchase_interval_count; end
sig {
params(_purchase_interval_count: T.nilable(Integer)).returns(T.nilable(Integer))
}
def purchase_interval_count=(_purchase_interval_count); end
sig {
params(average_amount: T.nilable(Integer), maximum_amount: T.nilable(Integer), minimum_amount: T.nilable(Integer), purchase_interval: T.nilable(String), purchase_interval_count: T.nilable(Integer)).void
}
def initialize(
average_amount: nil,
maximum_amount: nil,
minimum_amount: nil,
purchase_interval: nil,
purchase_interval_count: nil
); end
end
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing; end
sig {
params(_next_billing: T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription::NextBilling)).returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription::NextBilling), reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# On-demand details if setting up or charging an on-demand payment.
sig {
returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand; end
sig {
params(_on_demand: T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::OnDemand)).returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand=(_on_demand); end
# Preferred language of the Klarna authorization page that the customer is redirected to
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Subscription details if setting up or charging a subscription.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(capture_method: T.nilable(String), on_demand: T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::OnDemand), preferred_locale: T.nilable(String), setup_future_usage: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(
capture_method: nil,
on_demand: nil,
preferred_locale: nil,
setup_future_usage: nil,
subscriptions: nil
); end
end
class Link < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
sig { params(_persistent_token: T.nilable(String)).returns(T.nilable(String)) }
def persistent_token=(_persistent_token); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), persistent_token: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(
capture_method: nil,
persistent_token: nil,
setup_future_usage: nil
); end
end
class Oxxo < Stripe::RequestParams
# The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class P24 < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Confirm that the payer has accepted the P24 terms and conditions.
sig { returns(T.nilable(T::Boolean)) }
def tos_shown_and_accepted; end
sig {
params(_tos_shown_and_accepted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def tos_shown_and_accepted=(_tos_shown_and_accepted); end
sig {
params(setup_future_usage: T.nilable(String), tos_shown_and_accepted: T.nilable(T::Boolean)).void
}
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
end
class Paypal < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The tax for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The tax behavior for the line item.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(amount: Integer, behavior: String).void }
def initialize(amount: nil, behavior: nil); end
end
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Descriptive name of the line item.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Quantity of the line item. Must be a positive number.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Client facing stock keeping unit, article number or similar.
sig { returns(T.nilable(String)) }
def sku; end
sig { params(_sku: T.nilable(String)).returns(T.nilable(String)) }
def sku=(_sku); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
# The tax information for the line item.
sig {
returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem::Tax)).returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax=(_tax); end
# Price for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def unit_amount; end
sig { params(_unit_amount: Integer).returns(Integer) }
def unit_amount=(_unit_amount); end
sig {
params(category: T.nilable(String), description: T.nilable(String), name: String, quantity: Integer, sku: T.nilable(String), sold_by: T.nilable(String), tax: T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem::Tax), unit_amount: Integer).void
}
def initialize(
category: nil,
description: nil,
name: nil,
quantity: nil,
sku: nil,
sold_by: nil,
tax: nil,
unit_amount: nil
); end
end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# The line items purchased by the customer.
sig {
returns(T.nilable(T::Array[::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem])).returns(T.nilable(T::Array[::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items=(_line_items); end
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference_id; end
sig { params(_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def reference_id=(_reference_id); end
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
sig { returns(T.nilable(String)) }
def risk_correlation_id; end
sig { params(_risk_correlation_id: T.nilable(String)).returns(T.nilable(String)) }
def risk_correlation_id=(_risk_correlation_id); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(capture_method: T.nilable(String), line_items: T.nilable(T::Array[::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal::LineItem]), preferred_locale: T.nilable(String), reference: T.nilable(String), reference_id: T.nilable(String), risk_correlation_id: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String)), subsellers: T.nilable(T::Array[String])).void
}
def initialize(
capture_method: nil,
line_items: nil,
preferred_locale: nil,
reference: nil,
reference_id: nil,
risk_correlation_id: nil,
setup_future_usage: nil,
subsellers: nil
); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Sofort < Stripe::RequestParams
# Language shown to the payer on redirect.
sig { returns(T.nilable(T.any(String, String))) }
def preferred_language; end
sig {
params(_preferred_language: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(T.any(String, String)), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class WechatPay < Stripe::RequestParams
# The app ID registered with WeChat Pay. Only required when client is ios or android.
sig { returns(T.nilable(String)) }
def app_id; end
sig { params(_app_id: T.nilable(String)).returns(T.nilable(String)) }
def app_id=(_app_id); end
# The client type that the end customer will pay from
sig { returns(T.nilable(String)) }
def client; end
sig { params(_client: T.nilable(String)).returns(T.nilable(String)) }
def client=(_client); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(app_id: T.nilable(String), client: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
end
# If paying by `acss_debit`, this sub-hash contains details about the ACSS Debit payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit=(_acss_debit); end
# If paying by `afterpay_clearpay`, this sub-hash contains details about the AfterpayClearpay payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::AfterpayClearpay)))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::AfterpayClearpay))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::AfterpayClearpay)))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If paying by `alipay`, this sub-hash contains details about the Alipay payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Alipay)))
}
def alipay; end
sig {
params(_alipay: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Alipay))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Alipay)))
}
def alipay=(_alipay); end
# If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Bancontact)))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Bancontact))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Bancontact)))
}
def bancontact=(_bancontact); end
# If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Card)))
}
def card; end
sig {
params(_card: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Card))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Card)))
}
def card=(_card); end
# If paying by `customer_balance`, this sub-hash contains details about the Customer Balance payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance=(_customer_balance); end
# If paying by `ideal`, this sub-hash contains details about the iDEAL payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Ideal)))
}
def ideal; end
sig {
params(_ideal: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Ideal))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Ideal)))
}
def ideal=(_ideal); end
# If paying by `klarna`, this sub-hash contains details about the Klarna payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna)))
}
def klarna; end
sig {
params(_klarna: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna)))
}
def klarna=(_klarna); end
# If paying by `link`, this sub-hash contains details about the Link payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Link)))
}
def link; end
sig {
params(_link: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Link))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Link)))
}
def link=(_link); end
# If paying by `oxxo`, this sub-hash contains details about the OXXO payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Oxxo)))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Oxxo))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Oxxo)))
}
def oxxo=(_oxxo); end
# If paying by `p24`, this sub-hash contains details about the P24 payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::P24)))
}
def p24; end
sig {
params(_p24: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::P24))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::P24)))
}
def p24=(_p24); end
# If paying by `paypal`, this sub-hash contains details about the PayPal payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal)))
}
def paypal; end
sig {
params(_paypal: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal)))
}
def paypal=(_paypal); end
# If paying by `sepa_debit`, this sub-hash contains details about the SEPA Debit payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit=(_sepa_debit); end
# If paying by `sofort`, this sub-hash contains details about the Sofort payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Sofort)))
}
def sofort; end
sig {
params(_sofort: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Sofort))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Sofort)))
}
def sofort=(_sofort); end
# If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the order's PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::WechatPay)))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::WechatPay))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::WechatPay)))
}
def wechat_pay=(_wechat_pay); end
sig {
params(acss_debit: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit)), afterpay_clearpay: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::AfterpayClearpay)), alipay: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Alipay)), bancontact: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Bancontact)), card: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Card)), customer_balance: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::CustomerBalance)), ideal: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Ideal)), klarna: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Klarna)), link: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Link)), oxxo: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Oxxo)), p24: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::P24)), paypal: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal)), sepa_debit: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit)), sofort: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Sofort)), wechat_pay: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::WechatPay))).void
}
def initialize(
acss_debit: nil,
afterpay_clearpay: nil,
alipay: nil,
bancontact: nil,
card: nil,
customer_balance: nil,
ideal: nil,
klarna: nil,
link: nil,
oxxo: nil,
p24: nil,
paypal: nil,
sepa_debit: nil,
sofort: nil,
wechat_pay: nil
); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when the order is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# ID of the Connected account receiving the transfer.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.
sig { returns(T.nilable(T.any(String, Integer))) }
def application_fee_amount; end
sig {
params(_application_fee_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def application_fee_amount=(_application_fee_amount); end
# PaymentMethod-specific configuration to provide to the order's PaymentIntent.
sig {
returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions)).returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
# The URL to redirect the customer to after they authenticate their payment.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# Provides configuration for completing a transfer for the order after it is paid.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::TransferData)))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::TransferData))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::TransferData)))
}
def transfer_data=(_transfer_data); end
sig {
params(application_fee_amount: T.nilable(T.any(String, Integer)), payment_method_options: T.nilable(::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), return_url: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::Payment::Settings::TransferData))).void
}
def initialize(
application_fee_amount: nil,
payment_method_options: nil,
payment_method_types: nil,
return_url: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil
); end
end
# Settings describing how the order should configure generated PaymentIntents.
sig { returns(::Stripe::OrderService::UpdateParams::Payment::Settings) }
def settings; end
sig {
params(_settings: ::Stripe::OrderService::UpdateParams::Payment::Settings).returns(::Stripe::OrderService::UpdateParams::Payment::Settings)
}
def settings=(_settings); end
sig { params(settings: ::Stripe::OrderService::UpdateParams::Payment::Settings).void }
def initialize(settings: nil); end
end
class ShippingCost < Stripe::RequestParams
class ShippingRateData < Stripe::RequestParams
class DeliveryEstimate < Stripe::RequestParams
class Maximum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
class Minimum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
sig {
returns(T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum; end
sig {
params(_maximum: T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum)).returns(T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum))
}
def maximum=(_maximum); end
# The lower bound of the estimated range. If empty, represents no lower bound.
sig {
returns(T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum; end
sig {
params(_minimum: T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum)).returns(T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum))
}
def minimum=(_minimum); end
sig {
params(maximum: T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Maximum), minimum: T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate::Minimum)).void
}
def initialize(maximum: nil, minimum: nil); end
end
class FixedAmount < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig { params(amount: Integer, tax_behavior: T.nilable(String)).void }
def initialize(amount: nil, tax_behavior: nil); end
end
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(amount: Integer, currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::FixedAmount::CurrencyOptions])).void
}
def initialize(amount: nil, currency: nil, currency_options: nil); end
end
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig {
returns(T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate; end
sig {
params(_delivery_estimate: T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate)).returns(T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate))
}
def delivery_estimate=(_delivery_estimate); end
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
sig {
returns(T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::FixedAmount))
}
def fixed_amount; end
sig {
params(_fixed_amount: T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::FixedAmount)).returns(T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::FixedAmount))
}
def fixed_amount=(_fixed_amount); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The type of calculation to use on the shipping rate.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(delivery_estimate: T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::DeliveryEstimate), display_name: String, fixed_amount: T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData::FixedAmount), metadata: T.nilable(T::Hash[String, String]), tax_behavior: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
delivery_estimate: nil,
display_name: nil,
fixed_amount: nil,
metadata: nil,
tax_behavior: nil,
tax_code: nil,
type: nil
); end
end
# The ID of the shipping rate to use for this order.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
# Parameters to create a new ad-hoc shipping rate for this order.
sig {
returns(T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData))
}
def shipping_rate_data; end
sig {
params(_shipping_rate_data: T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData)).returns(T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData))
}
def shipping_rate_data=(_shipping_rate_data); end
sig {
params(shipping_rate: T.nilable(String), shipping_rate_data: T.nilable(::Stripe::OrderService::UpdateParams::ShippingCost::ShippingRateData)).void
}
def initialize(shipping_rate: nil, shipping_rate_data: nil); end
end
class ShippingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The shipping address for the order.
sig { returns(::Stripe::OrderService::UpdateParams::ShippingDetails::Address) }
def address; end
sig {
params(_address: ::Stripe::OrderService::UpdateParams::ShippingDetails::Address).returns(::Stripe::OrderService::UpdateParams::ShippingDetails::Address)
}
def address=(_address); end
# The name of the recipient of the order.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The phone number (including extension) for the recipient of the order.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: ::Stripe::OrderService::UpdateParams::ShippingDetails::Address, name: String, phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
class TaxDetails < Stripe::RequestParams
class TaxId < Stripe::RequestParams
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Value of the tax ID.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(type: String, value: String).void }
def initialize(type: nil, value: nil); end
end
# The purchaser's tax exemption status. One of `none`, `exempt`, or `reverse`.
sig { returns(T.nilable(T.any(String, String))) }
def tax_exempt; end
sig {
params(_tax_exempt: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def tax_exempt=(_tax_exempt); end
# The purchaser's tax IDs to be used for this order.
sig {
returns(T.nilable(T::Array[::Stripe::OrderService::UpdateParams::TaxDetails::TaxId]))
}
def tax_ids; end
sig {
params(_tax_ids: T.nilable(T::Array[::Stripe::OrderService::UpdateParams::TaxDetails::TaxId])).returns(T.nilable(T::Array[::Stripe::OrderService::UpdateParams::TaxDetails::TaxId]))
}
def tax_ids=(_tax_ids); end
sig {
params(tax_exempt: T.nilable(T.any(String, String)), tax_ids: T.nilable(T::Array[::Stripe::OrderService::UpdateParams::TaxDetails::TaxId])).void
}
def initialize(tax_exempt: nil, tax_ids: nil); end
end
# Settings for automatic tax calculation for this order.
sig { returns(T.nilable(::Stripe::OrderService::UpdateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::OrderService::UpdateParams::AutomaticTax)).returns(T.nilable(::Stripe::OrderService::UpdateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Billing details for the customer. If a customer is provided, this will be automatically populated with values from that customer if override values are not provided.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::BillingDetails)))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::BillingDetails))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::BillingDetails)))
}
def billing_details=(_billing_details); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The customer associated with this order.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The coupons, promotion codes, and/or discounts to apply to the order. Pass the empty string `""` to unset this field.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::OrderService::UpdateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::OrderService::UpdateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::OrderService::UpdateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The IP address of the purchaser for this order.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost.
sig { returns(T.nilable(T::Array[::Stripe::OrderService::UpdateParams::LineItem])) }
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::OrderService::UpdateParams::LineItem])).returns(T.nilable(T::Array[::Stripe::OrderService::UpdateParams::LineItem]))
}
def line_items=(_line_items); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Payment information associated with the order, including payment settings.
sig { returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment)) }
def payment; end
sig {
params(_payment: T.nilable(::Stripe::OrderService::UpdateParams::Payment)).returns(T.nilable(::Stripe::OrderService::UpdateParams::Payment))
}
def payment=(_payment); end
# Settings for the customer cost of shipping for this order.
sig { returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::ShippingCost))) }
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::ShippingCost))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::ShippingCost)))
}
def shipping_cost=(_shipping_cost); end
# Shipping details for the order.
sig {
returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::ShippingDetails)))
}
def shipping_details; end
sig {
params(_shipping_details: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::ShippingDetails))).returns(T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::ShippingDetails)))
}
def shipping_details=(_shipping_details); end
# Additional tax details about the purchaser to be used for this order.
sig { returns(T.nilable(::Stripe::OrderService::UpdateParams::TaxDetails)) }
def tax_details; end
sig {
params(_tax_details: T.nilable(::Stripe::OrderService::UpdateParams::TaxDetails)).returns(T.nilable(::Stripe::OrderService::UpdateParams::TaxDetails))
}
def tax_details=(_tax_details); end
sig {
params(automatic_tax: T.nilable(::Stripe::OrderService::UpdateParams::AutomaticTax), billing_details: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::BillingDetails)), currency: T.nilable(String), customer: T.nilable(String), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::OrderService::UpdateParams::Discount])), expand: T.nilable(T::Array[String]), ip_address: T.nilable(String), line_items: T.nilable(T::Array[::Stripe::OrderService::UpdateParams::LineItem]), metadata: T.nilable(T.any(String, T::Hash[String, String])), payment: T.nilable(::Stripe::OrderService::UpdateParams::Payment), shipping_cost: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::ShippingCost)), shipping_details: T.nilable(T.any(String, ::Stripe::OrderService::UpdateParams::ShippingDetails)), tax_details: T.nilable(::Stripe::OrderService::UpdateParams::TaxDetails)).void
}
def initialize(
automatic_tax: nil,
billing_details: nil,
currency: nil,
customer: nil,
description: nil,
discounts: nil,
expand: nil,
ip_address: nil,
line_items: nil,
metadata: nil,
payment: nil,
shipping_cost: nil,
shipping_details: nil,
tax_details: nil
); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ReopenParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class SubmitParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# `expected_total` should always be set to the order's `amount_total` field. If they don't match, submitting the order will fail. This helps detect race conditions where something else concurrently modifies the order.
sig { returns(Integer) }
def expected_total; end
sig { params(_expected_total: Integer).returns(Integer) }
def expected_total=(_expected_total); end
sig { params(expand: T.nilable(T::Array[String]), expected_total: Integer).void }
def initialize(expand: nil, expected_total: nil); end
end
# Cancels the order as well as the payment intent if one is attached.
sig {
params(id: String, params: T.any(::Stripe::OrderService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order)
}
def cancel(id, params = {}, opts = {}); end
# Creates a new open order object.
sig {
params(params: T.any(::Stripe::OrderService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order)
}
def create(params = {}, opts = {}); end
# Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.
sig {
params(params: T.any(::Stripe::OrderService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Reopens a submitted order.
sig {
params(id: String, params: T.any(::Stripe::OrderService::ReopenParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order)
}
def reopen(id, params = {}, opts = {}); end
# Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.
sig {
params(id: String, params: T.any(::Stripe::OrderService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order)
}
def retrieve(id, params = {}, opts = {}); end
# Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://docs.stripe.com/api#reopen_order) method is called.
sig {
params(id: String, params: T.any(::Stripe::OrderService::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order)
}
def submit(id, params = {}, opts = {}); end
# Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(id: String, params: T.any(::Stripe::OrderService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order)
}
def update(id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class OrderLineItemService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# When retrieving an order, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
sig {
params(id: String, params: T.any(::Stripe::OrderLineItemService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class PaymentAttemptRecordService < StripeService
class ListParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The ID of the Payment Record.
sig { returns(String) }
def payment_record; end
sig { params(_payment_record: String).returns(String) }
def payment_record=(_payment_record); end
sig {
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_record: String).void
}
def initialize(expand: nil, limit: nil, payment_record: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# List all the Payment Attempt Records attached to the specified Payment Record.
sig {
params(params: T.any(::Stripe::PaymentAttemptRecordService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a Payment Attempt Record with the given ID
sig {
params(id: String, params: T.any(::Stripe::PaymentAttemptRecordService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentAttemptRecord)
}
def retrieve(id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class PaymentIntentService < StripeService
attr_reader :amount_details_line_items
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.
sig {
returns(T.nilable(T.any(::Stripe::PaymentIntentService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::PaymentIntentService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::PaymentIntentService::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return PaymentIntents for the customer that this customer ID specifies.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Only return PaymentIntents for the account that this ID specifies.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::PaymentIntentService::ListParams::Created, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class AmountDetails < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class Card < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class CardPresent < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class Klarna < Stripe::RequestParams
# URL to an image for the product. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def image_url; end
sig { params(_image_url: T.nilable(String)).returns(T.nilable(String)) }
def image_url=(_image_url); end
# URL to the product page. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def product_url; end
sig { params(_product_url: T.nilable(String)).returns(T.nilable(String)) }
def product_url=(_product_url); end
# Reference for the subscription this line item is for.
sig { returns(T.nilable(String)) }
def subscription_reference; end
sig { params(_subscription_reference: T.nilable(String)).returns(T.nilable(String)) }
def subscription_reference=(_subscription_reference); end
sig {
params(image_url: T.nilable(String), product_url: T.nilable(String), subscription_reference: T.nilable(String)).void
}
def initialize(image_url: nil, product_url: nil, subscription_reference: nil); end
end
class Paypal < Stripe::RequestParams
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
sig {
params(category: T.nilable(String), description: T.nilable(String), sold_by: T.nilable(String)).void
}
def initialize(category: nil, description: nil, sold_by: nil); end
end
# This sub-hash contains line item details that are specific to `card` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card=(_card); end
# This sub-hash contains line item details that are specific to `card_present` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present=(_card_present); end
# This sub-hash contains line item details that are specific to `klarna` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# This sub-hash contains line item details that are specific to `paypal` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
sig {
params(card: T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent), klarna: T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna), paypal: T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).void
}
def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end
end
class Tax < Stripe::RequestParams
# The total tax on an item. Non-negative integer.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The amount an item was discounted for. Positive integer.
sig { returns(T.nilable(Integer)) }
def discount_amount; end
sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def discount_amount=(_discount_amount); end
# Payment method-specific information for line items.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# Unique identifier of the product. At most 12 characters long.
sig { returns(T.nilable(String)) }
def product_code; end
sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) }
def product_code=(_product_code); end
# Name of the product. At most 100 characters long.
sig { returns(String) }
def product_name; end
sig { params(_product_name: String).returns(String) }
def product_name=(_product_name); end
# Number of items of the product. Positive integer.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Contains information about the tax on the item.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::Tax)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::Tax))
}
def tax=(_tax); end
# Cost of the product. Non-negative integer.
sig { returns(Integer) }
def unit_cost; end
sig { params(_unit_cost: Integer).returns(Integer) }
def unit_cost=(_unit_cost); end
# A unit of measure for the line item, such as gallons, feet, meters, etc.
sig { returns(T.nilable(String)) }
def unit_of_measure; end
sig { params(_unit_of_measure: T.nilable(String)).returns(T.nilable(String)) }
def unit_of_measure=(_unit_of_measure); end
sig {
params(discount_amount: T.nilable(Integer), payment_method_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::PaymentMethodOptions), product_code: T.nilable(String), product_name: String, quantity: Integer, tax: T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem::Tax), unit_cost: Integer, unit_of_measure: T.nilable(String)).void
}
def initialize(
discount_amount: nil,
payment_method_options: nil,
product_code: nil,
product_name: nil,
quantity: nil,
tax: nil,
unit_cost: nil,
unit_of_measure: nil
); end
end
class Shipping < Stripe::RequestParams
# Portion of the amount that is for shipping.
sig { returns(T.nilable(T.any(String, Integer))) }
def amount; end
sig {
params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def amount=(_amount); end
# The postal code that represents the shipping source.
sig { returns(T.nilable(String)) }
def from_postal_code; end
sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def from_postal_code=(_from_postal_code); end
# The postal code that represents the shipping destination.
sig { returns(T.nilable(String)) }
def to_postal_code; end
sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def to_postal_code=(_to_postal_code); end
sig {
params(amount: T.nilable(T.any(String, Integer)), from_postal_code: T.nilable(String), to_postal_code: T.nilable(String)).void
}
def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end
end
class Tax < Stripe::RequestParams
# Total portion of the amount that is for tax.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The total discount applied on the transaction.
sig { returns(T.nilable(T.any(String, Integer))) }
def discount_amount; end
sig {
params(_discount_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def discount_amount=(_discount_amount); end
# A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem])))
}
def line_items; end
sig {
params(_line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem])))
}
def line_items=(_line_items); end
# Contains information about the shipping portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::AmountDetails::Shipping)))
}
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::AmountDetails::Shipping))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::AmountDetails::Shipping)))
}
def shipping=(_shipping); end
# Contains information about the tax portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::AmountDetails::Tax)))
}
def tax; end
sig {
params(_tax: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::AmountDetails::Tax))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::AmountDetails::Tax)))
}
def tax=(_tax); end
sig {
params(discount_amount: T.nilable(T.any(String, Integer)), line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::CreateParams::AmountDetails::LineItem])), shipping: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::AmountDetails::Shipping)), tax: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::AmountDetails::Tax))).void
}
def initialize(discount_amount: nil, line_items: nil, shipping: nil, tax: nil); end
end
class AutomaticPaymentMethods < Stripe::RequestParams
# Controls whether this PaymentIntent will accept redirect-based payment methods.
#
# Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment.
sig { returns(T.nilable(String)) }
def allow_redirects; end
sig { params(_allow_redirects: T.nilable(String)).returns(T.nilable(String)) }
def allow_redirects=(_allow_redirects); end
# Whether this feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(allow_redirects: T.nilable(String), enabled: T::Boolean).void }
def initialize(allow_redirects: nil, enabled: nil); end
end
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
sig { returns(String) }
def calculation; end
sig { params(_calculation: String).returns(String) }
def calculation=(_calculation); end
sig { params(calculation: String).void }
def initialize(calculation: nil); end
end
# Tax arguments for automations
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::Hooks::Inputs::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntentService::CreateParams::Hooks::Inputs::Tax)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::Hooks::Inputs::Tax))
}
def tax=(_tax); end
sig {
params(tax: T.nilable(::Stripe::PaymentIntentService::CreateParams::Hooks::Inputs::Tax)).void
}
def initialize(tax: nil); end
end
# Arguments passed in automations
sig { returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::Hooks::Inputs)) }
def inputs; end
sig {
params(_inputs: T.nilable(::Stripe::PaymentIntentService::CreateParams::Hooks::Inputs)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::Hooks::Inputs))
}
def inputs=(_inputs); end
sig {
params(inputs: T.nilable(::Stripe::PaymentIntentService::CreateParams::Hooks::Inputs)).void
}
def initialize(inputs: nil); end
end
class MandateData < Stripe::RequestParams
class CustomerAcceptance < Stripe::RequestParams
class Offline < Stripe::RequestParams; end
class Online < Stripe::RequestParams
# The IP address from which the Mandate was accepted by the customer.
sig { returns(String) }
def ip_address; end
sig { params(_ip_address: String).returns(String) }
def ip_address=(_ip_address); end
# The user agent of the browser from which the Mandate was accepted by the customer.
sig { returns(String) }
def user_agent; end
sig { params(_user_agent: String).returns(String) }
def user_agent=(_user_agent); end
sig { params(ip_address: String, user_agent: String).void }
def initialize(ip_address: nil, user_agent: nil); end
end
# The time at which the customer accepted the Mandate.
sig { returns(T.nilable(Integer)) }
def accepted_at; end
sig { params(_accepted_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def accepted_at=(_accepted_at); end
# If this is a Mandate accepted offline, this hash contains details about the offline acceptance.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::MandateData::CustomerAcceptance::Offline))
}
def offline; end
sig {
params(_offline: T.nilable(::Stripe::PaymentIntentService::CreateParams::MandateData::CustomerAcceptance::Offline)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::MandateData::CustomerAcceptance::Offline))
}
def offline=(_offline); end
# If this is a Mandate accepted online, this hash contains details about the online acceptance.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::MandateData::CustomerAcceptance::Online))
}
def online; end
sig {
params(_online: T.nilable(::Stripe::PaymentIntentService::CreateParams::MandateData::CustomerAcceptance::Online)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::MandateData::CustomerAcceptance::Online))
}
def online=(_online); end
# The type of customer acceptance information included with the Mandate. One of `online` or `offline`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(accepted_at: T.nilable(Integer), offline: T.nilable(::Stripe::PaymentIntentService::CreateParams::MandateData::CustomerAcceptance::Offline), online: T.nilable(::Stripe::PaymentIntentService::CreateParams::MandateData::CustomerAcceptance::Online), type: String).void
}
def initialize(accepted_at: nil, offline: nil, online: nil, type: nil); end
end
# This hash contains details about the customer acceptance of the Mandate.
sig {
returns(::Stripe::PaymentIntentService::CreateParams::MandateData::CustomerAcceptance)
}
def customer_acceptance; end
sig {
params(_customer_acceptance: ::Stripe::PaymentIntentService::CreateParams::MandateData::CustomerAcceptance).returns(::Stripe::PaymentIntentService::CreateParams::MandateData::CustomerAcceptance)
}
def customer_acceptance=(_customer_acceptance); end
sig {
params(customer_acceptance: ::Stripe::PaymentIntentService::CreateParams::MandateData::CustomerAcceptance).void
}
def initialize(customer_acceptance: nil); end
end
class PaymentDetails < Stripe::RequestParams
class CarRental < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Distance < Stripe::RequestParams
# Distance traveled.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
sig { params(amount: T.nilable(Integer), unit: T.nilable(String)).void }
def initialize(amount: nil, unit: nil); end
end
class Driver < Stripe::RequestParams
# Driver's identification number.
sig { returns(T.nilable(String)) }
def driver_identification_number; end
sig {
params(_driver_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def driver_identification_number=(_driver_identification_number); end
# Driver's tax number.
sig { returns(T.nilable(String)) }
def driver_tax_number; end
sig { params(_driver_tax_number: T.nilable(String)).returns(T.nilable(String)) }
def driver_tax_number=(_driver_tax_number); end
# Full name of the person or entity on the car reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(driver_identification_number: T.nilable(String), driver_tax_number: T.nilable(String), name: String).void
}
def initialize(
driver_identification_number: nil,
driver_tax_number: nil,
name: nil
); end
end
class PickupAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class ReturnAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the car rental.
sig { returns(String) }
def booking_number; end
sig { params(_booking_number: String).returns(String) }
def booking_number=(_booking_number); end
# Class code of the car.
sig { returns(T.nilable(String)) }
def car_class_code; end
sig { params(_car_class_code: T.nilable(String)).returns(T.nilable(String)) }
def car_class_code=(_car_class_code); end
# Make of the car.
sig { returns(T.nilable(String)) }
def car_make; end
sig { params(_car_make: T.nilable(String)).returns(T.nilable(String)) }
def car_make=(_car_make); end
# Model of the car.
sig { returns(T.nilable(String)) }
def car_model; end
sig { params(_car_model: T.nilable(String)).returns(T.nilable(String)) }
def car_model=(_car_model); end
# The name of the rental car company.
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# The customer service phone number of the car rental company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# Number of days the car is being rented.
sig { returns(Integer) }
def days_rented; end
sig { params(_days_rented: Integer).returns(Integer) }
def days_rented=(_days_rented); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Delivery)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Delivery))
}
def delivery=(_delivery); end
# The details of the distance traveled during the rental period.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Distance))
}
def distance; end
sig {
params(_distance: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Distance)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Distance))
}
def distance=(_distance); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Driver]))
}
def drivers; end
sig {
params(_drivers: T.nilable(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Driver])).returns(T.nilable(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Driver]))
}
def drivers=(_drivers); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates if the customer did not keep nor cancel their booking.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# Car pick-up address.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address; end
sig {
params(_pickup_address: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::PickupAddress)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address=(_pickup_address); end
# Car pick-up time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def pickup_at; end
sig { params(_pickup_at: Integer).returns(Integer) }
def pickup_at=(_pickup_at); end
# Name of the pickup location.
sig { returns(T.nilable(String)) }
def pickup_location_name; end
sig { params(_pickup_location_name: T.nilable(String)).returns(T.nilable(String)) }
def pickup_location_name=(_pickup_location_name); end
# Rental rate.
sig { returns(T.nilable(Integer)) }
def rate_amount; end
sig { params(_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def rate_amount=(_rate_amount); end
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
sig { returns(T.nilable(String)) }
def rate_interval; end
sig { params(_rate_interval: T.nilable(String)).returns(T.nilable(String)) }
def rate_interval=(_rate_interval); end
# The name of the person or entity renting the car.
sig { returns(T.nilable(String)) }
def renter_name; end
sig { params(_renter_name: T.nilable(String)).returns(T.nilable(String)) }
def renter_name=(_renter_name); end
# Car return address.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address; end
sig {
params(_return_address: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::ReturnAddress)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address=(_return_address); end
# Car return time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def return_at; end
sig { params(_return_at: Integer).returns(Integer) }
def return_at=(_return_at); end
# Name of the return location.
sig { returns(T.nilable(String)) }
def return_location_name; end
sig { params(_return_location_name: T.nilable(String)).returns(T.nilable(String)) }
def return_location_name=(_return_location_name); end
# Indicates whether the goods or services are tax-exempt or tax is not collected.
sig { returns(T.nilable(T::Boolean)) }
def tax_exempt; end
sig { params(_tax_exempt: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def tax_exempt=(_tax_exempt); end
# The vehicle identification number.
sig { returns(T.nilable(String)) }
def vehicle_identification_number; end
sig {
params(_vehicle_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def vehicle_identification_number=(_vehicle_identification_number); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Affiliate), booking_number: String, car_class_code: T.nilable(String), car_make: T.nilable(String), car_model: T.nilable(String), company: T.nilable(String), customer_service_phone_number: T.nilable(String), days_rented: Integer, delivery: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Delivery), distance: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Distance), drivers: T.nilable(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::Driver]), extra_charges: T.nilable(T::Array[String]), no_show: T.nilable(T::Boolean), pickup_address: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::PickupAddress), pickup_at: Integer, pickup_location_name: T.nilable(String), rate_amount: T.nilable(Integer), rate_interval: T.nilable(String), renter_name: T.nilable(String), return_address: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental::ReturnAddress), return_at: Integer, return_location_name: T.nilable(String), tax_exempt: T.nilable(T::Boolean), vehicle_identification_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
booking_number: nil,
car_class_code: nil,
car_make: nil,
car_model: nil,
company: nil,
customer_service_phone_number: nil,
days_rented: nil,
delivery: nil,
distance: nil,
drivers: nil,
extra_charges: nil,
no_show: nil,
pickup_address: nil,
pickup_at: nil,
pickup_location_name: nil,
rate_amount: nil,
rate_interval: nil,
renter_name: nil,
return_address: nil,
return_at: nil,
return_location_name: nil,
tax_exempt: nil,
vehicle_identification_number: nil
); end
end
class EventDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
# Indicates if the tickets are digitally checked when entering the venue.
sig { returns(T.nilable(T::Boolean)) }
def access_controlled_venue; end
sig {
params(_access_controlled_venue: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def access_controlled_venue=(_access_controlled_venue); end
# The event location's address.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails::Address)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails::Address))
}
def address=(_address); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate=(_affiliate); end
# The name of the company
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails::Delivery)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails::Delivery))
}
def delivery=(_delivery); end
# Event end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Type of the event entertainment (concert, sports event etc)
sig { returns(T.nilable(String)) }
def genre; end
sig { params(_genre: T.nilable(String)).returns(T.nilable(String)) }
def genre=(_genre); end
# The name of the event.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Event start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(access_controlled_venue: T.nilable(T::Boolean), address: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails::Address), affiliate: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails::Affiliate), company: T.nilable(String), delivery: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails::Delivery), ends_at: T.nilable(Integer), genre: T.nilable(String), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
access_controlled_venue: nil,
address: nil,
affiliate: nil,
company: nil,
delivery: nil,
ends_at: nil,
genre: nil,
name: nil,
starts_at: nil
); end
end
class Flight < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the flight reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Segment < Stripe::RequestParams
# The flight segment amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The International Air Transport Association (IATA) airport code for the arrival airport.
sig { returns(T.nilable(String)) }
def arrival_airport; end
sig { params(_arrival_airport: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport=(_arrival_airport); end
# The arrival time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def arrives_at; end
sig { params(_arrives_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def arrives_at=(_arrives_at); end
# The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The departure time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def departs_at; end
sig { params(_departs_at: Integer).returns(Integer) }
def departs_at=(_departs_at); end
# The International Air Transport Association (IATA) airport code for the departure airport.
sig { returns(T.nilable(String)) }
def departure_airport; end
sig { params(_departure_airport: T.nilable(String)).returns(T.nilable(String)) }
def departure_airport=(_departure_airport); end
# The flight number associated with the segment
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The fare class for the segment.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
sig {
params(amount: T.nilable(Integer), arrival_airport: T.nilable(String), arrives_at: T.nilable(Integer), carrier: T.nilable(String), departs_at: Integer, departure_airport: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String)).void
}
def initialize(
amount: nil,
arrival_airport: nil,
arrives_at: nil,
carrier: nil,
departs_at: nil,
departure_airport: nil,
flight_number: nil,
service_class: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Affiliate))
}
def affiliate=(_affiliate); end
# The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
sig { returns(T.nilable(String)) }
def agency_number; end
sig { params(_agency_number: T.nilable(String)).returns(T.nilable(String)) }
def agency_number=(_agency_number); end
# The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Delivery)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Delivery))
}
def delivery=(_delivery); end
# The name of the person or entity on the reservation.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# The details of the passengers in the travel reservation.
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Passenger])).returns(T.nilable(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Passenger]))
}
def passengers=(_passengers); end
# The individual flight segments associated with the trip.
sig {
returns(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Segment])
}
def segments; end
sig {
params(_segments: T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Segment]).returns(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Segment])
}
def segments=(_segments); end
# The ticket number associated with the travel reservation.
sig { returns(T.nilable(String)) }
def ticket_number; end
sig { params(_ticket_number: T.nilable(String)).returns(T.nilable(String)) }
def ticket_number=(_ticket_number); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Affiliate), agency_number: T.nilable(String), carrier: T.nilable(String), delivery: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Delivery), passenger_name: T.nilable(String), passengers: T.nilable(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Passenger]), segments: T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight::Segment], ticket_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
agency_number: nil,
carrier: nil,
delivery: nil,
passenger_name: nil,
passengers: nil,
segments: nil,
ticket_number: nil
); end
end
class Lodging < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the lodging reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
# The lodging location's address.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Address)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Address))
}
def address=(_address); end
# The number of adults on the booking
sig { returns(T.nilable(Integer)) }
def adults; end
sig { params(_adults: T.nilable(Integer)).returns(T.nilable(Integer)) }
def adults=(_adults); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the lodging reservation.
sig { returns(T.nilable(String)) }
def booking_number; end
sig { params(_booking_number: T.nilable(String)).returns(T.nilable(String)) }
def booking_number=(_booking_number); end
# The lodging category
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Lodging check-in time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkin_at; end
sig { params(_checkin_at: Integer).returns(Integer) }
def checkin_at=(_checkin_at); end
# Lodging check-out time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkout_at; end
sig { params(_checkout_at: Integer).returns(Integer) }
def checkout_at=(_checkout_at); end
# The customer service phone number of the lodging company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# The daily lodging room rate.
sig { returns(T.nilable(Integer)) }
def daily_room_rate_amount; end
sig { params(_daily_room_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def daily_room_rate_amount=(_daily_room_rate_amount); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Delivery)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Delivery))
}
def delivery=(_delivery); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates whether the lodging location is compliant with the Fire Safety Act.
sig { returns(T.nilable(T::Boolean)) }
def fire_safety_act_compliance; end
sig {
params(_fire_safety_act_compliance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def fire_safety_act_compliance=(_fire_safety_act_compliance); end
# The name of the lodging location.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Indicates if the customer did not keep their booking while failing to cancel the reservation.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# The number of rooms on the booking
sig { returns(T.nilable(Integer)) }
def number_of_rooms; end
sig { params(_number_of_rooms: T.nilable(Integer)).returns(T.nilable(Integer)) }
def number_of_rooms=(_number_of_rooms); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Passenger])).returns(T.nilable(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Passenger]))
}
def passengers=(_passengers); end
# The phone number of the lodging location.
sig { returns(T.nilable(String)) }
def property_phone_number; end
sig { params(_property_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def property_phone_number=(_property_phone_number); end
# The room class for this purchase.
sig { returns(T.nilable(String)) }
def room_class; end
sig { params(_room_class: T.nilable(String)).returns(T.nilable(String)) }
def room_class=(_room_class); end
# The number of room nights
sig { returns(T.nilable(Integer)) }
def room_nights; end
sig { params(_room_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def room_nights=(_room_nights); end
# The total tax amount associating with the room reservation.
sig { returns(T.nilable(Integer)) }
def total_room_tax_amount; end
sig { params(_total_room_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_room_tax_amount=(_total_room_tax_amount); end
# The total tax amount
sig { returns(T.nilable(Integer)) }
def total_tax_amount; end
sig { params(_total_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_tax_amount=(_total_tax_amount); end
sig {
params(address: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Address), adults: T.nilable(Integer), affiliate: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Affiliate), booking_number: T.nilable(String), category: T.nilable(String), checkin_at: Integer, checkout_at: Integer, customer_service_phone_number: T.nilable(String), daily_room_rate_amount: T.nilable(Integer), delivery: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Delivery), extra_charges: T.nilable(T::Array[String]), fire_safety_act_compliance: T.nilable(T::Boolean), name: T.nilable(String), no_show: T.nilable(T::Boolean), number_of_rooms: T.nilable(Integer), passengers: T.nilable(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging::Passenger]), property_phone_number: T.nilable(String), room_class: T.nilable(String), room_nights: T.nilable(Integer), total_room_tax_amount: T.nilable(Integer), total_tax_amount: T.nilable(Integer)).void
}
def initialize(
address: nil,
adults: nil,
affiliate: nil,
booking_number: nil,
category: nil,
checkin_at: nil,
checkout_at: nil,
customer_service_phone_number: nil,
daily_room_rate_amount: nil,
delivery: nil,
extra_charges: nil,
fire_safety_act_compliance: nil,
name: nil,
no_show: nil,
number_of_rooms: nil,
passengers: nil,
property_phone_number: nil,
room_class: nil,
room_nights: nil,
total_room_tax_amount: nil,
total_tax_amount: nil
); end
end
class Subscription < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class BillingInterval < Stripe::RequestParams
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def count; end
sig { params(_count: Integer).returns(Integer) }
def count=(_count); end
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig { params(count: Integer, interval: String).void }
def initialize(count: nil, interval: nil); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Subscription::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate=(_affiliate); end
# Info whether the subscription will be auto renewed upon expiry.
sig { returns(T.nilable(T::Boolean)) }
def auto_renewal; end
sig { params(_auto_renewal: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_renewal=(_auto_renewal); end
# Subscription billing details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval; end
sig {
params(_billing_interval: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Subscription::BillingInterval)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval=(_billing_interval); end
# Subscription end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Name of the product on subscription. e.g. Apple Music Subscription
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Subscription start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Subscription::Affiliate), auto_renewal: T.nilable(T::Boolean), billing_interval: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Subscription::BillingInterval), ends_at: T.nilable(Integer), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
affiliate: nil,
auto_renewal: nil,
billing_interval: nil,
ends_at: nil,
name: nil,
starts_at: nil
); end
end
# Car rental details for this PaymentIntent.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental))
}
def car_rental; end
sig {
params(_car_rental: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental))
}
def car_rental=(_car_rental); end
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
sig { returns(T.nilable(String)) }
def customer_reference; end
sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) }
def customer_reference=(_customer_reference); end
# Event details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails))
}
def event_details; end
sig {
params(_event_details: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails))
}
def event_details=(_event_details); end
# Flight reservation details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight))
}
def flight; end
sig {
params(_flight: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight))
}
def flight=(_flight); end
# Lodging reservation details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging))
}
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging))
}
def lodging=(_lodging); end
# A unique value assigned by the business to identify the transaction.
sig { returns(T.nilable(String)) }
def order_reference; end
sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) }
def order_reference=(_order_reference); end
# Subscription details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Subscription))
}
def subscription; end
sig {
params(_subscription: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Subscription)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Subscription))
}
def subscription=(_subscription); end
sig {
params(car_rental: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::CarRental), customer_reference: T.nilable(String), event_details: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::EventDetails), flight: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Flight), lodging: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Lodging), order_reference: T.nilable(String), subscription: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails::Subscription)).void
}
def initialize(
car_rental: nil,
customer_reference: nil,
event_details: nil,
flight: nil,
lodging: nil,
order_reference: nil,
subscription: nil
); end
end
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Institution number of the customer's bank.
sig { returns(String) }
def institution_number; end
sig { params(_institution_number: String).returns(String) }
def institution_number=(_institution_number); end
# Transit number of the customer's bank.
sig { returns(String) }
def transit_number; end
sig { params(_transit_number: String).returns(String) }
def transit_number=(_transit_number); end
sig {
params(account_number: String, institution_number: String, transit_number: String).void
}
def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(String) }
def bsb_number; end
sig { params(_bsb_number: String).returns(String) }
def bsb_number=(_bsb_number); end
sig { params(account_number: String, bsb_number: String).void }
def initialize(account_number: nil, bsb_number: nil); end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
sig { params(_sort_code: T.nilable(String)).returns(T.nilable(String)) }
def sort_code=(_sort_code); end
sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
def initialize(account_number: nil, sort_code: nil); end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
sig { params(_tax_id: String).returns(String) }
def tax_id=(_tax_id); end
sig { params(tax_id: String).void }
def initialize(tax_id: nil); end
end
class Cashapp < Stripe::RequestParams; end
class Crypto < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The customer's bank.
sig { returns(String) }
def bank; end
sig { params(_bank: String).returns(String) }
def bank=(_bank); end
sig { params(account_holder_type: T.nilable(String), bank: String).void }
def initialize(account_holder_type: nil, bank: nil); end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Klarna::Dob))
}
def dob; end
sig {
params(_dob: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Klarna::Dob)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Klarna::Dob))
}
def dob=(_dob); end
sig {
params(dob: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Klarna::Dob)).void
}
def initialize(dob: nil); end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
sig { returns(T.nilable(String)) }
def funding; end
sig { params(_funding: T.nilable(String)).returns(T.nilable(String)) }
def funding=(_funding); end
sig { params(funding: T.nilable(String)).void }
def initialize(funding: nil); end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
sig { params(_bank_code: String).returns(String) }
def bank_code=(_bank_code); end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
sig { params(_branch_code: String).returns(String) }
def branch_code=(_branch_code); end
# Attribute for param field reference
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# The suffix of the bank account number.
sig { returns(String) }
def suffix; end
sig { params(_suffix: String).returns(String) }
def suffix=(_suffix); end
sig {
params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
); end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Paypay < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Rechnung::Dob)
}
def dob; end
sig {
params(_dob: ::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Rechnung::Dob).returns(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Rechnung::Dob)
}
def dob=(_dob); end
sig {
params(dob: ::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Rechnung::Dob).void
}
def initialize(dob: nil); end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
sig { returns(String) }
def iban; end
sig { params(_iban: String).returns(String) }
def iban=(_iban); end
sig { params(iban: String).void }
def initialize(iban: nil); end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
sig { params(account: T.nilable(String), source_type: T.nilable(String)).void }
def initialize(account: nil, source_type: nil); end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig {
params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String))
}
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AcssDebit)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Affirm))
}
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Affirm)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Affirm))
}
def affirm=(_affirm); end
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AfterpayClearpay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Alipay))
}
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Alipay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Alipay))
}
def alipay=(_alipay); end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Alma))
}
def alma; end
sig {
params(_alma: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Alma)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Alma))
}
def alma=(_alma); end
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AmazonPay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AuBecsDebit)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::BacsDebit)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Bancontact)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Bancontact))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Billie))
}
def billie; end
sig {
params(_billie: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Billie)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Billie))
}
def billie=(_billie); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::BillingDetails)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Blik))
}
def blik; end
sig {
params(_blik: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Blik)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Blik))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Boleto))
}
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Boleto)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Boleto))
}
def boleto=(_boleto); end
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Cashapp))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Cashapp)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Cashapp))
}
def cashapp=(_cashapp); end
# If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Crypto))
}
def crypto; end
sig {
params(_crypto: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Crypto)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Crypto))
}
def crypto=(_crypto); end
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::CustomerBalance)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Eps))
}
def eps; end
sig {
params(_eps: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Eps)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Eps))
}
def eps=(_eps); end
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Fpx))
}
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Fpx)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Fpx))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Giropay))
}
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Giropay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Giropay))
}
def giropay=(_giropay); end
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Gopay))
}
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Gopay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Gopay))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Grabpay))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Grabpay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Grabpay))
}
def grabpay=(_grabpay); end
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::IdBankTransfer)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Ideal))
}
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Ideal)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Ideal))
}
def ideal=(_ideal); end
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::InteracPresent))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::InteracPresent)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::InteracPresent))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::KakaoPay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Klarna)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Klarna))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Konbini))
}
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Konbini)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Konbini))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::KrCard))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::KrCard)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::KrCard))
}
def kr_card=(_kr_card); end
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Link))
}
def link; end
sig {
params(_link: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Link)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Link))
}
def link=(_link); end
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::MbWay))
}
def mb_way; end
sig {
params(_mb_way: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::MbWay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::MbWay))
}
def mb_way=(_mb_way); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Mobilepay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Mobilepay))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Multibanco)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Multibanco))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::NaverPay))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::NaverPay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::NaverPay))
}
def naver_pay=(_naver_pay); end
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::NzBankAccount)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Oxxo))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Oxxo)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Oxxo))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::P24))
}
def p24; end
sig {
params(_p24: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::P24)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::P24))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::PayByBank)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Payco))
}
def payco; end
sig {
params(_payco: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Payco)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Payco))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Paynow))
}
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Paynow)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Paynow))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Paypal)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Paypal))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Paypay))
}
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Paypay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Paypay))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Payto))
}
def payto; end
sig {
params(_payto: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Payto)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Payto))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Pix))
}
def pix; end
sig {
params(_pix: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Pix)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Pix))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Promptpay))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Promptpay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Promptpay))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Qris))
}
def qris; end
sig {
params(_qris: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Qris)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Qris))
}
def qris=(_qris); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::RadarOptions))
}
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::RadarOptions)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::RadarOptions))
}
def radar_options=(_radar_options); end
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Rechnung))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Rechnung)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Rechnung))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::RevolutPay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::SamsungPay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Satispay))
}
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Satispay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Satispay))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::SepaDebit)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Shopeepay))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Shopeepay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Shopeepay))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Sofort))
}
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Sofort)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Sofort))
}
def sofort=(_sofort); end
# This hash contains details about the Stripe balance payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::StripeBalance)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Swish))
}
def swish; end
sig {
params(_swish: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Swish)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Swish))
}
def swish=(_swish); end
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Twint))
}
def twint; end
sig {
params(_twint: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Twint)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Twint))
}
def twint=(_twint); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::UsBankAccount)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::WechatPay)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Zip))
}
def zip; end
sig {
params(_zip: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Zip)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Cashapp), crypto: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Crypto), customer_balance: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Giropay), gopay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Gopay), grabpay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Grabpay), id_bank_transfer: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::IdBankTransfer), ideal: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Link), mb_way: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::MbWay), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Paypal), paypay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Paypay), payto: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Payto), pix: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Promptpay), qris: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Qris), radar_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::RadarOptions), rechnung: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Rechnung), revolut_pay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::SepaDebit), shopeepay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Shopeepay), sofort: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Sofort), stripe_balance: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::StripeBalance), swish: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
mandate_options: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class Affirm < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Preferred language of the Affirm authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), preferred_locale: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, preferred_locale: nil, setup_future_usage: nil); end
end
class AfterpayClearpay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.
# This field differs from the statement descriptor and item name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), reference: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, reference: nil, setup_future_usage: nil); end
end
class Alipay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Alma < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class AmazonPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class AuBecsDebit < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(setup_future_usage: nil, target_date: nil); end
end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class Billie < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Blik < Stripe::RequestParams
# The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.
sig { returns(T.nilable(String)) }
def code; end
sig { params(_code: T.nilable(String)).returns(T.nilable(String)) }
def code=(_code); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(code: T.nilable(String), setup_future_usage: T.nilable(String)).void }
def initialize(code: nil, setup_future_usage: nil); end
end
class Boleto < Stripe::RequestParams
# The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
class Plan < Stripe::RequestParams
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
sig { returns(T.nilable(Integer)) }
def count; end
sig { params(_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def count=(_count); end
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
# One of `month`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(count: T.nilable(Integer), interval: T.nilable(String), type: String).void
}
def initialize(count: nil, interval: nil, type: nil); end
end
# Setting to true enables installments for this PaymentIntent.
# This will cause the response to contain a list of available installment plans.
# Setting to false will prevent any selected plan from applying to a charge.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# The selected installment plan to use for this payment attempt.
# This parameter can only be provided during confirmation.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan; end
sig {
params(_plan: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::Installments::Plan))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan=(_plan); end
sig {
params(enabled: T.nilable(T::Boolean), plan: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::Installments::Plan))).void
}
def initialize(enabled: nil, plan: nil); end
end
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(String) }
def amount_type; end
sig { params(_amount_type: String).returns(String) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Unique identifier for the mandate or subscription.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
sig { returns(Integer) }
def start_date; end
sig { params(_start_date: Integer).returns(Integer) }
def start_date=(_start_date); end
# Specifies the type of mandates supported. Possible values are `india`.
sig { returns(T.nilable(T::Array[String])) }
def supported_types; end
sig {
params(_supported_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def supported_types=(_supported_types); end
sig {
params(amount: Integer, amount_type: String, description: T.nilable(String), end_date: T.nilable(Integer), interval: String, interval_count: T.nilable(Integer), reference: String, start_date: Integer, supported_types: T.nilable(T::Array[String])).void
}
def initialize(
amount: nil,
amount_type: nil,
description: nil,
end_date: nil,
interval: nil,
interval_count: nil,
reference: nil,
start_date: nil,
supported_types: nil
); end
end
class StatementDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Please pass in an address that is within your Stripe user account country
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::StatementDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::StatementDetails::Address)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::StatementDetails::Address))
}
def address=(_address); end
# Phone number (e.g., a toll-free number that customers can call)
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::StatementDetails::Address), phone: T.nilable(String)).void
}
def initialize(address: nil, phone: nil); end
end
class ThreeDSecure < Stripe::RequestParams
class NetworkOptions < Stripe::RequestParams
class CartesBancaires < Stripe::RequestParams
# The cryptogram calculation algorithm used by the card Issuer's ACS
# to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
# messageExtension: CB-AVALGO
sig { returns(String) }
def cb_avalgo; end
sig { params(_cb_avalgo: String).returns(String) }
def cb_avalgo=(_cb_avalgo); end
# The exemption indicator returned from Cartes Bancaires in the ARes.
# message extension: CB-EXEMPTION; string (4 characters)
# This is a 3 byte bitmap (low significant byte first and most significant
# bit first) that has been Base64 encoded
sig { returns(T.nilable(String)) }
def cb_exemption; end
sig { params(_cb_exemption: T.nilable(String)).returns(T.nilable(String)) }
def cb_exemption=(_cb_exemption); end
# The risk score returned from Cartes Bancaires in the ARes.
# message extension: CB-SCORE; numeric value 0-99
sig { returns(T.nilable(Integer)) }
def cb_score; end
sig { params(_cb_score: T.nilable(Integer)).returns(T.nilable(Integer)) }
def cb_score=(_cb_score); end
sig {
params(cb_avalgo: String, cb_exemption: T.nilable(String), cb_score: T.nilable(Integer)).void
}
def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil); end
end
# Cartes Bancaires-specific 3DS fields.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires; end
sig {
params(_cartes_bancaires: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires=(_cartes_bancaires); end
sig {
params(cartes_bancaires: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).void
}
def initialize(cartes_bancaires: nil); end
end
# The `transStatus` returned from the card Issuer’s ACS in the ARes.
sig { returns(T.nilable(String)) }
def ares_trans_status; end
sig { params(_ares_trans_status: T.nilable(String)).returns(T.nilable(String)) }
def ares_trans_status=(_ares_trans_status); end
# The cryptogram, also known as the "authentication value" (AAV, CAVV or
# AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
# (Most 3D Secure providers will return the base64-encoded version, which
# is what you should specify here.)
sig { returns(String) }
def cryptogram; end
sig { params(_cryptogram: String).returns(String) }
def cryptogram=(_cryptogram); end
# The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
# provider and indicates what degree of authentication was performed.
sig { returns(T.nilable(String)) }
def electronic_commerce_indicator; end
sig {
params(_electronic_commerce_indicator: T.nilable(String)).returns(T.nilable(String))
}
def electronic_commerce_indicator=(_electronic_commerce_indicator); end
# The exemption requested via 3DS and accepted by the issuer at authentication time.
sig { returns(T.nilable(String)) }
def exemption_indicator; end
sig { params(_exemption_indicator: T.nilable(String)).returns(T.nilable(String)) }
def exemption_indicator=(_exemption_indicator); end
# Network specific 3DS fields. Network specific arguments require an
# explicit card brand choice. The parameter `payment_method_options.card.network``
# must be populated accordingly
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options; end
sig {
params(_network_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options=(_network_options); end
# The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
# AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
sig { returns(T.nilable(String)) }
def requestor_challenge_indicator; end
sig {
params(_requestor_challenge_indicator: T.nilable(String)).returns(T.nilable(String))
}
def requestor_challenge_indicator=(_requestor_challenge_indicator); end
# For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
# Transaction ID (dsTransID).
sig { returns(String) }
def transaction_id; end
sig { params(_transaction_id: String).returns(String) }
def transaction_id=(_transaction_id); end
# The version of 3D Secure that was performed.
sig { returns(String) }
def version; end
sig { params(_version: String).returns(String) }
def version=(_version); end
sig {
params(ares_trans_status: T.nilable(String), cryptogram: String, electronic_commerce_indicator: T.nilable(String), exemption_indicator: T.nilable(String), network_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions), requestor_challenge_indicator: T.nilable(String), transaction_id: String, version: String).void
}
def initialize(
ares_trans_status: nil,
cryptogram: nil,
electronic_commerce_indicator: nil,
exemption_indicator: nil,
network_options: nil,
requestor_challenge_indicator: nil,
transaction_id: nil,
version: nil
); end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.
sig { returns(T.nilable(String)) }
def cvc_token; end
sig { params(_cvc_token: T.nilable(String)).returns(T.nilable(String)) }
def cvc_token=(_cvc_token); end
# Installment configuration for payments attempted on this PaymentIntent.
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::Installments))
}
def installments; end
sig {
params(_installments: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::Installments)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::Installments))
}
def installments=(_installments); end
# Configuration options for setting up an eMandate for cards issued in India.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options=(_mandate_options); end
# When specified, this parameter indicates that a transaction will be marked
# as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
# parameter can only be provided during confirmation.
sig { returns(T.nilable(T::Boolean)) }
def moto; end
sig { params(_moto: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def moto=(_moto); end
# Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
# Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_decremental_authorization; end
sig {
params(_request_decremental_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_decremental_authorization=(_request_decremental_authorization); end
# Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_extended_authorization; end
sig {
params(_request_extended_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_extended_authorization=(_request_extended_authorization); end
# Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_incremental_authorization; end
sig {
params(_request_incremental_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_incremental_authorization=(_request_incremental_authorization); end
# Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_multicapture; end
sig { params(_request_multicapture: T.nilable(String)).returns(T.nilable(String)) }
def request_multicapture=(_request_multicapture); end
# Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_overcapture; end
sig { params(_request_overcapture: T.nilable(String)).returns(T.nilable(String)) }
def request_overcapture=(_request_overcapture); end
# Request partial authorization on this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_partial_authorization; end
sig {
params(_request_partial_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_partial_authorization=(_request_partial_authorization); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
# When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).
sig { returns(T.nilable(T::Boolean)) }
def require_cvc_recollection; end
sig {
params(_require_cvc_recollection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def require_cvc_recollection=(_require_cvc_recollection); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kana; end
sig {
params(_statement_descriptor_suffix_kana: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_suffix_kana=(_statement_descriptor_suffix_kana); end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kanji; end
sig {
params(_statement_descriptor_suffix_kanji: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_suffix_kanji=(_statement_descriptor_suffix_kanji); end
# Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::StatementDetails)))
}
def statement_details; end
sig {
params(_statement_details: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::StatementDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::StatementDetails)))
}
def statement_details=(_statement_details); end
# If 3D Secure authentication was performed with a third-party provider,
# the authentication details to use for this payment.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure; end
sig {
params(_three_d_secure: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure=(_three_d_secure); end
sig {
params(capture_method: T.nilable(String), cvc_token: T.nilable(String), installments: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::Installments), mandate_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::MandateOptions), moto: T.nilable(T::Boolean), network: T.nilable(String), request_decremental_authorization: T.nilable(String), request_extended_authorization: T.nilable(String), request_incremental_authorization: T.nilable(String), request_multicapture: T.nilable(String), request_overcapture: T.nilable(String), request_partial_authorization: T.nilable(String), request_three_d_secure: T.nilable(String), require_cvc_recollection: T.nilable(T::Boolean), setup_future_usage: T.nilable(T.any(String, String)), statement_descriptor_suffix_kana: T.nilable(String), statement_descriptor_suffix_kanji: T.nilable(String), statement_details: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::StatementDetails)), three_d_secure: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure)).void
}
def initialize(
capture_method: nil,
cvc_token: nil,
installments: nil,
mandate_options: nil,
moto: nil,
network: nil,
request_decremental_authorization: nil,
request_extended_authorization: nil,
request_incremental_authorization: nil,
request_multicapture: nil,
request_overcapture: nil,
request_partial_authorization: nil,
request_three_d_secure: nil,
require_cvc_recollection: nil,
setup_future_usage: nil,
statement_descriptor_suffix_kana: nil,
statement_descriptor_suffix_kanji: nil,
statement_details: nil,
three_d_secure: nil
); end
end
class CardPresent < Stripe::RequestParams
class Routing < Stripe::RequestParams
# Routing requested priority
sig { returns(T.nilable(String)) }
def requested_priority; end
sig { params(_requested_priority: T.nilable(String)).returns(T.nilable(String)) }
def requested_priority=(_requested_priority); end
sig { params(requested_priority: T.nilable(String)).void }
def initialize(requested_priority: nil); end
end
# Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)
sig { returns(T.nilable(T::Boolean)) }
def request_extended_authorization; end
sig {
params(_request_extended_authorization: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def request_extended_authorization=(_request_extended_authorization); end
# Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
sig { returns(T.nilable(T::Boolean)) }
def request_incremental_authorization_support; end
sig {
params(_request_incremental_authorization_support: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def request_incremental_authorization_support=(
_request_incremental_authorization_support
); end
# Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CardPresent::Routing))
}
def routing; end
sig {
params(_routing: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CardPresent::Routing)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CardPresent::Routing))
}
def routing=(_routing); end
sig {
params(request_extended_authorization: T.nilable(T::Boolean), request_incremental_authorization_support: T.nilable(T::Boolean), routing: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CardPresent::Routing)).void
}
def initialize(
request_extended_authorization: nil,
request_incremental_authorization_support: nil,
routing: nil
); end
end
class Cashapp < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Crypto < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for the eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
sig {
params(_requested_address_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested_address_types=(_requested_address_types); end
# The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
}
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(bank_transfer: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
end
class Eps < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Fpx < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Giropay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Gopay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Grabpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class IdBankTransfer < Stripe::RequestParams
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from 5 minutes from now until 31 days from now. If unset, it defaults to 3 days from now.
sig { returns(T.nilable(Integer)) }
def expires_after; end
sig { params(_expires_after: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after=(_expires_after); end
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now until 30 days from now. If unset, it defaults to 1 days from now.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after: T.nilable(Integer), expires_at: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after: nil, expires_at: nil, setup_future_usage: nil); end
end
class Ideal < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Klarna < Stripe::RequestParams
class OnDemand < Stripe::RequestParams
# Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def average_amount; end
sig { params(_average_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def average_amount=(_average_amount); end
# The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def maximum_amount; end
sig { params(_maximum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_amount=(_maximum_amount); end
# The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Interval at which the customer is making purchases
sig { returns(T.nilable(String)) }
def purchase_interval; end
sig { params(_purchase_interval: T.nilable(String)).returns(T.nilable(String)) }
def purchase_interval=(_purchase_interval); end
# The number of `purchase_interval` between charges
sig { returns(T.nilable(Integer)) }
def purchase_interval_count; end
sig { params(_purchase_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def purchase_interval_count=(_purchase_interval_count); end
sig {
params(average_amount: T.nilable(Integer), maximum_amount: T.nilable(Integer), minimum_amount: T.nilable(Integer), purchase_interval: T.nilable(String), purchase_interval_count: T.nilable(Integer)).void
}
def initialize(
average_amount: nil,
maximum_amount: nil,
minimum_amount: nil,
purchase_interval: nil,
purchase_interval_count: nil
); end
end
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing; end
sig {
params(_next_billing: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling), reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# On-demand details if setting up or charging an on-demand payment.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand; end
sig {
params(_on_demand: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna::OnDemand)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand=(_on_demand); end
# Preferred language of the Klarna authorization page that the customer is redirected to
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Subscription details if setting up or charging a subscription.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(capture_method: T.nilable(String), on_demand: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna::OnDemand), preferred_locale: T.nilable(String), setup_future_usage: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(
capture_method: nil,
on_demand: nil,
preferred_locale: nil,
setup_future_usage: nil,
subscriptions: nil
); end
end
class Konbini < Stripe::RequestParams
# An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number.
sig { returns(T.nilable(String)) }
def confirmation_number; end
sig { params(_confirmation_number: T.nilable(String)).returns(T.nilable(String)) }
def confirmation_number=(_confirmation_number); end
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
sig { returns(T.nilable(T.any(String, Integer))) }
def expires_after_days; end
sig {
params(_expires_after_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expires_after_days=(_expires_after_days); end
# The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.
sig { returns(T.nilable(T.any(String, Integer))) }
def expires_at; end
sig {
params(_expires_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expires_at=(_expires_at); end
# A product descriptor of up to 22 characters, which will appear to customers at the convenience store.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(confirmation_number: T.nilable(String), expires_after_days: T.nilable(T.any(String, Integer)), expires_at: T.nilable(T.any(String, Integer)), product_description: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(
confirmation_number: nil,
expires_after_days: nil,
expires_at: nil,
product_description: nil,
setup_future_usage: nil
); end
end
class KrCard < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Link < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
sig { params(_persistent_token: T.nilable(String)).returns(T.nilable(String)) }
def persistent_token=(_persistent_token); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), persistent_token: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, persistent_token: nil, setup_future_usage: nil); end
end
class MbWay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Mobilepay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Multibanco < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class NaverPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class NzBankAccount < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(setup_future_usage: nil, target_date: nil); end
end
class Oxxo < Stripe::RequestParams
# The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class P24 < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Confirm that the payer has accepted the P24 terms and conditions.
sig { returns(T.nilable(T::Boolean)) }
def tos_shown_and_accepted; end
sig {
params(_tos_shown_and_accepted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def tos_shown_and_accepted=(_tos_shown_and_accepted); end
sig {
params(setup_future_usage: T.nilable(String), tos_shown_and_accepted: T.nilable(T::Boolean)).void
}
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Paynow < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Paypal < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The tax for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The tax behavior for the line item.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(amount: Integer, behavior: String).void }
def initialize(amount: nil, behavior: nil); end
end
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Descriptive name of the line item.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Quantity of the line item. Must be a positive number.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Client facing stock keeping unit, article number or similar.
sig { returns(T.nilable(String)) }
def sku; end
sig { params(_sku: T.nilable(String)).returns(T.nilable(String)) }
def sku=(_sku); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
# The tax information for the line item.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypal::LineItem::Tax)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax=(_tax); end
# Price for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def unit_amount; end
sig { params(_unit_amount: Integer).returns(Integer) }
def unit_amount=(_unit_amount); end
sig {
params(category: T.nilable(String), description: T.nilable(String), name: String, quantity: Integer, sku: T.nilable(String), sold_by: T.nilable(String), tax: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypal::LineItem::Tax), unit_amount: Integer).void
}
def initialize(
category: nil,
description: nil,
name: nil,
quantity: nil,
sku: nil,
sold_by: nil,
tax: nil,
unit_amount: nil
); end
end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# The line items purchased by the customer.
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypal::LineItem])).returns(T.nilable(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items=(_line_items); end
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference_id; end
sig { params(_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def reference_id=(_reference_id); end
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
sig { returns(T.nilable(String)) }
def risk_correlation_id; end
sig { params(_risk_correlation_id: T.nilable(String)).returns(T.nilable(String)) }
def risk_correlation_id=(_risk_correlation_id); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(capture_method: T.nilable(String), line_items: T.nilable(T::Array[::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypal::LineItem]), preferred_locale: T.nilable(String), reference: T.nilable(String), reference_id: T.nilable(String), risk_correlation_id: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String)), subsellers: T.nilable(T::Array[String])).void
}
def initialize(
capture_method: nil,
line_items: nil,
preferred_locale: nil,
reference: nil,
reference_id: nil,
risk_correlation_id: nil,
setup_future_usage: nil,
subsellers: nil
); end
end
class Paypay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
sig { params(_payments_per_period: T.nilable(Integer)).returns(T.nilable(Integer)) }
def payments_per_period=(_payments_per_period); end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
sig { params(_purpose: T.nilable(String)).returns(T.nilable(String)) }
def purpose=(_purpose); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), payments_per_period: T.nilable(Integer), purpose: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil
); end
end
# Additional fields for Mandate creation. Only `purpose` field is configurable for PayTo PaymentIntent with `setup_future_usage=none`. Other fields are only applicable to PayTo PaymentIntent with `setup_future_usage=off_session`
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Payto::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Payto::MandateOptions), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(mandate_options: nil, setup_future_usage: nil); end
end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Type of amount. Defaults to `maximum`.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), amount_type: T.nilable(String), currency: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), reference: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
amount_type: nil,
currency: nil,
end_date: nil,
payment_schedule: nil,
reference: nil,
start_date: nil
); end
end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
sig { returns(T.nilable(Integer)) }
def expires_after_seconds; end
sig { params(_expires_after_seconds: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_seconds=(_expires_after_seconds); end
# The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# Additional fields for mandate creation. Only applicable when `setup_future_usage=off_session`.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(amount_includes_iof: T.nilable(String), expires_after_seconds: T.nilable(Integer), expires_at: T.nilable(Integer), mandate_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Pix::MandateOptions), setup_future_usage: T.nilable(String)).void
}
def initialize(
amount_includes_iof: nil,
expires_after_seconds: nil,
expires_at: nil,
mandate_options: nil,
setup_future_usage: nil
); end
end
class Promptpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Qris < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Rechnung < Stripe::RequestParams; end
class RevolutPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class SamsungPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Satispay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Shopeepay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Sofort < Stripe::RequestParams
# Language shown to the payer on redirect.
sig { returns(T.nilable(T.any(String, String))) }
def preferred_language; end
sig {
params(_preferred_language: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(T.any(String, String)), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class StripeBalance < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Swish < Stripe::RequestParams
# A reference for this payment to be displayed in the Swish app.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(reference: T.nilable(String), setup_future_usage: T.nilable(String)).void }
def initialize(reference: nil, setup_future_usage: nil); end
end
class Twint < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
class ManualEntry < Stripe::RequestParams
# Settings for configuring manual entry of account details.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
sig { params(mode: String).void }
def initialize(mode: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# Customize manual entry behavior
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry; end
sig {
params(_manual_entry: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry=(_manual_entry); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(filters: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), manual_entry: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
}
def initialize(
filters: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
); end
end
class MandateOptions < Stripe::RequestParams
# The method used to collect offline mandate customer acceptance.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
sig { params(collection_method: T.nilable(String)).void }
def initialize(collection_method: nil); end
end
class Networks < Stripe::RequestParams
# Triggers validations to run across the selected networks
sig { returns(T.nilable(T::Array[String])) }
def requested; end
sig {
params(_requested: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested=(_requested); end
sig { params(requested: T.nilable(T::Array[String])).void }
def initialize(requested: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Additional fields for network related functions
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks; end
sig {
params(_networks: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::Networks)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks=(_networks); end
# Preferred transaction settlement speed
sig { returns(T.nilable(T.any(String, String))) }
def preferred_settlement_speed; end
sig {
params(_preferred_settlement_speed: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred_settlement_speed=(_preferred_settlement_speed); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::Networks), preferred_settlement_speed: T.nilable(T.any(String, String)), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
financial_connections: nil,
mandate_options: nil,
networks: nil,
preferred_settlement_speed: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class WechatPay < Stripe::RequestParams
# The app ID registered with WeChat Pay. Only required when client is ios or android.
sig { returns(T.nilable(String)) }
def app_id; end
sig { params(_app_id: T.nilable(String)).returns(T.nilable(String)) }
def app_id=(_app_id); end
# The client type that the end customer will pay from
sig { returns(T.nilable(String)) }
def client; end
sig { params(_client: T.nilable(String)).returns(T.nilable(String)) }
def client=(_client); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(app_id: T.nilable(String), client: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
end
class Zip < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
# If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AcssDebit)))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AcssDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AcssDebit)))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Affirm)))
}
def affirm; end
sig {
params(_affirm: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Affirm))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Affirm)))
}
def affirm=(_affirm); end
# If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AfterpayClearpay)))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AfterpayClearpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AfterpayClearpay)))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Alipay)))
}
def alipay; end
sig {
params(_alipay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Alipay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Alipay)))
}
def alipay=(_alipay); end
# If this is a `alma` PaymentMethod, this sub-hash contains details about the Alma payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Alma)))
}
def alma; end
sig {
params(_alma: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Alma))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Alma)))
}
def alma=(_alma); end
# If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AmazonPay)))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AmazonPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AmazonPay)))
}
def amazon_pay=(_amazon_pay); end
# If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AuBecsDebit)))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AuBecsDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AuBecsDebit)))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::BacsDebit)))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::BacsDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::BacsDebit)))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Bancontact)))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Bancontact))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Bancontact)))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this sub-hash contains details about the Billie payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Billie)))
}
def billie; end
sig {
params(_billie: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Billie))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Billie)))
}
def billie=(_billie); end
# If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Blik)))
}
def blik; end
sig {
params(_blik: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Blik))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Blik)))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Boleto)))
}
def boleto; end
sig {
params(_boleto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Boleto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Boleto)))
}
def boleto=(_boleto); end
# Configuration for any card payments attempted on this PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card)))
}
def card; end
sig {
params(_card: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card)))
}
def card=(_card); end
# If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CardPresent)))
}
def card_present; end
sig {
params(_card_present: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CardPresent))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CardPresent)))
}
def card_present=(_card_present); end
# If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Cashapp)))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Cashapp))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Cashapp)))
}
def cashapp=(_cashapp); end
# If this is a `crypto` PaymentMethod, this sub-hash contains details about the Crypto payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Crypto)))
}
def crypto; end
sig {
params(_crypto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Crypto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Crypto)))
}
def crypto=(_crypto); end
# If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CustomerBalance))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance=(_customer_balance); end
# If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Eps)))
}
def eps; end
sig {
params(_eps: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Eps))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Eps)))
}
def eps=(_eps); end
# If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Fpx)))
}
def fpx; end
sig {
params(_fpx: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Fpx))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Fpx)))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Giropay)))
}
def giropay; end
sig {
params(_giropay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Giropay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Giropay)))
}
def giropay=(_giropay); end
# If this is a `gopay` PaymentMethod, this sub-hash contains details about the Gopay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Gopay)))
}
def gopay; end
sig {
params(_gopay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Gopay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Gopay)))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Grabpay)))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Grabpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Grabpay)))
}
def grabpay=(_grabpay); end
# If this is a `id_bank_transfer` PaymentMethod, this sub-hash contains details about the Indonesia Bank Transfer payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::IdBankTransfer))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Ideal)))
}
def ideal; end
sig {
params(_ideal: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Ideal))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Ideal)))
}
def ideal=(_ideal); end
# If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::InteracPresent)))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::InteracPresent))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::InteracPresent)))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::KakaoPay)))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::KakaoPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::KakaoPay)))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna)))
}
def klarna; end
sig {
params(_klarna: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna)))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Konbini)))
}
def konbini; end
sig {
params(_konbini: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Konbini))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Konbini)))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this sub-hash contains details about the KR Card payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::KrCard)))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::KrCard))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::KrCard)))
}
def kr_card=(_kr_card); end
# If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Link)))
}
def link; end
sig {
params(_link: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Link))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Link)))
}
def link=(_link); end
# If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::MbWay)))
}
def mb_way; end
sig {
params(_mb_way: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::MbWay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::MbWay)))
}
def mb_way=(_mb_way); end
# If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Mobilepay)))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Mobilepay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Mobilepay)))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Multibanco)))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Multibanco))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Multibanco)))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this sub-hash contains details about the Naver Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::NaverPay)))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::NaverPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::NaverPay)))
}
def naver_pay=(_naver_pay); end
# If this is a `nz_bank_account` PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::NzBankAccount)))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::NzBankAccount))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::NzBankAccount)))
}
def nz_bank_account=(_nz_bank_account); end
# If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Oxxo)))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Oxxo))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Oxxo)))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::P24)))
}
def p24; end
sig {
params(_p24: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::P24))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::P24)))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this sub-hash contains details about the PayByBank payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::PayByBank)))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::PayByBank))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::PayByBank)))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this sub-hash contains details about the PAYCO payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Payco)))
}
def payco; end
sig {
params(_payco: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Payco))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Payco)))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paynow)))
}
def paynow; end
sig {
params(_paynow: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paynow))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paynow)))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypal)))
}
def paypal; end
sig {
params(_paypal: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypal))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypal)))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this sub-hash contains details about the PayPay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypay)))
}
def paypay; end
sig {
params(_paypay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypay)))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Payto)))
}
def payto; end
sig {
params(_payto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Payto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Payto)))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Pix)))
}
def pix; end
sig {
params(_pix: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Pix))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Pix)))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Promptpay)))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Promptpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Promptpay)))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this sub-hash contains details about the QRIS payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Qris)))
}
def qris; end
sig {
params(_qris: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Qris))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Qris)))
}
def qris=(_qris); end
# If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Rechnung)))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Rechnung))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Rechnung)))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::RevolutPay)))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::RevolutPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::RevolutPay)))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SamsungPay)))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SamsungPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SamsungPay)))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Satispay)))
}
def satispay; end
sig {
params(_satispay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Satispay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Satispay)))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SepaDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit=(_sepa_debit); end
# If this is a `shopeepay` PaymentMethod, this sub-hash contains details about the ShopeePay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Shopeepay)))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Shopeepay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Shopeepay)))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Sofort)))
}
def sofort; end
sig {
params(_sofort: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Sofort))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Sofort)))
}
def sofort=(_sofort); end
# If this is a `stripe_balance` PaymentMethod, this sub-hash contains details about the Stripe Balance payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::StripeBalance)))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::StripeBalance))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::StripeBalance)))
}
def stripe_balance=(_stripe_balance); end
# If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Swish)))
}
def swish; end
sig {
params(_swish: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Swish))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Swish)))
}
def swish=(_swish); end
# If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Twint)))
}
def twint; end
sig {
params(_twint: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Twint))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Twint)))
}
def twint=(_twint); end
# If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
# If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::WechatPay)))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::WechatPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::WechatPay)))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Zip)))
}
def zip; end
sig {
params(_zip: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Zip))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Zip)))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AcssDebit)), affirm: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Affirm)), afterpay_clearpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AfterpayClearpay)), alipay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Alipay)), alma: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Alma)), amazon_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AmazonPay)), au_becs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AuBecsDebit)), bacs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::BacsDebit)), bancontact: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Bancontact)), billie: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Billie)), blik: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Blik)), boleto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Boleto)), card: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card)), card_present: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CardPresent)), cashapp: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Cashapp)), crypto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Crypto)), customer_balance: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CustomerBalance)), eps: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Eps)), fpx: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Fpx)), giropay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Giropay)), gopay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Gopay)), grabpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Grabpay)), id_bank_transfer: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::IdBankTransfer)), ideal: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Ideal)), interac_present: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::InteracPresent)), kakao_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::KakaoPay)), klarna: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna)), konbini: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Konbini)), kr_card: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::KrCard)), link: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Link)), mb_way: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::MbWay)), mobilepay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Mobilepay)), multibanco: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Multibanco)), naver_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::NaverPay)), nz_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::NzBankAccount)), oxxo: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Oxxo)), p24: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::P24)), pay_by_bank: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::PayByBank)), payco: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Payco)), paynow: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paynow)), paypal: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypal)), paypay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypay)), payto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Payto)), pix: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Pix)), promptpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Promptpay)), qris: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Qris)), rechnung: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Rechnung)), revolut_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::RevolutPay)), samsung_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SamsungPay)), satispay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Satispay)), sepa_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SepaDebit)), shopeepay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Shopeepay)), sofort: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Sofort)), stripe_balance: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::StripeBalance)), swish: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Swish)), twint: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Twint)), us_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount)), wechat_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::WechatPay)), zip: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Zip))).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
blik: nil,
boleto: nil,
card: nil,
card_present: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address.
sig { returns(::Stripe::PaymentIntentService::CreateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::PaymentIntentService::CreateParams::Shipping::Address).returns(::Stripe::PaymentIntentService::CreateParams::Shipping::Address)
}
def address=(_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
sig { params(_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def tracking_number=(_tracking_number); end
sig {
params(address: ::Stripe::PaymentIntentService::CreateParams::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
}
def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
# The amount is capped at the total transaction amount and if no amount is set,
# the full amount is transferred.
#
# If you intend to collect a fee and you need a more robust reporting experience, using
# [application_fee_amount](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-application_fee_amount)
# might be a better fit for your integration.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# If specified, successful charges will be attributed to the destination
# account for tax reporting, and the funds from charges will be transferred
# to the destination account. The ID of the resulting transfer will be
# returned on the successful charge's `transfer` field.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Provides industry-specific information about the amount.
sig { returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails)) }
def amount_details; end
sig {
params(_amount_details: T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails))
}
def amount_details=(_amount_details); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::AutomaticPaymentMethods))
}
def automatic_payment_methods; end
sig {
params(_automatic_payment_methods: T.nilable(::Stripe::PaymentIntentService::CreateParams::AutomaticPaymentMethods)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::AutomaticPaymentMethods))
}
def automatic_payment_methods=(_automatic_payment_methods); end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm).
sig { returns(T.nilable(T::Boolean)) }
def confirm; end
sig { params(_confirm: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def confirm=(_confirm); end
# Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.
sig { returns(T.nilable(String)) }
def confirmation_method; end
sig { params(_confirmation_method: T.nilable(String)).returns(T.nilable(String)) }
def confirmation_method=(_confirmation_method); end
# ID of the ConfirmationToken used to confirm this PaymentIntent.
#
# If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.
sig { returns(T.nilable(String)) }
def confirmation_token; end
sig { params(_confirmation_token: T.nilable(String)).returns(T.nilable(String)) }
def confirmation_token=(_confirmation_token); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# ID of the Customer this PaymentIntent belongs to, if one exists.
#
# Payment methods attached to other Customers cannot be used with this PaymentIntent.
#
# If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# ID of the Account this PaymentIntent belongs to, if one exists.
#
# Payment methods attached to other Accounts cannot be used with this PaymentIntent.
#
# If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
sig { returns(T.nilable(T::Boolean)) }
def error_on_requires_action; end
sig {
params(_error_on_requires_action: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def error_on_requires_action=(_error_on_requires_action); end
# The list of payment method types to exclude from use with this payment.
sig { returns(T.nilable(T::Array[String])) }
def excluded_payment_method_types; end
sig {
params(_excluded_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def excluded_payment_method_types=(_excluded_payment_method_types); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.
sig { returns(T.nilable(String)) }
def fx_quote; end
sig { params(_fx_quote: T.nilable(String)).returns(T.nilable(String)) }
def fx_quote=(_fx_quote); end
# Automations to be run during the PaymentIntent lifecycle
sig { returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::Hooks)) }
def hooks; end
sig {
params(_hooks: T.nilable(::Stripe::PaymentIntentService::CreateParams::Hooks)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::Hooks))
}
def hooks=(_hooks); end
# ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
sig { returns(T.nilable(String)) }
def mandate; end
sig { params(_mandate: T.nilable(String)).returns(T.nilable(String)) }
def mandate=(_mandate); end
# This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::MandateData)))
}
def mandate_data; end
sig {
params(_mandate_data: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::MandateData))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::MandateData)))
}
def mandate_data=(_mandate_data); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
sig { returns(T.nilable(T.any(T::Boolean, String))) }
def off_session; end
sig {
params(_off_session: T.nilable(T.any(T::Boolean, String))).returns(T.nilable(T.any(T::Boolean, String)))
}
def off_session=(_off_session); end
# The Stripe account ID that these funds are intended for. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Provides industry-specific information about the charge.
sig { returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails)) }
def payment_details; end
sig {
params(_payment_details: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails))
}
def payment_details=(_payment_details); end
# ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent.
#
# If you don't provide the `payment_method` parameter or the `source` parameter with `confirm=true`, `source` automatically populates with `customer.default_source` to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward.
# If the payment method is attached to a Customer, you must also provide the ID of that Customer as the [customer](https://stripe.com/docs/api#create_payment_intent-customer) parameter of this PaymentIntent.
# end
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent.
sig { returns(T.nilable(String)) }
def payment_method_configuration; end
sig { params(_payment_method_configuration: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_configuration=(_payment_method_configuration); end
# If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
# in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)
# property on the PaymentIntent.
sig { returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData)) }
def payment_method_data; end
sig {
params(_payment_method_data: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData))
}
def payment_method_data=(_payment_method_data); end
# Payment method-specific configuration for this PaymentIntent.
sig { returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions)) }
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
# Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).
sig { returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::RadarOptions)) }
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::RadarOptions)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::RadarOptions))
}
def radar_options=(_radar_options); end
# Email address to send the receipt to. If you specify `receipt_email` for a payment in live mode, you send a receipt regardless of your [email settings](https://dashboard.stripe.com/account/emails).
sig { returns(T.nilable(String)) }
def receipt_email; end
sig { params(_receipt_email: T.nilable(String)).returns(T.nilable(String)) }
def receipt_email=(_receipt_email); end
# The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# Indicates whether confirmation for this PaymentIntent using a secret key is `required` or `optional`.
sig { returns(T.nilable(String)) }
def secret_key_confirmation; end
sig { params(_secret_key_confirmation: T.nilable(String)).returns(T.nilable(String)) }
def secret_key_confirmation=(_secret_key_confirmation); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Shipping information for this PaymentIntent.
sig { returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::Shipping)) }
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::PaymentIntentService::CreateParams::Shipping)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::Shipping))
}
def shipping=(_shipping); end
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# The parameters that you can use to automatically create a Transfer.
# Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::PaymentIntentService::CreateParams::TransferData)).returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::TransferData))
}
def transfer_data=(_transfer_data); end
# A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
# Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
sig { returns(T.nilable(T::Boolean)) }
def use_stripe_sdk; end
sig { params(_use_stripe_sdk: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def use_stripe_sdk=(_use_stripe_sdk); end
sig {
params(amount: Integer, amount_details: T.nilable(::Stripe::PaymentIntentService::CreateParams::AmountDetails), application_fee_amount: T.nilable(Integer), automatic_payment_methods: T.nilable(::Stripe::PaymentIntentService::CreateParams::AutomaticPaymentMethods), capture_method: T.nilable(String), confirm: T.nilable(T::Boolean), confirmation_method: T.nilable(String), confirmation_token: T.nilable(String), currency: String, customer: T.nilable(String), customer_account: T.nilable(String), description: T.nilable(String), error_on_requires_action: T.nilable(T::Boolean), excluded_payment_method_types: T.nilable(T::Array[String]), expand: T.nilable(T::Array[String]), fx_quote: T.nilable(String), hooks: T.nilable(::Stripe::PaymentIntentService::CreateParams::Hooks), mandate: T.nilable(String), mandate_data: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::MandateData)), metadata: T.nilable(T::Hash[String, String]), off_session: T.nilable(T.any(T::Boolean, String)), on_behalf_of: T.nilable(String), payment_details: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentDetails), payment_method: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), radar_options: T.nilable(::Stripe::PaymentIntentService::CreateParams::RadarOptions), receipt_email: T.nilable(String), return_url: T.nilable(String), secret_key_confirmation: T.nilable(String), setup_future_usage: T.nilable(String), shipping: T.nilable(::Stripe::PaymentIntentService::CreateParams::Shipping), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::PaymentIntentService::CreateParams::TransferData), transfer_group: T.nilable(String), use_stripe_sdk: T.nilable(T::Boolean)).void
}
def initialize(
amount: nil,
amount_details: nil,
application_fee_amount: nil,
automatic_payment_methods: nil,
capture_method: nil,
confirm: nil,
confirmation_method: nil,
confirmation_token: nil,
currency: nil,
customer: nil,
customer_account: nil,
description: nil,
error_on_requires_action: nil,
excluded_payment_method_types: nil,
expand: nil,
fx_quote: nil,
hooks: nil,
mandate: nil,
mandate_data: nil,
metadata: nil,
off_session: nil,
on_behalf_of: nil,
payment_details: nil,
payment_method: nil,
payment_method_configuration: nil,
payment_method_data: nil,
payment_method_options: nil,
payment_method_types: nil,
radar_options: nil,
receipt_email: nil,
return_url: nil,
secret_key_confirmation: nil,
setup_future_usage: nil,
shipping: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil,
transfer_group: nil,
use_stripe_sdk: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.
sig { returns(T.nilable(String)) }
def client_secret; end
sig { params(_client_secret: T.nilable(String)).returns(T.nilable(String)) }
def client_secret=(_client_secret); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(client_secret: T.nilable(String), expand: T.nilable(T::Array[String])).void }
def initialize(client_secret: nil, expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class AmountDetails < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class Card < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class CardPresent < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class Klarna < Stripe::RequestParams
# URL to an image for the product. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def image_url; end
sig { params(_image_url: T.nilable(String)).returns(T.nilable(String)) }
def image_url=(_image_url); end
# URL to the product page. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def product_url; end
sig { params(_product_url: T.nilable(String)).returns(T.nilable(String)) }
def product_url=(_product_url); end
# Reference for the subscription this line item is for.
sig { returns(T.nilable(String)) }
def subscription_reference; end
sig { params(_subscription_reference: T.nilable(String)).returns(T.nilable(String)) }
def subscription_reference=(_subscription_reference); end
sig {
params(image_url: T.nilable(String), product_url: T.nilable(String), subscription_reference: T.nilable(String)).void
}
def initialize(image_url: nil, product_url: nil, subscription_reference: nil); end
end
class Paypal < Stripe::RequestParams
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
sig {
params(category: T.nilable(String), description: T.nilable(String), sold_by: T.nilable(String)).void
}
def initialize(category: nil, description: nil, sold_by: nil); end
end
# This sub-hash contains line item details that are specific to `card` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card=(_card); end
# This sub-hash contains line item details that are specific to `card_present` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present=(_card_present); end
# This sub-hash contains line item details that are specific to `klarna` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# This sub-hash contains line item details that are specific to `paypal` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
sig {
params(card: T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent), klarna: T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna), paypal: T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).void
}
def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end
end
class Tax < Stripe::RequestParams
# The total tax on an item. Non-negative integer.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The amount an item was discounted for. Positive integer.
sig { returns(T.nilable(Integer)) }
def discount_amount; end
sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def discount_amount=(_discount_amount); end
# Payment method-specific information for line items.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# Unique identifier of the product. At most 12 characters long.
sig { returns(T.nilable(String)) }
def product_code; end
sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) }
def product_code=(_product_code); end
# Name of the product. At most 100 characters long.
sig { returns(String) }
def product_name; end
sig { params(_product_name: String).returns(String) }
def product_name=(_product_name); end
# Number of items of the product. Positive integer.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Contains information about the tax on the item.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::Tax)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::Tax))
}
def tax=(_tax); end
# Cost of the product. Non-negative integer.
sig { returns(Integer) }
def unit_cost; end
sig { params(_unit_cost: Integer).returns(Integer) }
def unit_cost=(_unit_cost); end
# A unit of measure for the line item, such as gallons, feet, meters, etc.
sig { returns(T.nilable(String)) }
def unit_of_measure; end
sig { params(_unit_of_measure: T.nilable(String)).returns(T.nilable(String)) }
def unit_of_measure=(_unit_of_measure); end
sig {
params(discount_amount: T.nilable(Integer), payment_method_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::PaymentMethodOptions), product_code: T.nilable(String), product_name: String, quantity: Integer, tax: T.nilable(::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem::Tax), unit_cost: Integer, unit_of_measure: T.nilable(String)).void
}
def initialize(
discount_amount: nil,
payment_method_options: nil,
product_code: nil,
product_name: nil,
quantity: nil,
tax: nil,
unit_cost: nil,
unit_of_measure: nil
); end
end
class Shipping < Stripe::RequestParams
# Portion of the amount that is for shipping.
sig { returns(T.nilable(T.any(String, Integer))) }
def amount; end
sig {
params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def amount=(_amount); end
# The postal code that represents the shipping source.
sig { returns(T.nilable(String)) }
def from_postal_code; end
sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def from_postal_code=(_from_postal_code); end
# The postal code that represents the shipping destination.
sig { returns(T.nilable(String)) }
def to_postal_code; end
sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def to_postal_code=(_to_postal_code); end
sig {
params(amount: T.nilable(T.any(String, Integer)), from_postal_code: T.nilable(String), to_postal_code: T.nilable(String)).void
}
def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end
end
class Tax < Stripe::RequestParams
# Total portion of the amount that is for tax.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The total discount applied on the transaction.
sig { returns(T.nilable(T.any(String, Integer))) }
def discount_amount; end
sig {
params(_discount_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def discount_amount=(_discount_amount); end
# A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem])))
}
def line_items; end
sig {
params(_line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem])))
}
def line_items=(_line_items); end
# Contains information about the shipping portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::AmountDetails::Shipping)))
}
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::AmountDetails::Shipping))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::AmountDetails::Shipping)))
}
def shipping=(_shipping); end
# Contains information about the tax portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::AmountDetails::Tax)))
}
def tax; end
sig {
params(_tax: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::AmountDetails::Tax))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::AmountDetails::Tax)))
}
def tax=(_tax); end
sig {
params(discount_amount: T.nilable(T.any(String, Integer)), line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::UpdateParams::AmountDetails::LineItem])), shipping: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::AmountDetails::Shipping)), tax: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::AmountDetails::Tax))).void
}
def initialize(discount_amount: nil, line_items: nil, shipping: nil, tax: nil); end
end
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
sig { returns(String) }
def calculation; end
sig { params(_calculation: String).returns(String) }
def calculation=(_calculation); end
sig { params(calculation: String).void }
def initialize(calculation: nil); end
end
# Tax arguments for automations
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::Hooks::Inputs::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntentService::UpdateParams::Hooks::Inputs::Tax)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::Hooks::Inputs::Tax))
}
def tax=(_tax); end
sig {
params(tax: T.nilable(::Stripe::PaymentIntentService::UpdateParams::Hooks::Inputs::Tax)).void
}
def initialize(tax: nil); end
end
# Arguments passed in automations
sig { returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::Hooks::Inputs)) }
def inputs; end
sig {
params(_inputs: T.nilable(::Stripe::PaymentIntentService::UpdateParams::Hooks::Inputs)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::Hooks::Inputs))
}
def inputs=(_inputs); end
sig {
params(inputs: T.nilable(::Stripe::PaymentIntentService::UpdateParams::Hooks::Inputs)).void
}
def initialize(inputs: nil); end
end
class MandateData < Stripe::RequestParams
class CustomerAcceptance < Stripe::RequestParams
class Online < Stripe::RequestParams
# The IP address from which the Mandate was accepted by the customer.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# The user agent of the browser from which the Mandate was accepted by the customer.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig { params(ip_address: T.nilable(String), user_agent: T.nilable(String)).void }
def initialize(ip_address: nil, user_agent: nil); end
end
# If this is a Mandate accepted online, this hash contains details about the online acceptance.
sig {
returns(::Stripe::PaymentIntentService::UpdateParams::MandateData::CustomerAcceptance::Online)
}
def online; end
sig {
params(_online: ::Stripe::PaymentIntentService::UpdateParams::MandateData::CustomerAcceptance::Online).returns(::Stripe::PaymentIntentService::UpdateParams::MandateData::CustomerAcceptance::Online)
}
def online=(_online); end
# The type of customer acceptance information included with the Mandate.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(online: ::Stripe::PaymentIntentService::UpdateParams::MandateData::CustomerAcceptance::Online, type: String).void
}
def initialize(online: nil, type: nil); end
end
# This hash contains details about the customer acceptance of the Mandate.
sig {
returns(::Stripe::PaymentIntentService::UpdateParams::MandateData::CustomerAcceptance)
}
def customer_acceptance; end
sig {
params(_customer_acceptance: ::Stripe::PaymentIntentService::UpdateParams::MandateData::CustomerAcceptance).returns(::Stripe::PaymentIntentService::UpdateParams::MandateData::CustomerAcceptance)
}
def customer_acceptance=(_customer_acceptance); end
sig {
params(customer_acceptance: ::Stripe::PaymentIntentService::UpdateParams::MandateData::CustomerAcceptance).void
}
def initialize(customer_acceptance: nil); end
end
class PaymentDetails < Stripe::RequestParams
class CarRental < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Distance < Stripe::RequestParams
# Distance traveled.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
sig { params(amount: T.nilable(Integer), unit: T.nilable(String)).void }
def initialize(amount: nil, unit: nil); end
end
class Driver < Stripe::RequestParams
# Driver's identification number.
sig { returns(T.nilable(String)) }
def driver_identification_number; end
sig {
params(_driver_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def driver_identification_number=(_driver_identification_number); end
# Driver's tax number.
sig { returns(T.nilable(String)) }
def driver_tax_number; end
sig { params(_driver_tax_number: T.nilable(String)).returns(T.nilable(String)) }
def driver_tax_number=(_driver_tax_number); end
# Full name of the person or entity on the car reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(driver_identification_number: T.nilable(String), driver_tax_number: T.nilable(String), name: String).void
}
def initialize(
driver_identification_number: nil,
driver_tax_number: nil,
name: nil
); end
end
class PickupAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class ReturnAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the car rental.
sig { returns(String) }
def booking_number; end
sig { params(_booking_number: String).returns(String) }
def booking_number=(_booking_number); end
# Class code of the car.
sig { returns(T.nilable(String)) }
def car_class_code; end
sig { params(_car_class_code: T.nilable(String)).returns(T.nilable(String)) }
def car_class_code=(_car_class_code); end
# Make of the car.
sig { returns(T.nilable(String)) }
def car_make; end
sig { params(_car_make: T.nilable(String)).returns(T.nilable(String)) }
def car_make=(_car_make); end
# Model of the car.
sig { returns(T.nilable(String)) }
def car_model; end
sig { params(_car_model: T.nilable(String)).returns(T.nilable(String)) }
def car_model=(_car_model); end
# The name of the rental car company.
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# The customer service phone number of the car rental company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# Number of days the car is being rented.
sig { returns(Integer) }
def days_rented; end
sig { params(_days_rented: Integer).returns(Integer) }
def days_rented=(_days_rented); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Delivery)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Delivery))
}
def delivery=(_delivery); end
# The details of the distance traveled during the rental period.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Distance))
}
def distance; end
sig {
params(_distance: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Distance)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Distance))
}
def distance=(_distance); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Driver]))
}
def drivers; end
sig {
params(_drivers: T.nilable(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Driver])).returns(T.nilable(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Driver]))
}
def drivers=(_drivers); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates if the customer did not keep nor cancel their booking.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# Car pick-up address.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address; end
sig {
params(_pickup_address: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::PickupAddress)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address=(_pickup_address); end
# Car pick-up time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def pickup_at; end
sig { params(_pickup_at: Integer).returns(Integer) }
def pickup_at=(_pickup_at); end
# Name of the pickup location.
sig { returns(T.nilable(String)) }
def pickup_location_name; end
sig { params(_pickup_location_name: T.nilable(String)).returns(T.nilable(String)) }
def pickup_location_name=(_pickup_location_name); end
# Rental rate.
sig { returns(T.nilable(Integer)) }
def rate_amount; end
sig { params(_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def rate_amount=(_rate_amount); end
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
sig { returns(T.nilable(String)) }
def rate_interval; end
sig { params(_rate_interval: T.nilable(String)).returns(T.nilable(String)) }
def rate_interval=(_rate_interval); end
# The name of the person or entity renting the car.
sig { returns(T.nilable(String)) }
def renter_name; end
sig { params(_renter_name: T.nilable(String)).returns(T.nilable(String)) }
def renter_name=(_renter_name); end
# Car return address.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address; end
sig {
params(_return_address: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::ReturnAddress)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address=(_return_address); end
# Car return time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def return_at; end
sig { params(_return_at: Integer).returns(Integer) }
def return_at=(_return_at); end
# Name of the return location.
sig { returns(T.nilable(String)) }
def return_location_name; end
sig { params(_return_location_name: T.nilable(String)).returns(T.nilable(String)) }
def return_location_name=(_return_location_name); end
# Indicates whether the goods or services are tax-exempt or tax is not collected.
sig { returns(T.nilable(T::Boolean)) }
def tax_exempt; end
sig { params(_tax_exempt: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def tax_exempt=(_tax_exempt); end
# The vehicle identification number.
sig { returns(T.nilable(String)) }
def vehicle_identification_number; end
sig {
params(_vehicle_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def vehicle_identification_number=(_vehicle_identification_number); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Affiliate), booking_number: String, car_class_code: T.nilable(String), car_make: T.nilable(String), car_model: T.nilable(String), company: T.nilable(String), customer_service_phone_number: T.nilable(String), days_rented: Integer, delivery: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Delivery), distance: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Distance), drivers: T.nilable(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::Driver]), extra_charges: T.nilable(T::Array[String]), no_show: T.nilable(T::Boolean), pickup_address: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::PickupAddress), pickup_at: Integer, pickup_location_name: T.nilable(String), rate_amount: T.nilable(Integer), rate_interval: T.nilable(String), renter_name: T.nilable(String), return_address: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental::ReturnAddress), return_at: Integer, return_location_name: T.nilable(String), tax_exempt: T.nilable(T::Boolean), vehicle_identification_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
booking_number: nil,
car_class_code: nil,
car_make: nil,
car_model: nil,
company: nil,
customer_service_phone_number: nil,
days_rented: nil,
delivery: nil,
distance: nil,
drivers: nil,
extra_charges: nil,
no_show: nil,
pickup_address: nil,
pickup_at: nil,
pickup_location_name: nil,
rate_amount: nil,
rate_interval: nil,
renter_name: nil,
return_address: nil,
return_at: nil,
return_location_name: nil,
tax_exempt: nil,
vehicle_identification_number: nil
); end
end
class EventDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
# Indicates if the tickets are digitally checked when entering the venue.
sig { returns(T.nilable(T::Boolean)) }
def access_controlled_venue; end
sig {
params(_access_controlled_venue: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def access_controlled_venue=(_access_controlled_venue); end
# The event location's address.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails::Address)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails::Address))
}
def address=(_address); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate=(_affiliate); end
# The name of the company
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails::Delivery)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails::Delivery))
}
def delivery=(_delivery); end
# Event end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Type of the event entertainment (concert, sports event etc)
sig { returns(T.nilable(String)) }
def genre; end
sig { params(_genre: T.nilable(String)).returns(T.nilable(String)) }
def genre=(_genre); end
# The name of the event.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Event start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(access_controlled_venue: T.nilable(T::Boolean), address: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails::Address), affiliate: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails::Affiliate), company: T.nilable(String), delivery: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails::Delivery), ends_at: T.nilable(Integer), genre: T.nilable(String), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
access_controlled_venue: nil,
address: nil,
affiliate: nil,
company: nil,
delivery: nil,
ends_at: nil,
genre: nil,
name: nil,
starts_at: nil
); end
end
class Flight < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the flight reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Segment < Stripe::RequestParams
# The flight segment amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The International Air Transport Association (IATA) airport code for the arrival airport.
sig { returns(T.nilable(String)) }
def arrival_airport; end
sig { params(_arrival_airport: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport=(_arrival_airport); end
# The arrival time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def arrives_at; end
sig { params(_arrives_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def arrives_at=(_arrives_at); end
# The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The departure time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def departs_at; end
sig { params(_departs_at: Integer).returns(Integer) }
def departs_at=(_departs_at); end
# The International Air Transport Association (IATA) airport code for the departure airport.
sig { returns(T.nilable(String)) }
def departure_airport; end
sig { params(_departure_airport: T.nilable(String)).returns(T.nilable(String)) }
def departure_airport=(_departure_airport); end
# The flight number associated with the segment
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The fare class for the segment.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
sig {
params(amount: T.nilable(Integer), arrival_airport: T.nilable(String), arrives_at: T.nilable(Integer), carrier: T.nilable(String), departs_at: Integer, departure_airport: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String)).void
}
def initialize(
amount: nil,
arrival_airport: nil,
arrives_at: nil,
carrier: nil,
departs_at: nil,
departure_airport: nil,
flight_number: nil,
service_class: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Affiliate))
}
def affiliate=(_affiliate); end
# The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
sig { returns(T.nilable(String)) }
def agency_number; end
sig { params(_agency_number: T.nilable(String)).returns(T.nilable(String)) }
def agency_number=(_agency_number); end
# The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Delivery)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Delivery))
}
def delivery=(_delivery); end
# The name of the person or entity on the reservation.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# The details of the passengers in the travel reservation.
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Passenger])).returns(T.nilable(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Passenger]))
}
def passengers=(_passengers); end
# The individual flight segments associated with the trip.
sig {
returns(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Segment])
}
def segments; end
sig {
params(_segments: T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Segment]).returns(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Segment])
}
def segments=(_segments); end
# The ticket number associated with the travel reservation.
sig { returns(T.nilable(String)) }
def ticket_number; end
sig { params(_ticket_number: T.nilable(String)).returns(T.nilable(String)) }
def ticket_number=(_ticket_number); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Affiliate), agency_number: T.nilable(String), carrier: T.nilable(String), delivery: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Delivery), passenger_name: T.nilable(String), passengers: T.nilable(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Passenger]), segments: T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight::Segment], ticket_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
agency_number: nil,
carrier: nil,
delivery: nil,
passenger_name: nil,
passengers: nil,
segments: nil,
ticket_number: nil
); end
end
class Lodging < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the lodging reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
# The lodging location's address.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Address)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Address))
}
def address=(_address); end
# The number of adults on the booking
sig { returns(T.nilable(Integer)) }
def adults; end
sig { params(_adults: T.nilable(Integer)).returns(T.nilable(Integer)) }
def adults=(_adults); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the lodging reservation.
sig { returns(T.nilable(String)) }
def booking_number; end
sig { params(_booking_number: T.nilable(String)).returns(T.nilable(String)) }
def booking_number=(_booking_number); end
# The lodging category
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Lodging check-in time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkin_at; end
sig { params(_checkin_at: Integer).returns(Integer) }
def checkin_at=(_checkin_at); end
# Lodging check-out time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkout_at; end
sig { params(_checkout_at: Integer).returns(Integer) }
def checkout_at=(_checkout_at); end
# The customer service phone number of the lodging company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# The daily lodging room rate.
sig { returns(T.nilable(Integer)) }
def daily_room_rate_amount; end
sig { params(_daily_room_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def daily_room_rate_amount=(_daily_room_rate_amount); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Delivery)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Delivery))
}
def delivery=(_delivery); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates whether the lodging location is compliant with the Fire Safety Act.
sig { returns(T.nilable(T::Boolean)) }
def fire_safety_act_compliance; end
sig {
params(_fire_safety_act_compliance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def fire_safety_act_compliance=(_fire_safety_act_compliance); end
# The name of the lodging location.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Indicates if the customer did not keep their booking while failing to cancel the reservation.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# The number of rooms on the booking
sig { returns(T.nilable(Integer)) }
def number_of_rooms; end
sig { params(_number_of_rooms: T.nilable(Integer)).returns(T.nilable(Integer)) }
def number_of_rooms=(_number_of_rooms); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Passenger])).returns(T.nilable(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Passenger]))
}
def passengers=(_passengers); end
# The phone number of the lodging location.
sig { returns(T.nilable(String)) }
def property_phone_number; end
sig { params(_property_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def property_phone_number=(_property_phone_number); end
# The room class for this purchase.
sig { returns(T.nilable(String)) }
def room_class; end
sig { params(_room_class: T.nilable(String)).returns(T.nilable(String)) }
def room_class=(_room_class); end
# The number of room nights
sig { returns(T.nilable(Integer)) }
def room_nights; end
sig { params(_room_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def room_nights=(_room_nights); end
# The total tax amount associating with the room reservation.
sig { returns(T.nilable(Integer)) }
def total_room_tax_amount; end
sig { params(_total_room_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_room_tax_amount=(_total_room_tax_amount); end
# The total tax amount
sig { returns(T.nilable(Integer)) }
def total_tax_amount; end
sig { params(_total_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_tax_amount=(_total_tax_amount); end
sig {
params(address: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Address), adults: T.nilable(Integer), affiliate: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Affiliate), booking_number: T.nilable(String), category: T.nilable(String), checkin_at: Integer, checkout_at: Integer, customer_service_phone_number: T.nilable(String), daily_room_rate_amount: T.nilable(Integer), delivery: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Delivery), extra_charges: T.nilable(T::Array[String]), fire_safety_act_compliance: T.nilable(T::Boolean), name: T.nilable(String), no_show: T.nilable(T::Boolean), number_of_rooms: T.nilable(Integer), passengers: T.nilable(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging::Passenger]), property_phone_number: T.nilable(String), room_class: T.nilable(String), room_nights: T.nilable(Integer), total_room_tax_amount: T.nilable(Integer), total_tax_amount: T.nilable(Integer)).void
}
def initialize(
address: nil,
adults: nil,
affiliate: nil,
booking_number: nil,
category: nil,
checkin_at: nil,
checkout_at: nil,
customer_service_phone_number: nil,
daily_room_rate_amount: nil,
delivery: nil,
extra_charges: nil,
fire_safety_act_compliance: nil,
name: nil,
no_show: nil,
number_of_rooms: nil,
passengers: nil,
property_phone_number: nil,
room_class: nil,
room_nights: nil,
total_room_tax_amount: nil,
total_tax_amount: nil
); end
end
class Subscription < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class BillingInterval < Stripe::RequestParams
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def count; end
sig { params(_count: Integer).returns(Integer) }
def count=(_count); end
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig { params(count: Integer, interval: String).void }
def initialize(count: nil, interval: nil); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Subscription::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate=(_affiliate); end
# Info whether the subscription will be auto renewed upon expiry.
sig { returns(T.nilable(T::Boolean)) }
def auto_renewal; end
sig { params(_auto_renewal: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_renewal=(_auto_renewal); end
# Subscription billing details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval; end
sig {
params(_billing_interval: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Subscription::BillingInterval)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval=(_billing_interval); end
# Subscription end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Name of the product on subscription. e.g. Apple Music Subscription
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Subscription start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Subscription::Affiliate), auto_renewal: T.nilable(T::Boolean), billing_interval: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Subscription::BillingInterval), ends_at: T.nilable(Integer), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
affiliate: nil,
auto_renewal: nil,
billing_interval: nil,
ends_at: nil,
name: nil,
starts_at: nil
); end
end
# Car rental details for this PaymentIntent.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental))
}
def car_rental; end
sig {
params(_car_rental: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental))
}
def car_rental=(_car_rental); end
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
sig { returns(T.nilable(String)) }
def customer_reference; end
sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) }
def customer_reference=(_customer_reference); end
# Event details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails))
}
def event_details; end
sig {
params(_event_details: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails))
}
def event_details=(_event_details); end
# Flight reservation details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight))
}
def flight; end
sig {
params(_flight: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight))
}
def flight=(_flight); end
# Lodging reservation details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging))
}
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging))
}
def lodging=(_lodging); end
# A unique value assigned by the business to identify the transaction.
sig { returns(T.nilable(String)) }
def order_reference; end
sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) }
def order_reference=(_order_reference); end
# Subscription details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Subscription))
}
def subscription; end
sig {
params(_subscription: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Subscription)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Subscription))
}
def subscription=(_subscription); end
sig {
params(car_rental: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::CarRental), customer_reference: T.nilable(String), event_details: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::EventDetails), flight: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Flight), lodging: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Lodging), order_reference: T.nilable(String), subscription: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentDetails::Subscription)).void
}
def initialize(
car_rental: nil,
customer_reference: nil,
event_details: nil,
flight: nil,
lodging: nil,
order_reference: nil,
subscription: nil
); end
end
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Institution number of the customer's bank.
sig { returns(String) }
def institution_number; end
sig { params(_institution_number: String).returns(String) }
def institution_number=(_institution_number); end
# Transit number of the customer's bank.
sig { returns(String) }
def transit_number; end
sig { params(_transit_number: String).returns(String) }
def transit_number=(_transit_number); end
sig {
params(account_number: String, institution_number: String, transit_number: String).void
}
def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(String) }
def bsb_number; end
sig { params(_bsb_number: String).returns(String) }
def bsb_number=(_bsb_number); end
sig { params(account_number: String, bsb_number: String).void }
def initialize(account_number: nil, bsb_number: nil); end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
sig { params(_sort_code: T.nilable(String)).returns(T.nilable(String)) }
def sort_code=(_sort_code); end
sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
def initialize(account_number: nil, sort_code: nil); end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
sig { params(_tax_id: String).returns(String) }
def tax_id=(_tax_id); end
sig { params(tax_id: String).void }
def initialize(tax_id: nil); end
end
class Cashapp < Stripe::RequestParams; end
class Crypto < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The customer's bank.
sig { returns(String) }
def bank; end
sig { params(_bank: String).returns(String) }
def bank=(_bank); end
sig { params(account_holder_type: T.nilable(String), bank: String).void }
def initialize(account_holder_type: nil, bank: nil); end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Klarna::Dob))
}
def dob; end
sig {
params(_dob: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Klarna::Dob)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Klarna::Dob))
}
def dob=(_dob); end
sig {
params(dob: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Klarna::Dob)).void
}
def initialize(dob: nil); end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
sig { returns(T.nilable(String)) }
def funding; end
sig { params(_funding: T.nilable(String)).returns(T.nilable(String)) }
def funding=(_funding); end
sig { params(funding: T.nilable(String)).void }
def initialize(funding: nil); end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
sig { params(_bank_code: String).returns(String) }
def bank_code=(_bank_code); end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
sig { params(_branch_code: String).returns(String) }
def branch_code=(_branch_code); end
# Attribute for param field reference
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# The suffix of the bank account number.
sig { returns(String) }
def suffix; end
sig { params(_suffix: String).returns(String) }
def suffix=(_suffix); end
sig {
params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
); end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Paypay < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Rechnung::Dob)
}
def dob; end
sig {
params(_dob: ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Rechnung::Dob).returns(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Rechnung::Dob)
}
def dob=(_dob); end
sig {
params(dob: ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Rechnung::Dob).void
}
def initialize(dob: nil); end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
sig { returns(String) }
def iban; end
sig { params(_iban: String).returns(String) }
def iban=(_iban); end
sig { params(iban: String).void }
def initialize(iban: nil); end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
sig { params(account: T.nilable(String), source_type: T.nilable(String)).void }
def initialize(account: nil, source_type: nil); end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig {
params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String))
}
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AcssDebit)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Affirm))
}
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Affirm)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Affirm))
}
def affirm=(_affirm); end
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AfterpayClearpay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Alipay))
}
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Alipay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Alipay))
}
def alipay=(_alipay); end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Alma))
}
def alma; end
sig {
params(_alma: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Alma)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Alma))
}
def alma=(_alma); end
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AmazonPay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AuBecsDebit)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::BacsDebit)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Bancontact)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Bancontact))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Billie))
}
def billie; end
sig {
params(_billie: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Billie)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Billie))
}
def billie=(_billie); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::BillingDetails)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Blik))
}
def blik; end
sig {
params(_blik: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Blik)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Blik))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Boleto))
}
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Boleto)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Boleto))
}
def boleto=(_boleto); end
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Cashapp))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Cashapp)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Cashapp))
}
def cashapp=(_cashapp); end
# If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Crypto))
}
def crypto; end
sig {
params(_crypto: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Crypto)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Crypto))
}
def crypto=(_crypto); end
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::CustomerBalance)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Eps))
}
def eps; end
sig {
params(_eps: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Eps)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Eps))
}
def eps=(_eps); end
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Fpx))
}
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Fpx)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Fpx))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Giropay))
}
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Giropay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Giropay))
}
def giropay=(_giropay); end
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Gopay))
}
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Gopay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Gopay))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Grabpay))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Grabpay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Grabpay))
}
def grabpay=(_grabpay); end
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::IdBankTransfer)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Ideal))
}
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Ideal)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Ideal))
}
def ideal=(_ideal); end
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::InteracPresent))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::InteracPresent)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::InteracPresent))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::KakaoPay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Klarna)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Klarna))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Konbini))
}
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Konbini)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Konbini))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::KrCard))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::KrCard)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::KrCard))
}
def kr_card=(_kr_card); end
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Link))
}
def link; end
sig {
params(_link: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Link)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Link))
}
def link=(_link); end
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::MbWay))
}
def mb_way; end
sig {
params(_mb_way: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::MbWay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::MbWay))
}
def mb_way=(_mb_way); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Mobilepay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Mobilepay))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Multibanco)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Multibanco))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::NaverPay))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::NaverPay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::NaverPay))
}
def naver_pay=(_naver_pay); end
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::NzBankAccount)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Oxxo))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Oxxo)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Oxxo))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::P24))
}
def p24; end
sig {
params(_p24: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::P24)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::P24))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::PayByBank)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Payco))
}
def payco; end
sig {
params(_payco: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Payco)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Payco))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Paynow))
}
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Paynow)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Paynow))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Paypal)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Paypal))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Paypay))
}
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Paypay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Paypay))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Payto))
}
def payto; end
sig {
params(_payto: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Payto)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Payto))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Pix))
}
def pix; end
sig {
params(_pix: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Pix)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Pix))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Promptpay))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Promptpay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Promptpay))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Qris))
}
def qris; end
sig {
params(_qris: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Qris)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Qris))
}
def qris=(_qris); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::RadarOptions))
}
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::RadarOptions)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::RadarOptions))
}
def radar_options=(_radar_options); end
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Rechnung))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Rechnung)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Rechnung))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::RevolutPay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::SamsungPay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Satispay))
}
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Satispay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Satispay))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::SepaDebit)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Shopeepay))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Shopeepay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Shopeepay))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Sofort))
}
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Sofort)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Sofort))
}
def sofort=(_sofort); end
# This hash contains details about the Stripe balance payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::StripeBalance)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Swish))
}
def swish; end
sig {
params(_swish: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Swish)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Swish))
}
def swish=(_swish); end
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Twint))
}
def twint; end
sig {
params(_twint: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Twint)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Twint))
}
def twint=(_twint); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::UsBankAccount)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::WechatPay)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Zip))
}
def zip; end
sig {
params(_zip: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Zip)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Cashapp), crypto: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Crypto), customer_balance: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Giropay), gopay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Gopay), grabpay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Grabpay), id_bank_transfer: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::IdBankTransfer), ideal: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Link), mb_way: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::MbWay), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Paypal), paypay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Paypay), payto: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Payto), pix: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Promptpay), qris: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Qris), radar_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::RadarOptions), rechnung: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Rechnung), revolut_pay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::SepaDebit), shopeepay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Shopeepay), sofort: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Sofort), stripe_balance: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::StripeBalance), swish: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
mandate_options: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class Affirm < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Preferred language of the Affirm authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), preferred_locale: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, preferred_locale: nil, setup_future_usage: nil); end
end
class AfterpayClearpay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.
# This field differs from the statement descriptor and item name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), reference: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, reference: nil, setup_future_usage: nil); end
end
class Alipay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Alma < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class AmazonPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class AuBecsDebit < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(setup_future_usage: nil, target_date: nil); end
end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class Billie < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Blik < Stripe::RequestParams
# The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.
sig { returns(T.nilable(String)) }
def code; end
sig { params(_code: T.nilable(String)).returns(T.nilable(String)) }
def code=(_code); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(code: T.nilable(String), setup_future_usage: T.nilable(String)).void }
def initialize(code: nil, setup_future_usage: nil); end
end
class Boleto < Stripe::RequestParams
# The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
class Plan < Stripe::RequestParams
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
sig { returns(T.nilable(Integer)) }
def count; end
sig { params(_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def count=(_count); end
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
# One of `month`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(count: T.nilable(Integer), interval: T.nilable(String), type: String).void
}
def initialize(count: nil, interval: nil, type: nil); end
end
# Setting to true enables installments for this PaymentIntent.
# This will cause the response to contain a list of available installment plans.
# Setting to false will prevent any selected plan from applying to a charge.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# The selected installment plan to use for this payment attempt.
# This parameter can only be provided during confirmation.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan; end
sig {
params(_plan: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::Installments::Plan))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan=(_plan); end
sig {
params(enabled: T.nilable(T::Boolean), plan: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::Installments::Plan))).void
}
def initialize(enabled: nil, plan: nil); end
end
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(String) }
def amount_type; end
sig { params(_amount_type: String).returns(String) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Unique identifier for the mandate or subscription.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
sig { returns(Integer) }
def start_date; end
sig { params(_start_date: Integer).returns(Integer) }
def start_date=(_start_date); end
# Specifies the type of mandates supported. Possible values are `india`.
sig { returns(T.nilable(T::Array[String])) }
def supported_types; end
sig {
params(_supported_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def supported_types=(_supported_types); end
sig {
params(amount: Integer, amount_type: String, description: T.nilable(String), end_date: T.nilable(Integer), interval: String, interval_count: T.nilable(Integer), reference: String, start_date: Integer, supported_types: T.nilable(T::Array[String])).void
}
def initialize(
amount: nil,
amount_type: nil,
description: nil,
end_date: nil,
interval: nil,
interval_count: nil,
reference: nil,
start_date: nil,
supported_types: nil
); end
end
class StatementDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Please pass in an address that is within your Stripe user account country
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::StatementDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::StatementDetails::Address)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::StatementDetails::Address))
}
def address=(_address); end
# Phone number (e.g., a toll-free number that customers can call)
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::StatementDetails::Address), phone: T.nilable(String)).void
}
def initialize(address: nil, phone: nil); end
end
class ThreeDSecure < Stripe::RequestParams
class NetworkOptions < Stripe::RequestParams
class CartesBancaires < Stripe::RequestParams
# The cryptogram calculation algorithm used by the card Issuer's ACS
# to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
# messageExtension: CB-AVALGO
sig { returns(String) }
def cb_avalgo; end
sig { params(_cb_avalgo: String).returns(String) }
def cb_avalgo=(_cb_avalgo); end
# The exemption indicator returned from Cartes Bancaires in the ARes.
# message extension: CB-EXEMPTION; string (4 characters)
# This is a 3 byte bitmap (low significant byte first and most significant
# bit first) that has been Base64 encoded
sig { returns(T.nilable(String)) }
def cb_exemption; end
sig { params(_cb_exemption: T.nilable(String)).returns(T.nilable(String)) }
def cb_exemption=(_cb_exemption); end
# The risk score returned from Cartes Bancaires in the ARes.
# message extension: CB-SCORE; numeric value 0-99
sig { returns(T.nilable(Integer)) }
def cb_score; end
sig { params(_cb_score: T.nilable(Integer)).returns(T.nilable(Integer)) }
def cb_score=(_cb_score); end
sig {
params(cb_avalgo: String, cb_exemption: T.nilable(String), cb_score: T.nilable(Integer)).void
}
def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil); end
end
# Cartes Bancaires-specific 3DS fields.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires; end
sig {
params(_cartes_bancaires: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires=(_cartes_bancaires); end
sig {
params(cartes_bancaires: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).void
}
def initialize(cartes_bancaires: nil); end
end
# The `transStatus` returned from the card Issuer’s ACS in the ARes.
sig { returns(T.nilable(String)) }
def ares_trans_status; end
sig { params(_ares_trans_status: T.nilable(String)).returns(T.nilable(String)) }
def ares_trans_status=(_ares_trans_status); end
# The cryptogram, also known as the "authentication value" (AAV, CAVV or
# AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
# (Most 3D Secure providers will return the base64-encoded version, which
# is what you should specify here.)
sig { returns(String) }
def cryptogram; end
sig { params(_cryptogram: String).returns(String) }
def cryptogram=(_cryptogram); end
# The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
# provider and indicates what degree of authentication was performed.
sig { returns(T.nilable(String)) }
def electronic_commerce_indicator; end
sig {
params(_electronic_commerce_indicator: T.nilable(String)).returns(T.nilable(String))
}
def electronic_commerce_indicator=(_electronic_commerce_indicator); end
# The exemption requested via 3DS and accepted by the issuer at authentication time.
sig { returns(T.nilable(String)) }
def exemption_indicator; end
sig { params(_exemption_indicator: T.nilable(String)).returns(T.nilable(String)) }
def exemption_indicator=(_exemption_indicator); end
# Network specific 3DS fields. Network specific arguments require an
# explicit card brand choice. The parameter `payment_method_options.card.network``
# must be populated accordingly
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options; end
sig {
params(_network_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options=(_network_options); end
# The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
# AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
sig { returns(T.nilable(String)) }
def requestor_challenge_indicator; end
sig {
params(_requestor_challenge_indicator: T.nilable(String)).returns(T.nilable(String))
}
def requestor_challenge_indicator=(_requestor_challenge_indicator); end
# For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
# Transaction ID (dsTransID).
sig { returns(String) }
def transaction_id; end
sig { params(_transaction_id: String).returns(String) }
def transaction_id=(_transaction_id); end
# The version of 3D Secure that was performed.
sig { returns(String) }
def version; end
sig { params(_version: String).returns(String) }
def version=(_version); end
sig {
params(ares_trans_status: T.nilable(String), cryptogram: String, electronic_commerce_indicator: T.nilable(String), exemption_indicator: T.nilable(String), network_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions), requestor_challenge_indicator: T.nilable(String), transaction_id: String, version: String).void
}
def initialize(
ares_trans_status: nil,
cryptogram: nil,
electronic_commerce_indicator: nil,
exemption_indicator: nil,
network_options: nil,
requestor_challenge_indicator: nil,
transaction_id: nil,
version: nil
); end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.
sig { returns(T.nilable(String)) }
def cvc_token; end
sig { params(_cvc_token: T.nilable(String)).returns(T.nilable(String)) }
def cvc_token=(_cvc_token); end
# Installment configuration for payments attempted on this PaymentIntent.
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::Installments))
}
def installments; end
sig {
params(_installments: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::Installments)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::Installments))
}
def installments=(_installments); end
# Configuration options for setting up an eMandate for cards issued in India.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options=(_mandate_options); end
# When specified, this parameter indicates that a transaction will be marked
# as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
# parameter can only be provided during confirmation.
sig { returns(T.nilable(T::Boolean)) }
def moto; end
sig { params(_moto: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def moto=(_moto); end
# Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
# Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_decremental_authorization; end
sig {
params(_request_decremental_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_decremental_authorization=(_request_decremental_authorization); end
# Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_extended_authorization; end
sig {
params(_request_extended_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_extended_authorization=(_request_extended_authorization); end
# Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_incremental_authorization; end
sig {
params(_request_incremental_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_incremental_authorization=(_request_incremental_authorization); end
# Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_multicapture; end
sig { params(_request_multicapture: T.nilable(String)).returns(T.nilable(String)) }
def request_multicapture=(_request_multicapture); end
# Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_overcapture; end
sig { params(_request_overcapture: T.nilable(String)).returns(T.nilable(String)) }
def request_overcapture=(_request_overcapture); end
# Request partial authorization on this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_partial_authorization; end
sig {
params(_request_partial_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_partial_authorization=(_request_partial_authorization); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
# When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).
sig { returns(T.nilable(T::Boolean)) }
def require_cvc_recollection; end
sig {
params(_require_cvc_recollection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def require_cvc_recollection=(_require_cvc_recollection); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kana; end
sig {
params(_statement_descriptor_suffix_kana: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_suffix_kana=(_statement_descriptor_suffix_kana); end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kanji; end
sig {
params(_statement_descriptor_suffix_kanji: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_suffix_kanji=(_statement_descriptor_suffix_kanji); end
# Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::StatementDetails)))
}
def statement_details; end
sig {
params(_statement_details: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::StatementDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::StatementDetails)))
}
def statement_details=(_statement_details); end
# If 3D Secure authentication was performed with a third-party provider,
# the authentication details to use for this payment.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure; end
sig {
params(_three_d_secure: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure=(_three_d_secure); end
sig {
params(capture_method: T.nilable(String), cvc_token: T.nilable(String), installments: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::Installments), mandate_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::MandateOptions), moto: T.nilable(T::Boolean), network: T.nilable(String), request_decremental_authorization: T.nilable(String), request_extended_authorization: T.nilable(String), request_incremental_authorization: T.nilable(String), request_multicapture: T.nilable(String), request_overcapture: T.nilable(String), request_partial_authorization: T.nilable(String), request_three_d_secure: T.nilable(String), require_cvc_recollection: T.nilable(T::Boolean), setup_future_usage: T.nilable(T.any(String, String)), statement_descriptor_suffix_kana: T.nilable(String), statement_descriptor_suffix_kanji: T.nilable(String), statement_details: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::StatementDetails)), three_d_secure: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure)).void
}
def initialize(
capture_method: nil,
cvc_token: nil,
installments: nil,
mandate_options: nil,
moto: nil,
network: nil,
request_decremental_authorization: nil,
request_extended_authorization: nil,
request_incremental_authorization: nil,
request_multicapture: nil,
request_overcapture: nil,
request_partial_authorization: nil,
request_three_d_secure: nil,
require_cvc_recollection: nil,
setup_future_usage: nil,
statement_descriptor_suffix_kana: nil,
statement_descriptor_suffix_kanji: nil,
statement_details: nil,
three_d_secure: nil
); end
end
class CardPresent < Stripe::RequestParams
class Routing < Stripe::RequestParams
# Routing requested priority
sig { returns(T.nilable(String)) }
def requested_priority; end
sig { params(_requested_priority: T.nilable(String)).returns(T.nilable(String)) }
def requested_priority=(_requested_priority); end
sig { params(requested_priority: T.nilable(String)).void }
def initialize(requested_priority: nil); end
end
# Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)
sig { returns(T.nilable(T::Boolean)) }
def request_extended_authorization; end
sig {
params(_request_extended_authorization: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def request_extended_authorization=(_request_extended_authorization); end
# Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
sig { returns(T.nilable(T::Boolean)) }
def request_incremental_authorization_support; end
sig {
params(_request_incremental_authorization_support: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def request_incremental_authorization_support=(
_request_incremental_authorization_support
); end
# Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CardPresent::Routing))
}
def routing; end
sig {
params(_routing: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CardPresent::Routing)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CardPresent::Routing))
}
def routing=(_routing); end
sig {
params(request_extended_authorization: T.nilable(T::Boolean), request_incremental_authorization_support: T.nilable(T::Boolean), routing: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CardPresent::Routing)).void
}
def initialize(
request_extended_authorization: nil,
request_incremental_authorization_support: nil,
routing: nil
); end
end
class Cashapp < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Crypto < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for the eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
sig {
params(_requested_address_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested_address_types=(_requested_address_types); end
# The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
}
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(bank_transfer: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
end
class Eps < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Fpx < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Giropay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Gopay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Grabpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class IdBankTransfer < Stripe::RequestParams
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from 5 minutes from now until 31 days from now. If unset, it defaults to 3 days from now.
sig { returns(T.nilable(Integer)) }
def expires_after; end
sig { params(_expires_after: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after=(_expires_after); end
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now until 30 days from now. If unset, it defaults to 1 days from now.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after: T.nilable(Integer), expires_at: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after: nil, expires_at: nil, setup_future_usage: nil); end
end
class Ideal < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Klarna < Stripe::RequestParams
class OnDemand < Stripe::RequestParams
# Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def average_amount; end
sig { params(_average_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def average_amount=(_average_amount); end
# The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def maximum_amount; end
sig { params(_maximum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_amount=(_maximum_amount); end
# The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Interval at which the customer is making purchases
sig { returns(T.nilable(String)) }
def purchase_interval; end
sig { params(_purchase_interval: T.nilable(String)).returns(T.nilable(String)) }
def purchase_interval=(_purchase_interval); end
# The number of `purchase_interval` between charges
sig { returns(T.nilable(Integer)) }
def purchase_interval_count; end
sig { params(_purchase_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def purchase_interval_count=(_purchase_interval_count); end
sig {
params(average_amount: T.nilable(Integer), maximum_amount: T.nilable(Integer), minimum_amount: T.nilable(Integer), purchase_interval: T.nilable(String), purchase_interval_count: T.nilable(Integer)).void
}
def initialize(
average_amount: nil,
maximum_amount: nil,
minimum_amount: nil,
purchase_interval: nil,
purchase_interval_count: nil
); end
end
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing; end
sig {
params(_next_billing: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling), reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# On-demand details if setting up or charging an on-demand payment.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand; end
sig {
params(_on_demand: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna::OnDemand)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand=(_on_demand); end
# Preferred language of the Klarna authorization page that the customer is redirected to
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Subscription details if setting up or charging a subscription.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(capture_method: T.nilable(String), on_demand: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna::OnDemand), preferred_locale: T.nilable(String), setup_future_usage: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(
capture_method: nil,
on_demand: nil,
preferred_locale: nil,
setup_future_usage: nil,
subscriptions: nil
); end
end
class Konbini < Stripe::RequestParams
# An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number.
sig { returns(T.nilable(String)) }
def confirmation_number; end
sig { params(_confirmation_number: T.nilable(String)).returns(T.nilable(String)) }
def confirmation_number=(_confirmation_number); end
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
sig { returns(T.nilable(T.any(String, Integer))) }
def expires_after_days; end
sig {
params(_expires_after_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expires_after_days=(_expires_after_days); end
# The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.
sig { returns(T.nilable(T.any(String, Integer))) }
def expires_at; end
sig {
params(_expires_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expires_at=(_expires_at); end
# A product descriptor of up to 22 characters, which will appear to customers at the convenience store.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(confirmation_number: T.nilable(String), expires_after_days: T.nilable(T.any(String, Integer)), expires_at: T.nilable(T.any(String, Integer)), product_description: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(
confirmation_number: nil,
expires_after_days: nil,
expires_at: nil,
product_description: nil,
setup_future_usage: nil
); end
end
class KrCard < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Link < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
sig { params(_persistent_token: T.nilable(String)).returns(T.nilable(String)) }
def persistent_token=(_persistent_token); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), persistent_token: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, persistent_token: nil, setup_future_usage: nil); end
end
class MbWay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Mobilepay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Multibanco < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class NaverPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class NzBankAccount < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(setup_future_usage: nil, target_date: nil); end
end
class Oxxo < Stripe::RequestParams
# The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class P24 < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Confirm that the payer has accepted the P24 terms and conditions.
sig { returns(T.nilable(T::Boolean)) }
def tos_shown_and_accepted; end
sig {
params(_tos_shown_and_accepted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def tos_shown_and_accepted=(_tos_shown_and_accepted); end
sig {
params(setup_future_usage: T.nilable(String), tos_shown_and_accepted: T.nilable(T::Boolean)).void
}
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Paynow < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Paypal < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The tax for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The tax behavior for the line item.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(amount: Integer, behavior: String).void }
def initialize(amount: nil, behavior: nil); end
end
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Descriptive name of the line item.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Quantity of the line item. Must be a positive number.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Client facing stock keeping unit, article number or similar.
sig { returns(T.nilable(String)) }
def sku; end
sig { params(_sku: T.nilable(String)).returns(T.nilable(String)) }
def sku=(_sku); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
# The tax information for the line item.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypal::LineItem::Tax)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax=(_tax); end
# Price for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def unit_amount; end
sig { params(_unit_amount: Integer).returns(Integer) }
def unit_amount=(_unit_amount); end
sig {
params(category: T.nilable(String), description: T.nilable(String), name: String, quantity: Integer, sku: T.nilable(String), sold_by: T.nilable(String), tax: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypal::LineItem::Tax), unit_amount: Integer).void
}
def initialize(
category: nil,
description: nil,
name: nil,
quantity: nil,
sku: nil,
sold_by: nil,
tax: nil,
unit_amount: nil
); end
end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# The line items purchased by the customer.
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypal::LineItem])).returns(T.nilable(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items=(_line_items); end
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference_id; end
sig { params(_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def reference_id=(_reference_id); end
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
sig { returns(T.nilable(String)) }
def risk_correlation_id; end
sig { params(_risk_correlation_id: T.nilable(String)).returns(T.nilable(String)) }
def risk_correlation_id=(_risk_correlation_id); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(capture_method: T.nilable(String), line_items: T.nilable(T::Array[::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypal::LineItem]), preferred_locale: T.nilable(String), reference: T.nilable(String), reference_id: T.nilable(String), risk_correlation_id: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String)), subsellers: T.nilable(T::Array[String])).void
}
def initialize(
capture_method: nil,
line_items: nil,
preferred_locale: nil,
reference: nil,
reference_id: nil,
risk_correlation_id: nil,
setup_future_usage: nil,
subsellers: nil
); end
end
class Paypay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
sig { params(_payments_per_period: T.nilable(Integer)).returns(T.nilable(Integer)) }
def payments_per_period=(_payments_per_period); end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
sig { params(_purpose: T.nilable(String)).returns(T.nilable(String)) }
def purpose=(_purpose); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), payments_per_period: T.nilable(Integer), purpose: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil
); end
end
# Additional fields for Mandate creation. Only `purpose` field is configurable for PayTo PaymentIntent with `setup_future_usage=none`. Other fields are only applicable to PayTo PaymentIntent with `setup_future_usage=off_session`
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Payto::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Payto::MandateOptions), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(mandate_options: nil, setup_future_usage: nil); end
end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Type of amount. Defaults to `maximum`.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), amount_type: T.nilable(String), currency: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), reference: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
amount_type: nil,
currency: nil,
end_date: nil,
payment_schedule: nil,
reference: nil,
start_date: nil
); end
end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
sig { returns(T.nilable(Integer)) }
def expires_after_seconds; end
sig { params(_expires_after_seconds: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_seconds=(_expires_after_seconds); end
# The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# Additional fields for mandate creation. Only applicable when `setup_future_usage=off_session`.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(amount_includes_iof: T.nilable(String), expires_after_seconds: T.nilable(Integer), expires_at: T.nilable(Integer), mandate_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Pix::MandateOptions), setup_future_usage: T.nilable(String)).void
}
def initialize(
amount_includes_iof: nil,
expires_after_seconds: nil,
expires_at: nil,
mandate_options: nil,
setup_future_usage: nil
); end
end
class Promptpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Qris < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Rechnung < Stripe::RequestParams; end
class RevolutPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class SamsungPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Satispay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Shopeepay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Sofort < Stripe::RequestParams
# Language shown to the payer on redirect.
sig { returns(T.nilable(T.any(String, String))) }
def preferred_language; end
sig {
params(_preferred_language: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(T.any(String, String)), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class StripeBalance < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Swish < Stripe::RequestParams
# A reference for this payment to be displayed in the Swish app.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(reference: T.nilable(String), setup_future_usage: T.nilable(String)).void }
def initialize(reference: nil, setup_future_usage: nil); end
end
class Twint < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
class ManualEntry < Stripe::RequestParams
# Settings for configuring manual entry of account details.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
sig { params(mode: String).void }
def initialize(mode: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# Customize manual entry behavior
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry; end
sig {
params(_manual_entry: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry=(_manual_entry); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(filters: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), manual_entry: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
}
def initialize(
filters: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
); end
end
class MandateOptions < Stripe::RequestParams
# The method used to collect offline mandate customer acceptance.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
sig { params(collection_method: T.nilable(String)).void }
def initialize(collection_method: nil); end
end
class Networks < Stripe::RequestParams
# Triggers validations to run across the selected networks
sig { returns(T.nilable(T::Array[String])) }
def requested; end
sig {
params(_requested: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested=(_requested); end
sig { params(requested: T.nilable(T::Array[String])).void }
def initialize(requested: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Additional fields for network related functions
sig {
returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks; end
sig {
params(_networks: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks=(_networks); end
# Preferred transaction settlement speed
sig { returns(T.nilable(T.any(String, String))) }
def preferred_settlement_speed; end
sig {
params(_preferred_settlement_speed: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred_settlement_speed=(_preferred_settlement_speed); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks), preferred_settlement_speed: T.nilable(T.any(String, String)), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
financial_connections: nil,
mandate_options: nil,
networks: nil,
preferred_settlement_speed: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class WechatPay < Stripe::RequestParams
# The app ID registered with WeChat Pay. Only required when client is ios or android.
sig { returns(T.nilable(String)) }
def app_id; end
sig { params(_app_id: T.nilable(String)).returns(T.nilable(String)) }
def app_id=(_app_id); end
# The client type that the end customer will pay from
sig { returns(T.nilable(String)) }
def client; end
sig { params(_client: T.nilable(String)).returns(T.nilable(String)) }
def client=(_client); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(app_id: T.nilable(String), client: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
end
class Zip < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
# If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AcssDebit)))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AcssDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AcssDebit)))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Affirm)))
}
def affirm; end
sig {
params(_affirm: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Affirm))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Affirm)))
}
def affirm=(_affirm); end
# If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AfterpayClearpay)))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AfterpayClearpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AfterpayClearpay)))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Alipay)))
}
def alipay; end
sig {
params(_alipay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Alipay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Alipay)))
}
def alipay=(_alipay); end
# If this is a `alma` PaymentMethod, this sub-hash contains details about the Alma payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Alma)))
}
def alma; end
sig {
params(_alma: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Alma))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Alma)))
}
def alma=(_alma); end
# If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AmazonPay)))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AmazonPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AmazonPay)))
}
def amazon_pay=(_amazon_pay); end
# If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AuBecsDebit)))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AuBecsDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AuBecsDebit)))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::BacsDebit)))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::BacsDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::BacsDebit)))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Bancontact)))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Bancontact))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Bancontact)))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this sub-hash contains details about the Billie payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Billie)))
}
def billie; end
sig {
params(_billie: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Billie))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Billie)))
}
def billie=(_billie); end
# If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Blik)))
}
def blik; end
sig {
params(_blik: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Blik))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Blik)))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Boleto)))
}
def boleto; end
sig {
params(_boleto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Boleto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Boleto)))
}
def boleto=(_boleto); end
# Configuration for any card payments attempted on this PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card)))
}
def card; end
sig {
params(_card: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card)))
}
def card=(_card); end
# If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CardPresent)))
}
def card_present; end
sig {
params(_card_present: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CardPresent))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CardPresent)))
}
def card_present=(_card_present); end
# If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Cashapp)))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Cashapp))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Cashapp)))
}
def cashapp=(_cashapp); end
# If this is a `crypto` PaymentMethod, this sub-hash contains details about the Crypto payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Crypto)))
}
def crypto; end
sig {
params(_crypto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Crypto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Crypto)))
}
def crypto=(_crypto); end
# If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CustomerBalance))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance=(_customer_balance); end
# If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Eps)))
}
def eps; end
sig {
params(_eps: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Eps))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Eps)))
}
def eps=(_eps); end
# If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Fpx)))
}
def fpx; end
sig {
params(_fpx: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Fpx))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Fpx)))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Giropay)))
}
def giropay; end
sig {
params(_giropay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Giropay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Giropay)))
}
def giropay=(_giropay); end
# If this is a `gopay` PaymentMethod, this sub-hash contains details about the Gopay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Gopay)))
}
def gopay; end
sig {
params(_gopay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Gopay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Gopay)))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Grabpay)))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Grabpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Grabpay)))
}
def grabpay=(_grabpay); end
# If this is a `id_bank_transfer` PaymentMethod, this sub-hash contains details about the Indonesia Bank Transfer payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::IdBankTransfer))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Ideal)))
}
def ideal; end
sig {
params(_ideal: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Ideal))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Ideal)))
}
def ideal=(_ideal); end
# If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::InteracPresent)))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::InteracPresent))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::InteracPresent)))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::KakaoPay)))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::KakaoPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::KakaoPay)))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna)))
}
def klarna; end
sig {
params(_klarna: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna)))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Konbini)))
}
def konbini; end
sig {
params(_konbini: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Konbini))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Konbini)))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this sub-hash contains details about the KR Card payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::KrCard)))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::KrCard))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::KrCard)))
}
def kr_card=(_kr_card); end
# If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Link)))
}
def link; end
sig {
params(_link: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Link))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Link)))
}
def link=(_link); end
# If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::MbWay)))
}
def mb_way; end
sig {
params(_mb_way: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::MbWay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::MbWay)))
}
def mb_way=(_mb_way); end
# If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Mobilepay)))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Mobilepay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Mobilepay)))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Multibanco)))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Multibanco))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Multibanco)))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this sub-hash contains details about the Naver Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::NaverPay)))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::NaverPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::NaverPay)))
}
def naver_pay=(_naver_pay); end
# If this is a `nz_bank_account` PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::NzBankAccount)))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::NzBankAccount))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::NzBankAccount)))
}
def nz_bank_account=(_nz_bank_account); end
# If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Oxxo)))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Oxxo))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Oxxo)))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::P24)))
}
def p24; end
sig {
params(_p24: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::P24))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::P24)))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this sub-hash contains details about the PayByBank payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::PayByBank)))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::PayByBank))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::PayByBank)))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this sub-hash contains details about the PAYCO payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Payco)))
}
def payco; end
sig {
params(_payco: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Payco))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Payco)))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paynow)))
}
def paynow; end
sig {
params(_paynow: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paynow))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paynow)))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypal)))
}
def paypal; end
sig {
params(_paypal: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypal))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypal)))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this sub-hash contains details about the PayPay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypay)))
}
def paypay; end
sig {
params(_paypay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypay)))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Payto)))
}
def payto; end
sig {
params(_payto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Payto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Payto)))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Pix)))
}
def pix; end
sig {
params(_pix: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Pix))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Pix)))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Promptpay)))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Promptpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Promptpay)))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this sub-hash contains details about the QRIS payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Qris)))
}
def qris; end
sig {
params(_qris: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Qris))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Qris)))
}
def qris=(_qris); end
# If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Rechnung)))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Rechnung))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Rechnung)))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::RevolutPay)))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::RevolutPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::RevolutPay)))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SamsungPay)))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SamsungPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SamsungPay)))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Satispay)))
}
def satispay; end
sig {
params(_satispay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Satispay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Satispay)))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SepaDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit=(_sepa_debit); end
# If this is a `shopeepay` PaymentMethod, this sub-hash contains details about the ShopeePay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Shopeepay)))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Shopeepay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Shopeepay)))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Sofort)))
}
def sofort; end
sig {
params(_sofort: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Sofort))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Sofort)))
}
def sofort=(_sofort); end
# If this is a `stripe_balance` PaymentMethod, this sub-hash contains details about the Stripe Balance payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::StripeBalance)))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::StripeBalance))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::StripeBalance)))
}
def stripe_balance=(_stripe_balance); end
# If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Swish)))
}
def swish; end
sig {
params(_swish: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Swish))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Swish)))
}
def swish=(_swish); end
# If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Twint)))
}
def twint; end
sig {
params(_twint: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Twint))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Twint)))
}
def twint=(_twint); end
# If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
# If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::WechatPay)))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::WechatPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::WechatPay)))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Zip)))
}
def zip; end
sig {
params(_zip: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Zip))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Zip)))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AcssDebit)), affirm: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Affirm)), afterpay_clearpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AfterpayClearpay)), alipay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Alipay)), alma: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Alma)), amazon_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AmazonPay)), au_becs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AuBecsDebit)), bacs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::BacsDebit)), bancontact: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Bancontact)), billie: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Billie)), blik: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Blik)), boleto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Boleto)), card: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card)), card_present: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CardPresent)), cashapp: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Cashapp)), crypto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Crypto)), customer_balance: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CustomerBalance)), eps: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Eps)), fpx: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Fpx)), giropay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Giropay)), gopay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Gopay)), grabpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Grabpay)), id_bank_transfer: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::IdBankTransfer)), ideal: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Ideal)), interac_present: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::InteracPresent)), kakao_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::KakaoPay)), klarna: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna)), konbini: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Konbini)), kr_card: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::KrCard)), link: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Link)), mb_way: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::MbWay)), mobilepay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Mobilepay)), multibanco: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Multibanco)), naver_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::NaverPay)), nz_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::NzBankAccount)), oxxo: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Oxxo)), p24: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::P24)), pay_by_bank: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::PayByBank)), payco: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Payco)), paynow: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paynow)), paypal: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypal)), paypay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypay)), payto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Payto)), pix: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Pix)), promptpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Promptpay)), qris: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Qris)), rechnung: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Rechnung)), revolut_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::RevolutPay)), samsung_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SamsungPay)), satispay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Satispay)), sepa_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SepaDebit)), shopeepay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Shopeepay)), sofort: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Sofort)), stripe_balance: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::StripeBalance)), swish: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Swish)), twint: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Twint)), us_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount)), wechat_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::WechatPay)), zip: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Zip))).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
blik: nil,
boleto: nil,
card: nil,
card_present: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address.
sig { returns(::Stripe::PaymentIntentService::UpdateParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::PaymentIntentService::UpdateParams::Shipping::Address).returns(::Stripe::PaymentIntentService::UpdateParams::Shipping::Address)
}
def address=(_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
sig { params(_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def tracking_number=(_tracking_number); end
sig {
params(address: ::Stripe::PaymentIntentService::UpdateParams::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
}
def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
sig { params(amount: T.nilable(Integer)).void }
def initialize(amount: nil); end
end
# Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Provides industry-specific information about the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::AmountDetails)))
}
def amount_details; end
sig {
params(_amount_details: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::AmountDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::AmountDetails)))
}
def amount_details=(_amount_details); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(T.any(String, Integer))) }
def application_fee_amount; end
sig {
params(_application_fee_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def application_fee_amount=(_application_fee_amount); end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# ID of the Customer this PaymentIntent belongs to, if one exists.
#
# Payment methods attached to other Customers cannot be used with this PaymentIntent.
#
# If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# ID of the Account this PaymentIntent belongs to, if one exists.
#
# Payment methods attached to other Accounts cannot be used with this PaymentIntent.
#
# If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The list of payment method types to exclude from use with this payment.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def excluded_payment_method_types; end
sig {
params(_excluded_payment_method_types: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def excluded_payment_method_types=(_excluded_payment_method_types); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.
sig { returns(T.nilable(String)) }
def fx_quote; end
sig { params(_fx_quote: T.nilable(String)).returns(T.nilable(String)) }
def fx_quote=(_fx_quote); end
# Automations to be run during the PaymentIntent lifecycle
sig { returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::Hooks)) }
def hooks; end
sig {
params(_hooks: T.nilable(::Stripe::PaymentIntentService::UpdateParams::Hooks)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::Hooks))
}
def hooks=(_hooks); end
# This hash contains details about the Mandate to create.
sig { returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::MandateData)) }
def mandate_data; end
sig {
params(_mandate_data: T.nilable(::Stripe::PaymentIntentService::UpdateParams::MandateData)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::MandateData))
}
def mandate_data=(_mandate_data); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Provides industry-specific information about the charge.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentDetails)))
}
def payment_details; end
sig {
params(_payment_details: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentDetails)))
}
def payment_details=(_payment_details); end
# Attribute for param field payment_method
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent.
sig { returns(T.nilable(String)) }
def payment_method_configuration; end
sig { params(_payment_method_configuration: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_configuration=(_payment_method_configuration); end
# If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
# in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)
# property on the PaymentIntent.
sig { returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData)) }
def payment_method_data; end
sig {
params(_payment_method_data: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData))
}
def payment_method_data=(_payment_method_data); end
# Payment-method-specific configuration for this PaymentIntent.
sig { returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions)) }
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
# Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
sig { returns(T.nilable(String)) }
def receipt_email; end
sig { params(_receipt_email: T.nilable(String)).returns(T.nilable(String)) }
def receipt_email=(_receipt_email); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Shipping information for this PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::Shipping)))
}
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::Shipping))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::Shipping)))
}
def shipping=(_shipping); end
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::PaymentIntentService::UpdateParams::TransferData)).returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::TransferData))
}
def transfer_data=(_transfer_data); end
# A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(amount: T.nilable(Integer), amount_details: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::AmountDetails)), application_fee_amount: T.nilable(T.any(String, Integer)), capture_method: T.nilable(String), currency: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), description: T.nilable(String), excluded_payment_method_types: T.nilable(T.any(String, T::Array[String])), expand: T.nilable(T::Array[String]), fx_quote: T.nilable(String), hooks: T.nilable(::Stripe::PaymentIntentService::UpdateParams::Hooks), mandate_data: T.nilable(::Stripe::PaymentIntentService::UpdateParams::MandateData), metadata: T.nilable(T.any(String, T::Hash[String, String])), payment_details: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentDetails)), payment_method: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), receipt_email: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String)), shipping: T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::Shipping)), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::PaymentIntentService::UpdateParams::TransferData), transfer_group: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_details: nil,
application_fee_amount: nil,
capture_method: nil,
currency: nil,
customer: nil,
customer_account: nil,
description: nil,
excluded_payment_method_types: nil,
expand: nil,
fx_quote: nil,
hooks: nil,
mandate_data: nil,
metadata: nil,
payment_details: nil,
payment_method: nil,
payment_method_configuration: nil,
payment_method_data: nil,
payment_method_options: nil,
payment_method_types: nil,
receipt_email: nil,
setup_future_usage: nil,
shipping: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil,
transfer_group: nil
); end
end
class SearchParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
sig { returns(T.nilable(String)) }
def page; end
sig { params(_page: T.nilable(String)).returns(T.nilable(String)) }
def page=(_page); end
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for payment intents](https://stripe.com/docs/search#query-fields-for-payment-intents).
sig { returns(String) }
def query; end
sig { params(_query: String).returns(String) }
def query=(_query); end
sig {
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
}
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
end
class ApplyCustomerBalanceParams < Stripe::RequestParams
# Amount that you intend to apply to this PaymentIntent from the customer’s cash balance. If the PaymentIntent was created by an Invoice, the full amount of the PaymentIntent is applied regardless of this parameter.
#
# A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent.
#
# When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(amount: T.nilable(Integer), currency: T.nilable(String), expand: T.nilable(T::Array[String])).void
}
def initialize(amount: nil, currency: nil, expand: nil); end
end
class CancelParams < Stripe::RequestParams
# Reason for canceling this PaymentIntent. Possible values are: `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`
sig { returns(T.nilable(String)) }
def cancellation_reason; end
sig { params(_cancellation_reason: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_reason=(_cancellation_reason); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(cancellation_reason: T.nilable(String), expand: T.nilable(T::Array[String])).void
}
def initialize(cancellation_reason: nil, expand: nil); end
end
class CaptureParams < Stripe::RequestParams
class AmountDetails < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class Card < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class CardPresent < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class Klarna < Stripe::RequestParams
# URL to an image for the product. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def image_url; end
sig { params(_image_url: T.nilable(String)).returns(T.nilable(String)) }
def image_url=(_image_url); end
# URL to the product page. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def product_url; end
sig { params(_product_url: T.nilable(String)).returns(T.nilable(String)) }
def product_url=(_product_url); end
# Reference for the subscription this line item is for.
sig { returns(T.nilable(String)) }
def subscription_reference; end
sig { params(_subscription_reference: T.nilable(String)).returns(T.nilable(String)) }
def subscription_reference=(_subscription_reference); end
sig {
params(image_url: T.nilable(String), product_url: T.nilable(String), subscription_reference: T.nilable(String)).void
}
def initialize(image_url: nil, product_url: nil, subscription_reference: nil); end
end
class Paypal < Stripe::RequestParams
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
sig {
params(category: T.nilable(String), description: T.nilable(String), sold_by: T.nilable(String)).void
}
def initialize(category: nil, description: nil, sold_by: nil); end
end
# This sub-hash contains line item details that are specific to `card` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card=(_card); end
# This sub-hash contains line item details that are specific to `card_present` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present=(_card_present); end
# This sub-hash contains line item details that are specific to `klarna` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# This sub-hash contains line item details that are specific to `paypal` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
sig {
params(card: T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent), klarna: T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna), paypal: T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).void
}
def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end
end
class Tax < Stripe::RequestParams
# The total tax on an item. Non-negative integer.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The amount an item was discounted for. Positive integer.
sig { returns(T.nilable(Integer)) }
def discount_amount; end
sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def discount_amount=(_discount_amount); end
# Payment method-specific information for line items.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# Unique identifier of the product. At most 12 characters long.
sig { returns(T.nilable(String)) }
def product_code; end
sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) }
def product_code=(_product_code); end
# Name of the product. At most 100 characters long.
sig { returns(String) }
def product_name; end
sig { params(_product_name: String).returns(String) }
def product_name=(_product_name); end
# Number of items of the product. Positive integer.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Contains information about the tax on the item.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::Tax)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::Tax))
}
def tax=(_tax); end
# Cost of the product. Non-negative integer.
sig { returns(Integer) }
def unit_cost; end
sig { params(_unit_cost: Integer).returns(Integer) }
def unit_cost=(_unit_cost); end
# A unit of measure for the line item, such as gallons, feet, meters, etc.
sig { returns(T.nilable(String)) }
def unit_of_measure; end
sig { params(_unit_of_measure: T.nilable(String)).returns(T.nilable(String)) }
def unit_of_measure=(_unit_of_measure); end
sig {
params(discount_amount: T.nilable(Integer), payment_method_options: T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::PaymentMethodOptions), product_code: T.nilable(String), product_name: String, quantity: Integer, tax: T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem::Tax), unit_cost: Integer, unit_of_measure: T.nilable(String)).void
}
def initialize(
discount_amount: nil,
payment_method_options: nil,
product_code: nil,
product_name: nil,
quantity: nil,
tax: nil,
unit_cost: nil,
unit_of_measure: nil
); end
end
class Shipping < Stripe::RequestParams
# Portion of the amount that is for shipping.
sig { returns(T.nilable(T.any(String, Integer))) }
def amount; end
sig {
params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def amount=(_amount); end
# The postal code that represents the shipping source.
sig { returns(T.nilable(String)) }
def from_postal_code; end
sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def from_postal_code=(_from_postal_code); end
# The postal code that represents the shipping destination.
sig { returns(T.nilable(String)) }
def to_postal_code; end
sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def to_postal_code=(_to_postal_code); end
sig {
params(amount: T.nilable(T.any(String, Integer)), from_postal_code: T.nilable(String), to_postal_code: T.nilable(String)).void
}
def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end
end
class Tax < Stripe::RequestParams
# Total portion of the amount that is for tax.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The total discount applied on the transaction.
sig { returns(T.nilable(T.any(String, Integer))) }
def discount_amount; end
sig {
params(_discount_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def discount_amount=(_discount_amount); end
# A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem])))
}
def line_items; end
sig {
params(_line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem])))
}
def line_items=(_line_items); end
# Contains information about the shipping portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CaptureParams::AmountDetails::Shipping)))
}
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CaptureParams::AmountDetails::Shipping))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CaptureParams::AmountDetails::Shipping)))
}
def shipping=(_shipping); end
# Contains information about the tax portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CaptureParams::AmountDetails::Tax)))
}
def tax; end
sig {
params(_tax: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CaptureParams::AmountDetails::Tax))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CaptureParams::AmountDetails::Tax)))
}
def tax=(_tax); end
sig {
params(discount_amount: T.nilable(T.any(String, Integer)), line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::CaptureParams::AmountDetails::LineItem])), shipping: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CaptureParams::AmountDetails::Shipping)), tax: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CaptureParams::AmountDetails::Tax))).void
}
def initialize(discount_amount: nil, line_items: nil, shipping: nil, tax: nil); end
end
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
sig { returns(String) }
def calculation; end
sig { params(_calculation: String).returns(String) }
def calculation=(_calculation); end
sig { params(calculation: String).void }
def initialize(calculation: nil); end
end
# Tax arguments for automations
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::Hooks::Inputs::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntentService::CaptureParams::Hooks::Inputs::Tax)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::Hooks::Inputs::Tax))
}
def tax=(_tax); end
sig {
params(tax: T.nilable(::Stripe::PaymentIntentService::CaptureParams::Hooks::Inputs::Tax)).void
}
def initialize(tax: nil); end
end
# Arguments passed in automations
sig { returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::Hooks::Inputs)) }
def inputs; end
sig {
params(_inputs: T.nilable(::Stripe::PaymentIntentService::CaptureParams::Hooks::Inputs)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::Hooks::Inputs))
}
def inputs=(_inputs); end
sig {
params(inputs: T.nilable(::Stripe::PaymentIntentService::CaptureParams::Hooks::Inputs)).void
}
def initialize(inputs: nil); end
end
class PaymentDetails < Stripe::RequestParams
class CarRental < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Distance < Stripe::RequestParams
# Distance traveled.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
sig { params(amount: T.nilable(Integer), unit: T.nilable(String)).void }
def initialize(amount: nil, unit: nil); end
end
class Driver < Stripe::RequestParams
# Driver's identification number.
sig { returns(T.nilable(String)) }
def driver_identification_number; end
sig {
params(_driver_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def driver_identification_number=(_driver_identification_number); end
# Driver's tax number.
sig { returns(T.nilable(String)) }
def driver_tax_number; end
sig { params(_driver_tax_number: T.nilable(String)).returns(T.nilable(String)) }
def driver_tax_number=(_driver_tax_number); end
# Full name of the person or entity on the car reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(driver_identification_number: T.nilable(String), driver_tax_number: T.nilable(String), name: String).void
}
def initialize(
driver_identification_number: nil,
driver_tax_number: nil,
name: nil
); end
end
class PickupAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class ReturnAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the car rental.
sig { returns(String) }
def booking_number; end
sig { params(_booking_number: String).returns(String) }
def booking_number=(_booking_number); end
# Class code of the car.
sig { returns(T.nilable(String)) }
def car_class_code; end
sig { params(_car_class_code: T.nilable(String)).returns(T.nilable(String)) }
def car_class_code=(_car_class_code); end
# Make of the car.
sig { returns(T.nilable(String)) }
def car_make; end
sig { params(_car_make: T.nilable(String)).returns(T.nilable(String)) }
def car_make=(_car_make); end
# Model of the car.
sig { returns(T.nilable(String)) }
def car_model; end
sig { params(_car_model: T.nilable(String)).returns(T.nilable(String)) }
def car_model=(_car_model); end
# The name of the rental car company.
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# The customer service phone number of the car rental company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# Number of days the car is being rented.
sig { returns(Integer) }
def days_rented; end
sig { params(_days_rented: Integer).returns(Integer) }
def days_rented=(_days_rented); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Delivery)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Delivery))
}
def delivery=(_delivery); end
# The details of the distance traveled during the rental period.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Distance))
}
def distance; end
sig {
params(_distance: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Distance)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Distance))
}
def distance=(_distance); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Driver]))
}
def drivers; end
sig {
params(_drivers: T.nilable(T::Array[::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Driver])).returns(T.nilable(T::Array[::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Driver]))
}
def drivers=(_drivers); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates if the customer did not keep nor cancel their booking.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# Car pick-up address.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address; end
sig {
params(_pickup_address: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::PickupAddress)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address=(_pickup_address); end
# Car pick-up time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def pickup_at; end
sig { params(_pickup_at: Integer).returns(Integer) }
def pickup_at=(_pickup_at); end
# Name of the pickup location.
sig { returns(T.nilable(String)) }
def pickup_location_name; end
sig { params(_pickup_location_name: T.nilable(String)).returns(T.nilable(String)) }
def pickup_location_name=(_pickup_location_name); end
# Rental rate.
sig { returns(T.nilable(Integer)) }
def rate_amount; end
sig { params(_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def rate_amount=(_rate_amount); end
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
sig { returns(T.nilable(String)) }
def rate_interval; end
sig { params(_rate_interval: T.nilable(String)).returns(T.nilable(String)) }
def rate_interval=(_rate_interval); end
# The name of the person or entity renting the car.
sig { returns(T.nilable(String)) }
def renter_name; end
sig { params(_renter_name: T.nilable(String)).returns(T.nilable(String)) }
def renter_name=(_renter_name); end
# Car return address.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address; end
sig {
params(_return_address: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::ReturnAddress)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address=(_return_address); end
# Car return time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def return_at; end
sig { params(_return_at: Integer).returns(Integer) }
def return_at=(_return_at); end
# Name of the return location.
sig { returns(T.nilable(String)) }
def return_location_name; end
sig { params(_return_location_name: T.nilable(String)).returns(T.nilable(String)) }
def return_location_name=(_return_location_name); end
# Indicates whether the goods or services are tax-exempt or tax is not collected.
sig { returns(T.nilable(T::Boolean)) }
def tax_exempt; end
sig { params(_tax_exempt: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def tax_exempt=(_tax_exempt); end
# The vehicle identification number.
sig { returns(T.nilable(String)) }
def vehicle_identification_number; end
sig {
params(_vehicle_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def vehicle_identification_number=(_vehicle_identification_number); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Affiliate), booking_number: String, car_class_code: T.nilable(String), car_make: T.nilable(String), car_model: T.nilable(String), company: T.nilable(String), customer_service_phone_number: T.nilable(String), days_rented: Integer, delivery: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Delivery), distance: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Distance), drivers: T.nilable(T::Array[::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::Driver]), extra_charges: T.nilable(T::Array[String]), no_show: T.nilable(T::Boolean), pickup_address: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::PickupAddress), pickup_at: Integer, pickup_location_name: T.nilable(String), rate_amount: T.nilable(Integer), rate_interval: T.nilable(String), renter_name: T.nilable(String), return_address: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental::ReturnAddress), return_at: Integer, return_location_name: T.nilable(String), tax_exempt: T.nilable(T::Boolean), vehicle_identification_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
booking_number: nil,
car_class_code: nil,
car_make: nil,
car_model: nil,
company: nil,
customer_service_phone_number: nil,
days_rented: nil,
delivery: nil,
distance: nil,
drivers: nil,
extra_charges: nil,
no_show: nil,
pickup_address: nil,
pickup_at: nil,
pickup_location_name: nil,
rate_amount: nil,
rate_interval: nil,
renter_name: nil,
return_address: nil,
return_at: nil,
return_location_name: nil,
tax_exempt: nil,
vehicle_identification_number: nil
); end
end
class EventDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
# Indicates if the tickets are digitally checked when entering the venue.
sig { returns(T.nilable(T::Boolean)) }
def access_controlled_venue; end
sig {
params(_access_controlled_venue: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def access_controlled_venue=(_access_controlled_venue); end
# The event location's address.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails::Address)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails::Address))
}
def address=(_address); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate=(_affiliate); end
# The name of the company
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails::Delivery)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails::Delivery))
}
def delivery=(_delivery); end
# Event end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Type of the event entertainment (concert, sports event etc)
sig { returns(T.nilable(String)) }
def genre; end
sig { params(_genre: T.nilable(String)).returns(T.nilable(String)) }
def genre=(_genre); end
# The name of the event.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Event start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(access_controlled_venue: T.nilable(T::Boolean), address: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails::Address), affiliate: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails::Affiliate), company: T.nilable(String), delivery: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails::Delivery), ends_at: T.nilable(Integer), genre: T.nilable(String), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
access_controlled_venue: nil,
address: nil,
affiliate: nil,
company: nil,
delivery: nil,
ends_at: nil,
genre: nil,
name: nil,
starts_at: nil
); end
end
class Flight < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the flight reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Segment < Stripe::RequestParams
# The flight segment amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The International Air Transport Association (IATA) airport code for the arrival airport.
sig { returns(T.nilable(String)) }
def arrival_airport; end
sig { params(_arrival_airport: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport=(_arrival_airport); end
# The arrival time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def arrives_at; end
sig { params(_arrives_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def arrives_at=(_arrives_at); end
# The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The departure time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def departs_at; end
sig { params(_departs_at: Integer).returns(Integer) }
def departs_at=(_departs_at); end
# The International Air Transport Association (IATA) airport code for the departure airport.
sig { returns(T.nilable(String)) }
def departure_airport; end
sig { params(_departure_airport: T.nilable(String)).returns(T.nilable(String)) }
def departure_airport=(_departure_airport); end
# The flight number associated with the segment
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The fare class for the segment.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
sig {
params(amount: T.nilable(Integer), arrival_airport: T.nilable(String), arrives_at: T.nilable(Integer), carrier: T.nilable(String), departs_at: Integer, departure_airport: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String)).void
}
def initialize(
amount: nil,
arrival_airport: nil,
arrives_at: nil,
carrier: nil,
departs_at: nil,
departure_airport: nil,
flight_number: nil,
service_class: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Affiliate))
}
def affiliate=(_affiliate); end
# The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
sig { returns(T.nilable(String)) }
def agency_number; end
sig { params(_agency_number: T.nilable(String)).returns(T.nilable(String)) }
def agency_number=(_agency_number); end
# The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Delivery)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Delivery))
}
def delivery=(_delivery); end
# The name of the person or entity on the reservation.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# The details of the passengers in the travel reservation.
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Passenger])).returns(T.nilable(T::Array[::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Passenger]))
}
def passengers=(_passengers); end
# The individual flight segments associated with the trip.
sig {
returns(T::Array[::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Segment])
}
def segments; end
sig {
params(_segments: T::Array[::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Segment]).returns(T::Array[::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Segment])
}
def segments=(_segments); end
# The ticket number associated with the travel reservation.
sig { returns(T.nilable(String)) }
def ticket_number; end
sig { params(_ticket_number: T.nilable(String)).returns(T.nilable(String)) }
def ticket_number=(_ticket_number); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Affiliate), agency_number: T.nilable(String), carrier: T.nilable(String), delivery: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Delivery), passenger_name: T.nilable(String), passengers: T.nilable(T::Array[::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Passenger]), segments: T::Array[::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight::Segment], ticket_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
agency_number: nil,
carrier: nil,
delivery: nil,
passenger_name: nil,
passengers: nil,
segments: nil,
ticket_number: nil
); end
end
class Lodging < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the lodging reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
# The lodging location's address.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Address)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Address))
}
def address=(_address); end
# The number of adults on the booking
sig { returns(T.nilable(Integer)) }
def adults; end
sig { params(_adults: T.nilable(Integer)).returns(T.nilable(Integer)) }
def adults=(_adults); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the lodging reservation.
sig { returns(T.nilable(String)) }
def booking_number; end
sig { params(_booking_number: T.nilable(String)).returns(T.nilable(String)) }
def booking_number=(_booking_number); end
# The lodging category
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Lodging check-in time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkin_at; end
sig { params(_checkin_at: Integer).returns(Integer) }
def checkin_at=(_checkin_at); end
# Lodging check-out time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkout_at; end
sig { params(_checkout_at: Integer).returns(Integer) }
def checkout_at=(_checkout_at); end
# The customer service phone number of the lodging company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# The daily lodging room rate.
sig { returns(T.nilable(Integer)) }
def daily_room_rate_amount; end
sig { params(_daily_room_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def daily_room_rate_amount=(_daily_room_rate_amount); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Delivery)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Delivery))
}
def delivery=(_delivery); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates whether the lodging location is compliant with the Fire Safety Act.
sig { returns(T.nilable(T::Boolean)) }
def fire_safety_act_compliance; end
sig {
params(_fire_safety_act_compliance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def fire_safety_act_compliance=(_fire_safety_act_compliance); end
# The name of the lodging location.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Indicates if the customer did not keep their booking while failing to cancel the reservation.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# The number of rooms on the booking
sig { returns(T.nilable(Integer)) }
def number_of_rooms; end
sig { params(_number_of_rooms: T.nilable(Integer)).returns(T.nilable(Integer)) }
def number_of_rooms=(_number_of_rooms); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Passenger])).returns(T.nilable(T::Array[::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Passenger]))
}
def passengers=(_passengers); end
# The phone number of the lodging location.
sig { returns(T.nilable(String)) }
def property_phone_number; end
sig { params(_property_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def property_phone_number=(_property_phone_number); end
# The room class for this purchase.
sig { returns(T.nilable(String)) }
def room_class; end
sig { params(_room_class: T.nilable(String)).returns(T.nilable(String)) }
def room_class=(_room_class); end
# The number of room nights
sig { returns(T.nilable(Integer)) }
def room_nights; end
sig { params(_room_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def room_nights=(_room_nights); end
# The total tax amount associating with the room reservation.
sig { returns(T.nilable(Integer)) }
def total_room_tax_amount; end
sig { params(_total_room_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_room_tax_amount=(_total_room_tax_amount); end
# The total tax amount
sig { returns(T.nilable(Integer)) }
def total_tax_amount; end
sig { params(_total_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_tax_amount=(_total_tax_amount); end
sig {
params(address: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Address), adults: T.nilable(Integer), affiliate: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Affiliate), booking_number: T.nilable(String), category: T.nilable(String), checkin_at: Integer, checkout_at: Integer, customer_service_phone_number: T.nilable(String), daily_room_rate_amount: T.nilable(Integer), delivery: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Delivery), extra_charges: T.nilable(T::Array[String]), fire_safety_act_compliance: T.nilable(T::Boolean), name: T.nilable(String), no_show: T.nilable(T::Boolean), number_of_rooms: T.nilable(Integer), passengers: T.nilable(T::Array[::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging::Passenger]), property_phone_number: T.nilable(String), room_class: T.nilable(String), room_nights: T.nilable(Integer), total_room_tax_amount: T.nilable(Integer), total_tax_amount: T.nilable(Integer)).void
}
def initialize(
address: nil,
adults: nil,
affiliate: nil,
booking_number: nil,
category: nil,
checkin_at: nil,
checkout_at: nil,
customer_service_phone_number: nil,
daily_room_rate_amount: nil,
delivery: nil,
extra_charges: nil,
fire_safety_act_compliance: nil,
name: nil,
no_show: nil,
number_of_rooms: nil,
passengers: nil,
property_phone_number: nil,
room_class: nil,
room_nights: nil,
total_room_tax_amount: nil,
total_tax_amount: nil
); end
end
class Subscription < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class BillingInterval < Stripe::RequestParams
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def count; end
sig { params(_count: Integer).returns(Integer) }
def count=(_count); end
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig { params(count: Integer, interval: String).void }
def initialize(count: nil, interval: nil); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Subscription::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate=(_affiliate); end
# Info whether the subscription will be auto renewed upon expiry.
sig { returns(T.nilable(T::Boolean)) }
def auto_renewal; end
sig { params(_auto_renewal: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_renewal=(_auto_renewal); end
# Subscription billing details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval; end
sig {
params(_billing_interval: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Subscription::BillingInterval)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval=(_billing_interval); end
# Subscription end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Name of the product on subscription. e.g. Apple Music Subscription
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Subscription start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Subscription::Affiliate), auto_renewal: T.nilable(T::Boolean), billing_interval: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Subscription::BillingInterval), ends_at: T.nilable(Integer), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
affiliate: nil,
auto_renewal: nil,
billing_interval: nil,
ends_at: nil,
name: nil,
starts_at: nil
); end
end
# Car rental details for this PaymentIntent.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental))
}
def car_rental; end
sig {
params(_car_rental: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental))
}
def car_rental=(_car_rental); end
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
sig { returns(T.nilable(String)) }
def customer_reference; end
sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) }
def customer_reference=(_customer_reference); end
# Event details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails))
}
def event_details; end
sig {
params(_event_details: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails))
}
def event_details=(_event_details); end
# Flight reservation details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight))
}
def flight; end
sig {
params(_flight: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight))
}
def flight=(_flight); end
# Lodging reservation details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging))
}
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging))
}
def lodging=(_lodging); end
# A unique value assigned by the business to identify the transaction.
sig { returns(T.nilable(String)) }
def order_reference; end
sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) }
def order_reference=(_order_reference); end
# Subscription details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Subscription))
}
def subscription; end
sig {
params(_subscription: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Subscription)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Subscription))
}
def subscription=(_subscription); end
sig {
params(car_rental: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::CarRental), customer_reference: T.nilable(String), event_details: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::EventDetails), flight: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Flight), lodging: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Lodging), order_reference: T.nilable(String), subscription: T.nilable(::Stripe::PaymentIntentService::CaptureParams::PaymentDetails::Subscription)).void
}
def initialize(
car_rental: nil,
customer_reference: nil,
event_details: nil,
flight: nil,
lodging: nil,
order_reference: nil,
subscription: nil
); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
sig { params(amount: T.nilable(Integer)).void }
def initialize(amount: nil); end
end
# Provides industry-specific information about the amount.
sig { returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails)) }
def amount_details; end
sig {
params(_amount_details: T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails))
}
def amount_details=(_amount_details); end
# The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Defaults to the full `amount_capturable` if it's not provided.
sig { returns(T.nilable(Integer)) }
def amount_to_capture; end
sig { params(_amount_to_capture: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_to_capture=(_amount_to_capture); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Defaults to `true`. When capturing a PaymentIntent, setting `final_capture` to `false` notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when [multicapture](https://stripe.com/docs/payments/multicapture) is available for PaymentIntents.
sig { returns(T.nilable(T::Boolean)) }
def final_capture; end
sig { params(_final_capture: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def final_capture=(_final_capture); end
# Automations to be run during the PaymentIntent lifecycle
sig { returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::Hooks)) }
def hooks; end
sig {
params(_hooks: T.nilable(::Stripe::PaymentIntentService::CaptureParams::Hooks)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::Hooks))
}
def hooks=(_hooks); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Provides industry-specific information about the charge.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CaptureParams::PaymentDetails)))
}
def payment_details; end
sig {
params(_payment_details: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CaptureParams::PaymentDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CaptureParams::PaymentDetails)))
}
def payment_details=(_payment_details); end
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# The parameters that you can use to automatically create a transfer after the payment
# is captured. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::PaymentIntentService::CaptureParams::TransferData)).returns(T.nilable(::Stripe::PaymentIntentService::CaptureParams::TransferData))
}
def transfer_data=(_transfer_data); end
sig {
params(amount_details: T.nilable(::Stripe::PaymentIntentService::CaptureParams::AmountDetails), amount_to_capture: T.nilable(Integer), application_fee_amount: T.nilable(Integer), expand: T.nilable(T::Array[String]), final_capture: T.nilable(T::Boolean), hooks: T.nilable(::Stripe::PaymentIntentService::CaptureParams::Hooks), metadata: T.nilable(T.any(String, T::Hash[String, String])), payment_details: T.nilable(T.any(String, ::Stripe::PaymentIntentService::CaptureParams::PaymentDetails)), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::PaymentIntentService::CaptureParams::TransferData)).void
}
def initialize(
amount_details: nil,
amount_to_capture: nil,
application_fee_amount: nil,
expand: nil,
final_capture: nil,
hooks: nil,
metadata: nil,
payment_details: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil
); end
end
class ConfirmParams < Stripe::RequestParams
class AmountDetails < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class Card < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class CardPresent < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class Klarna < Stripe::RequestParams
# URL to an image for the product. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def image_url; end
sig { params(_image_url: T.nilable(String)).returns(T.nilable(String)) }
def image_url=(_image_url); end
# URL to the product page. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def product_url; end
sig { params(_product_url: T.nilable(String)).returns(T.nilable(String)) }
def product_url=(_product_url); end
# Reference for the subscription this line item is for.
sig { returns(T.nilable(String)) }
def subscription_reference; end
sig { params(_subscription_reference: T.nilable(String)).returns(T.nilable(String)) }
def subscription_reference=(_subscription_reference); end
sig {
params(image_url: T.nilable(String), product_url: T.nilable(String), subscription_reference: T.nilable(String)).void
}
def initialize(image_url: nil, product_url: nil, subscription_reference: nil); end
end
class Paypal < Stripe::RequestParams
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
sig {
params(category: T.nilable(String), description: T.nilable(String), sold_by: T.nilable(String)).void
}
def initialize(category: nil, description: nil, sold_by: nil); end
end
# This sub-hash contains line item details that are specific to `card` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card=(_card); end
# This sub-hash contains line item details that are specific to `card_present` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present=(_card_present); end
# This sub-hash contains line item details that are specific to `klarna` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# This sub-hash contains line item details that are specific to `paypal` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
sig {
params(card: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent), klarna: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna), paypal: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).void
}
def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end
end
class Tax < Stripe::RequestParams
# The total tax on an item. Non-negative integer.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The amount an item was discounted for. Positive integer.
sig { returns(T.nilable(Integer)) }
def discount_amount; end
sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def discount_amount=(_discount_amount); end
# Payment method-specific information for line items.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# Unique identifier of the product. At most 12 characters long.
sig { returns(T.nilable(String)) }
def product_code; end
sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) }
def product_code=(_product_code); end
# Name of the product. At most 100 characters long.
sig { returns(String) }
def product_name; end
sig { params(_product_name: String).returns(String) }
def product_name=(_product_name); end
# Number of items of the product. Positive integer.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Contains information about the tax on the item.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::Tax)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::Tax))
}
def tax=(_tax); end
# Cost of the product. Non-negative integer.
sig { returns(Integer) }
def unit_cost; end
sig { params(_unit_cost: Integer).returns(Integer) }
def unit_cost=(_unit_cost); end
# A unit of measure for the line item, such as gallons, feet, meters, etc.
sig { returns(T.nilable(String)) }
def unit_of_measure; end
sig { params(_unit_of_measure: T.nilable(String)).returns(T.nilable(String)) }
def unit_of_measure=(_unit_of_measure); end
sig {
params(discount_amount: T.nilable(Integer), payment_method_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::PaymentMethodOptions), product_code: T.nilable(String), product_name: String, quantity: Integer, tax: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem::Tax), unit_cost: Integer, unit_of_measure: T.nilable(String)).void
}
def initialize(
discount_amount: nil,
payment_method_options: nil,
product_code: nil,
product_name: nil,
quantity: nil,
tax: nil,
unit_cost: nil,
unit_of_measure: nil
); end
end
class Shipping < Stripe::RequestParams
# Portion of the amount that is for shipping.
sig { returns(T.nilable(T.any(String, Integer))) }
def amount; end
sig {
params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def amount=(_amount); end
# The postal code that represents the shipping source.
sig { returns(T.nilable(String)) }
def from_postal_code; end
sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def from_postal_code=(_from_postal_code); end
# The postal code that represents the shipping destination.
sig { returns(T.nilable(String)) }
def to_postal_code; end
sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def to_postal_code=(_to_postal_code); end
sig {
params(amount: T.nilable(T.any(String, Integer)), from_postal_code: T.nilable(String), to_postal_code: T.nilable(String)).void
}
def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end
end
class Tax < Stripe::RequestParams
# Total portion of the amount that is for tax.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The total discount applied on the transaction.
sig { returns(T.nilable(T.any(String, Integer))) }
def discount_amount; end
sig {
params(_discount_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def discount_amount=(_discount_amount); end
# A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem])))
}
def line_items; end
sig {
params(_line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem])))
}
def line_items=(_line_items); end
# Contains information about the shipping portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::Shipping)))
}
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::Shipping))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::Shipping)))
}
def shipping=(_shipping); end
# Contains information about the tax portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::Tax)))
}
def tax; end
sig {
params(_tax: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::Tax))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::Tax)))
}
def tax=(_tax); end
sig {
params(discount_amount: T.nilable(T.any(String, Integer)), line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::LineItem])), shipping: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::Shipping)), tax: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::AmountDetails::Tax))).void
}
def initialize(discount_amount: nil, line_items: nil, shipping: nil, tax: nil); end
end
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
sig { returns(String) }
def calculation; end
sig { params(_calculation: String).returns(String) }
def calculation=(_calculation); end
sig { params(calculation: String).void }
def initialize(calculation: nil); end
end
# Tax arguments for automations
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::Hooks::Inputs::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::Hooks::Inputs::Tax)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::Hooks::Inputs::Tax))
}
def tax=(_tax); end
sig {
params(tax: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::Hooks::Inputs::Tax)).void
}
def initialize(tax: nil); end
end
# Arguments passed in automations
sig { returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::Hooks::Inputs)) }
def inputs; end
sig {
params(_inputs: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::Hooks::Inputs)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::Hooks::Inputs))
}
def inputs=(_inputs); end
sig {
params(inputs: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::Hooks::Inputs)).void
}
def initialize(inputs: nil); end
end
class MandateData < Stripe::RequestParams
class CustomerAcceptance < Stripe::RequestParams
class Offline < Stripe::RequestParams; end
class Online < Stripe::RequestParams
# The IP address from which the Mandate was accepted by the customer.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# The user agent of the browser from which the Mandate was accepted by the customer.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig { params(ip_address: T.nilable(String), user_agent: T.nilable(String)).void }
def initialize(ip_address: nil, user_agent: nil); end
end
# The time at which the customer accepted the Mandate.
sig { returns(T.nilable(Integer)) }
def accepted_at; end
sig { params(_accepted_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def accepted_at=(_accepted_at); end
# If this is a Mandate accepted offline, this hash contains details about the offline acceptance.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::MandateData::CustomerAcceptance::Offline))
}
def offline; end
sig {
params(_offline: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::MandateData::CustomerAcceptance::Offline)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::MandateData::CustomerAcceptance::Offline))
}
def offline=(_offline); end
# If this is a Mandate accepted online, this hash contains details about the online acceptance.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::MandateData::CustomerAcceptance::Online))
}
def online; end
sig {
params(_online: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::MandateData::CustomerAcceptance::Online)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::MandateData::CustomerAcceptance::Online))
}
def online=(_online); end
# The type of customer acceptance information included with the Mandate. One of `online` or `offline`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(accepted_at: T.nilable(Integer), offline: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::MandateData::CustomerAcceptance::Offline), online: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::MandateData::CustomerAcceptance::Online), type: String).void
}
def initialize(accepted_at: nil, offline: nil, online: nil, type: nil); end
end
# This hash contains details about the customer acceptance of the Mandate.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::MandateData::CustomerAcceptance))
}
def customer_acceptance; end
sig {
params(_customer_acceptance: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::MandateData::CustomerAcceptance)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::MandateData::CustomerAcceptance))
}
def customer_acceptance=(_customer_acceptance); end
sig {
params(customer_acceptance: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::MandateData::CustomerAcceptance)).void
}
def initialize(customer_acceptance: nil); end
end
class PaymentDetails < Stripe::RequestParams
class CarRental < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Distance < Stripe::RequestParams
# Distance traveled.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
sig { params(amount: T.nilable(Integer), unit: T.nilable(String)).void }
def initialize(amount: nil, unit: nil); end
end
class Driver < Stripe::RequestParams
# Driver's identification number.
sig { returns(T.nilable(String)) }
def driver_identification_number; end
sig {
params(_driver_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def driver_identification_number=(_driver_identification_number); end
# Driver's tax number.
sig { returns(T.nilable(String)) }
def driver_tax_number; end
sig { params(_driver_tax_number: T.nilable(String)).returns(T.nilable(String)) }
def driver_tax_number=(_driver_tax_number); end
# Full name of the person or entity on the car reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(driver_identification_number: T.nilable(String), driver_tax_number: T.nilable(String), name: String).void
}
def initialize(
driver_identification_number: nil,
driver_tax_number: nil,
name: nil
); end
end
class PickupAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class ReturnAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the car rental.
sig { returns(String) }
def booking_number; end
sig { params(_booking_number: String).returns(String) }
def booking_number=(_booking_number); end
# Class code of the car.
sig { returns(T.nilable(String)) }
def car_class_code; end
sig { params(_car_class_code: T.nilable(String)).returns(T.nilable(String)) }
def car_class_code=(_car_class_code); end
# Make of the car.
sig { returns(T.nilable(String)) }
def car_make; end
sig { params(_car_make: T.nilable(String)).returns(T.nilable(String)) }
def car_make=(_car_make); end
# Model of the car.
sig { returns(T.nilable(String)) }
def car_model; end
sig { params(_car_model: T.nilable(String)).returns(T.nilable(String)) }
def car_model=(_car_model); end
# The name of the rental car company.
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# The customer service phone number of the car rental company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# Number of days the car is being rented.
sig { returns(Integer) }
def days_rented; end
sig { params(_days_rented: Integer).returns(Integer) }
def days_rented=(_days_rented); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Delivery)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Delivery))
}
def delivery=(_delivery); end
# The details of the distance traveled during the rental period.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Distance))
}
def distance; end
sig {
params(_distance: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Distance)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Distance))
}
def distance=(_distance); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Driver]))
}
def drivers; end
sig {
params(_drivers: T.nilable(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Driver])).returns(T.nilable(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Driver]))
}
def drivers=(_drivers); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates if the customer did not keep nor cancel their booking.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# Car pick-up address.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address; end
sig {
params(_pickup_address: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::PickupAddress)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::PickupAddress))
}
def pickup_address=(_pickup_address); end
# Car pick-up time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def pickup_at; end
sig { params(_pickup_at: Integer).returns(Integer) }
def pickup_at=(_pickup_at); end
# Name of the pickup location.
sig { returns(T.nilable(String)) }
def pickup_location_name; end
sig { params(_pickup_location_name: T.nilable(String)).returns(T.nilable(String)) }
def pickup_location_name=(_pickup_location_name); end
# Rental rate.
sig { returns(T.nilable(Integer)) }
def rate_amount; end
sig { params(_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def rate_amount=(_rate_amount); end
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
sig { returns(T.nilable(String)) }
def rate_interval; end
sig { params(_rate_interval: T.nilable(String)).returns(T.nilable(String)) }
def rate_interval=(_rate_interval); end
# The name of the person or entity renting the car.
sig { returns(T.nilable(String)) }
def renter_name; end
sig { params(_renter_name: T.nilable(String)).returns(T.nilable(String)) }
def renter_name=(_renter_name); end
# Car return address.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address; end
sig {
params(_return_address: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::ReturnAddress)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::ReturnAddress))
}
def return_address=(_return_address); end
# Car return time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def return_at; end
sig { params(_return_at: Integer).returns(Integer) }
def return_at=(_return_at); end
# Name of the return location.
sig { returns(T.nilable(String)) }
def return_location_name; end
sig { params(_return_location_name: T.nilable(String)).returns(T.nilable(String)) }
def return_location_name=(_return_location_name); end
# Indicates whether the goods or services are tax-exempt or tax is not collected.
sig { returns(T.nilable(T::Boolean)) }
def tax_exempt; end
sig { params(_tax_exempt: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def tax_exempt=(_tax_exempt); end
# The vehicle identification number.
sig { returns(T.nilable(String)) }
def vehicle_identification_number; end
sig {
params(_vehicle_identification_number: T.nilable(String)).returns(T.nilable(String))
}
def vehicle_identification_number=(_vehicle_identification_number); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Affiliate), booking_number: String, car_class_code: T.nilable(String), car_make: T.nilable(String), car_model: T.nilable(String), company: T.nilable(String), customer_service_phone_number: T.nilable(String), days_rented: Integer, delivery: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Delivery), distance: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Distance), drivers: T.nilable(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::Driver]), extra_charges: T.nilable(T::Array[String]), no_show: T.nilable(T::Boolean), pickup_address: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::PickupAddress), pickup_at: Integer, pickup_location_name: T.nilable(String), rate_amount: T.nilable(Integer), rate_interval: T.nilable(String), renter_name: T.nilable(String), return_address: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental::ReturnAddress), return_at: Integer, return_location_name: T.nilable(String), tax_exempt: T.nilable(T::Boolean), vehicle_identification_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
booking_number: nil,
car_class_code: nil,
car_make: nil,
car_model: nil,
company: nil,
customer_service_phone_number: nil,
days_rented: nil,
delivery: nil,
distance: nil,
drivers: nil,
extra_charges: nil,
no_show: nil,
pickup_address: nil,
pickup_at: nil,
pickup_location_name: nil,
rate_amount: nil,
rate_interval: nil,
renter_name: nil,
return_address: nil,
return_at: nil,
return_location_name: nil,
tax_exempt: nil,
vehicle_identification_number: nil
); end
end
class EventDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
# Indicates if the tickets are digitally checked when entering the venue.
sig { returns(T.nilable(T::Boolean)) }
def access_controlled_venue; end
sig {
params(_access_controlled_venue: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def access_controlled_venue=(_access_controlled_venue); end
# The event location's address.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails::Address)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails::Address))
}
def address=(_address); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails::Affiliate))
}
def affiliate=(_affiliate); end
# The name of the company
sig { returns(T.nilable(String)) }
def company; end
sig { params(_company: T.nilable(String)).returns(T.nilable(String)) }
def company=(_company); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails::Delivery)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails::Delivery))
}
def delivery=(_delivery); end
# Event end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Type of the event entertainment (concert, sports event etc)
sig { returns(T.nilable(String)) }
def genre; end
sig { params(_genre: T.nilable(String)).returns(T.nilable(String)) }
def genre=(_genre); end
# The name of the event.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Event start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(access_controlled_venue: T.nilable(T::Boolean), address: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails::Address), affiliate: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails::Affiliate), company: T.nilable(String), delivery: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails::Delivery), ends_at: T.nilable(Integer), genre: T.nilable(String), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
access_controlled_venue: nil,
address: nil,
affiliate: nil,
company: nil,
delivery: nil,
ends_at: nil,
genre: nil,
name: nil,
starts_at: nil
); end
end
class Flight < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the flight reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Segment < Stripe::RequestParams
# The flight segment amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The International Air Transport Association (IATA) airport code for the arrival airport.
sig { returns(T.nilable(String)) }
def arrival_airport; end
sig { params(_arrival_airport: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport=(_arrival_airport); end
# The arrival time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def arrives_at; end
sig { params(_arrives_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def arrives_at=(_arrives_at); end
# The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The departure time for the flight segment. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def departs_at; end
sig { params(_departs_at: Integer).returns(Integer) }
def departs_at=(_departs_at); end
# The International Air Transport Association (IATA) airport code for the departure airport.
sig { returns(T.nilable(String)) }
def departure_airport; end
sig { params(_departure_airport: T.nilable(String)).returns(T.nilable(String)) }
def departure_airport=(_departure_airport); end
# The flight number associated with the segment
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The fare class for the segment.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
sig {
params(amount: T.nilable(Integer), arrival_airport: T.nilable(String), arrives_at: T.nilable(Integer), carrier: T.nilable(String), departs_at: Integer, departure_airport: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String)).void
}
def initialize(
amount: nil,
arrival_airport: nil,
arrives_at: nil,
carrier: nil,
departs_at: nil,
departure_airport: nil,
flight_number: nil,
service_class: nil
); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Affiliate))
}
def affiliate=(_affiliate); end
# The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
sig { returns(T.nilable(String)) }
def agency_number; end
sig { params(_agency_number: T.nilable(String)).returns(T.nilable(String)) }
def agency_number=(_agency_number); end
# The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Delivery)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Delivery))
}
def delivery=(_delivery); end
# The name of the person or entity on the reservation.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# The details of the passengers in the travel reservation.
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Passenger])).returns(T.nilable(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Passenger]))
}
def passengers=(_passengers); end
# The individual flight segments associated with the trip.
sig {
returns(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Segment])
}
def segments; end
sig {
params(_segments: T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Segment]).returns(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Segment])
}
def segments=(_segments); end
# The ticket number associated with the travel reservation.
sig { returns(T.nilable(String)) }
def ticket_number; end
sig { params(_ticket_number: T.nilable(String)).returns(T.nilable(String)) }
def ticket_number=(_ticket_number); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Affiliate), agency_number: T.nilable(String), carrier: T.nilable(String), delivery: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Delivery), passenger_name: T.nilable(String), passengers: T.nilable(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Passenger]), segments: T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight::Segment], ticket_number: T.nilable(String)).void
}
def initialize(
affiliate: nil,
agency_number: nil,
carrier: nil,
delivery: nil,
passenger_name: nil,
passengers: nil,
segments: nil,
ticket_number: nil
); end
end
class Lodging < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The name of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The phone number of the recipient the ticket is delivered to.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(email: nil, name: nil, phone: nil); end
end
# The delivery method for the payment
sig { returns(T.nilable(String)) }
def mode; end
sig { params(_mode: T.nilable(String)).returns(T.nilable(String)) }
def mode=(_mode); end
# Details of the recipient.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Delivery::Recipient)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Delivery::Recipient))
}
def recipient=(_recipient); end
sig {
params(mode: T.nilable(String), recipient: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Delivery::Recipient)).void
}
def initialize(mode: nil, recipient: nil); end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the lodging reservation.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
# The lodging location's address.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Address)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Address))
}
def address=(_address); end
# The number of adults on the booking
sig { returns(T.nilable(Integer)) }
def adults; end
sig { params(_adults: T.nilable(Integer)).returns(T.nilable(Integer)) }
def adults=(_adults); end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Affiliate))
}
def affiliate=(_affiliate); end
# The booking number associated with the lodging reservation.
sig { returns(T.nilable(String)) }
def booking_number; end
sig { params(_booking_number: T.nilable(String)).returns(T.nilable(String)) }
def booking_number=(_booking_number); end
# The lodging category
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Lodging check-in time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkin_at; end
sig { params(_checkin_at: Integer).returns(Integer) }
def checkin_at=(_checkin_at); end
# Lodging check-out time. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def checkout_at; end
sig { params(_checkout_at: Integer).returns(Integer) }
def checkout_at=(_checkout_at); end
# The customer service phone number of the lodging company.
sig { returns(T.nilable(String)) }
def customer_service_phone_number; end
sig {
params(_customer_service_phone_number: T.nilable(String)).returns(T.nilable(String))
}
def customer_service_phone_number=(_customer_service_phone_number); end
# The daily lodging room rate.
sig { returns(T.nilable(Integer)) }
def daily_room_rate_amount; end
sig { params(_daily_room_rate_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def daily_room_rate_amount=(_daily_room_rate_amount); end
# Delivery details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Delivery))
}
def delivery; end
sig {
params(_delivery: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Delivery)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Delivery))
}
def delivery=(_delivery); end
# List of additional charges being billed.
sig { returns(T.nilable(T::Array[String])) }
def extra_charges; end
sig {
params(_extra_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def extra_charges=(_extra_charges); end
# Indicates whether the lodging location is compliant with the Fire Safety Act.
sig { returns(T.nilable(T::Boolean)) }
def fire_safety_act_compliance; end
sig {
params(_fire_safety_act_compliance: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def fire_safety_act_compliance=(_fire_safety_act_compliance); end
# The name of the lodging location.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Indicates if the customer did not keep their booking while failing to cancel the reservation.
sig { returns(T.nilable(T::Boolean)) }
def no_show; end
sig { params(_no_show: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def no_show=(_no_show); end
# The number of rooms on the booking
sig { returns(T.nilable(Integer)) }
def number_of_rooms; end
sig { params(_number_of_rooms: T.nilable(Integer)).returns(T.nilable(Integer)) }
def number_of_rooms=(_number_of_rooms); end
# The details of the passengers in the travel reservation
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Passenger]))
}
def passengers; end
sig {
params(_passengers: T.nilable(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Passenger])).returns(T.nilable(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Passenger]))
}
def passengers=(_passengers); end
# The phone number of the lodging location.
sig { returns(T.nilable(String)) }
def property_phone_number; end
sig { params(_property_phone_number: T.nilable(String)).returns(T.nilable(String)) }
def property_phone_number=(_property_phone_number); end
# The room class for this purchase.
sig { returns(T.nilable(String)) }
def room_class; end
sig { params(_room_class: T.nilable(String)).returns(T.nilable(String)) }
def room_class=(_room_class); end
# The number of room nights
sig { returns(T.nilable(Integer)) }
def room_nights; end
sig { params(_room_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def room_nights=(_room_nights); end
# The total tax amount associating with the room reservation.
sig { returns(T.nilable(Integer)) }
def total_room_tax_amount; end
sig { params(_total_room_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_room_tax_amount=(_total_room_tax_amount); end
# The total tax amount
sig { returns(T.nilable(Integer)) }
def total_tax_amount; end
sig { params(_total_tax_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total_tax_amount=(_total_tax_amount); end
sig {
params(address: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Address), adults: T.nilable(Integer), affiliate: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Affiliate), booking_number: T.nilable(String), category: T.nilable(String), checkin_at: Integer, checkout_at: Integer, customer_service_phone_number: T.nilable(String), daily_room_rate_amount: T.nilable(Integer), delivery: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Delivery), extra_charges: T.nilable(T::Array[String]), fire_safety_act_compliance: T.nilable(T::Boolean), name: T.nilable(String), no_show: T.nilable(T::Boolean), number_of_rooms: T.nilable(Integer), passengers: T.nilable(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging::Passenger]), property_phone_number: T.nilable(String), room_class: T.nilable(String), room_nights: T.nilable(Integer), total_room_tax_amount: T.nilable(Integer), total_tax_amount: T.nilable(Integer)).void
}
def initialize(
address: nil,
adults: nil,
affiliate: nil,
booking_number: nil,
category: nil,
checkin_at: nil,
checkout_at: nil,
customer_service_phone_number: nil,
daily_room_rate_amount: nil,
delivery: nil,
extra_charges: nil,
fire_safety_act_compliance: nil,
name: nil,
no_show: nil,
number_of_rooms: nil,
passengers: nil,
property_phone_number: nil,
room_class: nil,
room_nights: nil,
total_room_tax_amount: nil,
total_tax_amount: nil
); end
end
class Subscription < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class BillingInterval < Stripe::RequestParams
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def count; end
sig { params(_count: Integer).returns(Integer) }
def count=(_count); end
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
sig { params(count: Integer, interval: String).void }
def initialize(count: nil, interval: nil); end
end
# Affiliate details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate; end
sig {
params(_affiliate: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Subscription::Affiliate)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Subscription::Affiliate))
}
def affiliate=(_affiliate); end
# Info whether the subscription will be auto renewed upon expiry.
sig { returns(T.nilable(T::Boolean)) }
def auto_renewal; end
sig { params(_auto_renewal: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def auto_renewal=(_auto_renewal); end
# Subscription billing details for this purchase.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval; end
sig {
params(_billing_interval: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Subscription::BillingInterval)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Subscription::BillingInterval))
}
def billing_interval=(_billing_interval); end
# Subscription end time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def ends_at; end
sig { params(_ends_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def ends_at=(_ends_at); end
# Name of the product on subscription. e.g. Apple Music Subscription
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Subscription start time. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def starts_at; end
sig { params(_starts_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def starts_at=(_starts_at); end
sig {
params(affiliate: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Subscription::Affiliate), auto_renewal: T.nilable(T::Boolean), billing_interval: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Subscription::BillingInterval), ends_at: T.nilable(Integer), name: String, starts_at: T.nilable(Integer)).void
}
def initialize(
affiliate: nil,
auto_renewal: nil,
billing_interval: nil,
ends_at: nil,
name: nil,
starts_at: nil
); end
end
# Car rental details for this PaymentIntent.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental))
}
def car_rental; end
sig {
params(_car_rental: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental))
}
def car_rental=(_car_rental); end
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
sig { returns(T.nilable(String)) }
def customer_reference; end
sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) }
def customer_reference=(_customer_reference); end
# Event details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails))
}
def event_details; end
sig {
params(_event_details: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails))
}
def event_details=(_event_details); end
# Flight reservation details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight))
}
def flight; end
sig {
params(_flight: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight))
}
def flight=(_flight); end
# Lodging reservation details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging))
}
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging))
}
def lodging=(_lodging); end
# A unique value assigned by the business to identify the transaction.
sig { returns(T.nilable(String)) }
def order_reference; end
sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) }
def order_reference=(_order_reference); end
# Subscription details for this PaymentIntent
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Subscription))
}
def subscription; end
sig {
params(_subscription: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Subscription)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Subscription))
}
def subscription=(_subscription); end
sig {
params(car_rental: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::CarRental), customer_reference: T.nilable(String), event_details: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::EventDetails), flight: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Flight), lodging: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Lodging), order_reference: T.nilable(String), subscription: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails::Subscription)).void
}
def initialize(
car_rental: nil,
customer_reference: nil,
event_details: nil,
flight: nil,
lodging: nil,
order_reference: nil,
subscription: nil
); end
end
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Institution number of the customer's bank.
sig { returns(String) }
def institution_number; end
sig { params(_institution_number: String).returns(String) }
def institution_number=(_institution_number); end
# Transit number of the customer's bank.
sig { returns(String) }
def transit_number; end
sig { params(_transit_number: String).returns(String) }
def transit_number=(_transit_number); end
sig {
params(account_number: String, institution_number: String, transit_number: String).void
}
def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(String) }
def bsb_number; end
sig { params(_bsb_number: String).returns(String) }
def bsb_number=(_bsb_number); end
sig { params(account_number: String, bsb_number: String).void }
def initialize(account_number: nil, bsb_number: nil); end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
sig { params(_sort_code: T.nilable(String)).returns(T.nilable(String)) }
def sort_code=(_sort_code); end
sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
def initialize(account_number: nil, sort_code: nil); end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
sig { params(_tax_id: String).returns(String) }
def tax_id=(_tax_id); end
sig { params(tax_id: String).void }
def initialize(tax_id: nil); end
end
class Cashapp < Stripe::RequestParams; end
class Crypto < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The customer's bank.
sig { returns(String) }
def bank; end
sig { params(_bank: String).returns(String) }
def bank=(_bank); end
sig { params(account_holder_type: T.nilable(String), bank: String).void }
def initialize(account_holder_type: nil, bank: nil); end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Klarna::Dob))
}
def dob; end
sig {
params(_dob: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Klarna::Dob)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Klarna::Dob))
}
def dob=(_dob); end
sig {
params(dob: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Klarna::Dob)).void
}
def initialize(dob: nil); end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
sig { returns(T.nilable(String)) }
def funding; end
sig { params(_funding: T.nilable(String)).returns(T.nilable(String)) }
def funding=(_funding); end
sig { params(funding: T.nilable(String)).void }
def initialize(funding: nil); end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
sig { params(_bank_code: String).returns(String) }
def bank_code=(_bank_code); end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
sig { params(_branch_code: String).returns(String) }
def branch_code=(_branch_code); end
# Attribute for param field reference
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# The suffix of the bank account number.
sig { returns(String) }
def suffix; end
sig { params(_suffix: String).returns(String) }
def suffix=(_suffix); end
sig {
params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
); end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Paypay < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Rechnung::Dob)
}
def dob; end
sig {
params(_dob: ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Rechnung::Dob).returns(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Rechnung::Dob)
}
def dob=(_dob); end
sig {
params(dob: ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Rechnung::Dob).void
}
def initialize(dob: nil); end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
sig { returns(String) }
def iban; end
sig { params(_iban: String).returns(String) }
def iban=(_iban); end
sig { params(iban: String).void }
def initialize(iban: nil); end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
sig { params(account: T.nilable(String), source_type: T.nilable(String)).void }
def initialize(account: nil, source_type: nil); end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig {
params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String))
}
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AcssDebit)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Affirm))
}
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Affirm)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Affirm))
}
def affirm=(_affirm); end
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AfterpayClearpay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Alipay))
}
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Alipay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Alipay))
}
def alipay=(_alipay); end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Alma))
}
def alma; end
sig {
params(_alma: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Alma)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Alma))
}
def alma=(_alma); end
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AmazonPay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AuBecsDebit)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::BacsDebit)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Bancontact)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Bancontact))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Billie))
}
def billie; end
sig {
params(_billie: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Billie)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Billie))
}
def billie=(_billie); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::BillingDetails)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Blik))
}
def blik; end
sig {
params(_blik: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Blik)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Blik))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Boleto))
}
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Boleto)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Boleto))
}
def boleto=(_boleto); end
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Cashapp))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Cashapp)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Cashapp))
}
def cashapp=(_cashapp); end
# If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Crypto))
}
def crypto; end
sig {
params(_crypto: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Crypto)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Crypto))
}
def crypto=(_crypto); end
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::CustomerBalance)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Eps))
}
def eps; end
sig {
params(_eps: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Eps)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Eps))
}
def eps=(_eps); end
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Fpx))
}
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Fpx)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Fpx))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Giropay))
}
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Giropay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Giropay))
}
def giropay=(_giropay); end
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Gopay))
}
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Gopay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Gopay))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Grabpay))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Grabpay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Grabpay))
}
def grabpay=(_grabpay); end
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::IdBankTransfer)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Ideal))
}
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Ideal)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Ideal))
}
def ideal=(_ideal); end
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::InteracPresent))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::InteracPresent)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::InteracPresent))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::KakaoPay))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::KakaoPay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Klarna)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Klarna))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Konbini))
}
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Konbini)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Konbini))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::KrCard))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::KrCard)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::KrCard))
}
def kr_card=(_kr_card); end
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Link))
}
def link; end
sig {
params(_link: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Link)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Link))
}
def link=(_link); end
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::MbWay))
}
def mb_way; end
sig {
params(_mb_way: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::MbWay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::MbWay))
}
def mb_way=(_mb_way); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Mobilepay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Mobilepay))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Multibanco)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Multibanco))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::NaverPay))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::NaverPay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::NaverPay))
}
def naver_pay=(_naver_pay); end
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::NzBankAccount)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Oxxo))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Oxxo)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Oxxo))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::P24))
}
def p24; end
sig {
params(_p24: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::P24)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::P24))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::PayByBank)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Payco))
}
def payco; end
sig {
params(_payco: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Payco)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Payco))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Paynow))
}
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Paynow)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Paynow))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Paypal)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Paypal))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Paypay))
}
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Paypay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Paypay))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Payto))
}
def payto; end
sig {
params(_payto: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Payto)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Payto))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Pix))
}
def pix; end
sig {
params(_pix: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Pix)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Pix))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Promptpay))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Promptpay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Promptpay))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Qris))
}
def qris; end
sig {
params(_qris: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Qris)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Qris))
}
def qris=(_qris); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::RadarOptions))
}
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::RadarOptions)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::RadarOptions))
}
def radar_options=(_radar_options); end
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Rechnung))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Rechnung)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Rechnung))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::RevolutPay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::SamsungPay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Satispay))
}
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Satispay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Satispay))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::SepaDebit)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Shopeepay))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Shopeepay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Shopeepay))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Sofort))
}
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Sofort)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Sofort))
}
def sofort=(_sofort); end
# This hash contains details about the Stripe balance payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::StripeBalance))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::StripeBalance)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Swish))
}
def swish; end
sig {
params(_swish: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Swish)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Swish))
}
def swish=(_swish); end
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Twint))
}
def twint; end
sig {
params(_twint: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Twint)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Twint))
}
def twint=(_twint); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::UsBankAccount)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::WechatPay)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Zip))
}
def zip; end
sig {
params(_zip: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Zip)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Cashapp), crypto: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Crypto), customer_balance: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Giropay), gopay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Gopay), grabpay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Grabpay), id_bank_transfer: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::IdBankTransfer), ideal: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Link), mb_way: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::MbWay), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Paypal), paypay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Paypay), payto: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Payto), pix: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Promptpay), qris: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Qris), radar_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::RadarOptions), rechnung: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Rechnung), revolut_pay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::SepaDebit), shopeepay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Shopeepay), sofort: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Sofort), stripe_balance: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::StripeBalance), swish: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
mandate_options: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class Affirm < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Preferred language of the Affirm authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), preferred_locale: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, preferred_locale: nil, setup_future_usage: nil); end
end
class AfterpayClearpay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.
# This field differs from the statement descriptor and item name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), reference: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, reference: nil, setup_future_usage: nil); end
end
class Alipay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Alma < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class AmazonPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class AuBecsDebit < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(setup_future_usage: nil, target_date: nil); end
end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class Billie < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Blik < Stripe::RequestParams
# The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.
sig { returns(T.nilable(String)) }
def code; end
sig { params(_code: T.nilable(String)).returns(T.nilable(String)) }
def code=(_code); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(code: T.nilable(String), setup_future_usage: T.nilable(String)).void }
def initialize(code: nil, setup_future_usage: nil); end
end
class Boleto < Stripe::RequestParams
# The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
class Plan < Stripe::RequestParams
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
sig { returns(T.nilable(Integer)) }
def count; end
sig { params(_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def count=(_count); end
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
# One of `month`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(count: T.nilable(Integer), interval: T.nilable(String), type: String).void
}
def initialize(count: nil, interval: nil, type: nil); end
end
# Setting to true enables installments for this PaymentIntent.
# This will cause the response to contain a list of available installment plans.
# Setting to false will prevent any selected plan from applying to a charge.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# The selected installment plan to use for this payment attempt.
# This parameter can only be provided during confirmation.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan; end
sig {
params(_plan: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::Installments::Plan))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::Installments::Plan)))
}
def plan=(_plan); end
sig {
params(enabled: T.nilable(T::Boolean), plan: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::Installments::Plan))).void
}
def initialize(enabled: nil, plan: nil); end
end
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(String) }
def amount_type; end
sig { params(_amount_type: String).returns(String) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Unique identifier for the mandate or subscription.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
sig { returns(Integer) }
def start_date; end
sig { params(_start_date: Integer).returns(Integer) }
def start_date=(_start_date); end
# Specifies the type of mandates supported. Possible values are `india`.
sig { returns(T.nilable(T::Array[String])) }
def supported_types; end
sig {
params(_supported_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def supported_types=(_supported_types); end
sig {
params(amount: Integer, amount_type: String, description: T.nilable(String), end_date: T.nilable(Integer), interval: String, interval_count: T.nilable(Integer), reference: String, start_date: Integer, supported_types: T.nilable(T::Array[String])).void
}
def initialize(
amount: nil,
amount_type: nil,
description: nil,
end_date: nil,
interval: nil,
interval_count: nil,
reference: nil,
start_date: nil,
supported_types: nil
); end
end
class StatementDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Please pass in an address that is within your Stripe user account country
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::StatementDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::StatementDetails::Address)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::StatementDetails::Address))
}
def address=(_address); end
# Phone number (e.g., a toll-free number that customers can call)
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::StatementDetails::Address), phone: T.nilable(String)).void
}
def initialize(address: nil, phone: nil); end
end
class ThreeDSecure < Stripe::RequestParams
class NetworkOptions < Stripe::RequestParams
class CartesBancaires < Stripe::RequestParams
# The cryptogram calculation algorithm used by the card Issuer's ACS
# to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
# messageExtension: CB-AVALGO
sig { returns(String) }
def cb_avalgo; end
sig { params(_cb_avalgo: String).returns(String) }
def cb_avalgo=(_cb_avalgo); end
# The exemption indicator returned from Cartes Bancaires in the ARes.
# message extension: CB-EXEMPTION; string (4 characters)
# This is a 3 byte bitmap (low significant byte first and most significant
# bit first) that has been Base64 encoded
sig { returns(T.nilable(String)) }
def cb_exemption; end
sig { params(_cb_exemption: T.nilable(String)).returns(T.nilable(String)) }
def cb_exemption=(_cb_exemption); end
# The risk score returned from Cartes Bancaires in the ARes.
# message extension: CB-SCORE; numeric value 0-99
sig { returns(T.nilable(Integer)) }
def cb_score; end
sig { params(_cb_score: T.nilable(Integer)).returns(T.nilable(Integer)) }
def cb_score=(_cb_score); end
sig {
params(cb_avalgo: String, cb_exemption: T.nilable(String), cb_score: T.nilable(Integer)).void
}
def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil); end
end
# Cartes Bancaires-specific 3DS fields.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires; end
sig {
params(_cartes_bancaires: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires=(_cartes_bancaires); end
sig {
params(cartes_bancaires: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).void
}
def initialize(cartes_bancaires: nil); end
end
# The `transStatus` returned from the card Issuer’s ACS in the ARes.
sig { returns(T.nilable(String)) }
def ares_trans_status; end
sig { params(_ares_trans_status: T.nilable(String)).returns(T.nilable(String)) }
def ares_trans_status=(_ares_trans_status); end
# The cryptogram, also known as the "authentication value" (AAV, CAVV or
# AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
# (Most 3D Secure providers will return the base64-encoded version, which
# is what you should specify here.)
sig { returns(String) }
def cryptogram; end
sig { params(_cryptogram: String).returns(String) }
def cryptogram=(_cryptogram); end
# The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
# provider and indicates what degree of authentication was performed.
sig { returns(T.nilable(String)) }
def electronic_commerce_indicator; end
sig {
params(_electronic_commerce_indicator: T.nilable(String)).returns(T.nilable(String))
}
def electronic_commerce_indicator=(_electronic_commerce_indicator); end
# The exemption requested via 3DS and accepted by the issuer at authentication time.
sig { returns(T.nilable(String)) }
def exemption_indicator; end
sig { params(_exemption_indicator: T.nilable(String)).returns(T.nilable(String)) }
def exemption_indicator=(_exemption_indicator); end
# Network specific 3DS fields. Network specific arguments require an
# explicit card brand choice. The parameter `payment_method_options.card.network``
# must be populated accordingly
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options; end
sig {
params(_network_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options=(_network_options); end
# The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
# AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
sig { returns(T.nilable(String)) }
def requestor_challenge_indicator; end
sig {
params(_requestor_challenge_indicator: T.nilable(String)).returns(T.nilable(String))
}
def requestor_challenge_indicator=(_requestor_challenge_indicator); end
# For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
# Transaction ID (dsTransID).
sig { returns(String) }
def transaction_id; end
sig { params(_transaction_id: String).returns(String) }
def transaction_id=(_transaction_id); end
# The version of 3D Secure that was performed.
sig { returns(String) }
def version; end
sig { params(_version: String).returns(String) }
def version=(_version); end
sig {
params(ares_trans_status: T.nilable(String), cryptogram: String, electronic_commerce_indicator: T.nilable(String), exemption_indicator: T.nilable(String), network_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions), requestor_challenge_indicator: T.nilable(String), transaction_id: String, version: String).void
}
def initialize(
ares_trans_status: nil,
cryptogram: nil,
electronic_commerce_indicator: nil,
exemption_indicator: nil,
network_options: nil,
requestor_challenge_indicator: nil,
transaction_id: nil,
version: nil
); end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.
sig { returns(T.nilable(String)) }
def cvc_token; end
sig { params(_cvc_token: T.nilable(String)).returns(T.nilable(String)) }
def cvc_token=(_cvc_token); end
# Installment configuration for payments attempted on this PaymentIntent.
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::Installments))
}
def installments; end
sig {
params(_installments: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::Installments)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::Installments))
}
def installments=(_installments); end
# Configuration options for setting up an eMandate for cards issued in India.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options=(_mandate_options); end
# When specified, this parameter indicates that a transaction will be marked
# as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
# parameter can only be provided during confirmation.
sig { returns(T.nilable(T::Boolean)) }
def moto; end
sig { params(_moto: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def moto=(_moto); end
# Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
# Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_decremental_authorization; end
sig {
params(_request_decremental_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_decremental_authorization=(_request_decremental_authorization); end
# Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_extended_authorization; end
sig {
params(_request_extended_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_extended_authorization=(_request_extended_authorization); end
# Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_incremental_authorization; end
sig {
params(_request_incremental_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_incremental_authorization=(_request_incremental_authorization); end
# Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_multicapture; end
sig { params(_request_multicapture: T.nilable(String)).returns(T.nilable(String)) }
def request_multicapture=(_request_multicapture); end
# Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_overcapture; end
sig { params(_request_overcapture: T.nilable(String)).returns(T.nilable(String)) }
def request_overcapture=(_request_overcapture); end
# Request partial authorization on this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_partial_authorization; end
sig {
params(_request_partial_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_partial_authorization=(_request_partial_authorization); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
# When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).
sig { returns(T.nilable(T::Boolean)) }
def require_cvc_recollection; end
sig {
params(_require_cvc_recollection: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def require_cvc_recollection=(_require_cvc_recollection); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kana; end
sig {
params(_statement_descriptor_suffix_kana: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_suffix_kana=(_statement_descriptor_suffix_kana); end
# Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix_kanji; end
sig {
params(_statement_descriptor_suffix_kanji: T.nilable(String)).returns(T.nilable(String))
}
def statement_descriptor_suffix_kanji=(_statement_descriptor_suffix_kanji); end
# Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::StatementDetails)))
}
def statement_details; end
sig {
params(_statement_details: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::StatementDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::StatementDetails)))
}
def statement_details=(_statement_details); end
# If 3D Secure authentication was performed with a third-party provider,
# the authentication details to use for this payment.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure; end
sig {
params(_three_d_secure: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure=(_three_d_secure); end
sig {
params(capture_method: T.nilable(String), cvc_token: T.nilable(String), installments: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::Installments), mandate_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::MandateOptions), moto: T.nilable(T::Boolean), network: T.nilable(String), request_decremental_authorization: T.nilable(String), request_extended_authorization: T.nilable(String), request_incremental_authorization: T.nilable(String), request_multicapture: T.nilable(String), request_overcapture: T.nilable(String), request_partial_authorization: T.nilable(String), request_three_d_secure: T.nilable(String), require_cvc_recollection: T.nilable(T::Boolean), setup_future_usage: T.nilable(T.any(String, String)), statement_descriptor_suffix_kana: T.nilable(String), statement_descriptor_suffix_kanji: T.nilable(String), statement_details: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::StatementDetails)), three_d_secure: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure)).void
}
def initialize(
capture_method: nil,
cvc_token: nil,
installments: nil,
mandate_options: nil,
moto: nil,
network: nil,
request_decremental_authorization: nil,
request_extended_authorization: nil,
request_incremental_authorization: nil,
request_multicapture: nil,
request_overcapture: nil,
request_partial_authorization: nil,
request_three_d_secure: nil,
require_cvc_recollection: nil,
setup_future_usage: nil,
statement_descriptor_suffix_kana: nil,
statement_descriptor_suffix_kanji: nil,
statement_details: nil,
three_d_secure: nil
); end
end
class CardPresent < Stripe::RequestParams
class Routing < Stripe::RequestParams
# Routing requested priority
sig { returns(T.nilable(String)) }
def requested_priority; end
sig { params(_requested_priority: T.nilable(String)).returns(T.nilable(String)) }
def requested_priority=(_requested_priority); end
sig { params(requested_priority: T.nilable(String)).void }
def initialize(requested_priority: nil); end
end
# Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)
sig { returns(T.nilable(T::Boolean)) }
def request_extended_authorization; end
sig {
params(_request_extended_authorization: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def request_extended_authorization=(_request_extended_authorization); end
# Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
sig { returns(T.nilable(T::Boolean)) }
def request_incremental_authorization_support; end
sig {
params(_request_incremental_authorization_support: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def request_incremental_authorization_support=(
_request_incremental_authorization_support
); end
# Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CardPresent::Routing))
}
def routing; end
sig {
params(_routing: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CardPresent::Routing)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CardPresent::Routing))
}
def routing=(_routing); end
sig {
params(request_extended_authorization: T.nilable(T::Boolean), request_incremental_authorization_support: T.nilable(T::Boolean), routing: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CardPresent::Routing)).void
}
def initialize(
request_extended_authorization: nil,
request_incremental_authorization_support: nil,
routing: nil
); end
end
class Cashapp < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Crypto < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for the eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
sig { returns(T.nilable(T::Array[String])) }
def requested_address_types; end
sig {
params(_requested_address_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested_address_types=(_requested_address_types); end
# The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
}
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(bank_transfer: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
end
class Eps < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Fpx < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Giropay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Gopay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Grabpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class IdBankTransfer < Stripe::RequestParams
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from 5 minutes from now until 31 days from now. If unset, it defaults to 3 days from now.
sig { returns(T.nilable(Integer)) }
def expires_after; end
sig { params(_expires_after: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after=(_expires_after); end
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now until 30 days from now. If unset, it defaults to 1 days from now.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after: T.nilable(Integer), expires_at: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after: nil, expires_at: nil, setup_future_usage: nil); end
end
class Ideal < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Klarna < Stripe::RequestParams
class OnDemand < Stripe::RequestParams
# Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def average_amount; end
sig { params(_average_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def average_amount=(_average_amount); end
# The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def maximum_amount; end
sig { params(_maximum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_amount=(_maximum_amount); end
# The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Interval at which the customer is making purchases
sig { returns(T.nilable(String)) }
def purchase_interval; end
sig { params(_purchase_interval: T.nilable(String)).returns(T.nilable(String)) }
def purchase_interval=(_purchase_interval); end
# The number of `purchase_interval` between charges
sig { returns(T.nilable(Integer)) }
def purchase_interval_count; end
sig { params(_purchase_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def purchase_interval_count=(_purchase_interval_count); end
sig {
params(average_amount: T.nilable(Integer), maximum_amount: T.nilable(Integer), minimum_amount: T.nilable(Integer), purchase_interval: T.nilable(String), purchase_interval_count: T.nilable(Integer)).void
}
def initialize(
average_amount: nil,
maximum_amount: nil,
minimum_amount: nil,
purchase_interval: nil,
purchase_interval_count: nil
); end
end
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing; end
sig {
params(_next_billing: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna::Subscription::NextBilling))
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna::Subscription::NextBilling), reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# On-demand details if setting up or charging an on-demand payment.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand; end
sig {
params(_on_demand: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna::OnDemand)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand=(_on_demand); end
# Preferred language of the Klarna authorization page that the customer is redirected to
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Subscription details if setting up or charging a subscription.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(capture_method: T.nilable(String), on_demand: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna::OnDemand), preferred_locale: T.nilable(String), setup_future_usage: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(
capture_method: nil,
on_demand: nil,
preferred_locale: nil,
setup_future_usage: nil,
subscriptions: nil
); end
end
class Konbini < Stripe::RequestParams
# An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number.
sig { returns(T.nilable(String)) }
def confirmation_number; end
sig { params(_confirmation_number: T.nilable(String)).returns(T.nilable(String)) }
def confirmation_number=(_confirmation_number); end
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
sig { returns(T.nilable(T.any(String, Integer))) }
def expires_after_days; end
sig {
params(_expires_after_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expires_after_days=(_expires_after_days); end
# The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.
sig { returns(T.nilable(T.any(String, Integer))) }
def expires_at; end
sig {
params(_expires_at: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def expires_at=(_expires_at); end
# A product descriptor of up to 22 characters, which will appear to customers at the convenience store.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(confirmation_number: T.nilable(String), expires_after_days: T.nilable(T.any(String, Integer)), expires_at: T.nilable(T.any(String, Integer)), product_description: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(
confirmation_number: nil,
expires_after_days: nil,
expires_at: nil,
product_description: nil,
setup_future_usage: nil
); end
end
class KrCard < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Link < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
sig { params(_persistent_token: T.nilable(String)).returns(T.nilable(String)) }
def persistent_token=(_persistent_token); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), persistent_token: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, persistent_token: nil, setup_future_usage: nil); end
end
class MbWay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Mobilepay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class Multibanco < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class NaverPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class NzBankAccount < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(setup_future_usage: nil, target_date: nil); end
end
class Oxxo < Stripe::RequestParams
# The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
sig { returns(T.nilable(Integer)) }
def expires_after_days; end
sig { params(_expires_after_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_days=(_expires_after_days); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
}
def initialize(expires_after_days: nil, setup_future_usage: nil); end
end
class P24 < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Confirm that the payer has accepted the P24 terms and conditions.
sig { returns(T.nilable(T::Boolean)) }
def tos_shown_and_accepted; end
sig {
params(_tos_shown_and_accepted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def tos_shown_and_accepted=(_tos_shown_and_accepted); end
sig {
params(setup_future_usage: T.nilable(String), tos_shown_and_accepted: T.nilable(T::Boolean)).void
}
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Paynow < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Paypal < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The tax for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The tax behavior for the line item.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(amount: Integer, behavior: String).void }
def initialize(amount: nil, behavior: nil); end
end
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Descriptive name of the line item.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Quantity of the line item. Must be a positive number.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Client facing stock keeping unit, article number or similar.
sig { returns(T.nilable(String)) }
def sku; end
sig { params(_sku: T.nilable(String)).returns(T.nilable(String)) }
def sku=(_sku); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
# The tax information for the line item.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypal::LineItem::Tax)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypal::LineItem::Tax))
}
def tax=(_tax); end
# Price for a single unit of the line item in minor units. Cannot be a negative number.
sig { returns(Integer) }
def unit_amount; end
sig { params(_unit_amount: Integer).returns(Integer) }
def unit_amount=(_unit_amount); end
sig {
params(category: T.nilable(String), description: T.nilable(String), name: String, quantity: Integer, sku: T.nilable(String), sold_by: T.nilable(String), tax: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypal::LineItem::Tax), unit_amount: Integer).void
}
def initialize(
category: nil,
description: nil,
name: nil,
quantity: nil,
sku: nil,
sold_by: nil,
tax: nil,
unit_amount: nil
); end
end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# The line items purchased by the customer.
sig {
returns(T.nilable(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypal::LineItem])).returns(T.nilable(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypal::LineItem]))
}
def line_items=(_line_items); end
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
sig { returns(T.nilable(String)) }
def reference_id; end
sig { params(_reference_id: T.nilable(String)).returns(T.nilable(String)) }
def reference_id=(_reference_id); end
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
sig { returns(T.nilable(String)) }
def risk_correlation_id; end
sig { params(_risk_correlation_id: T.nilable(String)).returns(T.nilable(String)) }
def risk_correlation_id=(_risk_correlation_id); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(capture_method: T.nilable(String), line_items: T.nilable(T::Array[::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypal::LineItem]), preferred_locale: T.nilable(String), reference: T.nilable(String), reference_id: T.nilable(String), risk_correlation_id: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String)), subsellers: T.nilable(T::Array[String])).void
}
def initialize(
capture_method: nil,
line_items: nil,
preferred_locale: nil,
reference: nil,
reference_id: nil,
risk_correlation_id: nil,
setup_future_usage: nil,
subsellers: nil
); end
end
class Paypay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
sig { params(_payments_per_period: T.nilable(Integer)).returns(T.nilable(Integer)) }
def payments_per_period=(_payments_per_period); end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
sig { params(_purpose: T.nilable(String)).returns(T.nilable(String)) }
def purpose=(_purpose); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), payments_per_period: T.nilable(Integer), purpose: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil
); end
end
# Additional fields for Mandate creation. Only `purpose` field is configurable for PayTo PaymentIntent with `setup_future_usage=none`. Other fields are only applicable to PayTo PaymentIntent with `setup_future_usage=off_session`
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Payto::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Payto::MandateOptions), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(mandate_options: nil, setup_future_usage: nil); end
end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Type of amount. Defaults to `maximum`.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), amount_type: T.nilable(String), currency: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), reference: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
amount_type: nil,
currency: nil,
end_date: nil,
payment_schedule: nil,
reference: nil,
start_date: nil
); end
end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
sig { returns(T.nilable(Integer)) }
def expires_after_seconds; end
sig { params(_expires_after_seconds: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_after_seconds=(_expires_after_seconds); end
# The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# Additional fields for mandate creation. Only applicable when `setup_future_usage=off_session`.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(amount_includes_iof: T.nilable(String), expires_after_seconds: T.nilable(Integer), expires_at: T.nilable(Integer), mandate_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions), setup_future_usage: T.nilable(String)).void
}
def initialize(
amount_includes_iof: nil,
expires_after_seconds: nil,
expires_at: nil,
mandate_options: nil,
setup_future_usage: nil
); end
end
class Promptpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Qris < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Rechnung < Stripe::RequestParams; end
class RevolutPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(capture_method: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(capture_method: nil, setup_future_usage: nil); end
end
class SamsungPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class Satispay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
sig { params(capture_method: T.nilable(String)).void }
def initialize(capture_method: nil); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
sig {
params(mandate_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String)).void
}
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
end
class Shopeepay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class Sofort < Stripe::RequestParams
# Language shown to the payer on redirect.
sig { returns(T.nilable(T.any(String, String))) }
def preferred_language; end
sig {
params(_preferred_language: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred_language=(_preferred_language); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig {
params(preferred_language: T.nilable(T.any(String, String)), setup_future_usage: T.nilable(T.any(String, String))).void
}
def initialize(preferred_language: nil, setup_future_usage: nil); end
end
class StripeBalance < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(T.any(String, String))).void }
def initialize(setup_future_usage: nil); end
end
class Swish < Stripe::RequestParams
# A reference for this payment to be displayed in the Swish app.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(reference: T.nilable(String), setup_future_usage: T.nilable(String)).void }
def initialize(reference: nil, setup_future_usage: nil); end
end
class Twint < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
class ManualEntry < Stripe::RequestParams
# Settings for configuring manual entry of account details.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
sig { params(mode: String).void }
def initialize(mode: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# Customize manual entry behavior
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry; end
sig {
params(_manual_entry: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry=(_manual_entry); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(filters: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), manual_entry: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
}
def initialize(
filters: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
); end
end
class MandateOptions < Stripe::RequestParams
# The method used to collect offline mandate customer acceptance.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
sig { params(collection_method: T.nilable(String)).void }
def initialize(collection_method: nil); end
end
class Networks < Stripe::RequestParams
# Triggers validations to run across the selected networks
sig { returns(T.nilable(T::Array[String])) }
def requested; end
sig {
params(_requested: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested=(_requested); end
sig { params(requested: T.nilable(T::Array[String])).void }
def initialize(requested: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Additional fields for network related functions
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks; end
sig {
params(_networks: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks=(_networks); end
# Preferred transaction settlement speed
sig { returns(T.nilable(T.any(String, String))) }
def preferred_settlement_speed; end
sig {
params(_preferred_settlement_speed: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred_settlement_speed=(_preferred_settlement_speed); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
sig { returns(T.nilable(String)) }
def target_date; end
sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) }
def target_date=(_target_date); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks), preferred_settlement_speed: T.nilable(T.any(String, String)), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String)).void
}
def initialize(
financial_connections: nil,
mandate_options: nil,
networks: nil,
preferred_settlement_speed: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
); end
end
class WechatPay < Stripe::RequestParams
# The app ID registered with WeChat Pay. Only required when client is ios or android.
sig { returns(T.nilable(String)) }
def app_id; end
sig { params(_app_id: T.nilable(String)).returns(T.nilable(String)) }
def app_id=(_app_id); end
# The client type that the end customer will pay from
sig { returns(T.nilable(String)) }
def client; end
sig { params(_client: T.nilable(String)).returns(T.nilable(String)) }
def client=(_client); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig {
params(app_id: T.nilable(String), client: T.nilable(String), setup_future_usage: T.nilable(String)).void
}
def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
end
class Zip < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
sig { params(setup_future_usage: T.nilable(String)).void }
def initialize(setup_future_usage: nil); end
end
# If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit)))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit)))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Affirm)))
}
def affirm; end
sig {
params(_affirm: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Affirm))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Affirm)))
}
def affirm=(_affirm); end
# If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AfterpayClearpay)))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AfterpayClearpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AfterpayClearpay)))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Alipay)))
}
def alipay; end
sig {
params(_alipay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Alipay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Alipay)))
}
def alipay=(_alipay); end
# If this is a `alma` PaymentMethod, this sub-hash contains details about the Alma payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Alma)))
}
def alma; end
sig {
params(_alma: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Alma))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Alma)))
}
def alma=(_alma); end
# If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AmazonPay)))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AmazonPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AmazonPay)))
}
def amazon_pay=(_amazon_pay); end
# If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AuBecsDebit)))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AuBecsDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AuBecsDebit)))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit)))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit)))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Bancontact)))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Bancontact))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Bancontact)))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this sub-hash contains details about the Billie payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Billie)))
}
def billie; end
sig {
params(_billie: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Billie))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Billie)))
}
def billie=(_billie); end
# If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Blik)))
}
def blik; end
sig {
params(_blik: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Blik))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Blik)))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Boleto)))
}
def boleto; end
sig {
params(_boleto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Boleto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Boleto)))
}
def boleto=(_boleto); end
# Configuration for any card payments attempted on this PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card)))
}
def card; end
sig {
params(_card: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card)))
}
def card=(_card); end
# If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CardPresent)))
}
def card_present; end
sig {
params(_card_present: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CardPresent))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CardPresent)))
}
def card_present=(_card_present); end
# If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Cashapp)))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Cashapp))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Cashapp)))
}
def cashapp=(_cashapp); end
# If this is a `crypto` PaymentMethod, this sub-hash contains details about the Crypto payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Crypto)))
}
def crypto; end
sig {
params(_crypto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Crypto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Crypto)))
}
def crypto=(_crypto); end
# If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CustomerBalance))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance=(_customer_balance); end
# If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Eps)))
}
def eps; end
sig {
params(_eps: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Eps))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Eps)))
}
def eps=(_eps); end
# If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Fpx)))
}
def fpx; end
sig {
params(_fpx: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Fpx))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Fpx)))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Giropay)))
}
def giropay; end
sig {
params(_giropay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Giropay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Giropay)))
}
def giropay=(_giropay); end
# If this is a `gopay` PaymentMethod, this sub-hash contains details about the Gopay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Gopay)))
}
def gopay; end
sig {
params(_gopay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Gopay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Gopay)))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Grabpay)))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Grabpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Grabpay)))
}
def grabpay=(_grabpay); end
# If this is a `id_bank_transfer` PaymentMethod, this sub-hash contains details about the Indonesia Bank Transfer payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::IdBankTransfer))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Ideal)))
}
def ideal; end
sig {
params(_ideal: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Ideal))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Ideal)))
}
def ideal=(_ideal); end
# If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::InteracPresent)))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::InteracPresent))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::InteracPresent)))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::KakaoPay)))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::KakaoPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::KakaoPay)))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna)))
}
def klarna; end
sig {
params(_klarna: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna)))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Konbini)))
}
def konbini; end
sig {
params(_konbini: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Konbini))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Konbini)))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this sub-hash contains details about the KR Card payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::KrCard)))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::KrCard))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::KrCard)))
}
def kr_card=(_kr_card); end
# If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Link)))
}
def link; end
sig {
params(_link: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Link))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Link)))
}
def link=(_link); end
# If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::MbWay)))
}
def mb_way; end
sig {
params(_mb_way: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::MbWay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::MbWay)))
}
def mb_way=(_mb_way); end
# If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Mobilepay)))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Mobilepay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Mobilepay)))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Multibanco)))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Multibanco))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Multibanco)))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this sub-hash contains details about the Naver Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::NaverPay)))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::NaverPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::NaverPay)))
}
def naver_pay=(_naver_pay); end
# If this is a `nz_bank_account` PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::NzBankAccount)))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::NzBankAccount))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::NzBankAccount)))
}
def nz_bank_account=(_nz_bank_account); end
# If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Oxxo)))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Oxxo))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Oxxo)))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::P24)))
}
def p24; end
sig {
params(_p24: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::P24))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::P24)))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this sub-hash contains details about the PayByBank payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::PayByBank)))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::PayByBank))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::PayByBank)))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this sub-hash contains details about the PAYCO payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Payco)))
}
def payco; end
sig {
params(_payco: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Payco))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Payco)))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paynow)))
}
def paynow; end
sig {
params(_paynow: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paynow))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paynow)))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypal)))
}
def paypal; end
sig {
params(_paypal: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypal))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypal)))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this sub-hash contains details about the PayPay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypay)))
}
def paypay; end
sig {
params(_paypay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypay)))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Payto)))
}
def payto; end
sig {
params(_payto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Payto))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Payto)))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Pix)))
}
def pix; end
sig {
params(_pix: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Pix))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Pix)))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Promptpay)))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Promptpay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Promptpay)))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this sub-hash contains details about the QRIS payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Qris)))
}
def qris; end
sig {
params(_qris: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Qris))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Qris)))
}
def qris=(_qris); end
# If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Rechnung)))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Rechnung))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Rechnung)))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::RevolutPay)))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::RevolutPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::RevolutPay)))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SamsungPay)))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SamsungPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SamsungPay)))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Satispay)))
}
def satispay; end
sig {
params(_satispay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Satispay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Satispay)))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit=(_sepa_debit); end
# If this is a `shopeepay` PaymentMethod, this sub-hash contains details about the ShopeePay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Shopeepay)))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Shopeepay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Shopeepay)))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Sofort)))
}
def sofort; end
sig {
params(_sofort: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Sofort))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Sofort)))
}
def sofort=(_sofort); end
# If this is a `stripe_balance` PaymentMethod, this sub-hash contains details about the Stripe Balance payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::StripeBalance)))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::StripeBalance))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::StripeBalance)))
}
def stripe_balance=(_stripe_balance); end
# If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Swish)))
}
def swish; end
sig {
params(_swish: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Swish))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Swish)))
}
def swish=(_swish); end
# If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Twint)))
}
def twint; end
sig {
params(_twint: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Twint))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Twint)))
}
def twint=(_twint); end
# If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
# If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::WechatPay)))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::WechatPay))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::WechatPay)))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Zip)))
}
def zip; end
sig {
params(_zip: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Zip))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Zip)))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit)), affirm: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Affirm)), afterpay_clearpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AfterpayClearpay)), alipay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Alipay)), alma: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Alma)), amazon_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AmazonPay)), au_becs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AuBecsDebit)), bacs_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit)), bancontact: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Bancontact)), billie: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Billie)), blik: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Blik)), boleto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Boleto)), card: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card)), card_present: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CardPresent)), cashapp: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Cashapp)), crypto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Crypto)), customer_balance: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CustomerBalance)), eps: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Eps)), fpx: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Fpx)), giropay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Giropay)), gopay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Gopay)), grabpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Grabpay)), id_bank_transfer: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::IdBankTransfer)), ideal: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Ideal)), interac_present: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::InteracPresent)), kakao_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::KakaoPay)), klarna: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna)), konbini: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Konbini)), kr_card: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::KrCard)), link: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Link)), mb_way: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::MbWay)), mobilepay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Mobilepay)), multibanco: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Multibanco)), naver_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::NaverPay)), nz_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::NzBankAccount)), oxxo: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Oxxo)), p24: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::P24)), pay_by_bank: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::PayByBank)), payco: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Payco)), paynow: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paynow)), paypal: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypal)), paypay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypay)), payto: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Payto)), pix: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Pix)), promptpay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Promptpay)), qris: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Qris)), rechnung: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Rechnung)), revolut_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::RevolutPay)), samsung_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SamsungPay)), satispay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Satispay)), sepa_debit: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit)), shopeepay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Shopeepay)), sofort: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Sofort)), stripe_balance: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::StripeBalance)), swish: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Swish)), twint: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Twint)), us_bank_account: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount)), wechat_pay: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::WechatPay)), zip: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Zip))).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
blik: nil,
boleto: nil,
card: nil,
card_present: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address.
sig { returns(::Stripe::PaymentIntentService::ConfirmParams::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::PaymentIntentService::ConfirmParams::Shipping::Address).returns(::Stripe::PaymentIntentService::ConfirmParams::Shipping::Address)
}
def address=(_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
sig { params(_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def tracking_number=(_tracking_number); end
sig {
params(address: ::Stripe::PaymentIntentService::ConfirmParams::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
}
def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
end
# Provides industry-specific information about the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::AmountDetails)))
}
def amount_details; end
sig {
params(_amount_details: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::AmountDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::AmountDetails)))
}
def amount_details=(_amount_details); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(T.any(String, Integer))) }
def application_fee_amount; end
sig {
params(_application_fee_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def application_fee_amount=(_application_fee_amount); end
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# ID of the ConfirmationToken used to confirm this PaymentIntent.
#
# If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.
sig { returns(T.nilable(String)) }
def confirmation_token; end
sig { params(_confirmation_token: T.nilable(String)).returns(T.nilable(String)) }
def confirmation_token=(_confirmation_token); end
# Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication).
sig { returns(T.nilable(T::Boolean)) }
def error_on_requires_action; end
sig {
params(_error_on_requires_action: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def error_on_requires_action=(_error_on_requires_action); end
# The list of payment method types to exclude from use with this payment.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def excluded_payment_method_types; end
sig {
params(_excluded_payment_method_types: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def excluded_payment_method_types=(_excluded_payment_method_types); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.
sig { returns(T.nilable(String)) }
def fx_quote; end
sig { params(_fx_quote: T.nilable(String)).returns(T.nilable(String)) }
def fx_quote=(_fx_quote); end
# Automations to be run during the PaymentIntent lifecycle
sig { returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::Hooks)) }
def hooks; end
sig {
params(_hooks: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::Hooks)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::Hooks))
}
def hooks=(_hooks); end
# ID of the mandate that's used for this payment.
sig { returns(T.nilable(String)) }
def mandate; end
sig { params(_mandate: T.nilable(String)).returns(T.nilable(String)) }
def mandate=(_mandate); end
# Attribute for param field mandate_data
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::MandateData)))
}
def mandate_data; end
sig {
params(_mandate_data: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::MandateData))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::MandateData)))
}
def mandate_data=(_mandate_data); end
# Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards).
sig { returns(T.nilable(T.any(T::Boolean, String))) }
def off_session; end
sig {
params(_off_session: T.nilable(T.any(T::Boolean, String))).returns(T.nilable(T.any(T::Boolean, String)))
}
def off_session=(_off_session); end
# Provides industry-specific information about the charge.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails)))
}
def payment_details; end
sig {
params(_payment_details: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails)))
}
def payment_details=(_payment_details); end
# ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent.
# If the payment method is attached to a Customer, it must match the [customer](https://stripe.com/docs/api#create_payment_intent-customer) that is set on this PaymentIntent.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
# in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)
# property on the PaymentIntent.
sig { returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData)) }
def payment_method_data; end
sig {
params(_payment_method_data: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData))
}
def payment_method_data=(_payment_method_data); end
# Payment method-specific configuration for this PaymentIntent.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (for example, a card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
# Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).
sig { returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::RadarOptions)) }
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::RadarOptions)).returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::RadarOptions))
}
def radar_options=(_radar_options); end
# Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
sig { returns(T.nilable(String)) }
def receipt_email; end
sig { params(_receipt_email: T.nilable(String)).returns(T.nilable(String)) }
def receipt_email=(_receipt_email); end
# The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
# If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
# This parameter is only used for cards and other redirect-based payment methods.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
sig { returns(T.nilable(T.any(String, String))) }
def setup_future_usage; end
sig {
params(_setup_future_usage: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def setup_future_usage=(_setup_future_usage); end
# Shipping information for this PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::Shipping)))
}
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::Shipping))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::Shipping)))
}
def shipping=(_shipping); end
# Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
sig { returns(T.nilable(T::Boolean)) }
def use_stripe_sdk; end
sig { params(_use_stripe_sdk: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def use_stripe_sdk=(_use_stripe_sdk); end
sig {
params(amount_details: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::AmountDetails)), application_fee_amount: T.nilable(T.any(String, Integer)), capture_method: T.nilable(String), confirmation_token: T.nilable(String), error_on_requires_action: T.nilable(T::Boolean), excluded_payment_method_types: T.nilable(T.any(String, T::Array[String])), expand: T.nilable(T::Array[String]), fx_quote: T.nilable(String), hooks: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::Hooks), mandate: T.nilable(String), mandate_data: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::MandateData)), off_session: T.nilable(T.any(T::Boolean, String)), payment_details: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentDetails)), payment_method: T.nilable(String), payment_method_data: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), radar_options: T.nilable(::Stripe::PaymentIntentService::ConfirmParams::RadarOptions), receipt_email: T.nilable(String), return_url: T.nilable(String), setup_future_usage: T.nilable(T.any(String, String)), shipping: T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::Shipping)), use_stripe_sdk: T.nilable(T::Boolean)).void
}
def initialize(
amount_details: nil,
application_fee_amount: nil,
capture_method: nil,
confirmation_token: nil,
error_on_requires_action: nil,
excluded_payment_method_types: nil,
expand: nil,
fx_quote: nil,
hooks: nil,
mandate: nil,
mandate_data: nil,
off_session: nil,
payment_details: nil,
payment_method: nil,
payment_method_data: nil,
payment_method_options: nil,
payment_method_types: nil,
radar_options: nil,
receipt_email: nil,
return_url: nil,
setup_future_usage: nil,
shipping: nil,
use_stripe_sdk: nil
); end
end
class DecrementAuthorizationParams < Stripe::RequestParams
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
sig { returns(String) }
def calculation; end
sig { params(_calculation: String).returns(String) }
def calculation=(_calculation); end
sig { params(calculation: String).void }
def initialize(calculation: nil); end
end
# Tax arguments for automations
sig {
returns(T.nilable(::Stripe::PaymentIntentService::DecrementAuthorizationParams::Hooks::Inputs::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntentService::DecrementAuthorizationParams::Hooks::Inputs::Tax)).returns(T.nilable(::Stripe::PaymentIntentService::DecrementAuthorizationParams::Hooks::Inputs::Tax))
}
def tax=(_tax); end
sig {
params(tax: T.nilable(::Stripe::PaymentIntentService::DecrementAuthorizationParams::Hooks::Inputs::Tax)).void
}
def initialize(tax: nil); end
end
# Arguments passed in automations
sig {
returns(T.nilable(::Stripe::PaymentIntentService::DecrementAuthorizationParams::Hooks::Inputs))
}
def inputs; end
sig {
params(_inputs: T.nilable(::Stripe::PaymentIntentService::DecrementAuthorizationParams::Hooks::Inputs)).returns(T.nilable(::Stripe::PaymentIntentService::DecrementAuthorizationParams::Hooks::Inputs))
}
def inputs=(_inputs); end
sig {
params(inputs: T.nilable(::Stripe::PaymentIntentService::DecrementAuthorizationParams::Hooks::Inputs)).void
}
def initialize(inputs: nil); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
sig { params(amount: T.nilable(Integer)).void }
def initialize(amount: nil); end
end
# The updated total amount that you intend to collect from the cardholder. This amount must be smaller than the currently authorized amount and greater than the already captured amount.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Automations to be run during the PaymentIntent lifecycle
sig {
returns(T.nilable(::Stripe::PaymentIntentService::DecrementAuthorizationParams::Hooks))
}
def hooks; end
sig {
params(_hooks: T.nilable(::Stripe::PaymentIntentService::DecrementAuthorizationParams::Hooks)).returns(T.nilable(::Stripe::PaymentIntentService::DecrementAuthorizationParams::Hooks))
}
def hooks=(_hooks); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The parameters used to automatically create a transfer after the payment is captured.
# Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig {
returns(T.nilable(::Stripe::PaymentIntentService::DecrementAuthorizationParams::TransferData))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::PaymentIntentService::DecrementAuthorizationParams::TransferData)).returns(T.nilable(::Stripe::PaymentIntentService::DecrementAuthorizationParams::TransferData))
}
def transfer_data=(_transfer_data); end
sig {
params(amount: Integer, application_fee_amount: T.nilable(Integer), description: T.nilable(String), expand: T.nilable(T::Array[String]), hooks: T.nilable(::Stripe::PaymentIntentService::DecrementAuthorizationParams::Hooks), metadata: T.nilable(T::Hash[String, String]), transfer_data: T.nilable(::Stripe::PaymentIntentService::DecrementAuthorizationParams::TransferData)).void
}
def initialize(
amount: nil,
application_fee_amount: nil,
description: nil,
expand: nil,
hooks: nil,
metadata: nil,
transfer_data: nil
); end
end
class IncrementAuthorizationParams < Stripe::RequestParams
class AmountDetails < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class Card < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class CardPresent < Stripe::RequestParams
# Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
sig { returns(T.nilable(String)) }
def commodity_code; end
sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) }
def commodity_code=(_commodity_code); end
sig { params(commodity_code: T.nilable(String)).void }
def initialize(commodity_code: nil); end
end
class Klarna < Stripe::RequestParams
# URL to an image for the product. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def image_url; end
sig { params(_image_url: T.nilable(String)).returns(T.nilable(String)) }
def image_url=(_image_url); end
# URL to the product page. Max length, 4096 characters.
sig { returns(T.nilable(String)) }
def product_url; end
sig { params(_product_url: T.nilable(String)).returns(T.nilable(String)) }
def product_url=(_product_url); end
# Reference for the subscription this line item is for.
sig { returns(T.nilable(String)) }
def subscription_reference; end
sig { params(_subscription_reference: T.nilable(String)).returns(T.nilable(String)) }
def subscription_reference=(_subscription_reference); end
sig {
params(image_url: T.nilable(String), product_url: T.nilable(String), subscription_reference: T.nilable(String)).void
}
def initialize(image_url: nil, product_url: nil, subscription_reference: nil); end
end
class Paypal < Stripe::RequestParams
# Type of the line item.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# Description of the line item.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The Stripe account ID of the connected account that sells the item.
sig { returns(T.nilable(String)) }
def sold_by; end
sig { params(_sold_by: T.nilable(String)).returns(T.nilable(String)) }
def sold_by=(_sold_by); end
sig {
params(category: T.nilable(String), description: T.nilable(String), sold_by: T.nilable(String)).void
}
def initialize(category: nil, description: nil, sold_by: nil); end
end
# This sub-hash contains line item details that are specific to `card` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Card))
}
def card=(_card); end
# This sub-hash contains line item details that are specific to `card_present` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent))
}
def card_present=(_card_present); end
# This sub-hash contains line item details that are specific to `klarna` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# This sub-hash contains line item details that are specific to `paypal` payment method."
sig {
returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
sig {
params(card: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent), klarna: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna), paypal: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)).void
}
def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end
end
class Tax < Stripe::RequestParams
# The total tax on an item. Non-negative integer.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The amount an item was discounted for. Positive integer.
sig { returns(T.nilable(Integer)) }
def discount_amount; end
sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def discount_amount=(_discount_amount); end
# Payment method-specific information for line items.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# Unique identifier of the product. At most 12 characters long.
sig { returns(T.nilable(String)) }
def product_code; end
sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) }
def product_code=(_product_code); end
# Name of the product. At most 100 characters long.
sig { returns(String) }
def product_name; end
sig { params(_product_name: String).returns(String) }
def product_name=(_product_name); end
# Number of items of the product. Positive integer.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
# Contains information about the tax on the item.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::Tax)).returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::Tax))
}
def tax=(_tax); end
# Cost of the product. Non-negative integer.
sig { returns(Integer) }
def unit_cost; end
sig { params(_unit_cost: Integer).returns(Integer) }
def unit_cost=(_unit_cost); end
# A unit of measure for the line item, such as gallons, feet, meters, etc.
sig { returns(T.nilable(String)) }
def unit_of_measure; end
sig { params(_unit_of_measure: T.nilable(String)).returns(T.nilable(String)) }
def unit_of_measure=(_unit_of_measure); end
sig {
params(discount_amount: T.nilable(Integer), payment_method_options: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions), product_code: T.nilable(String), product_name: String, quantity: Integer, tax: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem::Tax), unit_cost: Integer, unit_of_measure: T.nilable(String)).void
}
def initialize(
discount_amount: nil,
payment_method_options: nil,
product_code: nil,
product_name: nil,
quantity: nil,
tax: nil,
unit_cost: nil,
unit_of_measure: nil
); end
end
class Shipping < Stripe::RequestParams
# Portion of the amount that is for shipping.
sig { returns(T.nilable(T.any(String, Integer))) }
def amount; end
sig {
params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def amount=(_amount); end
# The postal code that represents the shipping source.
sig { returns(T.nilable(String)) }
def from_postal_code; end
sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def from_postal_code=(_from_postal_code); end
# The postal code that represents the shipping destination.
sig { returns(T.nilable(String)) }
def to_postal_code; end
sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def to_postal_code=(_to_postal_code); end
sig {
params(amount: T.nilable(T.any(String, Integer)), from_postal_code: T.nilable(String), to_postal_code: T.nilable(String)).void
}
def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end
end
class Tax < Stripe::RequestParams
# Total portion of the amount that is for tax.
sig { returns(Integer) }
def total_tax_amount; end
sig { params(_total_tax_amount: Integer).returns(Integer) }
def total_tax_amount=(_total_tax_amount); end
sig { params(total_tax_amount: Integer).void }
def initialize(total_tax_amount: nil); end
end
# The total discount applied on the transaction.
sig { returns(T.nilable(T.any(String, Integer))) }
def discount_amount; end
sig {
params(_discount_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def discount_amount=(_discount_amount); end
# A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem])))
}
def line_items; end
sig {
params(_line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem])))
}
def line_items=(_line_items); end
# Contains information about the shipping portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::Shipping)))
}
def shipping; end
sig {
params(_shipping: T.nilable(T.any(String, ::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::Shipping))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::Shipping)))
}
def shipping=(_shipping); end
# Contains information about the tax portion of the amount.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::Tax)))
}
def tax; end
sig {
params(_tax: T.nilable(T.any(String, ::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::Tax))).returns(T.nilable(T.any(String, ::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::Tax)))
}
def tax=(_tax); end
sig {
params(discount_amount: T.nilable(T.any(String, Integer)), line_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::LineItem])), shipping: T.nilable(T.any(String, ::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::Shipping)), tax: T.nilable(T.any(String, ::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails::Tax))).void
}
def initialize(discount_amount: nil, line_items: nil, shipping: nil, tax: nil); end
end
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
sig { returns(String) }
def calculation; end
sig { params(_calculation: String).returns(String) }
def calculation=(_calculation); end
sig { params(calculation: String).void }
def initialize(calculation: nil); end
end
# Tax arguments for automations
sig {
returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::Hooks::Inputs::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::Hooks::Inputs::Tax)).returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::Hooks::Inputs::Tax))
}
def tax=(_tax); end
sig {
params(tax: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::Hooks::Inputs::Tax)).void
}
def initialize(tax: nil); end
end
# Arguments passed in automations
sig {
returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::Hooks::Inputs))
}
def inputs; end
sig {
params(_inputs: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::Hooks::Inputs)).returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::Hooks::Inputs))
}
def inputs=(_inputs); end
sig {
params(inputs: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::Hooks::Inputs)).void
}
def initialize(inputs: nil); end
end
class PaymentDetails < Stripe::RequestParams
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
sig { returns(T.nilable(String)) }
def customer_reference; end
sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) }
def customer_reference=(_customer_reference); end
# A unique value assigned by the business to identify the transaction.
sig { returns(T.nilable(String)) }
def order_reference; end
sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) }
def order_reference=(_order_reference); end
sig {
params(customer_reference: T.nilable(String), order_reference: T.nilable(String)).void
}
def initialize(customer_reference: nil, order_reference: nil); end
end
class PaymentMethodOptions < Stripe::RequestParams
class Card < Stripe::RequestParams
# Request partial authorization on this PaymentIntent.
sig { returns(T.nilable(String)) }
def request_partial_authorization; end
sig {
params(_request_partial_authorization: T.nilable(String)).returns(T.nilable(String))
}
def request_partial_authorization=(_request_partial_authorization); end
sig { params(request_partial_authorization: T.nilable(String)).void }
def initialize(request_partial_authorization: nil); end
end
# Configuration for any card payments attempted on this PaymentIntent.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::PaymentMethodOptions::Card))
}
def card=(_card); end
sig {
params(card: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::PaymentMethodOptions::Card)).void
}
def initialize(card: nil); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
sig { params(amount: T.nilable(Integer)).void }
def initialize(amount: nil); end
end
# The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Provides industry-specific information about the amount.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails))
}
def amount_details; end
sig {
params(_amount_details: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails)).returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails))
}
def amount_details=(_amount_details); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Automations to be run during the PaymentIntent lifecycle
sig {
returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::Hooks))
}
def hooks; end
sig {
params(_hooks: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::Hooks)).returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::Hooks))
}
def hooks=(_hooks); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Provides industry-specific information about the charge.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::PaymentDetails))
}
def payment_details; end
sig {
params(_payment_details: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::PaymentDetails)).returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::PaymentDetails))
}
def payment_details=(_payment_details); end
# Payment method-specific configuration for this PaymentIntent.
sig {
returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# The parameters used to automatically create a transfer after the payment is captured.
# Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
sig {
returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::TransferData))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::TransferData)).returns(T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::TransferData))
}
def transfer_data=(_transfer_data); end
sig {
params(amount: Integer, amount_details: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::AmountDetails), application_fee_amount: T.nilable(Integer), description: T.nilable(String), expand: T.nilable(T::Array[String]), hooks: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::Hooks), metadata: T.nilable(T::Hash[String, String]), payment_details: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::PaymentDetails), payment_method_options: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::PaymentMethodOptions), statement_descriptor: T.nilable(String), transfer_data: T.nilable(::Stripe::PaymentIntentService::IncrementAuthorizationParams::TransferData)).void
}
def initialize(
amount: nil,
amount_details: nil,
application_fee_amount: nil,
description: nil,
expand: nil,
hooks: nil,
metadata: nil,
payment_details: nil,
payment_method_options: nil,
statement_descriptor: nil,
transfer_data: nil
); end
end
class VerifyMicrodepositsParams < Stripe::RequestParams
# Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.
sig { returns(T.nilable(T::Array[Integer])) }
def amounts; end
sig { params(_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer])) }
def amounts=(_amounts); end
# A six-character code starting with SM present in the microdeposit sent to the bank account.
sig { returns(T.nilable(String)) }
def descriptor_code; end
sig { params(_descriptor_code: T.nilable(String)).returns(T.nilable(String)) }
def descriptor_code=(_descriptor_code); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(amounts: T.nilable(T::Array[Integer]), descriptor_code: T.nilable(String), expand: T.nilable(T::Array[String])).void
}
def initialize(amounts: nil, descriptor_code: nil, expand: nil); end
end
class TriggerActionParams < Stripe::RequestParams
class ScanQrCode < Stripe::RequestParams
# Whether the QR Code scan's payment should succeed or fail.
sig { returns(T.nilable(String)) }
def result; end
sig { params(_result: T.nilable(String)).returns(T.nilable(String)) }
def result=(_result); end
sig { params(result: T.nilable(String)).void }
def initialize(result: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# True to simulate success, false to simulate failure.
sig { returns(T.nilable(::Stripe::PaymentIntentService::TriggerActionParams::ScanQrCode)) }
def scan_qr_code; end
sig {
params(_scan_qr_code: T.nilable(::Stripe::PaymentIntentService::TriggerActionParams::ScanQrCode)).returns(T.nilable(::Stripe::PaymentIntentService::TriggerActionParams::ScanQrCode))
}
def scan_qr_code=(_scan_qr_code); end
# The type of action to be simulated.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(expand: T.nilable(T::Array[String]), scan_qr_code: T.nilable(::Stripe::PaymentIntentService::TriggerActionParams::ScanQrCode), type: String).void
}
def initialize(expand: nil, scan_qr_code: nil, type: nil); end
end
# Manually reconcile the remaining amount for a customer_balance PaymentIntent.
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntentService::ApplyCustomerBalanceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def apply_customer_balance(intent, params = {}, opts = {}); end
# You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://docs.stripe.com/docs/payments/intents), processing.
#
# After it's canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.
#
# You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead.
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntentService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def cancel(intent, params = {}, opts = {}); end
# Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.
#
# Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.
#
# Learn more about [separate authorization and capture](https://docs.stripe.com/docs/payments/capture-later).
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntentService::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def capture(intent, params = {}, opts = {}); end
# Confirm that your customer intends to pay with current or provided
# payment method. Upon confirmation, the PaymentIntent will attempt to initiate
# a payment.
#
# If the selected payment method requires additional authentication steps, the
# PaymentIntent will transition to the requires_action status and
# suggest additional actions via next_action. If payment fails,
# the PaymentIntent transitions to the requires_payment_method status or the
# canceled status if the confirmation limit is reached. If
# payment succeeds, the PaymentIntent will transition to the succeeded
# status (or requires_capture, if capture_method is set to manual).
#
# If the confirmation_method is automatic, payment may be attempted
# using our [client SDKs](https://docs.stripe.com/docs/stripe-js/reference#stripe-handle-card-payment)
# and the PaymentIntent's [client_secret](https://docs.stripe.com/api#payment_intent_object-client_secret).
# After next_actions are handled by the client, no additional
# confirmation is required to complete the payment.
#
# If the confirmation_method is manual, all payment attempts must be
# initiated using a secret key.
#
# If any actions are required for the payment, the PaymentIntent will
# return to the requires_confirmation state
# after those actions are completed. Your server needs to then
# explicitly re-confirm the PaymentIntent to initiate the next payment
# attempt.
#
# There is a variable upper limit on how many times a PaymentIntent can be confirmed.
# After this limit is reached, any further calls to this endpoint will
# transition the PaymentIntent to the canceled state.
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntentService::ConfirmParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def confirm(intent, params = {}, opts = {}); end
# Creates a PaymentIntent object.
#
# After the PaymentIntent is created, attach a payment method and [confirm](https://docs.stripe.com/docs/api/payment_intents/confirm)
# to continue the payment. Learn more about the available payment flows
# with the Payment Intents API.
#
# When you use confirm=true during creation, it's equivalent to creating
# and confirming the PaymentIntent in the same call. You can use any parameters
# available in the [confirm API](https://docs.stripe.com/docs/api/payment_intents/confirm) when you supply
# confirm=true.
sig {
params(params: T.any(::Stripe::PaymentIntentService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def create(params = {}, opts = {}); end
# Perform a decremental authorization on an eligible
# [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the
# PaymentIntent's status must be requires_capture and
# [decremental_authorization.status](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization)
# must be available.
#
# Decremental authorizations decrease the authorized amount on your customer's card
# to the new, lower amount provided. A single PaymentIntent can call this endpoint multiple times to further decrease the authorized amount.
#
# After decrement, the PaymentIntent object
# returns with the updated
# [amount](https://docs.stripe.com/docs/api/payment_intents/object#payment_intent_object-amount).
# The PaymentIntent will now be capturable up to the new authorized amount.
#
# Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines.
# After it's fully captured, a PaymentIntent can no longer be decremented.
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntentService::DecrementAuthorizationParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def decrement_authorization(intent, params = {}, opts = {}); end
# Perform an incremental authorization on an eligible
# [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the
# PaymentIntent's status must be requires_capture and
# [incremental_authorization_supported](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported)
# must be true.
#
# Incremental authorizations attempt to increase the authorized amount on
# your customer's card to the new, higher amount provided. Similar to the
# initial authorization, incremental authorizations can be declined. A
# single PaymentIntent can call this endpoint multiple times to further
# increase the authorized amount.
#
# If the incremental authorization succeeds, the PaymentIntent object
# returns with the updated
# [amount](https://docs.stripe.com/docs/api/payment_intents/object#payment_intent_object-amount).
# If the incremental authorization fails, a
# [card_declined](https://docs.stripe.com/docs/error-codes#card-declined) error returns, and no other
# fields on the PaymentIntent or Charge update. The PaymentIntent
# object remains capturable for the previously authorized amount.
#
# Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.
# After it's captured, a PaymentIntent can no longer be incremented.
#
# Learn more about [incremental authorizations](https://docs.stripe.com/docs/terminal/features/incremental-authorizations).
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntentService::IncrementAuthorizationParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def increment_authorization(intent, params = {}, opts = {}); end
# Returns a list of PaymentIntents.
sig {
params(params: T.any(::Stripe::PaymentIntentService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of a PaymentIntent that has previously been created.
#
# You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.
#
# If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the [payment intent](https://docs.stripe.com/api#payment_intent_object) object reference for more details.
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntentService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def retrieve(intent, params = {}, opts = {}); end
# Search for PaymentIntents 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.
sig {
params(params: T.any(::Stripe::PaymentIntentService::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
}
def search(params = {}, opts = {}); end
# Trigger an external action on a PaymentIntent.
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntentService::TriggerActionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def trigger_action(intent, params = {}, opts = {}); end
# Updates properties on a PaymentIntent object without confirming.
#
# Depending on which properties you update, you might need to confirm the
# PaymentIntent again. For example, updating the payment_method
# always requires you to confirm the PaymentIntent again. If you prefer to
# update and confirm at the same time, we recommend updating properties through
# the [confirm API](https://docs.stripe.com/docs/api/payment_intents/confirm) instead.
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntentService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def update(intent, params = {}, opts = {}); end
# Verifies microdeposits on a PaymentIntent object.
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntentService::VerifyMicrodepositsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent)
}
def verify_microdeposits(intent, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class PaymentIntentAmountDetailsLineItemService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Lists all LineItems of a given PaymentIntent.
sig {
params(intent: String, params: T.any(::Stripe::PaymentIntentAmountDetailsLineItemService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(intent, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class PaymentLinkService < StripeService
attr_reader :line_items
class ListParams < Stripe::RequestParams
# Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links).
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(active: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
active: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class AfterCompletion < Stripe::RequestParams
class HostedConfirmation < Stripe::RequestParams
# A custom message to display to the customer after the purchase is complete.
sig { returns(T.nilable(String)) }
def custom_message; end
sig { params(_custom_message: T.nilable(String)).returns(T.nilable(String)) }
def custom_message=(_custom_message); end
sig { params(custom_message: T.nilable(String)).void }
def initialize(custom_message: nil); end
end
class Redirect < Stripe::RequestParams
# The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-id) included.
sig { returns(String) }
def url; end
sig { params(_url: String).returns(String) }
def url=(_url); end
sig { params(url: String).void }
def initialize(url: nil); end
end
# Configuration when `type=hosted_confirmation`.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::HostedConfirmation))
}
def hosted_confirmation; end
sig {
params(_hosted_confirmation: T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::HostedConfirmation)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::HostedConfirmation))
}
def hosted_confirmation=(_hosted_confirmation); end
# Configuration when `type=redirect`.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::Redirect))
}
def redirect; end
sig {
params(_redirect: T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::Redirect)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::Redirect))
}
def redirect=(_redirect); end
# The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(hosted_confirmation: T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::HostedConfirmation), redirect: T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::Redirect), type: String).void
}
def initialize(hosted_confirmation: nil, redirect: nil, type: nil); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
#
# Enabling this parameter causes the payment link to collect any billing address information necessary for tax calculation.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::PaymentLinkService::CreateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::PaymentLinkService::CreateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class ConsentCollection < Stripe::RequestParams
class PaymentMethodReuseAgreement < Stripe::RequestParams
# Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's
# defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
sig { returns(String) }
def position; end
sig { params(_position: String).returns(String) }
def position=(_position); end
sig { params(position: String).void }
def initialize(position: nil); end
end
# Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement))
}
def payment_method_reuse_agreement; end
sig {
params(_payment_method_reuse_agreement: T.nilable(::Stripe::PaymentLinkService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement))
}
def payment_method_reuse_agreement=(_payment_method_reuse_agreement); end
# If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
# Session will determine whether to display an option to opt into promotional communication
# from the merchant depending on the customer's locale. Only available to US merchants.
sig { returns(T.nilable(String)) }
def promotions; end
sig { params(_promotions: T.nilable(String)).returns(T.nilable(String)) }
def promotions=(_promotions); end
# If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
# There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
sig { returns(T.nilable(String)) }
def terms_of_service; end
sig { params(_terms_of_service: T.nilable(String)).returns(T.nilable(String)) }
def terms_of_service=(_terms_of_service); end
sig {
params(payment_method_reuse_agreement: T.nilable(::Stripe::PaymentLinkService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement), promotions: T.nilable(String), terms_of_service: T.nilable(String)).void
}
def initialize(
payment_method_reuse_agreement: nil,
promotions: nil,
terms_of_service: nil
); end
end
class CustomField < Stripe::RequestParams
class Dropdown < Stripe::RequestParams
class Option < Stripe::RequestParams
# The label for the option, displayed to the customer. Up to 100 characters.
sig { returns(String) }
def label; end
sig { params(_label: String).returns(String) }
def label=(_label); end
# The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(label: String, value: String).void }
def initialize(label: nil, value: nil); end
end
# The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The options available for the customer to select. Up to 200 options allowed.
sig {
returns(T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown::Option])
}
def options; end
sig {
params(_options: T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown::Option]).returns(T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown::Option])
}
def options=(_options); end
sig {
params(default_value: T.nilable(String), options: T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown::Option]).void
}
def initialize(default_value: nil, options: nil); end
end
class Label < Stripe::RequestParams
# Custom text for the label, displayed to the customer. Up to 50 characters.
sig { returns(String) }
def custom; end
sig { params(_custom: String).returns(String) }
def custom=(_custom); end
# The type of the label.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(custom: String, type: String).void }
def initialize(custom: nil, type: nil); end
end
class Numeric < Stripe::RequestParams
# The value that will pre-fill the field on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The maximum character length constraint for the customer's input.
sig { returns(T.nilable(Integer)) }
def maximum_length; end
sig { params(_maximum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_length=(_maximum_length); end
# The minimum character length requirement for the customer's input.
sig { returns(T.nilable(Integer)) }
def minimum_length; end
sig { params(_minimum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_length=(_minimum_length); end
sig {
params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
}
def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
end
class Text < Stripe::RequestParams
# The value that will pre-fill the field on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The maximum character length constraint for the customer's input.
sig { returns(T.nilable(Integer)) }
def maximum_length; end
sig { params(_maximum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_length=(_maximum_length); end
# The minimum character length requirement for the customer's input.
sig { returns(T.nilable(Integer)) }
def minimum_length; end
sig { params(_minimum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_length=(_minimum_length); end
sig {
params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
}
def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
end
# Configuration for `type=dropdown` fields.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown))
}
def dropdown; end
sig {
params(_dropdown: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown))
}
def dropdown=(_dropdown); end
# String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
sig { returns(String) }
def key; end
sig { params(_key: String).returns(String) }
def key=(_key); end
# The label for the field, displayed to the customer.
sig { returns(::Stripe::PaymentLinkService::CreateParams::CustomField::Label) }
def label; end
sig {
params(_label: ::Stripe::PaymentLinkService::CreateParams::CustomField::Label).returns(::Stripe::PaymentLinkService::CreateParams::CustomField::Label)
}
def label=(_label); end
# Configuration for `type=numeric` fields.
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Numeric)) }
def numeric; end
sig {
params(_numeric: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Numeric)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Numeric))
}
def numeric=(_numeric); end
# Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def optional; end
sig { params(_optional: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def optional=(_optional); end
# Configuration for `type=text` fields.
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Text)) }
def text; end
sig {
params(_text: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Text)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Text))
}
def text=(_text); end
# The type of the field.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(dropdown: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown), key: String, label: ::Stripe::PaymentLinkService::CreateParams::CustomField::Label, numeric: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Numeric), optional: T.nilable(T::Boolean), text: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Text), type: String).void
}
def initialize(
dropdown: nil,
key: nil,
label: nil,
numeric: nil,
optional: nil,
text: nil,
type: nil
); end
end
class CustomText < Stripe::RequestParams
class AfterSubmit < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class ShippingAddress < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class Submit < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class TermsOfServiceAcceptance < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
# Custom text that should be displayed after the payment confirmation button.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::AfterSubmit)))
}
def after_submit; end
sig {
params(_after_submit: T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::AfterSubmit))).returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::AfterSubmit)))
}
def after_submit=(_after_submit); end
# Custom text that should be displayed alongside shipping address collection.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::ShippingAddress)))
}
def shipping_address; end
sig {
params(_shipping_address: T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::ShippingAddress))).returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::ShippingAddress)))
}
def shipping_address=(_shipping_address); end
# Custom text that should be displayed alongside the payment confirmation button.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::Submit)))
}
def submit; end
sig {
params(_submit: T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::Submit))).returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::Submit)))
}
def submit=(_submit); end
# Custom text that should be displayed in place of the default terms of service agreement text.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::TermsOfServiceAcceptance)))
}
def terms_of_service_acceptance; end
sig {
params(_terms_of_service_acceptance: T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::TermsOfServiceAcceptance))).returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::TermsOfServiceAcceptance)))
}
def terms_of_service_acceptance=(_terms_of_service_acceptance); end
sig {
params(after_submit: T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::AfterSubmit)), shipping_address: T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::ShippingAddress)), submit: T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::Submit)), terms_of_service_acceptance: T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::TermsOfServiceAcceptance))).void
}
def initialize(
after_submit: nil,
shipping_address: nil,
submit: nil,
terms_of_service_acceptance: nil
); end
end
class InvoiceCreation < Stripe::RequestParams
class InvoiceData < Stripe::RequestParams
class CustomField < Stripe::RequestParams
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The value of the custom field. This may be up to 140 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
class RenderingOptions < Stripe::RequestParams
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(T.any(String, String))) }
def amount_tax_display; end
sig {
params(_amount_tax_display: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def amount_tax_display=(_amount_tax_display); end
# ID of the invoice rendering template to use for this invoice.
sig { returns(T.nilable(String)) }
def template; end
sig { params(_template: T.nilable(String)).returns(T.nilable(String)) }
def template=(_template); end
sig {
params(amount_tax_display: T.nilable(T.any(String, String)), template: T.nilable(String)).void
}
def initialize(amount_tax_display: nil, template: nil); end
end
# The account tax IDs associated with the invoice.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# Default custom fields to be displayed on invoices for this customer.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::CustomField])))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::CustomField]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::CustomField])))
}
def custom_fields=(_custom_fields); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Default footer to be displayed on invoices for this customer.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::Issuer)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::Issuer))
}
def issuer=(_issuer); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Default options for invoice PDF rendering for this customer.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)))
}
def rendering_options; end
sig {
params(_rendering_options: T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))).returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)))
}
def rendering_options=(_rendering_options); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), custom_fields: T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::CustomField])), description: T.nilable(String), footer: T.nilable(String), issuer: T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::Issuer), metadata: T.nilable(T.any(String, T::Hash[String, String])), rendering_options: T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))).void
}
def initialize(
account_tax_ids: nil,
custom_fields: nil,
description: nil,
footer: nil,
issuer: nil,
metadata: nil,
rendering_options: nil
); end
end
# Whether the feature is enabled
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Invoice PDF configuration.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData))
}
def invoice_data; end
sig {
params(_invoice_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData))
}
def invoice_data=(_invoice_data); end
sig {
params(enabled: T::Boolean, invoice_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData)).void
}
def initialize(enabled: nil, invoice_data: nil); end
end
class LineItem < Stripe::RequestParams
class AdjustableQuantity < Stripe::RequestParams
# Set to true if the quantity can be adjusted to any non-negative Integer.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil); end
end
class PriceData < Stripe::RequestParams
class ProductData < Stripe::RequestParams
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T::Array[String])) }
def images; end
sig {
params(_images: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def images=(_images); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
sig {
params(description: T.nilable(String), images: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: String, tax_code: T.nilable(String), unit_label: T.nilable(String)).void
}
def initialize(
description: nil,
images: nil,
metadata: nil,
name: nil,
tax_code: nil,
unit_label: nil
); end
end
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::PriceData::ProductData))
}
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::PriceData::ProductData)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::PriceData::ProductData))
}
def product_data=(_product_data); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::PriceData::Recurring))
}
def recurring; end
sig {
params(_recurring: T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::PriceData::Recurring)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::PriceData::Recurring))
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: T.nilable(String), product_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::PriceData::ProductData), recurring: T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::PriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
product_data: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::AdjustableQuantity))
}
def adjustable_quantity; end
sig {
params(_adjustable_quantity: T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::AdjustableQuantity)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::AdjustableQuantity))
}
def adjustable_quantity=(_adjustable_quantity); end
# The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::PriceData)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::PriceData))
}
def price_data=(_price_data); end
# The quantity of the line item being purchased.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
sig {
params(adjustable_quantity: T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::AdjustableQuantity), price: T.nilable(String), price_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::PriceData), quantity: Integer).void
}
def initialize(adjustable_quantity: nil, price: nil, price_data: nil, quantity: nil); end
end
class OptionalItem < Stripe::RequestParams
class AdjustableQuantity < Stripe::RequestParams
# Set to true if the quantity can be adjusted to any non-negative integer.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum quantity of this item the customer can purchase. By default this value is 99.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil); end
end
# When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::OptionalItem::AdjustableQuantity))
}
def adjustable_quantity; end
sig {
params(_adjustable_quantity: T.nilable(::Stripe::PaymentLinkService::CreateParams::OptionalItem::AdjustableQuantity)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::OptionalItem::AdjustableQuantity))
}
def adjustable_quantity=(_adjustable_quantity); end
# The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# The initial quantity of the line item created when a customer chooses to add this optional item to their order.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
sig {
params(adjustable_quantity: T.nilable(::Stripe::PaymentLinkService::CreateParams::OptionalItem::AdjustableQuantity), price: String, quantity: Integer).void
}
def initialize(adjustable_quantity: nil, price: nil, quantity: nil); end
end
class PaymentIntentData < Stripe::RequestParams
# Controls when the funds will be captured from the customer's account.
sig { returns(T.nilable(String)) }
def capture_method; end
sig { params(_capture_method: T.nilable(String)).returns(T.nilable(String)) }
def capture_method=(_capture_method); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session.
#
# When setting this to `on_session`, Checkout will show a notice to the customer that their payment details will be saved.
#
# When setting this to `off_session`, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.
#
# If a Customer has been provided or Checkout creates a new Customer,Checkout will attach the payment method to the Customer.
#
# If Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.
#
# When processing card payments, Checkout also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(capture_method: T.nilable(String), description: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), setup_future_usage: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_group: T.nilable(String)).void
}
def initialize(
capture_method: nil,
description: nil,
metadata: nil,
setup_future_usage: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_group: nil
); end
end
class PhoneNumberCollection < Stripe::RequestParams
# Set to `true` to enable phone number collection.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class Restrictions < Stripe::RequestParams
class CompletedSessions < Stripe::RequestParams
# The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.
sig { returns(Integer) }
def limit; end
sig { params(_limit: Integer).returns(Integer) }
def limit=(_limit); end
sig { params(limit: Integer).void }
def initialize(limit: nil); end
end
# Configuration for the `completed_sessions` restriction type.
sig { returns(::Stripe::PaymentLinkService::CreateParams::Restrictions::CompletedSessions) }
def completed_sessions; end
sig {
params(_completed_sessions: ::Stripe::PaymentLinkService::CreateParams::Restrictions::CompletedSessions).returns(::Stripe::PaymentLinkService::CreateParams::Restrictions::CompletedSessions)
}
def completed_sessions=(_completed_sessions); end
sig {
params(completed_sessions: ::Stripe::PaymentLinkService::CreateParams::Restrictions::CompletedSessions).void
}
def initialize(completed_sessions: nil); end
end
class ShippingAddressCollection < Stripe::RequestParams
# An array of two-letter ISO country codes representing which countries Checkout should provide as options for
# shipping locations.
sig { returns(T::Array[String]) }
def allowed_countries; end
sig { params(_allowed_countries: T::Array[String]).returns(T::Array[String]) }
def allowed_countries=(_allowed_countries); end
sig { params(allowed_countries: T::Array[String]).void }
def initialize(allowed_countries: nil); end
end
class ShippingOption < Stripe::RequestParams
# The ID of the Shipping Rate to use for this shipping option.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
sig { params(shipping_rate: T.nilable(String)).void }
def initialize(shipping_rate: nil); end
end
class SubscriptionData < Stripe::RequestParams
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(issuer: T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings::Issuer)).void
}
def initialize(issuer: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
sig { returns(String) }
def missing_payment_method; end
sig { params(_missing_payment_method: String).returns(String) }
def missing_payment_method=(_missing_payment_method); end
sig { params(missing_payment_method: String).void }
def initialize(missing_payment_method: nil); end
end
# Defines how the subscription should behave when the user's free trial ends.
sig {
returns(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
}
def end_behavior; end
sig {
params(_end_behavior: ::Stripe::PaymentLinkService::CreateParams::SubscriptionData::TrialSettings::EndBehavior).returns(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: ::Stripe::PaymentLinkService::CreateParams::SubscriptionData::TrialSettings::EndBehavior).void
}
def initialize(end_behavior: nil); end
end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
sig { returns(T.nilable(Integer)) }
def trial_period_days; end
sig { params(_trial_period_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_period_days=(_trial_period_days); end
# Settings related to subscription trials.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::TrialSettings))
}
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::TrialSettings)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(description: T.nilable(String), invoice_settings: T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings), metadata: T.nilable(T::Hash[String, String]), trial_period_days: T.nilable(Integer), trial_settings: T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::TrialSettings)).void
}
def initialize(
description: nil,
invoice_settings: nil,
metadata: nil,
trial_period_days: nil,
trial_settings: nil
); end
end
class TaxIdCollection < Stripe::RequestParams
# Enable tax ID collection during checkout. Defaults to `false`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Describes whether a tax ID is required during checkout. Defaults to `never`.
sig { returns(T.nilable(String)) }
def required; end
sig { params(_required: T.nilable(String)).returns(T.nilable(String)) }
def required=(_required); end
sig { params(enabled: T::Boolean, required: T.nilable(String)).void }
def initialize(enabled: nil, required: nil); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# If specified, successful charges will be attributed to the destination
# account for tax reporting, and the funds from charges will be transferred
# to the destination account. The ID of the resulting transfer will be
# returned on the successful charge's `transfer` field.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# Behavior after the purchase is complete.
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion)) }
def after_completion; end
sig {
params(_after_completion: T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion))
}
def after_completion=(_after_completion); end
# Enables user redeemable promotion codes.
sig { returns(T.nilable(T::Boolean)) }
def allow_promotion_codes; end
sig { params(_allow_promotion_codes: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def allow_promotion_codes=(_allow_promotion_codes); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Can only be applied when there are no line items with recurring prices.
sig { returns(T.nilable(Integer)) }
def application_fee_amount; end
sig { params(_application_fee_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def application_fee_amount=(_application_fee_amount); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
sig { params(_application_fee_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def application_fee_percent=(_application_fee_percent); end
# Configuration for automatic tax collection.
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::PaymentLinkService::CreateParams::AutomaticTax)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Configuration for collecting the customer's billing address. Defaults to `auto`.
sig { returns(T.nilable(String)) }
def billing_address_collection; end
sig { params(_billing_address_collection: T.nilable(String)).returns(T.nilable(String)) }
def billing_address_collection=(_billing_address_collection); end
# Configure fields to gather active consent from customers.
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::ConsentCollection)) }
def consent_collection; end
sig {
params(_consent_collection: T.nilable(::Stripe::PaymentLinkService::CreateParams::ConsentCollection)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::ConsentCollection))
}
def consent_collection=(_consent_collection); end
# 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) and supported by each line item's price.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Collect additional information from your customer using custom fields. Up to 3 fields are supported.
sig { returns(T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField])) }
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField])).returns(T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField]))
}
def custom_fields=(_custom_fields); end
# Display additional text for your customers using custom text.
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomText)) }
def custom_text; end
sig {
params(_custom_text: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomText)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomText))
}
def custom_text=(_custom_text); end
# Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).
sig { returns(T.nilable(String)) }
def customer_creation; end
sig { params(_customer_creation: T.nilable(String)).returns(T.nilable(String)) }
def customer_creation=(_customer_creation); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The custom message to be displayed to a customer when a payment link is no longer active.
sig { returns(T.nilable(String)) }
def inactive_message; end
sig { params(_inactive_message: T.nilable(String)).returns(T.nilable(String)) }
def inactive_message=(_inactive_message); end
# Generate a post-purchase Invoice for one-time payments.
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation)) }
def invoice_creation; end
sig {
params(_invoice_creation: T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation))
}
def invoice_creation=(_invoice_creation); end
# The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
sig { returns(T::Array[::Stripe::PaymentLinkService::CreateParams::LineItem]) }
def line_items; end
sig {
params(_line_items: T::Array[::Stripe::PaymentLinkService::CreateParams::LineItem]).returns(T::Array[::Stripe::PaymentLinkService::CreateParams::LineItem])
}
def line_items=(_line_items); end
# 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The account on behalf of which to charge.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
# There is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items.
# There is a maximum of 20 combined line items and optional items.
sig { returns(T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::OptionalItem])) }
def optional_items; end
sig {
params(_optional_items: T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::OptionalItem])).returns(T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::OptionalItem]))
}
def optional_items=(_optional_items); end
# A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::PaymentIntentData)) }
def payment_intent_data; end
sig {
params(_payment_intent_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::PaymentIntentData)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::PaymentIntentData))
}
def payment_intent_data=(_payment_intent_data); end
# Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.
#
# Can only be set in `subscription` mode. Defaults to `always`.
#
# If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
sig { returns(T.nilable(String)) }
def payment_method_collection; end
sig { params(_payment_method_collection: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_collection=(_payment_method_collection); end
# The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
# Controls phone number collection settings during checkout.
#
# We recommend that you review your privacy policy and check with your legal contacts.
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::PhoneNumberCollection)) }
def phone_number_collection; end
sig {
params(_phone_number_collection: T.nilable(::Stripe::PaymentLinkService::CreateParams::PhoneNumberCollection)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::PhoneNumberCollection))
}
def phone_number_collection=(_phone_number_collection); end
# Settings that restrict the usage of a payment link.
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::Restrictions)) }
def restrictions; end
sig {
params(_restrictions: T.nilable(::Stripe::PaymentLinkService::CreateParams::Restrictions)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::Restrictions))
}
def restrictions=(_restrictions); end
# Configuration for collecting the customer's shipping address.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::ShippingAddressCollection))
}
def shipping_address_collection; end
sig {
params(_shipping_address_collection: T.nilable(::Stripe::PaymentLinkService::CreateParams::ShippingAddressCollection)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::ShippingAddressCollection))
}
def shipping_address_collection=(_shipping_address_collection); end
# The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
sig {
returns(T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::ShippingOption]))
}
def shipping_options; end
sig {
params(_shipping_options: T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::ShippingOption])).returns(T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::ShippingOption]))
}
def shipping_options=(_shipping_options); end
# Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).
sig { returns(T.nilable(String)) }
def submit_type; end
sig { params(_submit_type: T.nilable(String)).returns(T.nilable(String)) }
def submit_type=(_submit_type); end
# When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData)) }
def subscription_data; end
sig {
params(_subscription_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData))
}
def subscription_data=(_subscription_data); end
# Controls tax ID collection during checkout.
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::TaxIdCollection)) }
def tax_id_collection; end
sig {
params(_tax_id_collection: T.nilable(::Stripe::PaymentLinkService::CreateParams::TaxIdCollection)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::TaxIdCollection))
}
def tax_id_collection=(_tax_id_collection); end
# The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::TransferData)).returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::TransferData))
}
def transfer_data=(_transfer_data); end
sig {
params(after_completion: T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion), allow_promotion_codes: T.nilable(T::Boolean), application_fee_amount: T.nilable(Integer), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::PaymentLinkService::CreateParams::AutomaticTax), billing_address_collection: T.nilable(String), consent_collection: T.nilable(::Stripe::PaymentLinkService::CreateParams::ConsentCollection), currency: T.nilable(String), custom_fields: T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField]), custom_text: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomText), customer_creation: T.nilable(String), expand: T.nilable(T::Array[String]), inactive_message: T.nilable(String), invoice_creation: T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation), line_items: T::Array[::Stripe::PaymentLinkService::CreateParams::LineItem], metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), optional_items: T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::OptionalItem]), payment_intent_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_types: T.nilable(T::Array[String]), phone_number_collection: T.nilable(::Stripe::PaymentLinkService::CreateParams::PhoneNumberCollection), restrictions: T.nilable(::Stripe::PaymentLinkService::CreateParams::Restrictions), shipping_address_collection: T.nilable(::Stripe::PaymentLinkService::CreateParams::ShippingAddressCollection), shipping_options: T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::ShippingOption]), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData), tax_id_collection: T.nilable(::Stripe::PaymentLinkService::CreateParams::TaxIdCollection), transfer_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::TransferData)).void
}
def initialize(
after_completion: nil,
allow_promotion_codes: nil,
application_fee_amount: nil,
application_fee_percent: nil,
automatic_tax: nil,
billing_address_collection: nil,
consent_collection: nil,
currency: nil,
custom_fields: nil,
custom_text: nil,
customer_creation: nil,
expand: nil,
inactive_message: nil,
invoice_creation: nil,
line_items: nil,
metadata: nil,
on_behalf_of: nil,
optional_items: nil,
payment_intent_data: nil,
payment_method_collection: nil,
payment_method_types: nil,
phone_number_collection: nil,
restrictions: nil,
shipping_address_collection: nil,
shipping_options: nil,
submit_type: nil,
subscription_data: nil,
tax_id_collection: nil,
transfer_data: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class AfterCompletion < Stripe::RequestParams
class HostedConfirmation < Stripe::RequestParams
# A custom message to display to the customer after the purchase is complete.
sig { returns(T.nilable(String)) }
def custom_message; end
sig { params(_custom_message: T.nilable(String)).returns(T.nilable(String)) }
def custom_message=(_custom_message); end
sig { params(custom_message: T.nilable(String)).void }
def initialize(custom_message: nil); end
end
class Redirect < Stripe::RequestParams
# The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-id) included.
sig { returns(String) }
def url; end
sig { params(_url: String).returns(String) }
def url=(_url); end
sig { params(url: String).void }
def initialize(url: nil); end
end
# Configuration when `type=hosted_confirmation`.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::HostedConfirmation))
}
def hosted_confirmation; end
sig {
params(_hosted_confirmation: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::HostedConfirmation)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::HostedConfirmation))
}
def hosted_confirmation=(_hosted_confirmation); end
# Configuration when `type=redirect`.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::Redirect))
}
def redirect; end
sig {
params(_redirect: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::Redirect)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::Redirect))
}
def redirect=(_redirect); end
# The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(hosted_confirmation: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::HostedConfirmation), redirect: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::Redirect), type: String).void
}
def initialize(hosted_confirmation: nil, redirect: nil, type: nil); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
#
# Enabling this parameter causes the payment link to collect any billing address information necessary for tax calculation.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class CustomField < Stripe::RequestParams
class Dropdown < Stripe::RequestParams
class Option < Stripe::RequestParams
# The label for the option, displayed to the customer. Up to 100 characters.
sig { returns(String) }
def label; end
sig { params(_label: String).returns(String) }
def label=(_label); end
# The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(label: String, value: String).void }
def initialize(label: nil, value: nil); end
end
# The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The options available for the customer to select. Up to 200 options allowed.
sig {
returns(T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown::Option])
}
def options; end
sig {
params(_options: T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown::Option]).returns(T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown::Option])
}
def options=(_options); end
sig {
params(default_value: T.nilable(String), options: T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown::Option]).void
}
def initialize(default_value: nil, options: nil); end
end
class Label < Stripe::RequestParams
# Custom text for the label, displayed to the customer. Up to 50 characters.
sig { returns(String) }
def custom; end
sig { params(_custom: String).returns(String) }
def custom=(_custom); end
# The type of the label.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(custom: String, type: String).void }
def initialize(custom: nil, type: nil); end
end
class Numeric < Stripe::RequestParams
# The value that will pre-fill the field on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The maximum character length constraint for the customer's input.
sig { returns(T.nilable(Integer)) }
def maximum_length; end
sig { params(_maximum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_length=(_maximum_length); end
# The minimum character length requirement for the customer's input.
sig { returns(T.nilable(Integer)) }
def minimum_length; end
sig { params(_minimum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_length=(_minimum_length); end
sig {
params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
}
def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
end
class Text < Stripe::RequestParams
# The value that will pre-fill the field on the payment page.
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The maximum character length constraint for the customer's input.
sig { returns(T.nilable(Integer)) }
def maximum_length; end
sig { params(_maximum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_length=(_maximum_length); end
# The minimum character length requirement for the customer's input.
sig { returns(T.nilable(Integer)) }
def minimum_length; end
sig { params(_minimum_length: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_length=(_minimum_length); end
sig {
params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
}
def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
end
# Configuration for `type=dropdown` fields.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown))
}
def dropdown; end
sig {
params(_dropdown: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown))
}
def dropdown=(_dropdown); end
# String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
sig { returns(String) }
def key; end
sig { params(_key: String).returns(String) }
def key=(_key); end
# The label for the field, displayed to the customer.
sig { returns(::Stripe::PaymentLinkService::UpdateParams::CustomField::Label) }
def label; end
sig {
params(_label: ::Stripe::PaymentLinkService::UpdateParams::CustomField::Label).returns(::Stripe::PaymentLinkService::UpdateParams::CustomField::Label)
}
def label=(_label); end
# Configuration for `type=numeric` fields.
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Numeric)) }
def numeric; end
sig {
params(_numeric: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Numeric)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Numeric))
}
def numeric=(_numeric); end
# Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def optional; end
sig { params(_optional: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def optional=(_optional); end
# Configuration for `type=text` fields.
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Text)) }
def text; end
sig {
params(_text: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Text)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Text))
}
def text=(_text); end
# The type of the field.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(dropdown: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown), key: String, label: ::Stripe::PaymentLinkService::UpdateParams::CustomField::Label, numeric: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Numeric), optional: T.nilable(T::Boolean), text: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Text), type: String).void
}
def initialize(
dropdown: nil,
key: nil,
label: nil,
numeric: nil,
optional: nil,
text: nil,
type: nil
); end
end
class CustomText < Stripe::RequestParams
class AfterSubmit < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class ShippingAddress < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class Submit < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
class TermsOfServiceAcceptance < Stripe::RequestParams
# Text may be up to 1200 characters in length.
sig { returns(String) }
def message; end
sig { params(_message: String).returns(String) }
def message=(_message); end
sig { params(message: String).void }
def initialize(message: nil); end
end
# Custom text that should be displayed after the payment confirmation button.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::AfterSubmit)))
}
def after_submit; end
sig {
params(_after_submit: T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::AfterSubmit))).returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::AfterSubmit)))
}
def after_submit=(_after_submit); end
# Custom text that should be displayed alongside shipping address collection.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::ShippingAddress)))
}
def shipping_address; end
sig {
params(_shipping_address: T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::ShippingAddress))).returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::ShippingAddress)))
}
def shipping_address=(_shipping_address); end
# Custom text that should be displayed alongside the payment confirmation button.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::Submit)))
}
def submit; end
sig {
params(_submit: T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::Submit))).returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::Submit)))
}
def submit=(_submit); end
# Custom text that should be displayed in place of the default terms of service agreement text.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::TermsOfServiceAcceptance)))
}
def terms_of_service_acceptance; end
sig {
params(_terms_of_service_acceptance: T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::TermsOfServiceAcceptance))).returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::TermsOfServiceAcceptance)))
}
def terms_of_service_acceptance=(_terms_of_service_acceptance); end
sig {
params(after_submit: T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::AfterSubmit)), shipping_address: T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::ShippingAddress)), submit: T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::Submit)), terms_of_service_acceptance: T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::TermsOfServiceAcceptance))).void
}
def initialize(
after_submit: nil,
shipping_address: nil,
submit: nil,
terms_of_service_acceptance: nil
); end
end
class InvoiceCreation < Stripe::RequestParams
class InvoiceData < Stripe::RequestParams
class CustomField < Stripe::RequestParams
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The value of the custom field. This may be up to 140 characters.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
class RenderingOptions < Stripe::RequestParams
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(T.any(String, String))) }
def amount_tax_display; end
sig {
params(_amount_tax_display: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def amount_tax_display=(_amount_tax_display); end
# ID of the invoice rendering template to use for this invoice.
sig { returns(T.nilable(String)) }
def template; end
sig { params(_template: T.nilable(String)).returns(T.nilable(String)) }
def template=(_template); end
sig {
params(amount_tax_display: T.nilable(T.any(String, String)), template: T.nilable(String)).void
}
def initialize(amount_tax_display: nil, template: nil); end
end
# The account tax IDs associated with the invoice.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# Default custom fields to be displayed on invoices for this customer.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::CustomField])))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::CustomField]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::CustomField])))
}
def custom_fields=(_custom_fields); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Default footer to be displayed on invoices for this customer.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::Issuer)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::Issuer))
}
def issuer=(_issuer); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Default options for invoice PDF rendering for this customer.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::RenderingOptions)))
}
def rendering_options; end
sig {
params(_rendering_options: T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::RenderingOptions))).returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::RenderingOptions)))
}
def rendering_options=(_rendering_options); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), custom_fields: T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::CustomField])), description: T.nilable(String), footer: T.nilable(String), issuer: T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::Issuer), metadata: T.nilable(T.any(String, T::Hash[String, String])), rendering_options: T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::RenderingOptions))).void
}
def initialize(
account_tax_ids: nil,
custom_fields: nil,
description: nil,
footer: nil,
issuer: nil,
metadata: nil,
rendering_options: nil
); end
end
# Whether the feature is enabled
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Invoice PDF configuration.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData))
}
def invoice_data; end
sig {
params(_invoice_data: T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData))
}
def invoice_data=(_invoice_data); end
sig {
params(enabled: T::Boolean, invoice_data: T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData)).void
}
def initialize(enabled: nil, invoice_data: nil); end
end
class LineItem < Stripe::RequestParams
class AdjustableQuantity < Stripe::RequestParams
# Set to true if the quantity can be adjusted to any non-negative Integer.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil); end
end
# When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::LineItem::AdjustableQuantity))
}
def adjustable_quantity; end
sig {
params(_adjustable_quantity: T.nilable(::Stripe::PaymentLinkService::UpdateParams::LineItem::AdjustableQuantity)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::LineItem::AdjustableQuantity))
}
def adjustable_quantity=(_adjustable_quantity); end
# The ID of an existing line item on the payment link.
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
# The quantity of the line item being purchased.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
sig {
params(adjustable_quantity: T.nilable(::Stripe::PaymentLinkService::UpdateParams::LineItem::AdjustableQuantity), id: String, quantity: T.nilable(Integer)).void
}
def initialize(adjustable_quantity: nil, id: nil, quantity: nil); end
end
class PaymentIntentData < Stripe::RequestParams
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(description: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_group: T.nilable(String)).void
}
def initialize(
description: nil,
metadata: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_group: nil
); end
end
class PhoneNumberCollection < Stripe::RequestParams
# Set to `true` to enable phone number collection.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class Restrictions < Stripe::RequestParams
class CompletedSessions < Stripe::RequestParams
# The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.
sig { returns(Integer) }
def limit; end
sig { params(_limit: Integer).returns(Integer) }
def limit=(_limit); end
sig { params(limit: Integer).void }
def initialize(limit: nil); end
end
# Configuration for the `completed_sessions` restriction type.
sig { returns(::Stripe::PaymentLinkService::UpdateParams::Restrictions::CompletedSessions) }
def completed_sessions; end
sig {
params(_completed_sessions: ::Stripe::PaymentLinkService::UpdateParams::Restrictions::CompletedSessions).returns(::Stripe::PaymentLinkService::UpdateParams::Restrictions::CompletedSessions)
}
def completed_sessions=(_completed_sessions); end
sig {
params(completed_sessions: ::Stripe::PaymentLinkService::UpdateParams::Restrictions::CompletedSessions).void
}
def initialize(completed_sessions: nil); end
end
class ShippingAddressCollection < Stripe::RequestParams
# An array of two-letter ISO country codes representing which countries Checkout should provide as options for
# shipping locations.
sig { returns(T::Array[String]) }
def allowed_countries; end
sig { params(_allowed_countries: T::Array[String]).returns(T::Array[String]) }
def allowed_countries=(_allowed_countries); end
sig { params(allowed_countries: T::Array[String]).void }
def initialize(allowed_countries: nil); end
end
class SubscriptionData < Stripe::RequestParams
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(issuer: T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings::Issuer)).void
}
def initialize(issuer: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
sig { returns(String) }
def missing_payment_method; end
sig { params(_missing_payment_method: String).returns(String) }
def missing_payment_method=(_missing_payment_method); end
sig { params(missing_payment_method: String).void }
def initialize(missing_payment_method: nil); end
end
# Defines how the subscription should behave when the user's free trial ends.
sig {
returns(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::TrialSettings::EndBehavior)
}
def end_behavior; end
sig {
params(_end_behavior: ::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::TrialSettings::EndBehavior).returns(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::TrialSettings::EndBehavior)
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: ::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::TrialSettings::EndBehavior).void
}
def initialize(end_behavior: nil); end
end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
sig { returns(T.nilable(T.any(String, Integer))) }
def trial_period_days; end
sig {
params(_trial_period_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def trial_period_days=(_trial_period_days); end
# Settings related to subscription trials.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::TrialSettings)))
}
def trial_settings; end
sig {
params(_trial_settings: T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::TrialSettings))).returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::TrialSettings)))
}
def trial_settings=(_trial_settings); end
sig {
params(invoice_settings: T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings), metadata: T.nilable(T.any(String, T::Hash[String, String])), trial_period_days: T.nilable(T.any(String, Integer)), trial_settings: T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::TrialSettings))).void
}
def initialize(
invoice_settings: nil,
metadata: nil,
trial_period_days: nil,
trial_settings: nil
); end
end
class TaxIdCollection < Stripe::RequestParams
# Enable tax ID collection during checkout. Defaults to `false`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# Describes whether a tax ID is required during checkout. Defaults to `never`.
sig { returns(T.nilable(String)) }
def required; end
sig { params(_required: T.nilable(String)).returns(T.nilable(String)) }
def required=(_required); end
sig { params(enabled: T::Boolean, required: T.nilable(String)).void }
def initialize(enabled: nil, required: nil); end
end
# Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Behavior after the purchase is complete.
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion)) }
def after_completion; end
sig {
params(_after_completion: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion))
}
def after_completion=(_after_completion); end
# Enables user redeemable promotion codes.
sig { returns(T.nilable(T::Boolean)) }
def allow_promotion_codes; end
sig { params(_allow_promotion_codes: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def allow_promotion_codes=(_allow_promotion_codes); end
# Configuration for automatic tax collection.
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Configuration for collecting the customer's billing address. Defaults to `auto`.
sig { returns(T.nilable(String)) }
def billing_address_collection; end
sig { params(_billing_address_collection: T.nilable(String)).returns(T.nilable(String)) }
def billing_address_collection=(_billing_address_collection); end
# Collect additional information from your customer using custom fields. Up to 3 fields are supported.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField])))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField])))
}
def custom_fields=(_custom_fields); end
# Display additional text for your customers using custom text.
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomText)) }
def custom_text; end
sig {
params(_custom_text: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomText)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomText))
}
def custom_text=(_custom_text); end
# Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).
sig { returns(T.nilable(String)) }
def customer_creation; end
sig { params(_customer_creation: T.nilable(String)).returns(T.nilable(String)) }
def customer_creation=(_customer_creation); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The custom message to be displayed to a customer when a payment link is no longer active.
sig { returns(T.nilable(String)) }
def inactive_message; end
sig { params(_inactive_message: T.nilable(String)).returns(T.nilable(String)) }
def inactive_message=(_inactive_message); end
# Generate a post-purchase Invoice for one-time payments.
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation)) }
def invoice_creation; end
sig {
params(_invoice_creation: T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation))
}
def invoice_creation=(_invoice_creation); end
# The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
sig { returns(T.nilable(T::Array[::Stripe::PaymentLinkService::UpdateParams::LineItem])) }
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::PaymentLinkService::UpdateParams::LineItem])).returns(T.nilable(T::Array[::Stripe::PaymentLinkService::UpdateParams::LineItem]))
}
def line_items=(_line_items); end
# 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::PaymentIntentData)) }
def payment_intent_data; end
sig {
params(_payment_intent_data: T.nilable(::Stripe::PaymentLinkService::UpdateParams::PaymentIntentData)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::PaymentIntentData))
}
def payment_intent_data=(_payment_intent_data); end
# Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.
#
# Can only be set in `subscription` mode. Defaults to `always`.
#
# If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
sig { returns(T.nilable(String)) }
def payment_method_collection; end
sig { params(_payment_method_collection: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_collection=(_payment_method_collection); end
# The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def payment_method_types=(_payment_method_types); end
# Controls phone number collection settings during checkout.
#
# We recommend that you review your privacy policy and check with your legal contacts.
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::PhoneNumberCollection)) }
def phone_number_collection; end
sig {
params(_phone_number_collection: T.nilable(::Stripe::PaymentLinkService::UpdateParams::PhoneNumberCollection)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::PhoneNumberCollection))
}
def phone_number_collection=(_phone_number_collection); end
# Settings that restrict the usage of a payment link.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::Restrictions)))
}
def restrictions; end
sig {
params(_restrictions: T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::Restrictions))).returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::Restrictions)))
}
def restrictions=(_restrictions); end
# Configuration for collecting the customer's shipping address.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::ShippingAddressCollection)))
}
def shipping_address_collection; end
sig {
params(_shipping_address_collection: T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::ShippingAddressCollection))).returns(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::ShippingAddressCollection)))
}
def shipping_address_collection=(_shipping_address_collection); end
# Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).
sig { returns(T.nilable(String)) }
def submit_type; end
sig { params(_submit_type: T.nilable(String)).returns(T.nilable(String)) }
def submit_type=(_submit_type); end
# When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData)) }
def subscription_data; end
sig {
params(_subscription_data: T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData))
}
def subscription_data=(_subscription_data); end
# Controls tax ID collection during checkout.
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::TaxIdCollection)) }
def tax_id_collection; end
sig {
params(_tax_id_collection: T.nilable(::Stripe::PaymentLinkService::UpdateParams::TaxIdCollection)).returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::TaxIdCollection))
}
def tax_id_collection=(_tax_id_collection); end
sig {
params(active: T.nilable(T::Boolean), after_completion: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion), allow_promotion_codes: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax), billing_address_collection: T.nilable(String), custom_fields: T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField])), custom_text: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomText), customer_creation: T.nilable(String), expand: T.nilable(T::Array[String]), inactive_message: T.nilable(String), invoice_creation: T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::PaymentLinkService::UpdateParams::LineItem]), metadata: T.nilable(T::Hash[String, String]), payment_intent_data: T.nilable(::Stripe::PaymentLinkService::UpdateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_types: T.nilable(T.any(String, T::Array[String])), phone_number_collection: T.nilable(::Stripe::PaymentLinkService::UpdateParams::PhoneNumberCollection), restrictions: T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::Restrictions)), shipping_address_collection: T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::ShippingAddressCollection)), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData), tax_id_collection: T.nilable(::Stripe::PaymentLinkService::UpdateParams::TaxIdCollection)).void
}
def initialize(
active: nil,
after_completion: nil,
allow_promotion_codes: nil,
automatic_tax: nil,
billing_address_collection: nil,
custom_fields: nil,
custom_text: nil,
customer_creation: nil,
expand: nil,
inactive_message: nil,
invoice_creation: nil,
line_items: nil,
metadata: nil,
payment_intent_data: nil,
payment_method_collection: nil,
payment_method_types: nil,
phone_number_collection: nil,
restrictions: nil,
shipping_address_collection: nil,
submit_type: nil,
subscription_data: nil,
tax_id_collection: nil
); end
end
# Creates a payment link.
sig {
params(params: T.any(::Stripe::PaymentLinkService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentLink)
}
def create(params = {}, opts = {}); end
# Returns a list of your payment links.
sig {
params(params: T.any(::Stripe::PaymentLinkService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieve a payment link.
sig {
params(payment_link: String, params: T.any(::Stripe::PaymentLinkService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentLink)
}
def retrieve(payment_link, params = {}, opts = {}); end
# Updates a payment link.
sig {
params(payment_link: String, params: T.any(::Stripe::PaymentLinkService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentLink)
}
def update(payment_link, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class PaymentLinkLineItemService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
sig {
params(payment_link: String, params: T.any(::Stripe::PaymentLinkLineItemService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(payment_link, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class PaymentMethodService < StripeService
class ListParams < Stripe::RequestParams
# The ID of the customer whose PaymentMethods will be retrieved.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
customer: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
type: nil
); end
end
class CreateParams < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Institution number of the customer's bank.
sig { returns(String) }
def institution_number; end
sig { params(_institution_number: String).returns(String) }
def institution_number=(_institution_number); end
# Transit number of the customer's bank.
sig { returns(String) }
def transit_number; end
sig { params(_transit_number: String).returns(String) }
def transit_number=(_transit_number); end
sig {
params(account_number: String, institution_number: String, transit_number: String).void
}
def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(String) }
def bsb_number; end
sig { params(_bsb_number: String).returns(String) }
def bsb_number=(_bsb_number); end
sig { params(account_number: String, bsb_number: String).void }
def initialize(account_number: nil, bsb_number: nil); end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
sig { params(_sort_code: T.nilable(String)).returns(T.nilable(String)) }
def sort_code=(_sort_code); end
sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
def initialize(account_number: nil, sort_code: nil); end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentMethodService::CreateParams::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::PaymentMethodService::CreateParams::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::PaymentMethodService::CreateParams::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::PaymentMethodService::CreateParams::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
sig { params(_tax_id: String).returns(String) }
def tax_id=(_tax_id); end
sig { params(tax_id: String).void }
def initialize(tax_id: nil); end
end
class Card < Stripe::RequestParams
class Networks < Stripe::RequestParams
# The customer's preferred card network for co-branded cards. Supports `cartes_bancaires`, `mastercard`, or `visa`. Selection of a network that does not apply to the card will be stored as `invalid_preference` on the card.
sig { returns(T.nilable(String)) }
def preferred; end
sig { params(_preferred: T.nilable(String)).returns(T.nilable(String)) }
def preferred=(_preferred); end
sig { params(preferred: T.nilable(String)).void }
def initialize(preferred: nil); end
end
# The card's CVC. It is highly recommended to always include this value.
sig { returns(T.nilable(String)) }
def cvc; end
sig { params(_cvc: T.nilable(String)).returns(T.nilable(String)) }
def cvc=(_cvc); end
# Two-digit number representing the card's expiration month.
sig { returns(T.nilable(Integer)) }
def exp_month; end
sig { params(_exp_month: T.nilable(Integer)).returns(T.nilable(Integer)) }
def exp_month=(_exp_month); end
# Four-digit number representing the card's expiration year.
sig { returns(T.nilable(Integer)) }
def exp_year; end
sig { params(_exp_year: T.nilable(Integer)).returns(T.nilable(Integer)) }
def exp_year=(_exp_year); end
# Contains information about card networks used to process the payment.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Card::Networks)) }
def networks; end
sig {
params(_networks: T.nilable(::Stripe::PaymentMethodService::CreateParams::Card::Networks)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Card::Networks))
}
def networks=(_networks); end
# The card number, as a string without any separators.
sig { returns(T.nilable(String)) }
def number; end
sig { params(_number: T.nilable(String)).returns(T.nilable(String)) }
def number=(_number); end
# For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format card: {token: "tok_visa"}.
sig { returns(T.nilable(String)) }
def token; end
sig { params(_token: T.nilable(String)).returns(T.nilable(String)) }
def token=(_token); end
sig {
params(cvc: T.nilable(String), exp_month: T.nilable(Integer), exp_year: T.nilable(Integer), networks: T.nilable(::Stripe::PaymentMethodService::CreateParams::Card::Networks), number: T.nilable(String), token: T.nilable(String)).void
}
def initialize(
cvc: nil,
exp_month: nil,
exp_year: nil,
networks: nil,
number: nil,
token: nil
); end
end
class Cashapp < Stripe::RequestParams; end
class Crypto < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The customer's bank.
sig { returns(String) }
def bank; end
sig { params(_bank: String).returns(String) }
def bank=(_bank); end
sig { params(account_holder_type: T.nilable(String), bank: String).void }
def initialize(account_holder_type: nil, bank: nil); end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Klarna::Dob)) }
def dob; end
sig {
params(_dob: T.nilable(::Stripe::PaymentMethodService::CreateParams::Klarna::Dob)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Klarna::Dob))
}
def dob=(_dob); end
sig {
params(dob: T.nilable(::Stripe::PaymentMethodService::CreateParams::Klarna::Dob)).void
}
def initialize(dob: nil); end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
sig { returns(T.nilable(String)) }
def funding; end
sig { params(_funding: T.nilable(String)).returns(T.nilable(String)) }
def funding=(_funding); end
sig { params(funding: T.nilable(String)).void }
def initialize(funding: nil); end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
sig { params(_bank_code: String).returns(String) }
def bank_code=(_bank_code); end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
sig { params(_branch_code: String).returns(String) }
def branch_code=(_branch_code); end
# Attribute for param field reference
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# The suffix of the bank account number.
sig { returns(String) }
def suffix; end
sig { params(_suffix: String).returns(String) }
def suffix=(_suffix); end
sig {
params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
); end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Paypay < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig { returns(::Stripe::PaymentMethodService::CreateParams::Rechnung::Dob) }
def dob; end
sig {
params(_dob: ::Stripe::PaymentMethodService::CreateParams::Rechnung::Dob).returns(::Stripe::PaymentMethodService::CreateParams::Rechnung::Dob)
}
def dob=(_dob); end
sig { params(dob: ::Stripe::PaymentMethodService::CreateParams::Rechnung::Dob).void }
def initialize(dob: nil); end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
sig { returns(String) }
def iban; end
sig { params(_iban: String).returns(String) }
def iban=(_iban); end
sig { params(iban: String).void }
def initialize(iban: nil); end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
sig { params(account: T.nilable(String), source_type: T.nilable(String)).void }
def initialize(account: nil, source_type: nil); end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig { params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String)) }
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::AcssDebit)) }
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::PaymentMethodService::CreateParams::AcssDebit)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Affirm)) }
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::PaymentMethodService::CreateParams::Affirm)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Affirm))
}
def affirm=(_affirm); end
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::AfterpayClearpay)) }
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::PaymentMethodService::CreateParams::AfterpayClearpay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Alipay)) }
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Alipay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Alipay))
}
def alipay=(_alipay); end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Alma)) }
def alma; end
sig {
params(_alma: T.nilable(::Stripe::PaymentMethodService::CreateParams::Alma)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Alma))
}
def alma=(_alma); end
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::AmazonPay)) }
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::PaymentMethodService::CreateParams::AmazonPay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::AuBecsDebit)) }
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::PaymentMethodService::CreateParams::AuBecsDebit)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::BacsDebit)) }
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::PaymentMethodService::CreateParams::BacsDebit)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Bancontact)) }
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::PaymentMethodService::CreateParams::Bancontact)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Bancontact))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Billie)) }
def billie; end
sig {
params(_billie: T.nilable(::Stripe::PaymentMethodService::CreateParams::Billie)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Billie))
}
def billie=(_billie); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::BillingDetails)) }
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::PaymentMethodService::CreateParams::BillingDetails)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Blik)) }
def blik; end
sig {
params(_blik: T.nilable(::Stripe::PaymentMethodService::CreateParams::Blik)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Blik))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Boleto)) }
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::PaymentMethodService::CreateParams::Boleto)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Boleto))
}
def boleto=(_boleto); end
# If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Card)) }
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentMethodService::CreateParams::Card)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Card))
}
def card=(_card); end
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Cashapp)) }
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::PaymentMethodService::CreateParams::Cashapp)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Cashapp))
}
def cashapp=(_cashapp); end
# If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Crypto)) }
def crypto; end
sig {
params(_crypto: T.nilable(::Stripe::PaymentMethodService::CreateParams::Crypto)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Crypto))
}
def crypto=(_crypto); end
# The `Customer` to whom the original PaymentMethod is attached.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::CustomerBalance)) }
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::PaymentMethodService::CreateParams::CustomerBalance)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Eps)) }
def eps; end
sig {
params(_eps: T.nilable(::Stripe::PaymentMethodService::CreateParams::Eps)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Eps))
}
def eps=(_eps); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Fpx)) }
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::PaymentMethodService::CreateParams::Fpx)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Fpx))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Giropay)) }
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Giropay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Giropay))
}
def giropay=(_giropay); end
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Gopay)) }
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Gopay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Gopay))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Grabpay)) }
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Grabpay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Grabpay))
}
def grabpay=(_grabpay); end
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::IdBankTransfer)) }
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::PaymentMethodService::CreateParams::IdBankTransfer)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Ideal)) }
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::PaymentMethodService::CreateParams::Ideal)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Ideal))
}
def ideal=(_ideal); end
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::InteracPresent)) }
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::PaymentMethodService::CreateParams::InteracPresent)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::InteracPresent))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::KakaoPay)) }
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::PaymentMethodService::CreateParams::KakaoPay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Klarna)) }
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentMethodService::CreateParams::Klarna)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Klarna))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Konbini)) }
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::PaymentMethodService::CreateParams::Konbini)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Konbini))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::KrCard)) }
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::PaymentMethodService::CreateParams::KrCard)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::KrCard))
}
def kr_card=(_kr_card); end
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Link)) }
def link; end
sig {
params(_link: T.nilable(::Stripe::PaymentMethodService::CreateParams::Link)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Link))
}
def link=(_link); end
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::MbWay)) }
def mb_way; end
sig {
params(_mb_way: T.nilable(::Stripe::PaymentMethodService::CreateParams::MbWay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::MbWay))
}
def mb_way=(_mb_way); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Mobilepay)) }
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Mobilepay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Mobilepay))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Multibanco)) }
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::PaymentMethodService::CreateParams::Multibanco)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Multibanco))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::NaverPay)) }
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::PaymentMethodService::CreateParams::NaverPay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::NaverPay))
}
def naver_pay=(_naver_pay); end
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::NzBankAccount)) }
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::PaymentMethodService::CreateParams::NzBankAccount)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Oxxo)) }
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::PaymentMethodService::CreateParams::Oxxo)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Oxxo))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::P24)) }
def p24; end
sig {
params(_p24: T.nilable(::Stripe::PaymentMethodService::CreateParams::P24)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::P24))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::PayByBank)) }
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::PaymentMethodService::CreateParams::PayByBank)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Payco)) }
def payco; end
sig {
params(_payco: T.nilable(::Stripe::PaymentMethodService::CreateParams::Payco)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Payco))
}
def payco=(_payco); end
# The PaymentMethod to share.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Paynow)) }
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::PaymentMethodService::CreateParams::Paynow)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Paynow))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Paypal)) }
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentMethodService::CreateParams::Paypal)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Paypal))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Paypay)) }
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Paypay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Paypay))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Payto)) }
def payto; end
sig {
params(_payto: T.nilable(::Stripe::PaymentMethodService::CreateParams::Payto)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Payto))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Pix)) }
def pix; end
sig {
params(_pix: T.nilable(::Stripe::PaymentMethodService::CreateParams::Pix)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Pix))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Promptpay)) }
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Promptpay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Promptpay))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Qris)) }
def qris; end
sig {
params(_qris: T.nilable(::Stripe::PaymentMethodService::CreateParams::Qris)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Qris))
}
def qris=(_qris); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::RadarOptions)) }
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::PaymentMethodService::CreateParams::RadarOptions)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::RadarOptions))
}
def radar_options=(_radar_options); end
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Rechnung)) }
def rechnung; end
sig {
params(_rechnung: T.nilable(::Stripe::PaymentMethodService::CreateParams::Rechnung)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Rechnung))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::RevolutPay)) }
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::PaymentMethodService::CreateParams::RevolutPay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::SamsungPay)) }
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::PaymentMethodService::CreateParams::SamsungPay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Satispay)) }
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Satispay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Satispay))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::SepaDebit)) }
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::PaymentMethodService::CreateParams::SepaDebit)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Shopeepay)) }
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Shopeepay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Shopeepay))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Sofort)) }
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::PaymentMethodService::CreateParams::Sofort)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Sofort))
}
def sofort=(_sofort); end
# This hash contains details about the Stripe balance payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::StripeBalance)) }
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::PaymentMethodService::CreateParams::StripeBalance)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Swish)) }
def swish; end
sig {
params(_swish: T.nilable(::Stripe::PaymentMethodService::CreateParams::Swish)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Swish))
}
def swish=(_swish); end
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Twint)) }
def twint; end
sig {
params(_twint: T.nilable(::Stripe::PaymentMethodService::CreateParams::Twint)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Twint))
}
def twint=(_twint); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::UsBankAccount)) }
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::PaymentMethodService::CreateParams::UsBankAccount)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::WechatPay)) }
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::PaymentMethodService::CreateParams::WechatPay)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Zip)) }
def zip; end
sig {
params(_zip: T.nilable(::Stripe::PaymentMethodService::CreateParams::Zip)).returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::PaymentMethodService::CreateParams::AcssDebit), affirm: T.nilable(::Stripe::PaymentMethodService::CreateParams::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentMethodService::CreateParams::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::PaymentMethodService::CreateParams::Alma), amazon_pay: T.nilable(::Stripe::PaymentMethodService::CreateParams::AmazonPay), au_becs_debit: T.nilable(::Stripe::PaymentMethodService::CreateParams::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentMethodService::CreateParams::BacsDebit), bancontact: T.nilable(::Stripe::PaymentMethodService::CreateParams::Bancontact), billie: T.nilable(::Stripe::PaymentMethodService::CreateParams::Billie), billing_details: T.nilable(::Stripe::PaymentMethodService::CreateParams::BillingDetails), blik: T.nilable(::Stripe::PaymentMethodService::CreateParams::Blik), boleto: T.nilable(::Stripe::PaymentMethodService::CreateParams::Boleto), card: T.nilable(::Stripe::PaymentMethodService::CreateParams::Card), cashapp: T.nilable(::Stripe::PaymentMethodService::CreateParams::Cashapp), crypto: T.nilable(::Stripe::PaymentMethodService::CreateParams::Crypto), customer: T.nilable(String), customer_balance: T.nilable(::Stripe::PaymentMethodService::CreateParams::CustomerBalance), eps: T.nilable(::Stripe::PaymentMethodService::CreateParams::Eps), expand: T.nilable(T::Array[String]), fpx: T.nilable(::Stripe::PaymentMethodService::CreateParams::Fpx), giropay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Giropay), gopay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Gopay), grabpay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Grabpay), id_bank_transfer: T.nilable(::Stripe::PaymentMethodService::CreateParams::IdBankTransfer), ideal: T.nilable(::Stripe::PaymentMethodService::CreateParams::Ideal), interac_present: T.nilable(::Stripe::PaymentMethodService::CreateParams::InteracPresent), kakao_pay: T.nilable(::Stripe::PaymentMethodService::CreateParams::KakaoPay), klarna: T.nilable(::Stripe::PaymentMethodService::CreateParams::Klarna), konbini: T.nilable(::Stripe::PaymentMethodService::CreateParams::Konbini), kr_card: T.nilable(::Stripe::PaymentMethodService::CreateParams::KrCard), link: T.nilable(::Stripe::PaymentMethodService::CreateParams::Link), mb_way: T.nilable(::Stripe::PaymentMethodService::CreateParams::MbWay), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Mobilepay), multibanco: T.nilable(::Stripe::PaymentMethodService::CreateParams::Multibanco), naver_pay: T.nilable(::Stripe::PaymentMethodService::CreateParams::NaverPay), nz_bank_account: T.nilable(::Stripe::PaymentMethodService::CreateParams::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentMethodService::CreateParams::Oxxo), p24: T.nilable(::Stripe::PaymentMethodService::CreateParams::P24), pay_by_bank: T.nilable(::Stripe::PaymentMethodService::CreateParams::PayByBank), payco: T.nilable(::Stripe::PaymentMethodService::CreateParams::Payco), payment_method: T.nilable(String), paynow: T.nilable(::Stripe::PaymentMethodService::CreateParams::Paynow), paypal: T.nilable(::Stripe::PaymentMethodService::CreateParams::Paypal), paypay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Paypay), payto: T.nilable(::Stripe::PaymentMethodService::CreateParams::Payto), pix: T.nilable(::Stripe::PaymentMethodService::CreateParams::Pix), promptpay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Promptpay), qris: T.nilable(::Stripe::PaymentMethodService::CreateParams::Qris), radar_options: T.nilable(::Stripe::PaymentMethodService::CreateParams::RadarOptions), rechnung: T.nilable(::Stripe::PaymentMethodService::CreateParams::Rechnung), revolut_pay: T.nilable(::Stripe::PaymentMethodService::CreateParams::RevolutPay), samsung_pay: T.nilable(::Stripe::PaymentMethodService::CreateParams::SamsungPay), satispay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Satispay), sepa_debit: T.nilable(::Stripe::PaymentMethodService::CreateParams::SepaDebit), shopeepay: T.nilable(::Stripe::PaymentMethodService::CreateParams::Shopeepay), sofort: T.nilable(::Stripe::PaymentMethodService::CreateParams::Sofort), stripe_balance: T.nilable(::Stripe::PaymentMethodService::CreateParams::StripeBalance), swish: T.nilable(::Stripe::PaymentMethodService::CreateParams::Swish), twint: T.nilable(::Stripe::PaymentMethodService::CreateParams::Twint), type: T.nilable(String), us_bank_account: T.nilable(::Stripe::PaymentMethodService::CreateParams::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentMethodService::CreateParams::WechatPay), zip: T.nilable(::Stripe::PaymentMethodService::CreateParams::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
card: nil,
cashapp: nil,
crypto: nil,
customer: nil,
customer_balance: nil,
eps: nil,
expand: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
payment_method: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentMethodService::UpdateParams::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::PaymentMethodService::UpdateParams::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::PaymentMethodService::UpdateParams::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::PaymentMethodService::UpdateParams::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Card < Stripe::RequestParams
class Networks < Stripe::RequestParams
# The customer's preferred card network for co-branded cards. Supports `cartes_bancaires`, `mastercard`, or `visa`. Selection of a network that does not apply to the card will be stored as `invalid_preference` on the card.
sig { returns(T.nilable(T.any(String, String))) }
def preferred; end
sig {
params(_preferred: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def preferred=(_preferred); end
sig { params(preferred: T.nilable(T.any(String, String))).void }
def initialize(preferred: nil); end
end
# Two-digit number representing the card's expiration month.
sig { returns(T.nilable(Integer)) }
def exp_month; end
sig { params(_exp_month: T.nilable(Integer)).returns(T.nilable(Integer)) }
def exp_month=(_exp_month); end
# Four-digit number representing the card's expiration year.
sig { returns(T.nilable(Integer)) }
def exp_year; end
sig { params(_exp_year: T.nilable(Integer)).returns(T.nilable(Integer)) }
def exp_year=(_exp_year); end
# Contains information about card networks used to process the payment.
sig { returns(T.nilable(::Stripe::PaymentMethodService::UpdateParams::Card::Networks)) }
def networks; end
sig {
params(_networks: T.nilable(::Stripe::PaymentMethodService::UpdateParams::Card::Networks)).returns(T.nilable(::Stripe::PaymentMethodService::UpdateParams::Card::Networks))
}
def networks=(_networks); end
sig {
params(exp_month: T.nilable(Integer), exp_year: T.nilable(Integer), networks: T.nilable(::Stripe::PaymentMethodService::UpdateParams::Card::Networks)).void
}
def initialize(exp_month: nil, exp_year: nil, networks: nil); end
end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class UsBankAccount < Stripe::RequestParams
# Bank account holder type.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Bank account type.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
sig { params(account_holder_type: T.nilable(String), account_type: T.nilable(String)).void }
def initialize(account_holder_type: nil, account_type: nil); end
end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig { returns(T.nilable(::Stripe::PaymentMethodService::UpdateParams::BillingDetails)) }
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::PaymentMethodService::UpdateParams::BillingDetails)).returns(T.nilable(::Stripe::PaymentMethodService::UpdateParams::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `card` PaymentMethod, this hash contains the user's card details.
sig { returns(T.nilable(::Stripe::PaymentMethodService::UpdateParams::Card)) }
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentMethodService::UpdateParams::Card)).returns(T.nilable(::Stripe::PaymentMethodService::UpdateParams::Card))
}
def card=(_card); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::UpdateParams::Payto)) }
def payto; end
sig {
params(_payto: T.nilable(::Stripe::PaymentMethodService::UpdateParams::Payto)).returns(T.nilable(::Stripe::PaymentMethodService::UpdateParams::Payto))
}
def payto=(_payto); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig { returns(T.nilable(::Stripe::PaymentMethodService::UpdateParams::UsBankAccount)) }
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::PaymentMethodService::UpdateParams::UsBankAccount)).returns(T.nilable(::Stripe::PaymentMethodService::UpdateParams::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
sig {
params(allow_redisplay: T.nilable(String), billing_details: T.nilable(::Stripe::PaymentMethodService::UpdateParams::BillingDetails), card: T.nilable(::Stripe::PaymentMethodService::UpdateParams::Card), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), payto: T.nilable(::Stripe::PaymentMethodService::UpdateParams::Payto), us_bank_account: T.nilable(::Stripe::PaymentMethodService::UpdateParams::UsBankAccount)).void
}
def initialize(
allow_redisplay: nil,
billing_details: nil,
card: nil,
expand: nil,
metadata: nil,
payto: nil,
us_bank_account: nil
); end
end
class AttachParams < Stripe::RequestParams
# The ID of the customer to which to attach the PaymentMethod.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The ID of the account to which to attach the PaymentMethod.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(customer: T.nilable(String), customer_account: T.nilable(String), expand: T.nilable(T::Array[String])).void
}
def initialize(customer: nil, customer_account: nil, expand: nil); end
end
class DetachParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Attaches a PaymentMethod object to a Customer.
#
# To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://docs.stripe.com/docs/api/setup_intents)
# or a PaymentIntent with [setup_future_usage](https://docs.stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage).
# These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach
# endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for
# future use, which makes later declines and payment friction more likely.
# See [Optimizing cards for future payments](https://docs.stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up
# future payments.
#
# To use this PaymentMethod as the default for invoice or subscription payments,
# set [invoice_settings.default_payment_method](https://docs.stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method),
# on the Customer to the PaymentMethod's ID.
sig {
params(payment_method: String, params: T.any(::Stripe::PaymentMethodService::AttachParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
}
def attach(payment_method, params = {}, opts = {}); end
# Creates a PaymentMethod object. Read the [Stripe.js reference](https://docs.stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js.
#
# Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the SetupIntent](https://docs.stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment.
sig {
params(params: T.any(::Stripe::PaymentMethodService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
}
def create(params = {}, opts = {}); end
# Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.
sig {
params(payment_method: String, params: T.any(::Stripe::PaymentMethodService::DetachParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
}
def detach(payment_method, params = {}, opts = {}); end
# Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer_list) API instead.
sig {
params(params: T.any(::Stripe::PaymentMethodService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use [Retrieve a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer)
sig {
params(payment_method: String, params: T.any(::Stripe::PaymentMethodService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
}
def retrieve(payment_method, params = {}, opts = {}); end
# Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.
sig {
params(payment_method: String, params: T.any(::Stripe::PaymentMethodService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
}
def update(payment_method, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class PaymentMethodConfigurationService < StripeService
class ListParams < Stripe::RequestParams
# The Connect application to filter by.
sig { returns(T.nilable(String)) }
def application; end
sig { params(_application: T.nilable(String)).returns(T.nilable(String)) }
def application=(_application); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(application: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
application: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AcssDebit::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AcssDebit::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AcssDebit::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AcssDebit::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Affirm < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Affirm::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Affirm::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Affirm::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Affirm::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class AfterpayClearpay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AfterpayClearpay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AfterpayClearpay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AfterpayClearpay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AfterpayClearpay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Alipay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alipay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alipay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alipay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alipay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Alma < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alma::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alma::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alma::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alma::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class AmazonPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AmazonPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AmazonPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AmazonPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AmazonPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class ApplePay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class ApplePayLater < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePayLater::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePayLater::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePayLater::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePayLater::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class AuBecsDebit < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AuBecsDebit::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AuBecsDebit::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AuBecsDebit::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AuBecsDebit::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class BacsDebit < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::BacsDebit::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::BacsDebit::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::BacsDebit::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::BacsDebit::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Bancontact < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Bancontact::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Bancontact::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Bancontact::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Bancontact::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Billie < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Billie::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Billie::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Billie::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Billie::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Blik < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Blik::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Blik::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Blik::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Blik::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Boleto < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Boleto::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Boleto::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Boleto::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Boleto::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Card < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Card::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Card::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Card::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Card::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class CartesBancaires < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CartesBancaires::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CartesBancaires::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CartesBancaires::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CartesBancaires::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Cashapp < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Cashapp::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Cashapp::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Cashapp::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Cashapp::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class CustomerBalance < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CustomerBalance::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CustomerBalance::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CustomerBalance::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CustomerBalance::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Eps < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Eps::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Eps::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Eps::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Eps::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Fpx < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Fpx::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Fpx::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Fpx::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Fpx::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class FrMealVoucherConecs < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::FrMealVoucherConecs::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::FrMealVoucherConecs::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::FrMealVoucherConecs::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::FrMealVoucherConecs::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Giropay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Giropay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Giropay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Giropay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Giropay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class GooglePay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::GooglePay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::GooglePay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::GooglePay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::GooglePay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Gopay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Gopay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Gopay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Gopay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Gopay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Grabpay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Grabpay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Grabpay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Grabpay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Grabpay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class IdBankTransfer < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::IdBankTransfer::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::IdBankTransfer::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::IdBankTransfer::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::IdBankTransfer::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Ideal < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Ideal::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Ideal::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Ideal::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Ideal::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Jcb < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Jcb::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Jcb::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Jcb::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Jcb::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class KakaoPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KakaoPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KakaoPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KakaoPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KakaoPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Klarna < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Klarna::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Klarna::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Klarna::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Klarna::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Konbini < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Konbini::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Konbini::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Konbini::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Konbini::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class KrCard < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KrCard::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KrCard::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KrCard::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KrCard::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Link < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Link::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Link::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Link::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Link::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Mobilepay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Mobilepay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Mobilepay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Mobilepay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Mobilepay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Multibanco < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Multibanco::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Multibanco::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Multibanco::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Multibanco::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class NaverPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NaverPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NaverPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NaverPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NaverPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class NzBankAccount < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NzBankAccount::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NzBankAccount::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NzBankAccount::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NzBankAccount::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Oxxo < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Oxxo::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Oxxo::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Oxxo::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Oxxo::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class P24 < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::P24::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::P24::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::P24::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::P24::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class PayByBank < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::PayByBank::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::PayByBank::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::PayByBank::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::PayByBank::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Payco < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payco::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payco::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payco::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payco::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Paynow < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paynow::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paynow::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paynow::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paynow::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Paypal < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypal::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypal::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypal::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypal::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Paypay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Payto < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payto::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payto::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payto::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payto::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Pix < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Pix::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Pix::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Pix::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Pix::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Promptpay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Promptpay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Promptpay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Promptpay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Promptpay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Qris < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Qris::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Qris::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Qris::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Qris::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class RevolutPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::RevolutPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::RevolutPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::RevolutPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::RevolutPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class SamsungPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SamsungPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SamsungPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SamsungPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SamsungPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Satispay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Satispay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Satispay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Satispay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Satispay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class SepaDebit < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SepaDebit::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SepaDebit::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SepaDebit::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SepaDebit::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Shopeepay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Shopeepay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Shopeepay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Shopeepay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Shopeepay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Sofort < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Sofort::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Sofort::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Sofort::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Sofort::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Swish < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Swish::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Swish::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Swish::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Swish::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Twint < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Twint::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Twint::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Twint::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Twint::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class UsBankAccount < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::UsBankAccount::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::UsBankAccount::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::UsBankAccount::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::UsBankAccount::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class WechatPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::WechatPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::WechatPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::WechatPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::WechatPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Zip < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Zip::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Zip::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Zip::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Zip::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
# Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AcssDebit)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AcssDebit))
}
def acss_debit=(_acss_debit); end
# [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Affirm)) }
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Affirm)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Affirm))
}
def affirm=(_affirm); end
# Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AfterpayClearpay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alipay)) }
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alipay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alipay))
}
def alipay=(_alipay); end
# Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alma)) }
def alma; end
sig {
params(_alma: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alma)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alma))
}
def alma=(_alma); end
# Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AmazonPay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePay))
}
def apple_pay; end
sig {
params(_apple_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePay))
}
def apple_pay=(_apple_pay); end
# Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePayLater))
}
def apple_pay_later; end
sig {
params(_apple_pay_later: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePayLater)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePayLater))
}
def apple_pay_later=(_apple_pay_later); end
# Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AuBecsDebit)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::BacsDebit)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Bancontact)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Bancontact))
}
def bancontact=(_bancontact); end
# Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Billie)) }
def billie; end
sig {
params(_billie: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Billie)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Billie))
}
def billie=(_billie); end
# BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Blik)) }
def blik; end
sig {
params(_blik: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Blik)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Blik))
}
def blik=(_blik); end
# Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Boleto)) }
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Boleto)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Boleto))
}
def boleto=(_boleto); end
# Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Card)) }
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Card)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Card))
}
def card=(_card); end
# Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CartesBancaires))
}
def cartes_bancaires; end
sig {
params(_cartes_bancaires: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CartesBancaires)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CartesBancaires))
}
def cartes_bancaires=(_cartes_bancaires); end
# Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Cashapp)) }
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Cashapp)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Cashapp))
}
def cashapp=(_cashapp); end
# Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CustomerBalance)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Eps)) }
def eps; end
sig {
params(_eps: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Eps)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Eps))
}
def eps=(_eps); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Fpx)) }
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Fpx)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Fpx))
}
def fpx=(_fpx); end
# Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://stripe.com/docs/payments/benefits/fr-meal-vouchers) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::FrMealVoucherConecs))
}
def fr_meal_voucher_conecs; end
sig {
params(_fr_meal_voucher_conecs: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::FrMealVoucherConecs)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::FrMealVoucherConecs))
}
def fr_meal_voucher_conecs=(_fr_meal_voucher_conecs); end
# giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Giropay)) }
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Giropay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Giropay))
}
def giropay=(_giropay); end
# Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::GooglePay))
}
def google_pay; end
sig {
params(_google_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::GooglePay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::GooglePay))
}
def google_pay=(_google_pay); end
# GoPay is a [single use](https://stripe.com/docs/payments/payment-methods#usage) digital wallet payment method popular in Indonesia. When paying with GoPay, customers authenticate and approve payments using the Gojek app. Desktop checkout is performed by scanning a QR code. When checking out on mobile, customers are redirected to the Gojek app to confirm payment.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Gopay)) }
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Gopay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Gopay))
}
def gopay=(_gopay); end
# GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Grabpay)) }
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Grabpay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Grabpay))
}
def grabpay=(_grabpay); end
# Stripe users in Indonesia can receive bank transfers from customers in Indonesia. Bank transfers are a popular B2C and B2B payment method in Indonesia.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::IdBankTransfer))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::IdBankTransfer)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Ideal)) }
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Ideal)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Ideal))
}
def ideal=(_ideal); end
# JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Jcb)) }
def jcb; end
sig {
params(_jcb: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Jcb)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Jcb))
}
def jcb=(_jcb); end
# Kakao Pay is a popular local wallet available in South Korea.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KakaoPay))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KakaoPay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Klarna)) }
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Klarna)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Klarna))
}
def klarna=(_klarna); end
# Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Konbini)) }
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Konbini)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Konbini))
}
def konbini=(_konbini); end
# Korean cards let users pay using locally issued cards from South Korea.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KrCard)) }
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KrCard)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KrCard))
}
def kr_card=(_kr_card); end
# [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Link)) }
def link; end
sig {
params(_link: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Link)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Link))
}
def link=(_link); end
# MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Mobilepay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Mobilepay))
}
def mobilepay=(_mobilepay); end
# Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Multibanco)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Multibanco))
}
def multibanco=(_multibanco); end
# Configuration name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Naver Pay is a popular local wallet available in South Korea.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NaverPay))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NaverPay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NaverPay))
}
def naver_pay=(_naver_pay); end
# Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NzBankAccount))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NzBankAccount)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Oxxo)) }
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Oxxo)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Oxxo))
}
def oxxo=(_oxxo); end
# Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::P24)) }
def p24; end
sig {
params(_p24: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::P24)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::P24))
}
def p24=(_p24); end
# Configuration's parent configuration. Specify to create a child configuration.
sig { returns(T.nilable(String)) }
def parent; end
sig { params(_parent: T.nilable(String)).returns(T.nilable(String)) }
def parent=(_parent); end
# Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::PayByBank)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payco)) }
def payco; end
sig {
params(_payco: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payco)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payco))
}
def payco=(_payco); end
# PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paynow)) }
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paynow)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paynow))
}
def paynow=(_paynow); end
# PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypal)) }
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypal)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypal))
}
def paypal=(_paypal); end
# Customers can pay with PayPay online or using the PayPay app.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypay)) }
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypay))
}
def paypay=(_paypay); end
# PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payto)) }
def payto; end
sig {
params(_payto: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payto)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payto))
}
def payto=(_payto); end
# Pix is a payment method popular in Brazil. When paying with Pix, customers authenticate and approve payments by scanning a QR code in their preferred banking app. Check this [page](https://docs.stripe.com/payments/pix) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Pix)) }
def pix; end
sig {
params(_pix: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Pix)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Pix))
}
def pix=(_pix); end
# PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Promptpay))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Promptpay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Promptpay))
}
def promptpay=(_promptpay); end
# QRIS is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Indonesia. When paying with QRIS, customers authenticate and approve payments by scanning a QR code in their preferred digital wallet app.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Qris)) }
def qris; end
sig {
params(_qris: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Qris)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Qris))
}
def qris=(_qris); end
# Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::RevolutPay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SamsungPay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Satispay))
}
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Satispay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Satispay))
}
def satispay=(_satispay); end
# The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SepaDebit)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# ShopeePay is a [single use](https://stripe.com/docs/payments/payment-methods#usage) digital wallet payment method popular in Indonesia. When paying with GoPay, customers authenticate and approve payments using the Shopee app. Desktop checkout is performed by scanning a QR code. When checking out on mobile, customers are redirected to the Shopee app to confirm payment.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Shopeepay))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Shopeepay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Shopeepay))
}
def shopeepay=(_shopeepay); end
# Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Sofort)) }
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Sofort)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Sofort))
}
def sofort=(_sofort); end
# Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Swish)) }
def swish; end
sig {
params(_swish: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Swish)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Swish))
}
def swish=(_swish); end
# Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Twint)) }
def twint; end
sig {
params(_twint: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Twint)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Twint))
}
def twint=(_twint); end
# Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-direct-debit) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::UsBankAccount)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::WechatPay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Zip)) }
def zip; end
sig {
params(_zip: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Zip)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AcssDebit), affirm: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alipay), alma: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alma), amazon_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AmazonPay), apple_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePay), apple_pay_later: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePayLater), au_becs_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::BacsDebit), bancontact: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Bancontact), billie: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Billie), blik: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Blik), boleto: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Boleto), card: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Card), cartes_bancaires: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CartesBancaires), cashapp: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Cashapp), customer_balance: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CustomerBalance), eps: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Eps), expand: T.nilable(T::Array[String]), fpx: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Fpx), fr_meal_voucher_conecs: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::FrMealVoucherConecs), giropay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Giropay), google_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::GooglePay), gopay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Gopay), grabpay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Grabpay), id_bank_transfer: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::IdBankTransfer), ideal: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Ideal), jcb: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Jcb), kakao_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KakaoPay), klarna: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Klarna), konbini: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Konbini), kr_card: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KrCard), link: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Link), mobilepay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Mobilepay), multibanco: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Multibanco), name: T.nilable(String), naver_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NaverPay), nz_bank_account: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Oxxo), p24: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::P24), parent: T.nilable(String), pay_by_bank: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::PayByBank), payco: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payco), paynow: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paynow), paypal: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypal), paypay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypay), payto: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payto), pix: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Pix), promptpay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Promptpay), qris: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Qris), revolut_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::RevolutPay), samsung_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SamsungPay), satispay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Satispay), sepa_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SepaDebit), shopeepay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Shopeepay), sofort: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Sofort), swish: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Swish), twint: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Twint), us_bank_account: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::WechatPay), zip: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
alma: nil,
amazon_pay: nil,
apple_pay: nil,
apple_pay_later: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
blik: nil,
boleto: nil,
card: nil,
cartes_bancaires: nil,
cashapp: nil,
customer_balance: nil,
eps: nil,
expand: nil,
fpx: nil,
fr_meal_voucher_conecs: nil,
giropay: nil,
google_pay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
jcb: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mobilepay: nil,
multibanco: nil,
name: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
parent: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
swish: nil,
twint: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AcssDebit::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AcssDebit::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AcssDebit::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AcssDebit::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Affirm < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Affirm::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Affirm::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Affirm::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Affirm::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class AfterpayClearpay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AfterpayClearpay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AfterpayClearpay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AfterpayClearpay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AfterpayClearpay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Alipay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alipay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alipay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alipay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alipay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Alma < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alma::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alma::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alma::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alma::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class AmazonPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AmazonPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AmazonPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AmazonPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AmazonPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class ApplePay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class ApplePayLater < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePayLater::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePayLater::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePayLater::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePayLater::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class AuBecsDebit < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AuBecsDebit::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AuBecsDebit::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AuBecsDebit::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AuBecsDebit::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class BacsDebit < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::BacsDebit::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::BacsDebit::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::BacsDebit::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::BacsDebit::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Bancontact < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Bancontact::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Bancontact::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Bancontact::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Bancontact::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Billie < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Billie::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Billie::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Billie::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Billie::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Blik < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Blik::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Blik::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Blik::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Blik::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Boleto < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Boleto::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Boleto::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Boleto::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Boleto::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Card < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Card::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Card::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Card::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Card::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class CartesBancaires < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CartesBancaires::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CartesBancaires::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CartesBancaires::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CartesBancaires::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Cashapp < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Cashapp::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Cashapp::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Cashapp::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Cashapp::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class CustomerBalance < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CustomerBalance::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CustomerBalance::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CustomerBalance::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CustomerBalance::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Eps < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Eps::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Eps::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Eps::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Eps::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Fpx < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Fpx::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Fpx::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Fpx::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Fpx::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class FrMealVoucherConecs < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::FrMealVoucherConecs::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::FrMealVoucherConecs::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::FrMealVoucherConecs::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::FrMealVoucherConecs::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Giropay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Giropay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Giropay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Giropay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Giropay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class GooglePay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::GooglePay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::GooglePay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::GooglePay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::GooglePay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Gopay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Gopay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Gopay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Gopay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Gopay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Grabpay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Grabpay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Grabpay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Grabpay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Grabpay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class IdBankTransfer < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::IdBankTransfer::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::IdBankTransfer::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::IdBankTransfer::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::IdBankTransfer::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Ideal < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Ideal::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Ideal::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Ideal::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Ideal::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Jcb < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Jcb::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Jcb::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Jcb::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Jcb::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class KakaoPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KakaoPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KakaoPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KakaoPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KakaoPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Klarna < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Klarna::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Klarna::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Klarna::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Klarna::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Konbini < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Konbini::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Konbini::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Konbini::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Konbini::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class KrCard < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KrCard::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KrCard::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KrCard::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KrCard::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Link < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Link::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Link::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Link::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Link::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Mobilepay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Mobilepay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Mobilepay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Mobilepay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Mobilepay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Multibanco < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Multibanco::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Multibanco::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Multibanco::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Multibanco::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class NaverPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NaverPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NaverPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NaverPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NaverPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class NzBankAccount < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NzBankAccount::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NzBankAccount::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NzBankAccount::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NzBankAccount::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Oxxo < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Oxxo::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Oxxo::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Oxxo::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Oxxo::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class P24 < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::P24::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::P24::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::P24::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::P24::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class PayByBank < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::PayByBank::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::PayByBank::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::PayByBank::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::PayByBank::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Payco < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payco::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payco::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payco::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payco::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Paynow < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paynow::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paynow::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paynow::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paynow::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Paypal < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypal::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypal::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypal::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypal::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Paypay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Payto < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payto::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payto::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payto::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payto::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Pix < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Pix::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Pix::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Pix::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Pix::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Promptpay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Promptpay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Promptpay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Promptpay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Promptpay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Qris < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Qris::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Qris::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Qris::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Qris::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class RevolutPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::RevolutPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::RevolutPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::RevolutPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::RevolutPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class SamsungPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SamsungPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SamsungPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SamsungPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SamsungPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Satispay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Satispay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Satispay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Satispay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Satispay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class SepaDebit < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SepaDebit::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SepaDebit::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SepaDebit::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SepaDebit::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Shopeepay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Shopeepay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Shopeepay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Shopeepay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Shopeepay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Sofort < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Sofort::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Sofort::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Sofort::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Sofort::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Swish < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Swish::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Swish::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Swish::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Swish::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Twint < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Twint::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Twint::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Twint::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Twint::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class UsBankAccount < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::UsBankAccount::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::UsBankAccount::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::UsBankAccount::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::UsBankAccount::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class WechatPay < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::WechatPay::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::WechatPay::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::WechatPay::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::WechatPay::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
class Zip < Stripe::RequestParams
class DisplayPreference < Stripe::RequestParams
# The account's preference for whether or not to display this payment method.
sig { returns(T.nilable(String)) }
def preference; end
sig { params(_preference: T.nilable(String)).returns(T.nilable(String)) }
def preference=(_preference); end
sig { params(preference: T.nilable(String)).void }
def initialize(preference: nil); end
end
# Whether or not the payment method should be displayed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Zip::DisplayPreference))
}
def display_preference; end
sig {
params(_display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Zip::DisplayPreference)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Zip::DisplayPreference))
}
def display_preference=(_display_preference); end
sig {
params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Zip::DisplayPreference)).void
}
def initialize(display_preference: nil); end
end
# Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AcssDebit)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AcssDebit))
}
def acss_debit=(_acss_debit); end
# Whether the configuration can be used for new payments.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Affirm)) }
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Affirm)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Affirm))
}
def affirm=(_affirm); end
# Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AfterpayClearpay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alipay)) }
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alipay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alipay))
}
def alipay=(_alipay); end
# Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alma)) }
def alma; end
sig {
params(_alma: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alma)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alma))
}
def alma=(_alma); end
# Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AmazonPay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePay))
}
def apple_pay; end
sig {
params(_apple_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePay))
}
def apple_pay=(_apple_pay); end
# Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePayLater))
}
def apple_pay_later; end
sig {
params(_apple_pay_later: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePayLater)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePayLater))
}
def apple_pay_later=(_apple_pay_later); end
# Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AuBecsDebit)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::BacsDebit)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Bancontact)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Bancontact))
}
def bancontact=(_bancontact); end
# Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Billie)) }
def billie; end
sig {
params(_billie: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Billie)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Billie))
}
def billie=(_billie); end
# BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Blik)) }
def blik; end
sig {
params(_blik: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Blik)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Blik))
}
def blik=(_blik); end
# Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Boleto)) }
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Boleto)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Boleto))
}
def boleto=(_boleto); end
# Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Card)) }
def card; end
sig {
params(_card: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Card)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Card))
}
def card=(_card); end
# Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CartesBancaires))
}
def cartes_bancaires; end
sig {
params(_cartes_bancaires: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CartesBancaires)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CartesBancaires))
}
def cartes_bancaires=(_cartes_bancaires); end
# Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Cashapp)) }
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Cashapp)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Cashapp))
}
def cashapp=(_cashapp); end
# Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CustomerBalance)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Eps)) }
def eps; end
sig {
params(_eps: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Eps)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Eps))
}
def eps=(_eps); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Fpx)) }
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Fpx)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Fpx))
}
def fpx=(_fpx); end
# Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://stripe.com/docs/payments/benefits/fr-meal-vouchers) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::FrMealVoucherConecs))
}
def fr_meal_voucher_conecs; end
sig {
params(_fr_meal_voucher_conecs: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::FrMealVoucherConecs)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::FrMealVoucherConecs))
}
def fr_meal_voucher_conecs=(_fr_meal_voucher_conecs); end
# giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Giropay)) }
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Giropay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Giropay))
}
def giropay=(_giropay); end
# Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::GooglePay))
}
def google_pay; end
sig {
params(_google_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::GooglePay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::GooglePay))
}
def google_pay=(_google_pay); end
# GoPay is a [single use](https://stripe.com/docs/payments/payment-methods#usage) digital wallet payment method popular in Indonesia. When paying with GoPay, customers authenticate and approve payments using the Gojek app. Desktop checkout is performed by scanning a QR code. When checking out on mobile, customers are redirected to the Gojek app to confirm payment.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Gopay)) }
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Gopay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Gopay))
}
def gopay=(_gopay); end
# GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Grabpay)) }
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Grabpay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Grabpay))
}
def grabpay=(_grabpay); end
# Stripe users in Indonesia can receive bank transfers from customers in Indonesia. Bank transfers are a popular B2C and B2B payment method in Indonesia.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::IdBankTransfer))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::IdBankTransfer)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Ideal)) }
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Ideal)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Ideal))
}
def ideal=(_ideal); end
# JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Jcb)) }
def jcb; end
sig {
params(_jcb: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Jcb)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Jcb))
}
def jcb=(_jcb); end
# Kakao Pay is a popular local wallet available in South Korea.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KakaoPay))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KakaoPay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Klarna)) }
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Klarna)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Klarna))
}
def klarna=(_klarna); end
# Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Konbini)) }
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Konbini)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Konbini))
}
def konbini=(_konbini); end
# Korean cards let users pay using locally issued cards from South Korea.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KrCard)) }
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KrCard)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KrCard))
}
def kr_card=(_kr_card); end
# [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Link)) }
def link; end
sig {
params(_link: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Link)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Link))
}
def link=(_link); end
# MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Mobilepay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Mobilepay))
}
def mobilepay=(_mobilepay); end
# Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Multibanco)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Multibanco))
}
def multibanco=(_multibanco); end
# Configuration name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Naver Pay is a popular local wallet available in South Korea.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NaverPay))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NaverPay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NaverPay))
}
def naver_pay=(_naver_pay); end
# Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NzBankAccount))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NzBankAccount)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Oxxo)) }
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Oxxo)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Oxxo))
}
def oxxo=(_oxxo); end
# Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::P24)) }
def p24; end
sig {
params(_p24: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::P24)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::P24))
}
def p24=(_p24); end
# Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::PayByBank)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payco)) }
def payco; end
sig {
params(_payco: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payco)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payco))
}
def payco=(_payco); end
# PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paynow)) }
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paynow)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paynow))
}
def paynow=(_paynow); end
# PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypal)) }
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypal)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypal))
}
def paypal=(_paypal); end
# Customers can pay with PayPay online or using the PayPay app.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypay)) }
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypay))
}
def paypay=(_paypay); end
# PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payto)) }
def payto; end
sig {
params(_payto: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payto)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payto))
}
def payto=(_payto); end
# Pix is a payment method popular in Brazil. When paying with Pix, customers authenticate and approve payments by scanning a QR code in their preferred banking app. Check this [page](https://docs.stripe.com/payments/pix) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Pix)) }
def pix; end
sig {
params(_pix: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Pix)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Pix))
}
def pix=(_pix); end
# PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Promptpay))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Promptpay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Promptpay))
}
def promptpay=(_promptpay); end
# QRIS is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Indonesia. When paying with QRIS, customers authenticate and approve payments by scanning a QR code in their preferred digital wallet app.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Qris)) }
def qris; end
sig {
params(_qris: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Qris)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Qris))
}
def qris=(_qris); end
# Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::RevolutPay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SamsungPay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Satispay))
}
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Satispay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Satispay))
}
def satispay=(_satispay); end
# The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SepaDebit)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# ShopeePay is a [single use](https://stripe.com/docs/payments/payment-methods#usage) digital wallet payment method popular in Indonesia. When paying with GoPay, customers authenticate and approve payments using the Shopee app. Desktop checkout is performed by scanning a QR code. When checking out on mobile, customers are redirected to the Shopee app to confirm payment.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Shopeepay))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Shopeepay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Shopeepay))
}
def shopeepay=(_shopeepay); end
# Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Sofort)) }
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Sofort)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Sofort))
}
def sofort=(_sofort); end
# Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Swish)) }
def swish; end
sig {
params(_swish: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Swish)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Swish))
}
def swish=(_swish); end
# Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Twint)) }
def twint; end
sig {
params(_twint: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Twint)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Twint))
}
def twint=(_twint); end
# Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-direct-debit) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::UsBankAccount)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details.
sig {
returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::WechatPay)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability.
sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Zip)) }
def zip; end
sig {
params(_zip: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Zip)).returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AcssDebit), active: T.nilable(T::Boolean), affirm: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alipay), alma: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alma), amazon_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AmazonPay), apple_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePay), apple_pay_later: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePayLater), au_becs_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::BacsDebit), bancontact: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Bancontact), billie: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Billie), blik: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Blik), boleto: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Boleto), card: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Card), cartes_bancaires: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CartesBancaires), cashapp: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Cashapp), customer_balance: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CustomerBalance), eps: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Eps), expand: T.nilable(T::Array[String]), fpx: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Fpx), fr_meal_voucher_conecs: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::FrMealVoucherConecs), giropay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Giropay), google_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::GooglePay), gopay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Gopay), grabpay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Grabpay), id_bank_transfer: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::IdBankTransfer), ideal: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Ideal), jcb: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Jcb), kakao_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KakaoPay), klarna: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Klarna), konbini: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Konbini), kr_card: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KrCard), link: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Link), mobilepay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Mobilepay), multibanco: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Multibanco), name: T.nilable(String), naver_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NaverPay), nz_bank_account: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Oxxo), p24: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::P24), pay_by_bank: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::PayByBank), payco: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payco), paynow: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paynow), paypal: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypal), paypay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypay), payto: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payto), pix: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Pix), promptpay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Promptpay), qris: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Qris), revolut_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::RevolutPay), samsung_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SamsungPay), satispay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Satispay), sepa_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SepaDebit), shopeepay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Shopeepay), sofort: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Sofort), swish: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Swish), twint: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Twint), us_bank_account: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::WechatPay), zip: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Zip)).void
}
def initialize(
acss_debit: nil,
active: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
alma: nil,
amazon_pay: nil,
apple_pay: nil,
apple_pay_later: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
blik: nil,
boleto: nil,
card: nil,
cartes_bancaires: nil,
cashapp: nil,
customer_balance: nil,
eps: nil,
expand: nil,
fpx: nil,
fr_meal_voucher_conecs: nil,
giropay: nil,
google_pay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
jcb: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mobilepay: nil,
multibanco: nil,
name: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
swish: nil,
twint: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
# Creates a payment method configuration
sig {
params(params: T.any(::Stripe::PaymentMethodConfigurationService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethodConfiguration)
}
def create(params = {}, opts = {}); end
# List payment method configurations
sig {
params(params: T.any(::Stripe::PaymentMethodConfigurationService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieve payment method configuration
sig {
params(configuration: String, params: T.any(::Stripe::PaymentMethodConfigurationService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethodConfiguration)
}
def retrieve(configuration, params = {}, opts = {}); end
# Update payment method configuration
sig {
params(configuration: String, params: T.any(::Stripe::PaymentMethodConfigurationService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethodConfiguration)
}
def update(configuration, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class PaymentMethodDomainService < StripeService
class ListParams < Stripe::RequestParams
# The domain name that this payment method domain object represents.
sig { returns(T.nilable(String)) }
def domain_name; end
sig { params(_domain_name: T.nilable(String)).returns(T.nilable(String)) }
def domain_name=(_domain_name); end
# Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements or Embedded Checkout
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(domain_name: T.nilable(String), enabled: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
domain_name: nil,
enabled: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# The domain name that this payment method domain object represents.
sig { returns(String) }
def domain_name; end
sig { params(_domain_name: String).returns(String) }
def domain_name=(_domain_name); end
# Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(domain_name: String, enabled: T.nilable(T::Boolean), expand: T.nilable(T::Array[String])).void
}
def initialize(domain_name: nil, enabled: nil, expand: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.
sig { returns(T.nilable(T::Boolean)) }
def enabled; end
sig { params(_enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def enabled=(_enabled); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(enabled: T.nilable(T::Boolean), expand: T.nilable(T::Array[String])).void }
def initialize(enabled: nil, expand: nil); end
end
class ValidateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Creates a payment method domain.
sig {
params(params: T.any(::Stripe::PaymentMethodDomainService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethodDomain)
}
def create(params = {}, opts = {}); end
# Lists the details of existing payment method domains.
sig {
params(params: T.any(::Stripe::PaymentMethodDomainService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing payment method domain.
sig {
params(payment_method_domain: String, params: T.any(::Stripe::PaymentMethodDomainService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethodDomain)
}
def retrieve(payment_method_domain, params = {}, opts = {}); end
# Updates an existing payment method domain.
sig {
params(payment_method_domain: String, params: T.any(::Stripe::PaymentMethodDomainService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethodDomain)
}
def update(payment_method_domain, params = {}, opts = {}); end
# 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 registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
#
# Related guides: [Payment method domains](https://docs.stripe.com/docs/payments/payment-methods/pmd-registration).
sig {
params(payment_method_domain: String, params: T.any(::Stripe::PaymentMethodDomainService::ValidateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethodDomain)
}
def validate(payment_method_domain, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class PaymentRecordService < StripeService
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ReportPaymentAttemptParams < Stripe::RequestParams
class Failed < Stripe::RequestParams
# When the reported payment failed. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def failed_at; end
sig { params(_failed_at: Integer).returns(Integer) }
def failed_at=(_failed_at); end
sig { params(failed_at: Integer).void }
def initialize(failed_at: nil); end
end
class Guaranteed < Stripe::RequestParams
# When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def guaranteed_at; end
sig { params(_guaranteed_at: Integer).returns(Integer) }
def guaranteed_at=(_guaranteed_at); end
sig { params(guaranteed_at: Integer).void }
def initialize(guaranteed_at: nil); end
end
class PaymentMethodDetails < Stripe::RequestParams
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The billing address associated with the method of payment.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::PaymentMethodDetails::BillingDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::PaymentMethodDetails::BillingDetails::Address)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::PaymentMethodDetails::BillingDetails::Address))
}
def address=(_address); end
# The billing email associated with the method of payment.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The billing name associated with the method of payment.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The billing phone number associated with the method of payment.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::PaymentMethodDetails::BillingDetails::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil); end
end
class Custom < Stripe::RequestParams
# Display name for the custom (user-defined) payment method type used to make this payment.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# The custom payment method type associated with this payment.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig { params(display_name: T.nilable(String), type: T.nilable(String)).void }
def initialize(display_name: nil, type: nil); end
end
# The billing details associated with the method of payment.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::PaymentMethodDetails::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::PaymentMethodDetails::BillingDetails)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::PaymentMethodDetails::BillingDetails))
}
def billing_details=(_billing_details); end
# Information about the custom (user-defined) payment method used to make this payment.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::PaymentMethodDetails::Custom))
}
def custom; end
sig {
params(_custom: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::PaymentMethodDetails::Custom)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::PaymentMethodDetails::Custom))
}
def custom=(_custom); end
# ID of the Stripe Payment Method used to make this payment.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(billing_details: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::PaymentMethodDetails::BillingDetails), custom: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::PaymentMethodDetails::Custom), payment_method: T.nilable(String), type: T.nilable(String)).void
}
def initialize(billing_details: nil, custom: nil, payment_method: nil, type: nil); end
end
class ShippingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The physical shipping address.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::ShippingDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::ShippingDetails::Address)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::ShippingDetails::Address))
}
def address=(_address); end
# The shipping recipient's name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The shipping recipient's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::ShippingDetails::Address), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Information about the payment attempt failure.
sig { returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::Failed)) }
def failed; end
sig {
params(_failed: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::Failed)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::Failed))
}
def failed=(_failed); end
# Information about the payment attempt guarantee.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::Guaranteed))
}
def guaranteed; end
sig {
params(_guaranteed: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::Guaranteed)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::Guaranteed))
}
def guaranteed=(_guaranteed); end
# When the reported payment was initiated. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def initiated_at; end
sig { params(_initiated_at: Integer).returns(Integer) }
def initiated_at=(_initiated_at); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The outcome of the reported payment.
sig { returns(T.nilable(String)) }
def outcome; end
sig { params(_outcome: T.nilable(String)).returns(T.nilable(String)) }
def outcome=(_outcome); end
# Information about the Payment Method debited for this payment.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::PaymentMethodDetails))
}
def payment_method_details; end
sig {
params(_payment_method_details: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::PaymentMethodDetails)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::PaymentMethodDetails))
}
def payment_method_details=(_payment_method_details); end
# Shipping information for this payment.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::ShippingDetails))
}
def shipping_details; end
sig {
params(_shipping_details: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::ShippingDetails)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::ShippingDetails))
}
def shipping_details=(_shipping_details); end
sig {
params(description: T.nilable(String), expand: T.nilable(T::Array[String]), failed: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::Failed), guaranteed: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::Guaranteed), initiated_at: Integer, metadata: T.nilable(T.any(String, T::Hash[String, String])), outcome: T.nilable(String), payment_method_details: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::PaymentMethodDetails), shipping_details: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptParams::ShippingDetails)).void
}
def initialize(
description: nil,
expand: nil,
failed: nil,
guaranteed: nil,
initiated_at: nil,
metadata: nil,
outcome: nil,
payment_method_details: nil,
shipping_details: nil
); end
end
class ReportPaymentAttemptCanceledParams < Stripe::RequestParams
# When the reported payment was canceled. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def canceled_at; end
sig { params(_canceled_at: Integer).returns(Integer) }
def canceled_at=(_canceled_at); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Attribute for param field metadata
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(canceled_at: Integer, expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(canceled_at: nil, expand: nil, metadata: nil); end
end
class ReportPaymentAttemptFailedParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# When the reported payment failed. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def failed_at; end
sig { params(_failed_at: Integer).returns(Integer) }
def failed_at=(_failed_at); end
# Attribute for param field metadata
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), failed_at: Integer, metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, failed_at: nil, metadata: nil); end
end
class ReportPaymentAttemptGuaranteedParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def guaranteed_at; end
sig { params(_guaranteed_at: Integer).returns(Integer) }
def guaranteed_at=(_guaranteed_at); end
# Attribute for param field metadata
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), guaranteed_at: Integer, metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, guaranteed_at: nil, metadata: nil); end
end
class ReportPaymentAttemptInformationalParams < Stripe::RequestParams
class CustomerDetails < Stripe::RequestParams
# The customer who made the payment.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The customer's phone number.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The customer's name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The customer's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(customer: T.nilable(String), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(customer: nil, email: nil, name: nil, phone: nil); end
end
class ShippingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The physical shipping address.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptInformationalParams::ShippingDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptInformationalParams::ShippingDetails::Address)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptInformationalParams::ShippingDetails::Address))
}
def address=(_address); end
# The shipping recipient's name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The shipping recipient's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptInformationalParams::ShippingDetails::Address), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
# Customer information for this payment.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptInformationalParams::CustomerDetails))
}
def customer_details; end
sig {
params(_customer_details: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptInformationalParams::CustomerDetails)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptInformationalParams::CustomerDetails))
}
def customer_details=(_customer_details); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Shipping information for this payment.
sig {
returns(T.nilable(T.any(String, ::Stripe::PaymentRecordService::ReportPaymentAttemptInformationalParams::ShippingDetails)))
}
def shipping_details; end
sig {
params(_shipping_details: T.nilable(T.any(String, ::Stripe::PaymentRecordService::ReportPaymentAttemptInformationalParams::ShippingDetails))).returns(T.nilable(T.any(String, ::Stripe::PaymentRecordService::ReportPaymentAttemptInformationalParams::ShippingDetails)))
}
def shipping_details=(_shipping_details); end
sig {
params(customer_details: T.nilable(::Stripe::PaymentRecordService::ReportPaymentAttemptInformationalParams::CustomerDetails), description: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), shipping_details: T.nilable(T.any(String, ::Stripe::PaymentRecordService::ReportPaymentAttemptInformationalParams::ShippingDetails))).void
}
def initialize(
customer_details: nil,
description: nil,
expand: nil,
metadata: nil,
shipping_details: nil
); end
end
class ReportPaymentParams < Stripe::RequestParams
class AmountRequested < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(currency: String, value: Integer).void }
def initialize(currency: nil, value: nil); end
end
class CustomerDetails < Stripe::RequestParams
# The customer who made the payment.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The customer's phone number.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The customer's name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The customer's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(customer: T.nilable(String), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(customer: nil, email: nil, name: nil, phone: nil); end
end
class Failed < Stripe::RequestParams
# When the reported payment failed. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def failed_at; end
sig { params(_failed_at: Integer).returns(Integer) }
def failed_at=(_failed_at); end
sig { params(failed_at: Integer).void }
def initialize(failed_at: nil); end
end
class Guaranteed < Stripe::RequestParams
# When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def guaranteed_at; end
sig { params(_guaranteed_at: Integer).returns(Integer) }
def guaranteed_at=(_guaranteed_at); end
sig { params(guaranteed_at: Integer).void }
def initialize(guaranteed_at: nil); end
end
class PaymentMethodDetails < Stripe::RequestParams
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The billing address associated with the method of payment.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::PaymentMethodDetails::BillingDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::PaymentMethodDetails::BillingDetails::Address)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::PaymentMethodDetails::BillingDetails::Address))
}
def address=(_address); end
# The billing email associated with the method of payment.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The billing name associated with the method of payment.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The billing phone number associated with the method of payment.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::PaymentMethodDetails::BillingDetails::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil); end
end
class Custom < Stripe::RequestParams
# Display name for the custom (user-defined) payment method type used to make this payment.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# The custom payment method type associated with this payment.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig { params(display_name: T.nilable(String), type: T.nilable(String)).void }
def initialize(display_name: nil, type: nil); end
end
# The billing details associated with the method of payment.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::PaymentMethodDetails::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::PaymentMethodDetails::BillingDetails)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::PaymentMethodDetails::BillingDetails))
}
def billing_details=(_billing_details); end
# Information about the custom (user-defined) payment method used to make this payment.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::PaymentMethodDetails::Custom))
}
def custom; end
sig {
params(_custom: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::PaymentMethodDetails::Custom)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::PaymentMethodDetails::Custom))
}
def custom=(_custom); end
# ID of the Stripe Payment Method used to make this payment.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(billing_details: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::PaymentMethodDetails::BillingDetails), custom: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::PaymentMethodDetails::Custom), payment_method: T.nilable(String), type: T.nilable(String)).void
}
def initialize(billing_details: nil, custom: nil, payment_method: nil, type: nil); end
end
class ProcessorDetails < Stripe::RequestParams
class Custom < Stripe::RequestParams
# An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
sig { returns(String) }
def payment_reference; end
sig { params(_payment_reference: String).returns(String) }
def payment_reference=(_payment_reference); end
sig { params(payment_reference: String).void }
def initialize(payment_reference: nil); end
end
# Information about the custom processor used to make this payment.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::ProcessorDetails::Custom))
}
def custom; end
sig {
params(_custom: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::ProcessorDetails::Custom)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::ProcessorDetails::Custom))
}
def custom=(_custom); end
# The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(custom: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::ProcessorDetails::Custom), type: String).void
}
def initialize(custom: nil, type: nil); end
end
class ShippingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The physical shipping address.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::ShippingDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::ShippingDetails::Address)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::ShippingDetails::Address))
}
def address=(_address); end
# The shipping recipient's name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The shipping recipient's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::ShippingDetails::Address), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
# The amount you initially requested for this payment.
sig { returns(::Stripe::PaymentRecordService::ReportPaymentParams::AmountRequested) }
def amount_requested; end
sig {
params(_amount_requested: ::Stripe::PaymentRecordService::ReportPaymentParams::AmountRequested).returns(::Stripe::PaymentRecordService::ReportPaymentParams::AmountRequested)
}
def amount_requested=(_amount_requested); end
# Customer information for this payment.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::CustomerDetails))
}
def customer_details; end
sig {
params(_customer_details: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::CustomerDetails)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::CustomerDetails))
}
def customer_details=(_customer_details); end
# Indicates whether the customer was present in your checkout flow during this payment.
sig { returns(T.nilable(String)) }
def customer_presence; end
sig { params(_customer_presence: T.nilable(String)).returns(T.nilable(String)) }
def customer_presence=(_customer_presence); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Information about the payment attempt failure.
sig { returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::Failed)) }
def failed; end
sig {
params(_failed: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::Failed)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::Failed))
}
def failed=(_failed); end
# Information about the payment attempt guarantee.
sig { returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::Guaranteed)) }
def guaranteed; end
sig {
params(_guaranteed: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::Guaranteed)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::Guaranteed))
}
def guaranteed=(_guaranteed); end
# When the reported payment was initiated. Measured in seconds since the Unix epoch.
sig { returns(Integer) }
def initiated_at; end
sig { params(_initiated_at: Integer).returns(Integer) }
def initiated_at=(_initiated_at); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The outcome of the reported payment.
sig { returns(T.nilable(String)) }
def outcome; end
sig { params(_outcome: T.nilable(String)).returns(T.nilable(String)) }
def outcome=(_outcome); end
# Information about the Payment Method debited for this payment.
sig { returns(::Stripe::PaymentRecordService::ReportPaymentParams::PaymentMethodDetails) }
def payment_method_details; end
sig {
params(_payment_method_details: ::Stripe::PaymentRecordService::ReportPaymentParams::PaymentMethodDetails).returns(::Stripe::PaymentRecordService::ReportPaymentParams::PaymentMethodDetails)
}
def payment_method_details=(_payment_method_details); end
# Processor information for this payment.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::ProcessorDetails))
}
def processor_details; end
sig {
params(_processor_details: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::ProcessorDetails)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::ProcessorDetails))
}
def processor_details=(_processor_details); end
# Shipping information for this payment.
sig {
returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::ShippingDetails))
}
def shipping_details; end
sig {
params(_shipping_details: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::ShippingDetails)).returns(T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::ShippingDetails))
}
def shipping_details=(_shipping_details); end
sig {
params(amount_requested: ::Stripe::PaymentRecordService::ReportPaymentParams::AmountRequested, customer_details: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::CustomerDetails), customer_presence: T.nilable(String), description: T.nilable(String), expand: T.nilable(T::Array[String]), failed: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::Failed), guaranteed: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::Guaranteed), initiated_at: Integer, metadata: T.nilable(T.any(String, T::Hash[String, String])), outcome: T.nilable(String), payment_method_details: ::Stripe::PaymentRecordService::ReportPaymentParams::PaymentMethodDetails, processor_details: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::ProcessorDetails), shipping_details: T.nilable(::Stripe::PaymentRecordService::ReportPaymentParams::ShippingDetails)).void
}
def initialize(
amount_requested: nil,
customer_details: nil,
customer_presence: nil,
description: nil,
expand: nil,
failed: nil,
guaranteed: nil,
initiated_at: nil,
metadata: nil,
outcome: nil,
payment_method_details: nil,
processor_details: nil,
shipping_details: nil
); end
end
# Report a new Payment Record. You may report a Payment Record as it is
# initialized and later report updates through the other report_* methods, or report Payment
# Records in a terminal state directly, through this method.
sig {
params(params: T.any(::Stripe::PaymentRecordService::ReportPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def report_payment(params = {}, opts = {}); end
# Report a new payment attempt on the specified Payment Record. A new payment
# attempt can only be specified if all other payment attempts are canceled or failed.
sig {
params(id: String, params: T.any(::Stripe::PaymentRecordService::ReportPaymentAttemptParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def report_payment_attempt(id, params = {}, opts = {}); end
# Report that the most recent payment attempt on the specified Payment Record
# was canceled.
sig {
params(id: String, params: T.any(::Stripe::PaymentRecordService::ReportPaymentAttemptCanceledParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def report_payment_attempt_canceled(id, params = {}, opts = {}); end
# Report that the most recent payment attempt on the specified Payment Record
# failed or errored.
sig {
params(id: String, params: T.any(::Stripe::PaymentRecordService::ReportPaymentAttemptFailedParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def report_payment_attempt_failed(id, params = {}, opts = {}); end
# Report that the most recent payment attempt on the specified Payment Record
# was guaranteed.
sig {
params(id: String, params: T.any(::Stripe::PaymentRecordService::ReportPaymentAttemptGuaranteedParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def report_payment_attempt_guaranteed(id, params = {}, opts = {}); end
# Report informational updates on the specified Payment Record.
sig {
params(id: String, params: T.any(::Stripe::PaymentRecordService::ReportPaymentAttemptInformationalParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def report_payment_attempt_informational(id, params = {}, opts = {}); end
# Retrieves a Payment Record with the given ID
sig {
params(id: String, params: T.any(::Stripe::PaymentRecordService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentRecord)
}
def retrieve(id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class PayoutService < StripeService
class ListParams < Stripe::RequestParams
class ArrivalDate < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return payouts that are expected to arrive during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::PayoutService::ListParams::ArrivalDate, Integer))) }
def arrival_date; end
sig {
params(_arrival_date: T.nilable(T.any(::Stripe::PayoutService::ListParams::ArrivalDate, Integer))).returns(T.nilable(T.any(::Stripe::PayoutService::ListParams::ArrivalDate, Integer)))
}
def arrival_date=(_arrival_date); end
# Only return payouts that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::PayoutService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::PayoutService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::PayoutService::ListParams::Created, Integer)))
}
def created=(_created); end
# The ID of an external account - only return payouts sent to this external account.
sig { returns(T.nilable(String)) }
def destination; end
sig { params(_destination: T.nilable(String)).returns(T.nilable(String)) }
def destination=(_destination); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(arrival_date: T.nilable(T.any(::Stripe::PayoutService::ListParams::ArrivalDate, Integer)), created: T.nilable(T.any(::Stripe::PayoutService::ListParams::Created, Integer)), destination: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
arrival_date: nil,
created: nil,
destination: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
# A positive integer in cents representing how much to payout.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency.
sig { returns(T.nilable(String)) }
def destination; end
sig { params(_destination: T.nilable(String)).returns(T.nilable(String)) }
def destination=(_destination); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The method used to send this payout, which is `standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).
sig { returns(T.nilable(String)) }
def method; end
sig { params(_method: T.nilable(String)).returns(T.nilable(String)) }
def method=(_method); end
# The ID of a v2 FinancialAccount to send funds to.
sig { returns(T.nilable(String)) }
def payout_method; end
sig { params(_payout_method: T.nilable(String)).returns(T.nilable(String)) }
def payout_method=(_payout_method); end
# The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`.
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
# A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
sig {
params(amount: Integer, currency: String, description: T.nilable(String), destination: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), method: T.nilable(String), payout_method: T.nilable(String), source_type: T.nilable(String), statement_descriptor: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
destination: nil,
expand: nil,
metadata: nil,
method: nil,
payout_method: nil,
source_type: nil,
statement_descriptor: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, metadata: nil); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ReverseParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(expand: nil, metadata: nil); end
end
# You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can't cancel automatic Stripe payouts.
sig {
params(payout: String, params: T.any(::Stripe::PayoutService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Payout)
}
def cancel(payout, params = {}, opts = {}); end
# To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://docs.stripe.com/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error.
#
# If your API key is in test mode, money won't actually be sent, though every other action occurs as if you're in live mode.
#
# If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://docs.stripe.com/api#balance_object) details available and pending amounts by source type.
sig {
params(params: T.any(::Stripe::PayoutService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Payout)
}
def create(params = {}, opts = {}); end
# Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.
sig {
params(params: T.any(::Stripe::PayoutService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.
sig {
params(payout: String, params: T.any(::Stripe::PayoutService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Payout)
}
def retrieve(payout, params = {}, opts = {}); end
# Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.
#
# By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.
sig {
params(payout: String, params: T.any(::Stripe::PayoutService::ReverseParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Payout)
}
def reverse(payout, params = {}, opts = {}); end
# Updates the specified payout by setting the values of the parameters you pass. We don't change parameters that you don't provide. This request only accepts the metadata as arguments.
sig {
params(payout: String, params: T.any(::Stripe::PayoutService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Payout)
}
def update(payout, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class PlanService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Whether the plan is currently available for new subscriptions.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# A brief description of the plan, hidden from customers.
sig { returns(T.nilable(String)) }
def nickname; end
sig { params(_nickname: T.nilable(String)).returns(T.nilable(String)) }
def nickname=(_nickname); end
# The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
sig { returns(T.nilable(Integer)) }
def trial_period_days; end
sig { params(_trial_period_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_period_days=(_trial_period_days); end
sig {
params(active: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), nickname: T.nilable(String), product: T.nilable(String), trial_period_days: T.nilable(Integer)).void
}
def initialize(
active: nil,
expand: nil,
metadata: nil,
nickname: nil,
product: nil,
trial_period_days: nil
); end
end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans).
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
sig { returns(T.nilable(T.any(::Stripe::PlanService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::PlanService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::PlanService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return plans for the given product.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::PlanService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), product: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
active: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
product: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Product < Stripe::RequestParams
# Whether the product is currently available for purchase. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
#
# This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
sig {
params(active: T.nilable(T::Boolean), id: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), name: String, statement_descriptor: T.nilable(String), tax_code: T.nilable(String), unit_label: T.nilable(String)).void
}
def initialize(
active: nil,
id: nil,
metadata: nil,
name: nil,
statement_descriptor: nil,
tax_code: nil,
unit_label: nil
); end
end
class Tier < Stripe::RequestParams
# The flat billing amount for an entire tier, regardless of the number of units in the tier.
sig { returns(T.nilable(Integer)) }
def flat_amount; end
sig { params(_flat_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def flat_amount=(_flat_amount); end
# Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def flat_amount_decimal; end
sig { params(_flat_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def flat_amount_decimal=(_flat_amount_decimal); end
# The per unit billing amount for each individual unit for which this tier applies.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
# Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
sig { returns(T.any(String, Integer)) }
def up_to; end
sig { params(_up_to: T.any(String, Integer)).returns(T.any(String, Integer)) }
def up_to=(_up_to); end
sig {
params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
}
def initialize(
flat_amount: nil,
flat_amount_decimal: nil,
unit_amount: nil,
unit_amount_decimal: nil,
up_to: nil
); end
end
class TransformUsage < Stripe::RequestParams
# Divide usage by this number.
sig { returns(Integer) }
def divide_by; end
sig { params(_divide_by: Integer).returns(Integer) }
def divide_by=(_divide_by); end
# After division, either round the result `up` or `down`.
sig { returns(String) }
def round; end
sig { params(_round: String).returns(String) }
def round=(_round); end
sig { params(divide_by: Integer, round: String).void }
def initialize(divide_by: nil, round: nil); end
end
# Whether the plan is currently available for new subscriptions. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def amount_decimal; end
sig { params(_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def amount_decimal=(_amount_decimal); end
# Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
sig { returns(T.nilable(String)) }
def billing_scheme; end
sig { params(_billing_scheme: T.nilable(String)).returns(T.nilable(String)) }
def billing_scheme=(_billing_scheme); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The meter tracking the usage of a metered price
sig { returns(T.nilable(String)) }
def meter; end
sig { params(_meter: T.nilable(String)).returns(T.nilable(String)) }
def meter=(_meter); end
# A brief description of the plan, hidden from customers.
sig { returns(T.nilable(String)) }
def nickname; end
sig { params(_nickname: T.nilable(String)).returns(T.nilable(String)) }
def nickname=(_nickname); end
# Attribute for param field product
sig { returns(T.nilable(T.any(::Stripe::PlanService::CreateParams::Product, String))) }
def product; end
sig {
params(_product: T.nilable(T.any(::Stripe::PlanService::CreateParams::Product, String))).returns(T.nilable(T.any(::Stripe::PlanService::CreateParams::Product, String)))
}
def product=(_product); end
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
sig { returns(T.nilable(T::Array[::Stripe::PlanService::CreateParams::Tier])) }
def tiers; end
sig {
params(_tiers: T.nilable(T::Array[::Stripe::PlanService::CreateParams::Tier])).returns(T.nilable(T::Array[::Stripe::PlanService::CreateParams::Tier]))
}
def tiers=(_tiers); end
# Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.
sig { returns(T.nilable(String)) }
def tiers_mode; end
sig { params(_tiers_mode: T.nilable(String)).returns(T.nilable(String)) }
def tiers_mode=(_tiers_mode); end
# Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.
sig { returns(T.nilable(::Stripe::PlanService::CreateParams::TransformUsage)) }
def transform_usage; end
sig {
params(_transform_usage: T.nilable(::Stripe::PlanService::CreateParams::TransformUsage)).returns(T.nilable(::Stripe::PlanService::CreateParams::TransformUsage))
}
def transform_usage=(_transform_usage); end
# Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
sig { returns(T.nilable(Integer)) }
def trial_period_days; end
sig { params(_trial_period_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_period_days=(_trial_period_days); end
# Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
sig { returns(T.nilable(String)) }
def usage_type; end
sig { params(_usage_type: T.nilable(String)).returns(T.nilable(String)) }
def usage_type=(_usage_type); end
sig {
params(active: T.nilable(T::Boolean), amount: T.nilable(Integer), amount_decimal: T.nilable(String), billing_scheme: T.nilable(String), currency: String, expand: T.nilable(T::Array[String]), id: T.nilable(String), interval: String, interval_count: T.nilable(Integer), metadata: T.nilable(T.any(String, T::Hash[String, String])), meter: T.nilable(String), nickname: T.nilable(String), product: T.nilable(T.any(::Stripe::PlanService::CreateParams::Product, String)), tiers: T.nilable(T::Array[::Stripe::PlanService::CreateParams::Tier]), tiers_mode: T.nilable(String), transform_usage: T.nilable(::Stripe::PlanService::CreateParams::TransformUsage), trial_period_days: T.nilable(Integer), usage_type: T.nilable(String)).void
}
def initialize(
active: nil,
amount: nil,
amount_decimal: nil,
billing_scheme: nil,
currency: nil,
expand: nil,
id: nil,
interval: nil,
interval_count: nil,
metadata: nil,
meter: nil,
nickname: nil,
product: nil,
tiers: nil,
tiers_mode: nil,
transform_usage: nil,
trial_period_days: nil,
usage_type: nil
); end
end
# You can now model subscriptions more flexibly using the [Prices API](https://docs.stripe.com/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
sig {
params(params: T.any(::Stripe::PlanService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan)
}
def create(params = {}, opts = {}); end
# Deleting plans means new subscribers can't be added. Existing subscribers aren't affected.
sig {
params(plan: String, params: T.any(::Stripe::PlanService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan)
}
def delete(plan, params = {}, opts = {}); end
# Returns a list of your plans.
sig {
params(params: T.any(::Stripe::PlanService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the plan with the given ID.
sig {
params(plan: String, params: T.any(::Stripe::PlanService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan)
}
def retrieve(plan, params = {}, opts = {}); end
# Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan's ID, amount, currency, or billing cycle.
sig {
params(plan: String, params: T.any(::Stripe::PlanService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan)
}
def update(plan, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class PriceService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class Recurring < Stripe::RequestParams
# Filter by billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# Filter by the price's meter.
sig { returns(T.nilable(String)) }
def meter; end
sig { params(_meter: T.nilable(String)).returns(T.nilable(String)) }
def meter=(_meter); end
# Filter by the usage type for this price. Can be either `metered` or `licensed`.
sig { returns(T.nilable(String)) }
def usage_type; end
sig { params(_usage_type: T.nilable(String)).returns(T.nilable(String)) }
def usage_type=(_usage_type); end
sig {
params(interval: T.nilable(String), meter: T.nilable(String), usage_type: T.nilable(String)).void
}
def initialize(interval: nil, meter: nil, usage_type: nil); end
end
# Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
sig { returns(T.nilable(T.any(::Stripe::PriceService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::PriceService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::PriceService::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return prices for the given currency.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.
sig { returns(T.nilable(T::Array[String])) }
def lookup_keys; end
sig { params(_lookup_keys: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def lookup_keys=(_lookup_keys); end
# Only return prices for the given product.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# Only return prices with these recurring fields.
sig { returns(T.nilable(::Stripe::PriceService::ListParams::Recurring)) }
def recurring; end
sig {
params(_recurring: T.nilable(::Stripe::PriceService::ListParams::Recurring)).returns(T.nilable(::Stripe::PriceService::ListParams::Recurring))
}
def recurring=(_recurring); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return prices of type `recurring` or `one_time`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::PriceService::ListParams::Created, Integer)), currency: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), lookup_keys: T.nilable(T::Array[String]), product: T.nilable(String), recurring: T.nilable(::Stripe::PriceService::ListParams::Recurring), starting_after: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
active: nil,
created: nil,
currency: nil,
ending_before: nil,
expand: nil,
limit: nil,
lookup_keys: nil,
product: nil,
recurring: nil,
starting_after: nil,
type: nil
); end
end
class CreateParams < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
class CustomUnitAmount < Stripe::RequestParams
# Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum unit amount the customer can specify for this item.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
# The starting unit amount which can be updated by the customer.
sig { returns(T.nilable(Integer)) }
def preset; end
sig { params(_preset: T.nilable(Integer)).returns(T.nilable(Integer)) }
def preset=(_preset); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
end
class Tier < Stripe::RequestParams
# The flat billing amount for an entire tier, regardless of the number of units in the tier.
sig { returns(T.nilable(Integer)) }
def flat_amount; end
sig { params(_flat_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def flat_amount=(_flat_amount); end
# Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def flat_amount_decimal; end
sig { params(_flat_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def flat_amount_decimal=(_flat_amount_decimal); end
# The per unit billing amount for each individual unit for which this tier applies.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
# Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
sig { returns(T.any(String, Integer)) }
def up_to; end
sig { params(_up_to: T.any(String, Integer)).returns(T.any(String, Integer)) }
def up_to=(_up_to); end
sig {
params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
}
def initialize(
flat_amount: nil,
flat_amount_decimal: nil,
unit_amount: nil,
unit_amount_decimal: nil,
up_to: nil
); end
end
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
sig {
returns(T.nilable(::Stripe::PriceService::CreateParams::CurrencyOptions::CustomUnitAmount))
}
def custom_unit_amount; end
sig {
params(_custom_unit_amount: T.nilable(::Stripe::PriceService::CreateParams::CurrencyOptions::CustomUnitAmount)).returns(T.nilable(::Stripe::PriceService::CreateParams::CurrencyOptions::CustomUnitAmount))
}
def custom_unit_amount=(_custom_unit_amount); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
sig {
returns(T.nilable(T::Array[::Stripe::PriceService::CreateParams::CurrencyOptions::Tier]))
}
def tiers; end
sig {
params(_tiers: T.nilable(T::Array[::Stripe::PriceService::CreateParams::CurrencyOptions::Tier])).returns(T.nilable(T::Array[::Stripe::PriceService::CreateParams::CurrencyOptions::Tier]))
}
def tiers=(_tiers); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(custom_unit_amount: T.nilable(::Stripe::PriceService::CreateParams::CurrencyOptions::CustomUnitAmount), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::PriceService::CreateParams::CurrencyOptions::Tier]), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
custom_unit_amount: nil,
tax_behavior: nil,
tiers: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class CustomUnitAmount < Stripe::RequestParams
# Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum unit amount the customer can specify for this item.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
# The starting unit amount which can be updated by the customer.
sig { returns(T.nilable(Integer)) }
def preset; end
sig { params(_preset: T.nilable(Integer)).returns(T.nilable(Integer)) }
def preset=(_preset); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
end
class ProductData < Stripe::RequestParams
# Whether the product is currently available for purchase. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
#
# This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
sig {
params(active: T.nilable(T::Boolean), id: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), name: String, statement_descriptor: T.nilable(String), tax_code: T.nilable(String), unit_label: T.nilable(String)).void
}
def initialize(
active: nil,
id: nil,
metadata: nil,
name: nil,
statement_descriptor: nil,
tax_code: nil,
unit_label: nil
); end
end
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# The meter tracking the usage of a metered price
sig { returns(T.nilable(String)) }
def meter; end
sig { params(_meter: T.nilable(String)).returns(T.nilable(String)) }
def meter=(_meter); end
# Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
sig { returns(T.nilable(Integer)) }
def trial_period_days; end
sig { params(_trial_period_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_period_days=(_trial_period_days); end
# Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
sig { returns(T.nilable(String)) }
def usage_type; end
sig { params(_usage_type: T.nilable(String)).returns(T.nilable(String)) }
def usage_type=(_usage_type); end
sig {
params(interval: String, interval_count: T.nilable(Integer), meter: T.nilable(String), trial_period_days: T.nilable(Integer), usage_type: T.nilable(String)).void
}
def initialize(
interval: nil,
interval_count: nil,
meter: nil,
trial_period_days: nil,
usage_type: nil
); end
end
class Tier < Stripe::RequestParams
# The flat billing amount for an entire tier, regardless of the number of units in the tier.
sig { returns(T.nilable(Integer)) }
def flat_amount; end
sig { params(_flat_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def flat_amount=(_flat_amount); end
# Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def flat_amount_decimal; end
sig { params(_flat_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def flat_amount_decimal=(_flat_amount_decimal); end
# The per unit billing amount for each individual unit for which this tier applies.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
# Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
sig { returns(T.any(String, Integer)) }
def up_to; end
sig { params(_up_to: T.any(String, Integer)).returns(T.any(String, Integer)) }
def up_to=(_up_to); end
sig {
params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
}
def initialize(
flat_amount: nil,
flat_amount_decimal: nil,
unit_amount: nil,
unit_amount_decimal: nil,
up_to: nil
); end
end
class TransformQuantity < Stripe::RequestParams
# Divide usage by this number.
sig { returns(Integer) }
def divide_by; end
sig { params(_divide_by: Integer).returns(Integer) }
def divide_by=(_divide_by); end
# After division, either round the result `up` or `down`.
sig { returns(String) }
def round; end
sig { params(_round: String).returns(String) }
def round=(_round); end
sig { params(divide_by: Integer, round: String).void }
def initialize(divide_by: nil, round: nil); end
end
# Whether the price can be used for new purchases. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
sig { returns(T.nilable(String)) }
def billing_scheme; end
sig { params(_billing_scheme: T.nilable(String)).returns(T.nilable(String)) }
def billing_scheme=(_billing_scheme); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::PriceService::CreateParams::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::PriceService::CreateParams::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::PriceService::CreateParams::CurrencyOptions]))
}
def currency_options=(_currency_options); end
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
sig { returns(T.nilable(::Stripe::PriceService::CreateParams::CustomUnitAmount)) }
def custom_unit_amount; end
sig {
params(_custom_unit_amount: T.nilable(::Stripe::PriceService::CreateParams::CustomUnitAmount)).returns(T.nilable(::Stripe::PriceService::CreateParams::CustomUnitAmount))
}
def custom_unit_amount=(_custom_unit_amount); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
sig { returns(T.nilable(String)) }
def lookup_key; end
sig { params(_lookup_key: T.nilable(String)).returns(T.nilable(String)) }
def lookup_key=(_lookup_key); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# A brief description of the price, hidden from customers.
sig { returns(T.nilable(String)) }
def nickname; end
sig { params(_nickname: T.nilable(String)).returns(T.nilable(String)) }
def nickname=(_nickname); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# These fields can be used to create a new product that this price will belong to.
sig { returns(T.nilable(::Stripe::PriceService::CreateParams::ProductData)) }
def product_data; end
sig {
params(_product_data: T.nilable(::Stripe::PriceService::CreateParams::ProductData)).returns(T.nilable(::Stripe::PriceService::CreateParams::ProductData))
}
def product_data=(_product_data); end
# The recurring components of a price such as `interval` and `usage_type`.
sig { returns(T.nilable(::Stripe::PriceService::CreateParams::Recurring)) }
def recurring; end
sig {
params(_recurring: T.nilable(::Stripe::PriceService::CreateParams::Recurring)).returns(T.nilable(::Stripe::PriceService::CreateParams::Recurring))
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
sig { returns(T.nilable(T::Array[::Stripe::PriceService::CreateParams::Tier])) }
def tiers; end
sig {
params(_tiers: T.nilable(T::Array[::Stripe::PriceService::CreateParams::Tier])).returns(T.nilable(T::Array[::Stripe::PriceService::CreateParams::Tier]))
}
def tiers=(_tiers); end
# Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.
sig { returns(T.nilable(String)) }
def tiers_mode; end
sig { params(_tiers_mode: T.nilable(String)).returns(T.nilable(String)) }
def tiers_mode=(_tiers_mode); end
# If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
sig { returns(T.nilable(T::Boolean)) }
def transfer_lookup_key; end
sig { params(_transfer_lookup_key: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def transfer_lookup_key=(_transfer_lookup_key); end
# Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.
sig { returns(T.nilable(::Stripe::PriceService::CreateParams::TransformQuantity)) }
def transform_quantity; end
sig {
params(_transform_quantity: T.nilable(::Stripe::PriceService::CreateParams::TransformQuantity)).returns(T.nilable(::Stripe::PriceService::CreateParams::TransformQuantity))
}
def transform_quantity=(_transform_quantity); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(active: T.nilable(T::Boolean), billing_scheme: T.nilable(String), currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::PriceService::CreateParams::CurrencyOptions]), custom_unit_amount: T.nilable(::Stripe::PriceService::CreateParams::CustomUnitAmount), expand: T.nilable(T::Array[String]), lookup_key: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), nickname: T.nilable(String), product: T.nilable(String), product_data: T.nilable(::Stripe::PriceService::CreateParams::ProductData), recurring: T.nilable(::Stripe::PriceService::CreateParams::Recurring), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::PriceService::CreateParams::Tier]), tiers_mode: T.nilable(String), transfer_lookup_key: T.nilable(T::Boolean), transform_quantity: T.nilable(::Stripe::PriceService::CreateParams::TransformQuantity), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
active: nil,
billing_scheme: nil,
currency: nil,
currency_options: nil,
custom_unit_amount: nil,
expand: nil,
lookup_key: nil,
metadata: nil,
nickname: nil,
product: nil,
product_data: nil,
recurring: nil,
tax_behavior: nil,
tiers: nil,
tiers_mode: nil,
transfer_lookup_key: nil,
transform_quantity: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
class CustomUnitAmount < Stripe::RequestParams
# Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum unit amount the customer can specify for this item.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
# The starting unit amount which can be updated by the customer.
sig { returns(T.nilable(Integer)) }
def preset; end
sig { params(_preset: T.nilable(Integer)).returns(T.nilable(Integer)) }
def preset=(_preset); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
end
class Tier < Stripe::RequestParams
# The flat billing amount for an entire tier, regardless of the number of units in the tier.
sig { returns(T.nilable(Integer)) }
def flat_amount; end
sig { params(_flat_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def flat_amount=(_flat_amount); end
# Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def flat_amount_decimal; end
sig { params(_flat_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def flat_amount_decimal=(_flat_amount_decimal); end
# The per unit billing amount for each individual unit for which this tier applies.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
# Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
sig { returns(T.any(String, Integer)) }
def up_to; end
sig { params(_up_to: T.any(String, Integer)).returns(T.any(String, Integer)) }
def up_to=(_up_to); end
sig {
params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
}
def initialize(
flat_amount: nil,
flat_amount_decimal: nil,
unit_amount: nil,
unit_amount_decimal: nil,
up_to: nil
); end
end
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
sig {
returns(T.nilable(::Stripe::PriceService::UpdateParams::CurrencyOptions::CustomUnitAmount))
}
def custom_unit_amount; end
sig {
params(_custom_unit_amount: T.nilable(::Stripe::PriceService::UpdateParams::CurrencyOptions::CustomUnitAmount)).returns(T.nilable(::Stripe::PriceService::UpdateParams::CurrencyOptions::CustomUnitAmount))
}
def custom_unit_amount=(_custom_unit_amount); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
sig {
returns(T.nilable(T::Array[::Stripe::PriceService::UpdateParams::CurrencyOptions::Tier]))
}
def tiers; end
sig {
params(_tiers: T.nilable(T::Array[::Stripe::PriceService::UpdateParams::CurrencyOptions::Tier])).returns(T.nilable(T::Array[::Stripe::PriceService::UpdateParams::CurrencyOptions::Tier]))
}
def tiers=(_tiers); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(custom_unit_amount: T.nilable(::Stripe::PriceService::UpdateParams::CurrencyOptions::CustomUnitAmount), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::PriceService::UpdateParams::CurrencyOptions::Tier]), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
custom_unit_amount: nil,
tax_behavior: nil,
tiers: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class MigrateTo < Stripe::RequestParams
# The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
# The time after which subscriptions should start using the new price.
sig { returns(T.nilable(Integer)) }
def effective_after; end
sig { params(_effective_after: T.nilable(Integer)).returns(T.nilable(Integer)) }
def effective_after=(_effective_after); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
sig { params(behavior: String, effective_after: T.nilable(Integer), price: String).void }
def initialize(behavior: nil, effective_after: nil, price: nil); end
end
# Whether the price can be used for new purchases. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T.any(String, T::Hash[String, ::Stripe::PriceService::UpdateParams::CurrencyOptions])))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T.any(String, T::Hash[String, ::Stripe::PriceService::UpdateParams::CurrencyOptions]))).returns(T.nilable(T.any(String, T::Hash[String, ::Stripe::PriceService::UpdateParams::CurrencyOptions])))
}
def currency_options=(_currency_options); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
sig { returns(T.nilable(String)) }
def lookup_key; end
sig { params(_lookup_key: T.nilable(String)).returns(T.nilable(String)) }
def lookup_key=(_lookup_key); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# If specified, subscriptions using this price will be updated to use the new referenced price.
sig { returns(T.nilable(T.any(String, ::Stripe::PriceService::UpdateParams::MigrateTo))) }
def migrate_to; end
sig {
params(_migrate_to: T.nilable(T.any(String, ::Stripe::PriceService::UpdateParams::MigrateTo))).returns(T.nilable(T.any(String, ::Stripe::PriceService::UpdateParams::MigrateTo)))
}
def migrate_to=(_migrate_to); end
# A brief description of the price, hidden from customers.
sig { returns(T.nilable(String)) }
def nickname; end
sig { params(_nickname: T.nilable(String)).returns(T.nilable(String)) }
def nickname=(_nickname); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
sig { returns(T.nilable(T::Boolean)) }
def transfer_lookup_key; end
sig { params(_transfer_lookup_key: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def transfer_lookup_key=(_transfer_lookup_key); end
sig {
params(active: T.nilable(T::Boolean), currency_options: T.nilable(T.any(String, T::Hash[String, ::Stripe::PriceService::UpdateParams::CurrencyOptions])), expand: T.nilable(T::Array[String]), lookup_key: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), migrate_to: T.nilable(T.any(String, ::Stripe::PriceService::UpdateParams::MigrateTo)), nickname: T.nilable(String), tax_behavior: T.nilable(String), transfer_lookup_key: T.nilable(T::Boolean)).void
}
def initialize(
active: nil,
currency_options: nil,
expand: nil,
lookup_key: nil,
metadata: nil,
migrate_to: nil,
nickname: nil,
tax_behavior: nil,
transfer_lookup_key: nil
); end
end
class SearchParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
sig { returns(T.nilable(String)) }
def page; end
sig { params(_page: T.nilable(String)).returns(T.nilable(String)) }
def page=(_page); end
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for prices](https://stripe.com/docs/search#query-fields-for-prices).
sig { returns(String) }
def query; end
sig { params(_query: String).returns(String) }
def query=(_query); end
sig {
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
}
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
end
# Creates a new [Price for an existing Product](https://docs.stripe.com/api/prices). The Price can be recurring or one-time.
sig {
params(params: T.any(::Stripe::PriceService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Price)
}
def create(params = {}, opts = {}); end
# Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
sig {
params(params: T.any(::Stripe::PriceService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the price with the given ID.
sig {
params(price: String, params: T.any(::Stripe::PriceService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Price)
}
def retrieve(price, params = {}, opts = {}); end
# Search for prices 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.
sig {
params(params: T.any(::Stripe::PriceService::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
}
def search(params = {}, opts = {}); end
# Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
sig {
params(price: String, params: T.any(::Stripe::PriceService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Price)
}
def update(price, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class PrivacyService < StripeService
attr_reader :redaction_jobs
end
end
# typed: true
module Stripe
module Privacy
class RedactionJobService < StripeService
attr_reader :validation_errors
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Attribute for param field status
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class Objects < Stripe::RequestParams
# Attribute for param field charges
sig { returns(T.nilable(T::Array[String])) }
def charges; end
sig { params(_charges: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def charges=(_charges); end
# Attribute for param field checkout_sessions
sig { returns(T.nilable(T::Array[String])) }
def checkout_sessions; end
sig {
params(_checkout_sessions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def checkout_sessions=(_checkout_sessions); end
# Attribute for param field customers
sig { returns(T.nilable(T::Array[String])) }
def customers; end
sig {
params(_customers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def customers=(_customers); end
# Attribute for param field identity_verification_sessions
sig { returns(T.nilable(T::Array[String])) }
def identity_verification_sessions; end
sig {
params(_identity_verification_sessions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def identity_verification_sessions=(_identity_verification_sessions); end
# Attribute for param field invoices
sig { returns(T.nilable(T::Array[String])) }
def invoices; end
sig {
params(_invoices: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def invoices=(_invoices); end
# Attribute for param field issuing_cardholders
sig { returns(T.nilable(T::Array[String])) }
def issuing_cardholders; end
sig {
params(_issuing_cardholders: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def issuing_cardholders=(_issuing_cardholders); end
# Attribute for param field issuing_cards
sig { returns(T.nilable(T::Array[String])) }
def issuing_cards; end
sig {
params(_issuing_cards: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def issuing_cards=(_issuing_cards); end
# Attribute for param field payment_intents
sig { returns(T.nilable(T::Array[String])) }
def payment_intents; end
sig {
params(_payment_intents: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_intents=(_payment_intents); end
# Attribute for param field radar_value_list_items
sig { returns(T.nilable(T::Array[String])) }
def radar_value_list_items; end
sig {
params(_radar_value_list_items: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def radar_value_list_items=(_radar_value_list_items); end
# Attribute for param field setup_intents
sig { returns(T.nilable(T::Array[String])) }
def setup_intents; end
sig {
params(_setup_intents: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def setup_intents=(_setup_intents); end
sig {
params(charges: T.nilable(T::Array[String]), checkout_sessions: T.nilable(T::Array[String]), customers: T.nilable(T::Array[String]), identity_verification_sessions: T.nilable(T::Array[String]), invoices: T.nilable(T::Array[String]), issuing_cardholders: T.nilable(T::Array[String]), issuing_cards: T.nilable(T::Array[String]), payment_intents: T.nilable(T::Array[String]), radar_value_list_items: T.nilable(T::Array[String]), setup_intents: T.nilable(T::Array[String])).void
}
def initialize(
charges: nil,
checkout_sessions: nil,
customers: nil,
identity_verification_sessions: nil,
invoices: nil,
issuing_cardholders: nil,
issuing_cards: nil,
payment_intents: nil,
radar_value_list_items: nil,
setup_intents: nil
); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The objects to redact. These root objects and their related ones will be validated for redaction.
sig { returns(::Stripe::Privacy::RedactionJobService::CreateParams::Objects) }
def objects; end
sig {
params(_objects: ::Stripe::Privacy::RedactionJobService::CreateParams::Objects).returns(::Stripe::Privacy::RedactionJobService::CreateParams::Objects)
}
def objects=(_objects); end
# Determines the validation behavior of the job. Default is `error`.
sig { returns(T.nilable(String)) }
def validation_behavior; end
sig { params(_validation_behavior: T.nilable(String)).returns(T.nilable(String)) }
def validation_behavior=(_validation_behavior); end
sig {
params(expand: T.nilable(T::Array[String]), objects: ::Stripe::Privacy::RedactionJobService::CreateParams::Objects, validation_behavior: T.nilable(String)).void
}
def initialize(expand: nil, objects: nil, validation_behavior: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Determines the validation behavior of the job. Default is `error`.
sig { returns(T.nilable(String)) }
def validation_behavior; end
sig { params(_validation_behavior: T.nilable(String)).returns(T.nilable(String)) }
def validation_behavior=(_validation_behavior); end
sig {
params(expand: T.nilable(T::Array[String]), validation_behavior: T.nilable(String)).void
}
def initialize(expand: nil, validation_behavior: nil); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class RunParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ValidateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# You can cancel a redaction job when it's in one of these statuses: ready, failed.
#
# Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.
sig {
params(job: String, params: T.any(::Stripe::Privacy::RedactionJobService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Privacy::RedactionJob)
}
def cancel(job, params = {}, opts = {}); end
# Creates a redaction job. When a job is created, it will start to validate.
sig {
params(params: T.any(::Stripe::Privacy::RedactionJobService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Privacy::RedactionJob)
}
def create(params = {}, opts = {}); end
# Returns a list of redaction jobs.
sig {
params(params: T.any(::Stripe::Privacy::RedactionJobService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of a previously created redaction job.
sig {
params(job: String, params: T.any(::Stripe::Privacy::RedactionJobService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Privacy::RedactionJob)
}
def retrieve(job, params = {}, opts = {}); end
# Run a redaction job in a ready status.
#
# When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.
#
# The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job's validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.
sig {
params(job: String, params: T.any(::Stripe::Privacy::RedactionJobService::RunParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Privacy::RedactionJob)
}
def run(job, params = {}, opts = {}); end
# Updates the properties of a redaction job without running or canceling the job.
#
# If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.
sig {
params(job: String, params: T.any(::Stripe::Privacy::RedactionJobService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Privacy::RedactionJob)
}
def update(job, params = {}, opts = {}); end
# Validate a redaction job when it is in a failed status.
#
# When a job is created, it automatically begins to validate on the configured objects' eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job's validation_behavior is changed.
#
# The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.
sig {
params(job: String, params: T.any(::Stripe::Privacy::RedactionJobService::ValidateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Privacy::RedactionJob)
}
def validate(job, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Privacy
class RedactionJobValidationErrorService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Returns a list of validation errors for the specified redaction job.
sig {
params(job: String, params: T.any(::Stripe::Privacy::RedactionJobValidationErrorService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(job, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class ProductService < StripeService
attr_reader :features
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class MarketingFeature < Stripe::RequestParams
# The marketing feature name. Up to 80 characters long.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class PackageDimensions < Stripe::RequestParams
# Height, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def height; end
sig { params(_height: Float).returns(Float) }
def height=(_height); end
# Length, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def length; end
sig { params(_length: Float).returns(Float) }
def length=(_length); end
# Weight, in ounces. Maximum precision is 2 decimal places.
sig { returns(Float) }
def weight; end
sig { params(_weight: Float).returns(Float) }
def weight=(_weight); end
# Width, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def width; end
sig { params(_width: Float).returns(Float) }
def width=(_width); end
sig { params(height: Float, length: Float, weight: Float, width: Float).void }
def initialize(height: nil, length: nil, weight: nil, width: nil); end
end
# Whether the product is available for purchase.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.
sig { returns(T.nilable(String)) }
def default_price; end
sig { params(_default_price: T.nilable(String)).returns(T.nilable(String)) }
def default_price=(_default_price); end
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def images; end
sig {
params(_images: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def images=(_images); end
# A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::ProductService::UpdateParams::MarketingFeature])))
}
def marketing_features; end
sig {
params(_marketing_features: T.nilable(T.any(String, T::Array[::Stripe::ProductService::UpdateParams::MarketingFeature]))).returns(T.nilable(T.any(String, T::Array[::Stripe::ProductService::UpdateParams::MarketingFeature])))
}
def marketing_features=(_marketing_features); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The dimensions of this product for shipping purposes.
sig {
returns(T.nilable(T.any(String, ::Stripe::ProductService::UpdateParams::PackageDimensions)))
}
def package_dimensions; end
sig {
params(_package_dimensions: T.nilable(T.any(String, ::Stripe::ProductService::UpdateParams::PackageDimensions))).returns(T.nilable(T.any(String, ::Stripe::ProductService::UpdateParams::PackageDimensions)))
}
def package_dimensions=(_package_dimensions); end
# Whether this product is shipped (i.e., physical goods).
sig { returns(T.nilable(T::Boolean)) }
def shippable; end
sig { params(_shippable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def shippable=(_shippable); end
# An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
#
# This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
# It must contain at least one letter. May only be set if `type=service`. Only used for subscription payments.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
# A URL of a publicly-accessible webpage for this product.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(active: T.nilable(T::Boolean), default_price: T.nilable(String), description: T.nilable(String), expand: T.nilable(T::Array[String]), images: T.nilable(T.any(String, T::Array[String])), marketing_features: T.nilable(T.any(String, T::Array[::Stripe::ProductService::UpdateParams::MarketingFeature])), metadata: T.nilable(T.any(String, T::Hash[String, String])), name: T.nilable(String), package_dimensions: T.nilable(T.any(String, ::Stripe::ProductService::UpdateParams::PackageDimensions)), shippable: T.nilable(T::Boolean), statement_descriptor: T.nilable(String), tax_code: T.nilable(String), unit_label: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
active: nil,
default_price: nil,
description: nil,
expand: nil,
images: nil,
marketing_features: nil,
metadata: nil,
name: nil,
package_dimensions: nil,
shippable: nil,
statement_descriptor: nil,
tax_code: nil,
unit_label: nil,
url: nil
); end
end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return products that are active or inactive (e.g., pass `false` to list all inactive products).
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Only return products that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::ProductService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::ProductService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::ProductService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before).
sig { returns(T.nilable(T::Array[String])) }
def ids; end
sig { params(_ids: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def ids=(_ids); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return products that can be shipped (i.e., physical, not digital products).
sig { returns(T.nilable(T::Boolean)) }
def shippable; end
sig { params(_shippable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def shippable=(_shippable); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return products of this type.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# Only return products with the given url.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::ProductService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), ids: T.nilable(T::Array[String]), limit: T.nilable(Integer), shippable: T.nilable(T::Boolean), starting_after: T.nilable(String), type: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
active: nil,
created: nil,
ending_before: nil,
expand: nil,
ids: nil,
limit: nil,
shippable: nil,
starting_after: nil,
type: nil,
url: nil
); end
end
class CreateParams < Stripe::RequestParams
class DefaultPriceData < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
class CustomUnitAmount < Stripe::RequestParams
# Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum unit amount the customer can specify for this item.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
# The starting unit amount which can be updated by the customer.
sig { returns(T.nilable(Integer)) }
def preset; end
sig { params(_preset: T.nilable(Integer)).returns(T.nilable(Integer)) }
def preset=(_preset); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
end
class Tier < Stripe::RequestParams
# The flat billing amount for an entire tier, regardless of the number of units in the tier.
sig { returns(T.nilable(Integer)) }
def flat_amount; end
sig { params(_flat_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def flat_amount=(_flat_amount); end
# Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def flat_amount_decimal; end
sig { params(_flat_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def flat_amount_decimal=(_flat_amount_decimal); end
# The per unit billing amount for each individual unit for which this tier applies.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
# Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
sig { returns(T.any(String, Integer)) }
def up_to; end
sig { params(_up_to: T.any(String, Integer)).returns(T.any(String, Integer)) }
def up_to=(_up_to); end
sig {
params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
}
def initialize(
flat_amount: nil,
flat_amount_decimal: nil,
unit_amount: nil,
unit_amount_decimal: nil,
up_to: nil
); end
end
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
sig {
returns(T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions::CustomUnitAmount))
}
def custom_unit_amount; end
sig {
params(_custom_unit_amount: T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions::CustomUnitAmount)).returns(T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions::CustomUnitAmount))
}
def custom_unit_amount=(_custom_unit_amount); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
sig {
returns(T.nilable(T::Array[::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions::Tier]))
}
def tiers; end
sig {
params(_tiers: T.nilable(T::Array[::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions::Tier])).returns(T.nilable(T::Array[::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions::Tier]))
}
def tiers=(_tiers); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(custom_unit_amount: T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions::CustomUnitAmount), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions::Tier]), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
custom_unit_amount: nil,
tax_behavior: nil,
tiers: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class CustomUnitAmount < Stripe::RequestParams
# Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The maximum unit amount the customer can specify for this item.
sig { returns(T.nilable(Integer)) }
def maximum; end
sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum=(_maximum); end
# The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
sig { returns(T.nilable(Integer)) }
def minimum; end
sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum=(_minimum); end
# The starting unit amount which can be updated by the customer.
sig { returns(T.nilable(Integer)) }
def preset; end
sig { params(_preset: T.nilable(Integer)).returns(T.nilable(Integer)) }
def preset=(_preset); end
sig {
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
}
def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
end
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions]))
}
def currency_options=(_currency_options); end
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
sig {
returns(T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::CustomUnitAmount))
}
def custom_unit_amount; end
sig {
params(_custom_unit_amount: T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::CustomUnitAmount)).returns(T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::CustomUnitAmount))
}
def custom_unit_amount=(_custom_unit_amount); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::Recurring))
}
def recurring; end
sig {
params(_recurring: T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::Recurring)).returns(T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::Recurring))
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions]), custom_unit_amount: T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::CustomUnitAmount), metadata: T.nilable(T::Hash[String, String]), recurring: T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
currency_options: nil,
custom_unit_amount: nil,
metadata: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class MarketingFeature < Stripe::RequestParams
# The marketing feature name. Up to 80 characters long.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig { params(name: String).void }
def initialize(name: nil); end
end
class PackageDimensions < Stripe::RequestParams
# Height, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def height; end
sig { params(_height: Float).returns(Float) }
def height=(_height); end
# Length, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def length; end
sig { params(_length: Float).returns(Float) }
def length=(_length); end
# Weight, in ounces. Maximum precision is 2 decimal places.
sig { returns(Float) }
def weight; end
sig { params(_weight: Float).returns(Float) }
def weight=(_weight); end
# Width, in inches. Maximum precision is 2 decimal places.
sig { returns(Float) }
def width; end
sig { params(_width: Float).returns(Float) }
def width=(_width); end
sig { params(height: Float, length: Float, weight: Float, width: Float).void }
def initialize(height: nil, length: nil, weight: nil, width: nil); end
end
# Whether the product is currently available for purchase. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product.
sig { returns(T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData)) }
def default_price_data; end
sig {
params(_default_price_data: T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData)).returns(T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData))
}
def default_price_data=(_default_price_data); end
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
sig { returns(T.nilable(T::Array[String])) }
def images; end
sig { params(_images: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def images=(_images); end
# A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
sig { returns(T.nilable(T::Array[::Stripe::ProductService::CreateParams::MarketingFeature])) }
def marketing_features; end
sig {
params(_marketing_features: T.nilable(T::Array[::Stripe::ProductService::CreateParams::MarketingFeature])).returns(T.nilable(T::Array[::Stripe::ProductService::CreateParams::MarketingFeature]))
}
def marketing_features=(_marketing_features); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The product's name, meant to be displayable to the customer.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The dimensions of this product for shipping purposes.
sig { returns(T.nilable(::Stripe::ProductService::CreateParams::PackageDimensions)) }
def package_dimensions; end
sig {
params(_package_dimensions: T.nilable(::Stripe::ProductService::CreateParams::PackageDimensions)).returns(T.nilable(::Stripe::ProductService::CreateParams::PackageDimensions))
}
def package_dimensions=(_package_dimensions); end
# Whether this product is shipped (i.e., physical goods).
sig { returns(T.nilable(T::Boolean)) }
def shippable; end
sig { params(_shippable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def shippable=(_shippable); end
# An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
#
# This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
# It must contain at least one letter. Only used for subscription payments.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The type of the product. Defaults to `service` if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to `good` to use this product with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for compatibility reasons.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
sig { returns(T.nilable(String)) }
def unit_label; end
sig { params(_unit_label: T.nilable(String)).returns(T.nilable(String)) }
def unit_label=(_unit_label); end
# A URL of a publicly-accessible webpage for this product.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(active: T.nilable(T::Boolean), default_price_data: T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData), description: T.nilable(String), expand: T.nilable(T::Array[String]), id: T.nilable(String), images: T.nilable(T::Array[String]), marketing_features: T.nilable(T::Array[::Stripe::ProductService::CreateParams::MarketingFeature]), metadata: T.nilable(T::Hash[String, String]), name: String, package_dimensions: T.nilable(::Stripe::ProductService::CreateParams::PackageDimensions), shippable: T.nilable(T::Boolean), statement_descriptor: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String), unit_label: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
active: nil,
default_price_data: nil,
description: nil,
expand: nil,
id: nil,
images: nil,
marketing_features: nil,
metadata: nil,
name: nil,
package_dimensions: nil,
shippable: nil,
statement_descriptor: nil,
tax_code: nil,
type: nil,
unit_label: nil,
url: nil
); end
end
class SearchParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
sig { returns(T.nilable(String)) }
def page; end
sig { params(_page: T.nilable(String)).returns(T.nilable(String)) }
def page=(_page); end
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for products](https://stripe.com/docs/search#query-fields-for-products).
sig { returns(String) }
def query; end
sig { params(_query: String).returns(String) }
def query=(_query); end
sig {
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
}
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
end
# Creates a new product object.
sig {
params(params: T.any(::Stripe::ProductService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Product)
}
def create(params = {}, opts = {}); end
# Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.
sig {
params(id: String, params: T.any(::Stripe::ProductService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Product)
}
def delete(id, params = {}, opts = {}); end
# Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
sig {
params(params: T.any(::Stripe::ProductService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.
sig {
params(id: String, params: T.any(::Stripe::ProductService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Product)
}
def retrieve(id, params = {}, opts = {}); end
# Search for products 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.
sig {
params(params: T.any(::Stripe::ProductService::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
}
def search(params = {}, opts = {}); end
# Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(id: String, params: T.any(::Stripe::ProductService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Product)
}
def update(id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class ProductFeatureService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateParams < Stripe::RequestParams
# The ID of the [Feature](https://stripe.com/docs/api/entitlements/feature) object attached to this product.
sig { returns(String) }
def entitlement_feature; end
sig { params(_entitlement_feature: String).returns(String) }
def entitlement_feature=(_entitlement_feature); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(entitlement_feature: String, expand: T.nilable(T::Array[String])).void }
def initialize(entitlement_feature: nil, expand: nil); end
end
# Creates a product_feature, which represents a feature attachment to a product
sig {
params(product: String, params: T.any(::Stripe::ProductFeatureService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ProductFeature)
}
def create(product, params = {}, opts = {}); end
# Deletes the feature attachment to a product
sig {
params(product: String, id: String, params: T.any(::Stripe::ProductFeatureService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ProductFeature)
}
def delete(product, id, params = {}, opts = {}); end
# Retrieve a list of features for a product
sig {
params(product: String, params: T.any(::Stripe::ProductFeatureService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(product, params = {}, opts = {}); end
# Retrieves a product_feature, which represents a feature attachment to a product
sig {
params(product: String, id: String, params: T.any(::Stripe::ProductFeatureService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ProductFeature)
}
def retrieve(product, id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class PromotionCodeService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Filter promotion codes by whether they are active.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Only return promotion codes that have this case-insensitive code.
sig { returns(T.nilable(String)) }
def code; end
sig { params(_code: T.nilable(String)).returns(T.nilable(String)) }
def code=(_code); end
# Only return promotion codes for this coupon.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
sig {
returns(T.nilable(T.any(::Stripe::PromotionCodeService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::PromotionCodeService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::PromotionCodeService::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return promotion codes that are restricted to this customer.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Only return promotion codes that are restricted to this account.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(active: T.nilable(T::Boolean), code: T.nilable(String), coupon: T.nilable(String), created: T.nilable(T.any(::Stripe::PromotionCodeService::ListParams::Created, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
active: nil,
code: nil,
coupon: nil,
created: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Restrictions < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
sig { params(minimum_amount: T.nilable(Integer)).void }
def initialize(minimum_amount: nil); end
end
# Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::PromotionCodeService::CreateParams::Restrictions::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::PromotionCodeService::CreateParams::Restrictions::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::PromotionCodeService::CreateParams::Restrictions::CurrencyOptions]))
}
def currency_options=(_currency_options); end
# A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
sig { returns(T.nilable(T::Boolean)) }
def first_time_transaction; end
sig {
params(_first_time_transaction: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def first_time_transaction=(_first_time_transaction); end
# Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount
sig { returns(T.nilable(String)) }
def minimum_amount_currency; end
sig { params(_minimum_amount_currency: T.nilable(String)).returns(T.nilable(String)) }
def minimum_amount_currency=(_minimum_amount_currency); end
sig {
params(currency_options: T.nilable(T::Hash[String, ::Stripe::PromotionCodeService::CreateParams::Restrictions::CurrencyOptions]), first_time_transaction: T.nilable(T::Boolean), minimum_amount: T.nilable(Integer), minimum_amount_currency: T.nilable(String)).void
}
def initialize(
currency_options: nil,
first_time_transaction: nil,
minimum_amount: nil,
minimum_amount_currency: nil
); end
end
# Whether the promotion code is currently active.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).
#
# If left blank, we will generate one automatically.
sig { returns(T.nilable(String)) }
def code; end
sig { params(_code: T.nilable(String)).returns(T.nilable(String)) }
def code=(_code); end
# The coupon for this promotion code.
sig { returns(String) }
def coupon; end
sig { params(_coupon: String).returns(String) }
def coupon=(_coupon); end
# The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The account that this promotion code can be used by. If not set, the promotion code can be used by all accounts.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`.
sig { returns(T.nilable(Integer)) }
def max_redemptions; end
sig { params(_max_redemptions: T.nilable(Integer)).returns(T.nilable(Integer)) }
def max_redemptions=(_max_redemptions); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Settings that restrict the redemption of the promotion code.
sig { returns(T.nilable(::Stripe::PromotionCodeService::CreateParams::Restrictions)) }
def restrictions; end
sig {
params(_restrictions: T.nilable(::Stripe::PromotionCodeService::CreateParams::Restrictions)).returns(T.nilable(::Stripe::PromotionCodeService::CreateParams::Restrictions))
}
def restrictions=(_restrictions); end
sig {
params(active: T.nilable(T::Boolean), code: T.nilable(String), coupon: String, customer: T.nilable(String), customer_account: T.nilable(String), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), max_redemptions: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), restrictions: T.nilable(::Stripe::PromotionCodeService::CreateParams::Restrictions)).void
}
def initialize(
active: nil,
code: nil,
coupon: nil,
customer: nil,
customer_account: nil,
expand: nil,
expires_at: nil,
max_redemptions: nil,
metadata: nil,
restrictions: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Restrictions < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
sig { params(minimum_amount: T.nilable(Integer)).void }
def initialize(minimum_amount: nil); end
end
# Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::PromotionCodeService::UpdateParams::Restrictions::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::PromotionCodeService::UpdateParams::Restrictions::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::PromotionCodeService::UpdateParams::Restrictions::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(currency_options: T.nilable(T::Hash[String, ::Stripe::PromotionCodeService::UpdateParams::Restrictions::CurrencyOptions])).void
}
def initialize(currency_options: nil); end
end
# Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Settings that restrict the redemption of the promotion code.
sig { returns(T.nilable(::Stripe::PromotionCodeService::UpdateParams::Restrictions)) }
def restrictions; end
sig {
params(_restrictions: T.nilable(::Stripe::PromotionCodeService::UpdateParams::Restrictions)).returns(T.nilable(::Stripe::PromotionCodeService::UpdateParams::Restrictions))
}
def restrictions=(_restrictions); end
sig {
params(active: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), restrictions: T.nilable(::Stripe::PromotionCodeService::UpdateParams::Restrictions)).void
}
def initialize(active: nil, expand: nil, metadata: nil, restrictions: nil); end
end
# A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
sig {
params(params: T.any(::Stripe::PromotionCodeService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PromotionCode)
}
def create(params = {}, opts = {}); end
# Returns a list of your promotion codes.
sig {
params(params: T.any(::Stripe::PromotionCodeService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://docs.stripe.com/docs/api/promotion_codes/list) with the desired code.
sig {
params(promotion_code: String, params: T.any(::Stripe::PromotionCodeService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PromotionCode)
}
def retrieve(promotion_code, params = {}, opts = {}); end
# Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.
sig {
params(promotion_code: String, params: T.any(::Stripe::PromotionCodeService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PromotionCode)
}
def update(promotion_code, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class QuoteService < StripeService
attr_reader :computed_upfront_line_items
attr_reader :lines
attr_reader :line_items
attr_reader :preview_invoices
attr_reader :preview_subscription_schedules
class ListParams < Stripe::RequestParams
# The ID of the customer whose quotes will be retrieved.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The ID of the account whose quotes will be retrieved.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The subscription which the quote updates.
sig { returns(T.nilable(String)) }
def from_subscription; end
sig { params(_from_subscription: T.nilable(String)).returns(T.nilable(String)) }
def from_subscription=(_from_subscription); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# The status of the quote.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set.
sig { returns(T.nilable(String)) }
def test_clock; end
sig { params(_test_clock: T.nilable(String)).returns(T.nilable(String)) }
def test_clock=(_test_clock); end
sig {
params(customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), from_subscription: T.nilable(String), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String), test_clock: T.nilable(String)).void
}
def initialize(
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
from_subscription: nil,
limit: nil,
starting_after: nil,
status: nil,
test_clock: nil
); end
end
class CreateParams < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::AutomaticTax::Liability)) }
def liability; end
sig {
params(_liability: T.nilable(::Stripe::QuoteService::CreateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::QuoteService::CreateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::QuoteService::CreateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::QuoteService::CreateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::QuoteService::CreateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::QuoteService::CreateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::QuoteService::CreateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class FromQuote < Stripe::RequestParams
# Whether this quote is a revision of the previous quote.
sig { returns(T.nilable(T::Boolean)) }
def is_revision; end
sig { params(_is_revision: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def is_revision=(_is_revision); end
# The `id` of the quote that will be cloned.
sig { returns(String) }
def quote; end
sig { params(_quote: String).returns(String) }
def quote=(_quote); end
sig { params(is_revision: T.nilable(T::Boolean), quote: String).void }
def initialize(is_revision: nil, quote: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::InvoiceSettings::Issuer)) }
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::QuoteService::CreateParams::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::QuoteService::CreateParams::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::QuoteService::CreateParams::InvoiceSettings::Issuer)).void
}
def initialize(days_until_due: nil, issuer: nil); end
end
class Line < Stripe::RequestParams
class Action < Stripe::RequestParams
class AddDiscount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
# The coupon code to redeem.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# An ID of an existing discount for a coupon that was already redeemed.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddDiscount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddDiscount::DiscountEnd)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddDiscount::DiscountEnd))
}
def discount_end=(_discount_end); end
# The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
# The promotion code to redeem.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddDiscount::DiscountEnd), index: T.nilable(Integer), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
index: nil,
promotion_code: nil
); end
end
class AddItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); end
end
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
sig {
returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount])).returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# Quantity for this item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
# Options that configure the trial on the subscription item.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Trial)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Trial))
}
def trial=(_trial); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount]), metadata: T.nilable(T::Hash[String, String]), price: String, quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String]), trial: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Trial)).void
}
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
class RemoveDiscount < Stripe::RequestParams
# The coupon code to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# The ID of a discount to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# The ID of a promotion code to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
class RemoveItem < Stripe::RequestParams
# ID of a price to remove.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
sig { params(price: String).void }
def initialize(price: nil); end
end
class SetDiscount < Stripe::RequestParams
# The coupon code to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# An ID of an existing discount to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# An ID of an existing promotion code to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
class SetItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); end
end
# If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.
sig {
returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount])).returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount]))
}
def discounts=(_discounts); end
# If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
# If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Trial)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Trial))
}
def trial=(_trial); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount]), metadata: T.nilable(T::Hash[String, String]), price: String, quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String]), trial: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Trial)).void
}
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
# Details for the `add_discount` type.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddDiscount))
}
def add_discount; end
sig {
params(_add_discount: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddDiscount)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddDiscount))
}
def add_discount=(_add_discount); end
# Details for the `add_item` type.
sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddItem)) }
def add_item; end
sig {
params(_add_item: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddItem)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddItem))
}
def add_item=(_add_item); end
# Details for the `add_metadata` type: specify a hash of key-value pairs.
sig { returns(T.nilable(T::Hash[String, String])) }
def add_metadata; end
sig {
params(_add_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def add_metadata=(_add_metadata); end
# Details for the `remove_discount` type.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::RemoveDiscount))
}
def remove_discount; end
sig {
params(_remove_discount: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::RemoveDiscount)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::RemoveDiscount))
}
def remove_discount=(_remove_discount); end
# Details for the `remove_item` type.
sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::RemoveItem)) }
def remove_item; end
sig {
params(_remove_item: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::RemoveItem)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::RemoveItem))
}
def remove_item=(_remove_item); end
# Details for the `remove_metadata` type: specify an array of metadata keys.
sig { returns(T.nilable(T::Array[String])) }
def remove_metadata; end
sig {
params(_remove_metadata: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def remove_metadata=(_remove_metadata); end
# Details for the `set_discounts` type.
sig {
returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetDiscount]))
}
def set_discounts; end
sig {
params(_set_discounts: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetDiscount])).returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetDiscount]))
}
def set_discounts=(_set_discounts); end
# Details for the `set_items` type.
sig {
returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetItem]))
}
def set_items; end
sig {
params(_set_items: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetItem])).returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetItem]))
}
def set_items=(_set_items); end
# Details for the `set_metadata` type: specify an array of key-value pairs.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def set_metadata; end
sig {
params(_set_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def set_metadata=(_set_metadata); end
# The type of action the quote line performs.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(add_discount: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddDiscount), add_item: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::AddItem), add_metadata: T.nilable(T::Hash[String, String]), remove_discount: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::RemoveDiscount), remove_item: T.nilable(::Stripe::QuoteService::CreateParams::Line::Action::RemoveItem), remove_metadata: T.nilable(T::Array[String]), set_discounts: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetDiscount]), set_items: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetItem]), set_metadata: T.nilable(T.any(String, T::Hash[String, String])), type: String).void
}
def initialize(
add_discount: nil,
add_item: nil,
add_metadata: nil,
remove_discount: nil,
remove_item: nil,
remove_metadata: nil,
set_discounts: nil,
set_items: nil,
set_metadata: nil,
type: nil
); end
end
class AppliesTo < Stripe::RequestParams
# A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
sig { returns(T.nilable(String)) }
def new_reference; end
sig { params(_new_reference: T.nilable(String)).returns(T.nilable(String)) }
def new_reference=(_new_reference); end
# The ID of the schedule the line applies to.
sig { returns(T.nilable(String)) }
def subscription_schedule; end
sig { params(_subscription_schedule: T.nilable(String)).returns(T.nilable(String)) }
def subscription_schedule=(_subscription_schedule); end
# Describes whether the quote line is affecting a new schedule or an existing schedule.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(new_reference: T.nilable(String), subscription_schedule: T.nilable(String), type: String).void
}
def initialize(new_reference: nil, subscription_schedule: nil, type: nil); end
end
class CancelSubscriptionSchedule < Stripe::RequestParams
# Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
sig { returns(String) }
def cancel_at; end
sig { params(_cancel_at: String).returns(String) }
def cancel_at=(_cancel_at); end
# If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def invoice_now; end
sig { params(_invoice_now: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def invoice_now=(_invoice_now); end
# If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def prorate; end
sig { params(_prorate: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def prorate=(_prorate); end
sig {
params(cancel_at: String, invoice_now: T.nilable(T::Boolean), prorate: T.nilable(T::Boolean)).void
}
def initialize(cancel_at: nil, invoice_now: nil, prorate: nil); end
end
class EndsAt < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
sig { returns(String) }
def discount; end
sig { params(_discount: String).returns(String) }
def discount=(_discount); end
sig { params(discount: String).void }
def initialize(discount: nil); end
end
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Use the `end` time of a given discount.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::EndsAt::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::QuoteService::CreateParams::Line::EndsAt::DiscountEnd)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::EndsAt::DiscountEnd))
}
def discount_end=(_discount_end); end
# Time span for the quote line starting from the `starts_at` date.
sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::EndsAt::Duration)) }
def duration; end
sig {
params(_duration: T.nilable(::Stripe::QuoteService::CreateParams::Line::EndsAt::Duration)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::EndsAt::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select a way to pass in `ends_at`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(discount_end: T.nilable(::Stripe::QuoteService::CreateParams::Line::EndsAt::DiscountEnd), duration: T.nilable(::Stripe::QuoteService::CreateParams::Line::EndsAt::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(discount_end: nil, duration: nil, timestamp: nil, type: nil); end
end
class SetPauseCollection < Stripe::RequestParams
class Set < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(behavior: String).void }
def initialize(behavior: nil); end
end
# Details of the pause_collection behavior to apply to the amendment.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::SetPauseCollection::Set))
}
def set; end
sig {
params(_set: T.nilable(::Stripe::QuoteService::CreateParams::Line::SetPauseCollection::Set)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::SetPauseCollection::Set))
}
def set=(_set); end
# Determines the type of the pause_collection amendment.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(set: T.nilable(::Stripe::QuoteService::CreateParams::Line::SetPauseCollection::Set), type: String).void
}
def initialize(set: nil, type: nil); end
end
class StartsAt < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
sig { returns(String) }
def discount; end
sig { params(_discount: String).returns(String) }
def discount=(_discount); end
sig { params(discount: String).void }
def initialize(discount: nil); end
end
class LineEndsAt < Stripe::RequestParams
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(index: T.nilable(Integer)).void }
def initialize(index: nil); end
end
# Use the `end` time of a given discount.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::StartsAt::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::QuoteService::CreateParams::Line::StartsAt::DiscountEnd)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::StartsAt::DiscountEnd))
}
def discount_end=(_discount_end); end
# The timestamp the given line ends at.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::StartsAt::LineEndsAt))
}
def line_ends_at; end
sig {
params(_line_ends_at: T.nilable(::Stripe::QuoteService::CreateParams::Line::StartsAt::LineEndsAt)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::StartsAt::LineEndsAt))
}
def line_ends_at=(_line_ends_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select a way to pass in `starts_at`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(discount_end: T.nilable(::Stripe::QuoteService::CreateParams::Line::StartsAt::DiscountEnd), line_ends_at: T.nilable(::Stripe::QuoteService::CreateParams::Line::StartsAt::LineEndsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(discount_end: nil, line_ends_at: nil, timestamp: nil, type: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
sig { params(_prorate_up_front: T.nilable(String)).returns(T.nilable(String)) }
def prorate_up_front=(_prorate_up_front); end
sig { params(prorate_up_front: T.nilable(String)).void }
def initialize(prorate_up_front: nil); end
end
# Defines how the subscription should behave when a trial ends.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::TrialSettings::EndBehavior))
}
def end_behavior; end
sig {
params(_end_behavior: T.nilable(::Stripe::QuoteService::CreateParams::Line::TrialSettings::EndBehavior)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::TrialSettings::EndBehavior))
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: T.nilable(::Stripe::QuoteService::CreateParams::Line::TrialSettings::EndBehavior)).void
}
def initialize(end_behavior: nil); end
end
# An array of operations the quote line performs.
sig { returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action])) }
def actions; end
sig {
params(_actions: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action])).returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action]))
}
def actions=(_actions); end
# Details to identify the subscription schedule the quote line applies to.
sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::AppliesTo)) }
def applies_to; end
sig {
params(_applies_to: T.nilable(::Stripe::QuoteService::CreateParams::Line::AppliesTo)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::AppliesTo))
}
def applies_to=(_applies_to); end
# For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::CancelSubscriptionSchedule))
}
def cancel_subscription_schedule; end
sig {
params(_cancel_subscription_schedule: T.nilable(::Stripe::QuoteService::CreateParams::Line::CancelSubscriptionSchedule)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::CancelSubscriptionSchedule))
}
def cancel_subscription_schedule=(_cancel_subscription_schedule); end
# Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::EndsAt)) }
def ends_at; end
sig {
params(_ends_at: T.nilable(::Stripe::QuoteService::CreateParams::Line::EndsAt)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::EndsAt))
}
def ends_at=(_ends_at); end
# Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::SetPauseCollection)) }
def set_pause_collection; end
sig {
params(_set_pause_collection: T.nilable(::Stripe::QuoteService::CreateParams::Line::SetPauseCollection)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::SetPauseCollection))
}
def set_pause_collection=(_set_pause_collection); end
# Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
sig { returns(T.nilable(String)) }
def set_schedule_end; end
sig { params(_set_schedule_end: T.nilable(String)).returns(T.nilable(String)) }
def set_schedule_end=(_set_schedule_end); end
# Details to identify the earliest timestamp where the proposed change should take effect.
sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::StartsAt)) }
def starts_at; end
sig {
params(_starts_at: T.nilable(::Stripe::QuoteService::CreateParams::Line::StartsAt)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::StartsAt))
}
def starts_at=(_starts_at); end
# Settings related to subscription trials.
sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::TrialSettings)) }
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::QuoteService::CreateParams::Line::TrialSettings)).returns(T.nilable(::Stripe::QuoteService::CreateParams::Line::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(actions: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line::Action]), applies_to: T.nilable(::Stripe::QuoteService::CreateParams::Line::AppliesTo), billing_cycle_anchor: T.nilable(String), cancel_subscription_schedule: T.nilable(::Stripe::QuoteService::CreateParams::Line::CancelSubscriptionSchedule), ends_at: T.nilable(::Stripe::QuoteService::CreateParams::Line::EndsAt), proration_behavior: T.nilable(String), set_pause_collection: T.nilable(::Stripe::QuoteService::CreateParams::Line::SetPauseCollection), set_schedule_end: T.nilable(String), starts_at: T.nilable(::Stripe::QuoteService::CreateParams::Line::StartsAt), trial_settings: T.nilable(::Stripe::QuoteService::CreateParams::Line::TrialSettings)).void
}
def initialize(
actions: nil,
applies_to: nil,
billing_cycle_anchor: nil,
cancel_subscription_schedule: nil,
ends_at: nil,
proration_behavior: nil,
set_pause_collection: nil,
set_schedule_end: nil,
starts_at: nil,
trial_settings: nil
); end
end
class LineItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::LineItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::QuoteService::CreateParams::LineItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::QuoteService::CreateParams::LineItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::QuoteService::CreateParams::LineItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::LineItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::QuoteService::CreateParams::LineItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::QuoteService::CreateParams::LineItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::QuoteService::CreateParams::LineItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::LineItem::PriceData::Recurring))
}
def recurring; end
sig {
params(_recurring: T.nilable(::Stripe::QuoteService::CreateParams::LineItem::PriceData::Recurring)).returns(T.nilable(::Stripe::QuoteService::CreateParams::LineItem::PriceData::Recurring))
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: T.nilable(::Stripe::QuoteService::CreateParams::LineItem::PriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# The discounts applied to this line item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::QuoteService::CreateParams::LineItem::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::QuoteService::CreateParams::LineItem::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::QuoteService::CreateParams::LineItem::Discount])))
}
def discounts=(_discounts); end
# The ID of the price object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::LineItem::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::QuoteService::CreateParams::LineItem::PriceData)).returns(T.nilable(::Stripe::QuoteService::CreateParams::LineItem::PriceData))
}
def price_data=(_price_data); end
# The quantity of the line item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(discounts: T.nilable(T.any(String, T::Array[::Stripe::QuoteService::CreateParams::LineItem::Discount])), price: T.nilable(String), price_data: T.nilable(::Stripe::QuoteService::CreateParams::LineItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
discounts: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class SubscriptionData < Stripe::RequestParams
class BillOnAcceptance < Stripe::RequestParams
class BillFrom < Stripe::RequestParams
class LineStartsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Details of a Quote line to start the bill period from.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt))
}
def line_starts_at; end
sig {
params(_line_starts_at: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt)).returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt))
}
def line_starts_at=(_line_starts_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of method to specify the `bill_from` time.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(line_starts_at: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(line_starts_at: nil, timestamp: nil, type: nil); end
end
class BillUntil < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
class LineEndsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Details of the duration over which to bill.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration)).returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration))
}
def duration=(_duration); end
# Details of a Quote line item from which to bill until.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt))
}
def line_ends_at; end
sig {
params(_line_ends_at: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt)).returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt))
}
def line_ends_at=(_line_ends_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of method to specify the `bill_until` time.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration), line_ends_at: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, line_ends_at: nil, timestamp: nil, type: nil); end
end
# The start of the period to bill from when the Quote is accepted.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom))
}
def bill_from; end
sig {
params(_bill_from: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom)).returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom))
}
def bill_from=(_bill_from); end
# The end of the period to bill until when the Quote is accepted.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil))
}
def bill_until; end
sig {
params(_bill_until: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil)).returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil))
}
def bill_until=(_bill_until); end
sig {
params(bill_from: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom), bill_until: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil)).void
}
def initialize(bill_from: nil, bill_until: nil); end
end
class BillingMode < Stripe::RequestParams
class Flexible < Stripe::RequestParams
# Set to `true` to display gross amounts, net amounts, and discount amounts consistently between prorations and non-proration items on invoices, line items, and invoice items. Once set to `true`, you can't change it back to `false`.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
sig {
params(_consistent_proration_discount_amounts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consistent_proration_discount_amounts=(_consistent_proration_discount_amounts); end
sig { params(consistent_proration_discount_amounts: T.nilable(T::Boolean)).void }
def initialize(consistent_proration_discount_amounts: nil); end
end
# Configure behavior for flexible billing mode.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillingMode::Flexible))
}
def flexible; end
sig {
params(_flexible: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillingMode::Flexible)).returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillingMode::Flexible))
}
def flexible=(_flexible); end
# Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(flexible: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillingMode::Flexible), type: String).void
}
def initialize(flexible: nil, type: nil); end
end
class Prebilling < Stripe::RequestParams
# This is used to determine the number of billing cycles to prebill.
sig { returns(Integer) }
def iterations; end
sig { params(_iterations: Integer).returns(Integer) }
def iterations=(_iterations); end
sig { params(iterations: Integer).void }
def initialize(iterations: nil); end
end
# Describes the period to bill for upon accepting the quote.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance))
}
def bill_on_acceptance; end
sig {
params(_bill_on_acceptance: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance)).returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance))
}
def bill_on_acceptance=(_bill_on_acceptance); end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
sig { params(_billing_behavior: T.nilable(String)).returns(T.nilable(String)) }
def billing_behavior=(_billing_behavior); end
# When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillingMode))
}
def billing_mode; end
sig {
params(_billing_mode: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillingMode)).returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillingMode))
}
def billing_mode=(_billing_mode); end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
sig { returns(T.nilable(T.any(String, T.any(String, Integer)))) }
def effective_date; end
sig {
params(_effective_date: T.nilable(T.any(String, T.any(String, Integer)))).returns(T.nilable(T.any(String, T.any(String, Integer))))
}
def effective_date=(_effective_date); end
# Behavior of the subscription schedule and underlying subscription when it ends.
sig { returns(T.nilable(String)) }
def end_behavior; end
sig { params(_end_behavior: T.nilable(String)).returns(T.nilable(String)) }
def end_behavior=(_end_behavior); end
# The id of a subscription that the quote will update. By default, the quote will contain the state of the subscription (such as line items, collection method and billing thresholds) unless overridden.
sig { returns(T.nilable(String)) }
def from_subscription; end
sig { params(_from_subscription: T.nilable(String)).returns(T.nilable(String)) }
def from_subscription=(_from_subscription); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
sig {
returns(T.nilable(T.any(String, ::Stripe::QuoteService::CreateParams::SubscriptionData::Prebilling)))
}
def prebilling; end
sig {
params(_prebilling: T.nilable(T.any(String, ::Stripe::QuoteService::CreateParams::SubscriptionData::Prebilling))).returns(T.nilable(T.any(String, ::Stripe::QuoteService::CreateParams::SubscriptionData::Prebilling)))
}
def prebilling=(_prebilling); end
# Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
#
# When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
#
# Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
#
# Prorations can be disabled by passing `none`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Integer representing the number of trial period days before the customer is charged for the first time.
sig { returns(T.nilable(T.any(String, Integer))) }
def trial_period_days; end
sig {
params(_trial_period_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def trial_period_days=(_trial_period_days); end
sig {
params(bill_on_acceptance: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance), billing_behavior: T.nilable(String), billing_cycle_anchor: T.nilable(String), billing_mode: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::BillingMode), description: T.nilable(String), effective_date: T.nilable(T.any(String, T.any(String, Integer))), end_behavior: T.nilable(String), from_subscription: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), prebilling: T.nilable(T.any(String, ::Stripe::QuoteService::CreateParams::SubscriptionData::Prebilling)), proration_behavior: T.nilable(String), trial_period_days: T.nilable(T.any(String, Integer))).void
}
def initialize(
bill_on_acceptance: nil,
billing_behavior: nil,
billing_cycle_anchor: nil,
billing_mode: nil,
description: nil,
effective_date: nil,
end_behavior: nil,
from_subscription: nil,
metadata: nil,
prebilling: nil,
proration_behavior: nil,
trial_period_days: nil
); end
end
class SubscriptionDataOverride < Stripe::RequestParams
class AppliesTo < Stripe::RequestParams
# A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
sig { returns(T.nilable(String)) }
def new_reference; end
sig { params(_new_reference: T.nilable(String)).returns(T.nilable(String)) }
def new_reference=(_new_reference); end
# The ID of the schedule the line applies to.
sig { returns(T.nilable(String)) }
def subscription_schedule; end
sig { params(_subscription_schedule: T.nilable(String)).returns(T.nilable(String)) }
def subscription_schedule=(_subscription_schedule); end
# Describes whether the quote line is affecting a new schedule or an existing schedule.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(new_reference: T.nilable(String), subscription_schedule: T.nilable(String), type: String).void
}
def initialize(new_reference: nil, subscription_schedule: nil, type: nil); end
end
class BillOnAcceptance < Stripe::RequestParams
class BillFrom < Stripe::RequestParams
class LineStartsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Details of a Quote line to start the bill period from.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt))
}
def line_starts_at; end
sig {
params(_line_starts_at: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt)).returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt))
}
def line_starts_at=(_line_starts_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of method to specify the `bill_from` time.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(line_starts_at: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(line_starts_at: nil, timestamp: nil, type: nil); end
end
class BillUntil < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
class LineEndsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Details of the duration over which to bill.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration)).returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration))
}
def duration=(_duration); end
# Details of a Quote line item from which to bill until.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt))
}
def line_ends_at; end
sig {
params(_line_ends_at: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt)).returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt))
}
def line_ends_at=(_line_ends_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of method to specify the `bill_until` time.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration), line_ends_at: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, line_ends_at: nil, timestamp: nil, type: nil); end
end
# The start of the period to bill from when the Quote is accepted.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom))
}
def bill_from; end
sig {
params(_bill_from: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom)).returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom))
}
def bill_from=(_bill_from); end
# The end of the period to bill until when the Quote is accepted.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil))
}
def bill_until; end
sig {
params(_bill_until: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil)).returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil))
}
def bill_until=(_bill_until); end
sig {
params(bill_from: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom), bill_until: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil)).void
}
def initialize(bill_from: nil, bill_until: nil); end
end
# Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
sig { returns(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::AppliesTo) }
def applies_to; end
sig {
params(_applies_to: ::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::AppliesTo).returns(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::AppliesTo)
}
def applies_to=(_applies_to); end
# Describes the period to bill for upon accepting the quote.
sig {
returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance))
}
def bill_on_acceptance; end
sig {
params(_bill_on_acceptance: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance)).returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance))
}
def bill_on_acceptance=(_bill_on_acceptance); end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
sig { params(_billing_behavior: T.nilable(String)).returns(T.nilable(String)) }
def billing_behavior=(_billing_behavior); end
# The customer the Subscription Data override applies to. This is only relevant when `applies_to.type=new_reference`.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Behavior of the subscription schedule and underlying subscription when it ends.
sig { returns(T.nilable(String)) }
def end_behavior; end
sig { params(_end_behavior: T.nilable(String)).returns(T.nilable(String)) }
def end_behavior=(_end_behavior); end
# Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
#
# When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
#
# Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
#
# Prorations can be disabled by passing `none`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
sig {
params(applies_to: ::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::AppliesTo, bill_on_acceptance: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance), billing_behavior: T.nilable(String), customer: T.nilable(String), description: T.nilable(String), end_behavior: T.nilable(String), proration_behavior: T.nilable(String)).void
}
def initialize(
applies_to: nil,
bill_on_acceptance: nil,
billing_behavior: nil,
customer: nil,
description: nil,
end_behavior: nil,
proration_behavior: nil
); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig {
params(amount: T.nilable(Integer), amount_percent: T.nilable(Float), destination: String).void
}
def initialize(amount: nil, amount_percent: nil, destination: nil); end
end
# Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
sig { returns(T.nilable(T::Boolean)) }
def allow_backdated_lines; end
sig { params(_allow_backdated_lines: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def allow_backdated_lines=(_allow_backdated_lines); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.
sig { returns(T.nilable(T.any(String, Integer))) }
def application_fee_amount; end
sig {
params(_application_fee_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def application_fee_amount=(_application_fee_amount); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.
sig { returns(T.nilable(T.any(String, Float))) }
def application_fee_percent; end
sig {
params(_application_fee_percent: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def application_fee_percent=(_application_fee_percent); end
# Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.
sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::QuoteService::CreateParams::AutomaticTax)).returns(T.nilable(::Stripe::QuoteService::CreateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or 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`.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# The tax rates that will apply to any line item that does not have `tax_rates` set.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The discounts applied to the quote.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::QuoteService::CreateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::QuoteService::CreateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::QuoteService::CreateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`.
sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::FromQuote)) }
def from_quote; end
sig {
params(_from_quote: T.nilable(::Stripe::QuoteService::CreateParams::FromQuote)).returns(T.nilable(::Stripe::QuoteService::CreateParams::FromQuote))
}
def from_quote=(_from_quote); end
# A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
sig { returns(T.nilable(String)) }
def header; end
sig { params(_header: T.nilable(String)).returns(T.nilable(String)) }
def header=(_header); end
# All invoices will be billed using the specified settings.
sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::InvoiceSettings)) }
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::QuoteService::CreateParams::InvoiceSettings)).returns(T.nilable(::Stripe::QuoteService::CreateParams::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
sig { returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::LineItem])) }
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::LineItem])).returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::LineItem]))
}
def line_items=(_line_items); end
# A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
sig { returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line])) }
def lines; end
sig {
params(_lines: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line])).returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line]))
}
def lines=(_lines); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The account on behalf of which to charge.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.
sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData)) }
def subscription_data; end
sig {
params(_subscription_data: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData)).returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData))
}
def subscription_data=(_subscription_data); end
# List representing overrides for `subscription_data` configurations for specific subscription schedules.
sig {
returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::SubscriptionDataOverride]))
}
def subscription_data_overrides; end
sig {
params(_subscription_data_overrides: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::SubscriptionDataOverride])).returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::SubscriptionDataOverride]))
}
def subscription_data_overrides=(_subscription_data_overrides); end
# ID of the test clock to attach to the quote.
sig { returns(T.nilable(String)) }
def test_clock; end
sig { params(_test_clock: T.nilable(String)).returns(T.nilable(String)) }
def test_clock=(_test_clock); end
# The data with which to automatically create a Transfer for each of the invoices.
sig { returns(T.nilable(T.any(String, ::Stripe::QuoteService::CreateParams::TransferData))) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(T.any(String, ::Stripe::QuoteService::CreateParams::TransferData))).returns(T.nilable(T.any(String, ::Stripe::QuoteService::CreateParams::TransferData)))
}
def transfer_data=(_transfer_data); end
sig {
params(allow_backdated_lines: T.nilable(T::Boolean), application_fee_amount: T.nilable(T.any(String, Integer)), application_fee_percent: T.nilable(T.any(String, Float)), automatic_tax: T.nilable(::Stripe::QuoteService::CreateParams::AutomaticTax), collection_method: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), default_tax_rates: T.nilable(T.any(String, T::Array[String])), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::QuoteService::CreateParams::Discount])), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), footer: T.nilable(String), from_quote: T.nilable(::Stripe::QuoteService::CreateParams::FromQuote), header: T.nilable(String), invoice_settings: T.nilable(::Stripe::QuoteService::CreateParams::InvoiceSettings), line_items: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::LineItem]), lines: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Line]), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), subscription_data: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData), subscription_data_overrides: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::SubscriptionDataOverride]), test_clock: T.nilable(String), transfer_data: T.nilable(T.any(String, ::Stripe::QuoteService::CreateParams::TransferData))).void
}
def initialize(
allow_backdated_lines: nil,
application_fee_amount: nil,
application_fee_percent: nil,
automatic_tax: nil,
collection_method: nil,
customer: nil,
customer_account: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
expand: nil,
expires_at: nil,
footer: nil,
from_quote: nil,
header: nil,
invoice_settings: nil,
line_items: nil,
lines: nil,
metadata: nil,
on_behalf_of: nil,
subscription_data: nil,
subscription_data_overrides: nil,
test_clock: nil,
transfer_data: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig { returns(T.nilable(::Stripe::QuoteService::UpdateParams::AutomaticTax::Liability)) }
def liability; end
sig {
params(_liability: T.nilable(::Stripe::QuoteService::UpdateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::QuoteService::UpdateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::QuoteService::UpdateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::QuoteService::UpdateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig { returns(T.nilable(::Stripe::QuoteService::UpdateParams::Discount::DiscountEnd)) }
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::QuoteService::UpdateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::QuoteService::UpdateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig { returns(T.nilable(::Stripe::QuoteService::UpdateParams::InvoiceSettings::Issuer)) }
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::QuoteService::UpdateParams::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::QuoteService::UpdateParams::InvoiceSettings::Issuer)).void
}
def initialize(days_until_due: nil, issuer: nil); end
end
class Line < Stripe::RequestParams
class Action < Stripe::RequestParams
class AddDiscount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
# The coupon code to redeem.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# An ID of an existing discount for a coupon that was already redeemed.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddDiscount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddDiscount::DiscountEnd)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddDiscount::DiscountEnd))
}
def discount_end=(_discount_end); end
# The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
# The promotion code to redeem.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddDiscount::DiscountEnd), index: T.nilable(Integer), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
index: nil,
promotion_code: nil
); end
end
class AddItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); end
end
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
sig {
returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount])).returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# Quantity for this item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
# Options that configure the trial on the subscription item.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Trial)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Trial))
}
def trial=(_trial); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount]), metadata: T.nilable(T::Hash[String, String]), price: String, quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String]), trial: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Trial)).void
}
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
class RemoveDiscount < Stripe::RequestParams
# The coupon code to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# The ID of a discount to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# The ID of a promotion code to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
class RemoveItem < Stripe::RequestParams
# ID of a price to remove.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
sig { params(price: String).void }
def initialize(price: nil); end
end
class SetDiscount < Stripe::RequestParams
# The coupon code to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# An ID of an existing discount to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# An ID of an existing promotion code to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
class SetItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); end
end
# If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.
sig {
returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount])).returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount]))
}
def discounts=(_discounts); end
# If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
# If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Trial)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Trial))
}
def trial=(_trial); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount]), metadata: T.nilable(T::Hash[String, String]), price: String, quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String]), trial: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Trial)).void
}
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
# Details for the `add_discount` type.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddDiscount))
}
def add_discount; end
sig {
params(_add_discount: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddDiscount)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddDiscount))
}
def add_discount=(_add_discount); end
# Details for the `add_item` type.
sig { returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem)) }
def add_item; end
sig {
params(_add_item: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem))
}
def add_item=(_add_item); end
# Details for the `add_metadata` type: specify a hash of key-value pairs.
sig { returns(T.nilable(T::Hash[String, String])) }
def add_metadata; end
sig {
params(_add_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def add_metadata=(_add_metadata); end
# Details for the `remove_discount` type.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::RemoveDiscount))
}
def remove_discount; end
sig {
params(_remove_discount: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::RemoveDiscount)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::RemoveDiscount))
}
def remove_discount=(_remove_discount); end
# Details for the `remove_item` type.
sig { returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::RemoveItem)) }
def remove_item; end
sig {
params(_remove_item: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::RemoveItem)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::RemoveItem))
}
def remove_item=(_remove_item); end
# Details for the `remove_metadata` type: specify an array of metadata keys.
sig { returns(T.nilable(T::Array[String])) }
def remove_metadata; end
sig {
params(_remove_metadata: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def remove_metadata=(_remove_metadata); end
# Details for the `set_discounts` type.
sig {
returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetDiscount]))
}
def set_discounts; end
sig {
params(_set_discounts: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetDiscount])).returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetDiscount]))
}
def set_discounts=(_set_discounts); end
# Details for the `set_items` type.
sig {
returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetItem]))
}
def set_items; end
sig {
params(_set_items: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetItem])).returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetItem]))
}
def set_items=(_set_items); end
# Details for the `set_metadata` type: specify an array of key-value pairs.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def set_metadata; end
sig {
params(_set_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def set_metadata=(_set_metadata); end
# The type of action the quote line performs.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(add_discount: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddDiscount), add_item: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem), add_metadata: T.nilable(T::Hash[String, String]), remove_discount: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::RemoveDiscount), remove_item: T.nilable(::Stripe::QuoteService::UpdateParams::Line::Action::RemoveItem), remove_metadata: T.nilable(T::Array[String]), set_discounts: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetDiscount]), set_items: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetItem]), set_metadata: T.nilable(T.any(String, T::Hash[String, String])), type: String).void
}
def initialize(
add_discount: nil,
add_item: nil,
add_metadata: nil,
remove_discount: nil,
remove_item: nil,
remove_metadata: nil,
set_discounts: nil,
set_items: nil,
set_metadata: nil,
type: nil
); end
end
class AppliesTo < Stripe::RequestParams
# A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
sig { returns(T.nilable(String)) }
def new_reference; end
sig { params(_new_reference: T.nilable(String)).returns(T.nilable(String)) }
def new_reference=(_new_reference); end
# The ID of the schedule the line applies to.
sig { returns(T.nilable(String)) }
def subscription_schedule; end
sig { params(_subscription_schedule: T.nilable(String)).returns(T.nilable(String)) }
def subscription_schedule=(_subscription_schedule); end
# Describes whether the quote line is affecting a new schedule or an existing schedule.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(new_reference: T.nilable(String), subscription_schedule: T.nilable(String), type: String).void
}
def initialize(new_reference: nil, subscription_schedule: nil, type: nil); end
end
class CancelSubscriptionSchedule < Stripe::RequestParams
# Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
sig { returns(String) }
def cancel_at; end
sig { params(_cancel_at: String).returns(String) }
def cancel_at=(_cancel_at); end
# If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def invoice_now; end
sig { params(_invoice_now: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def invoice_now=(_invoice_now); end
# If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def prorate; end
sig { params(_prorate: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def prorate=(_prorate); end
sig {
params(cancel_at: String, invoice_now: T.nilable(T::Boolean), prorate: T.nilable(T::Boolean)).void
}
def initialize(cancel_at: nil, invoice_now: nil, prorate: nil); end
end
class EndsAt < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
sig { returns(String) }
def discount; end
sig { params(_discount: String).returns(String) }
def discount=(_discount); end
sig { params(discount: String).void }
def initialize(discount: nil); end
end
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Use the `end` time of a given discount.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::EndsAt::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::QuoteService::UpdateParams::Line::EndsAt::DiscountEnd)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::EndsAt::DiscountEnd))
}
def discount_end=(_discount_end); end
# Time span for the quote line starting from the `starts_at` date.
sig { returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::EndsAt::Duration)) }
def duration; end
sig {
params(_duration: T.nilable(::Stripe::QuoteService::UpdateParams::Line::EndsAt::Duration)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::EndsAt::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select a way to pass in `ends_at`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(discount_end: T.nilable(::Stripe::QuoteService::UpdateParams::Line::EndsAt::DiscountEnd), duration: T.nilable(::Stripe::QuoteService::UpdateParams::Line::EndsAt::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(discount_end: nil, duration: nil, timestamp: nil, type: nil); end
end
class SetPauseCollection < Stripe::RequestParams
class Set < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(behavior: String).void }
def initialize(behavior: nil); end
end
# Details of the pause_collection behavior to apply to the amendment.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::SetPauseCollection::Set))
}
def set; end
sig {
params(_set: T.nilable(::Stripe::QuoteService::UpdateParams::Line::SetPauseCollection::Set)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::SetPauseCollection::Set))
}
def set=(_set); end
# Determines the type of the pause_collection amendment.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(set: T.nilable(::Stripe::QuoteService::UpdateParams::Line::SetPauseCollection::Set), type: String).void
}
def initialize(set: nil, type: nil); end
end
class StartsAt < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
sig { returns(String) }
def discount; end
sig { params(_discount: String).returns(String) }
def discount=(_discount); end
sig { params(discount: String).void }
def initialize(discount: nil); end
end
class LineEndsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Use the `end` time of a given discount.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::StartsAt::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::QuoteService::UpdateParams::Line::StartsAt::DiscountEnd)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::StartsAt::DiscountEnd))
}
def discount_end=(_discount_end); end
# The timestamp the given line ends at.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::StartsAt::LineEndsAt))
}
def line_ends_at; end
sig {
params(_line_ends_at: T.nilable(::Stripe::QuoteService::UpdateParams::Line::StartsAt::LineEndsAt)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::StartsAt::LineEndsAt))
}
def line_ends_at=(_line_ends_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select a way to pass in `starts_at`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(discount_end: T.nilable(::Stripe::QuoteService::UpdateParams::Line::StartsAt::DiscountEnd), line_ends_at: T.nilable(::Stripe::QuoteService::UpdateParams::Line::StartsAt::LineEndsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(discount_end: nil, line_ends_at: nil, timestamp: nil, type: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
sig { params(_prorate_up_front: T.nilable(String)).returns(T.nilable(String)) }
def prorate_up_front=(_prorate_up_front); end
sig { params(prorate_up_front: T.nilable(String)).void }
def initialize(prorate_up_front: nil); end
end
# Defines how the subscription should behave when a trial ends.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::TrialSettings::EndBehavior))
}
def end_behavior; end
sig {
params(_end_behavior: T.nilable(::Stripe::QuoteService::UpdateParams::Line::TrialSettings::EndBehavior)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::TrialSettings::EndBehavior))
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: T.nilable(::Stripe::QuoteService::UpdateParams::Line::TrialSettings::EndBehavior)).void
}
def initialize(end_behavior: nil); end
end
# An array of operations the quote line performs.
sig { returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action])) }
def actions; end
sig {
params(_actions: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action])).returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action]))
}
def actions=(_actions); end
# Details to identify the subscription schedule the quote line applies to.
sig { returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::AppliesTo)) }
def applies_to; end
sig {
params(_applies_to: T.nilable(::Stripe::QuoteService::UpdateParams::Line::AppliesTo)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::AppliesTo))
}
def applies_to=(_applies_to); end
# For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::CancelSubscriptionSchedule))
}
def cancel_subscription_schedule; end
sig {
params(_cancel_subscription_schedule: T.nilable(::Stripe::QuoteService::UpdateParams::Line::CancelSubscriptionSchedule)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::CancelSubscriptionSchedule))
}
def cancel_subscription_schedule=(_cancel_subscription_schedule); end
# Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
sig { returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::EndsAt)) }
def ends_at; end
sig {
params(_ends_at: T.nilable(::Stripe::QuoteService::UpdateParams::Line::EndsAt)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::EndsAt))
}
def ends_at=(_ends_at); end
# The ID of an existing line on the quote.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
sig { returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::SetPauseCollection)) }
def set_pause_collection; end
sig {
params(_set_pause_collection: T.nilable(::Stripe::QuoteService::UpdateParams::Line::SetPauseCollection)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::SetPauseCollection))
}
def set_pause_collection=(_set_pause_collection); end
# Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
sig { returns(T.nilable(String)) }
def set_schedule_end; end
sig { params(_set_schedule_end: T.nilable(String)).returns(T.nilable(String)) }
def set_schedule_end=(_set_schedule_end); end
# Details to identify the earliest timestamp where the proposed change should take effect.
sig { returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::StartsAt)) }
def starts_at; end
sig {
params(_starts_at: T.nilable(::Stripe::QuoteService::UpdateParams::Line::StartsAt)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::StartsAt))
}
def starts_at=(_starts_at); end
# Settings related to subscription trials.
sig { returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::TrialSettings)) }
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::QuoteService::UpdateParams::Line::TrialSettings)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::Line::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(actions: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action]), applies_to: T.nilable(::Stripe::QuoteService::UpdateParams::Line::AppliesTo), billing_cycle_anchor: T.nilable(String), cancel_subscription_schedule: T.nilable(::Stripe::QuoteService::UpdateParams::Line::CancelSubscriptionSchedule), ends_at: T.nilable(::Stripe::QuoteService::UpdateParams::Line::EndsAt), id: T.nilable(String), proration_behavior: T.nilable(String), set_pause_collection: T.nilable(::Stripe::QuoteService::UpdateParams::Line::SetPauseCollection), set_schedule_end: T.nilable(String), starts_at: T.nilable(::Stripe::QuoteService::UpdateParams::Line::StartsAt), trial_settings: T.nilable(::Stripe::QuoteService::UpdateParams::Line::TrialSettings)).void
}
def initialize(
actions: nil,
applies_to: nil,
billing_cycle_anchor: nil,
cancel_subscription_schedule: nil,
ends_at: nil,
id: nil,
proration_behavior: nil,
set_pause_collection: nil,
set_schedule_end: nil,
starts_at: nil,
trial_settings: nil
); end
end
class LineItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::LineItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::QuoteService::UpdateParams::LineItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::LineItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::QuoteService::UpdateParams::LineItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::LineItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::QuoteService::UpdateParams::LineItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::LineItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::QuoteService::UpdateParams::LineItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::LineItem::PriceData::Recurring))
}
def recurring; end
sig {
params(_recurring: T.nilable(::Stripe::QuoteService::UpdateParams::LineItem::PriceData::Recurring)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::LineItem::PriceData::Recurring))
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: T.nilable(::Stripe::QuoteService::UpdateParams::LineItem::PriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# The discounts applied to this line item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::QuoteService::UpdateParams::LineItem::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::QuoteService::UpdateParams::LineItem::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::QuoteService::UpdateParams::LineItem::Discount])))
}
def discounts=(_discounts); end
# The ID of an existing line item on the quote.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The ID of the price object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig { returns(T.nilable(::Stripe::QuoteService::UpdateParams::LineItem::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::QuoteService::UpdateParams::LineItem::PriceData)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::LineItem::PriceData))
}
def price_data=(_price_data); end
# The quantity of the line item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(discounts: T.nilable(T.any(String, T::Array[::Stripe::QuoteService::UpdateParams::LineItem::Discount])), id: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::QuoteService::UpdateParams::LineItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
discounts: nil,
id: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class SubscriptionData < Stripe::RequestParams
class BillOnAcceptance < Stripe::RequestParams
class BillFrom < Stripe::RequestParams
class LineStartsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Details of a Quote line to start the bill period from.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt))
}
def line_starts_at; end
sig {
params(_line_starts_at: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt))
}
def line_starts_at=(_line_starts_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of method to specify the `bill_from` time.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(line_starts_at: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(line_starts_at: nil, timestamp: nil, type: nil); end
end
class BillUntil < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
class LineEndsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Details of the duration over which to bill.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration))
}
def duration=(_duration); end
# Details of a Quote line item from which to bill until.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt))
}
def line_ends_at; end
sig {
params(_line_ends_at: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt))
}
def line_ends_at=(_line_ends_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of method to specify the `bill_until` time.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration), line_ends_at: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, line_ends_at: nil, timestamp: nil, type: nil); end
end
# The start of the period to bill from when the Quote is accepted.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom))
}
def bill_from; end
sig {
params(_bill_from: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom))
}
def bill_from=(_bill_from); end
# The end of the period to bill until when the Quote is accepted.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil))
}
def bill_until; end
sig {
params(_bill_until: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil))
}
def bill_until=(_bill_until); end
sig {
params(bill_from: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom), bill_until: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil)).void
}
def initialize(bill_from: nil, bill_until: nil); end
end
class Prebilling < Stripe::RequestParams
# This is used to determine the number of billing cycles to prebill.
sig { returns(Integer) }
def iterations; end
sig { params(_iterations: Integer).returns(Integer) }
def iterations=(_iterations); end
sig { params(iterations: Integer).void }
def initialize(iterations: nil); end
end
# Describes the period to bill for upon accepting the quote.
sig {
returns(T.nilable(T.any(String, ::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance)))
}
def bill_on_acceptance; end
sig {
params(_bill_on_acceptance: T.nilable(T.any(String, ::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance))).returns(T.nilable(T.any(String, ::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance)))
}
def bill_on_acceptance=(_bill_on_acceptance); end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
sig { params(_billing_behavior: T.nilable(String)).returns(T.nilable(String)) }
def billing_behavior=(_billing_behavior); end
# When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
sig { returns(T.nilable(T.any(String, T.any(String, Integer)))) }
def effective_date; end
sig {
params(_effective_date: T.nilable(T.any(String, T.any(String, Integer)))).returns(T.nilable(T.any(String, T.any(String, Integer))))
}
def effective_date=(_effective_date); end
# Behavior of the subscription schedule and underlying subscription when it ends.
sig { returns(T.nilable(String)) }
def end_behavior; end
sig { params(_end_behavior: T.nilable(String)).returns(T.nilable(String)) }
def end_behavior=(_end_behavior); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
sig {
returns(T.nilable(T.any(String, ::Stripe::QuoteService::UpdateParams::SubscriptionData::Prebilling)))
}
def prebilling; end
sig {
params(_prebilling: T.nilable(T.any(String, ::Stripe::QuoteService::UpdateParams::SubscriptionData::Prebilling))).returns(T.nilable(T.any(String, ::Stripe::QuoteService::UpdateParams::SubscriptionData::Prebilling)))
}
def prebilling=(_prebilling); end
# Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
#
# When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
#
# Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
#
# Prorations can be disabled by passing `none`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Integer representing the number of trial period days before the customer is charged for the first time.
sig { returns(T.nilable(T.any(String, Integer))) }
def trial_period_days; end
sig {
params(_trial_period_days: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def trial_period_days=(_trial_period_days); end
sig {
params(bill_on_acceptance: T.nilable(T.any(String, ::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance)), billing_behavior: T.nilable(String), billing_cycle_anchor: T.nilable(String), description: T.nilable(String), effective_date: T.nilable(T.any(String, T.any(String, Integer))), end_behavior: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), prebilling: T.nilable(T.any(String, ::Stripe::QuoteService::UpdateParams::SubscriptionData::Prebilling)), proration_behavior: T.nilable(String), trial_period_days: T.nilable(T.any(String, Integer))).void
}
def initialize(
bill_on_acceptance: nil,
billing_behavior: nil,
billing_cycle_anchor: nil,
description: nil,
effective_date: nil,
end_behavior: nil,
metadata: nil,
prebilling: nil,
proration_behavior: nil,
trial_period_days: nil
); end
end
class SubscriptionDataOverride < Stripe::RequestParams
class AppliesTo < Stripe::RequestParams
# A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
sig { returns(T.nilable(String)) }
def new_reference; end
sig { params(_new_reference: T.nilable(String)).returns(T.nilable(String)) }
def new_reference=(_new_reference); end
# The ID of the schedule the line applies to.
sig { returns(T.nilable(String)) }
def subscription_schedule; end
sig { params(_subscription_schedule: T.nilable(String)).returns(T.nilable(String)) }
def subscription_schedule=(_subscription_schedule); end
# Describes whether the quote line is affecting a new schedule or an existing schedule.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(new_reference: T.nilable(String), subscription_schedule: T.nilable(String), type: String).void
}
def initialize(new_reference: nil, subscription_schedule: nil, type: nil); end
end
class BillOnAcceptance < Stripe::RequestParams
class BillFrom < Stripe::RequestParams
class LineStartsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Details of a Quote line to start the bill period from.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt))
}
def line_starts_at; end
sig {
params(_line_starts_at: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt))
}
def line_starts_at=(_line_starts_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of method to specify the `bill_from` time.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(line_starts_at: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(line_starts_at: nil, timestamp: nil, type: nil); end
end
class BillUntil < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
class LineEndsAt < Stripe::RequestParams
# The ID of a quote line.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
sig { params(id: T.nilable(String), index: T.nilable(Integer)).void }
def initialize(id: nil, index: nil); end
end
# Details of the duration over which to bill.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration))
}
def duration=(_duration); end
# Details of a Quote line item from which to bill until.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt))
}
def line_ends_at; end
sig {
params(_line_ends_at: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt))
}
def line_ends_at=(_line_ends_at); end
# A precise Unix timestamp.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of method to specify the `bill_until` time.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration), line_ends_at: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, line_ends_at: nil, timestamp: nil, type: nil); end
end
# The start of the period to bill from when the Quote is accepted.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom))
}
def bill_from; end
sig {
params(_bill_from: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom))
}
def bill_from=(_bill_from); end
# The end of the period to bill until when the Quote is accepted.
sig {
returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil))
}
def bill_until; end
sig {
params(_bill_until: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil))
}
def bill_until=(_bill_until); end
sig {
params(bill_from: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom), bill_until: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil)).void
}
def initialize(bill_from: nil, bill_until: nil); end
end
# Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
sig { returns(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::AppliesTo) }
def applies_to; end
sig {
params(_applies_to: ::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::AppliesTo).returns(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::AppliesTo)
}
def applies_to=(_applies_to); end
# Describes the period to bill for upon accepting the quote.
sig {
returns(T.nilable(T.any(String, ::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance)))
}
def bill_on_acceptance; end
sig {
params(_bill_on_acceptance: T.nilable(T.any(String, ::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance))).returns(T.nilable(T.any(String, ::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance)))
}
def bill_on_acceptance=(_bill_on_acceptance); end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
sig { params(_billing_behavior: T.nilable(String)).returns(T.nilable(String)) }
def billing_behavior=(_billing_behavior); end
# The customer the Subscription Data override applies to.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Behavior of the subscription schedule and underlying subscription when it ends.
sig { returns(T.nilable(String)) }
def end_behavior; end
sig { params(_end_behavior: T.nilable(String)).returns(T.nilable(String)) }
def end_behavior=(_end_behavior); end
# Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
#
# When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
#
# Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
#
# Prorations can be disabled by passing `none`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
sig {
params(applies_to: ::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::AppliesTo, bill_on_acceptance: T.nilable(T.any(String, ::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance)), billing_behavior: T.nilable(String), customer: T.nilable(String), description: T.nilable(String), end_behavior: T.nilable(String), proration_behavior: T.nilable(String)).void
}
def initialize(
applies_to: nil,
bill_on_acceptance: nil,
billing_behavior: nil,
customer: nil,
description: nil,
end_behavior: nil,
proration_behavior: nil
); end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig {
params(amount: T.nilable(Integer), amount_percent: T.nilable(Float), destination: String).void
}
def initialize(amount: nil, amount_percent: nil, destination: nil); end
end
# Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
sig { returns(T.nilable(T::Boolean)) }
def allow_backdated_lines; end
sig { params(_allow_backdated_lines: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def allow_backdated_lines=(_allow_backdated_lines); end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.
sig { returns(T.nilable(T.any(String, Integer))) }
def application_fee_amount; end
sig {
params(_application_fee_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def application_fee_amount=(_application_fee_amount); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.
sig { returns(T.nilable(T.any(String, Float))) }
def application_fee_percent; end
sig {
params(_application_fee_percent: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def application_fee_percent=(_application_fee_percent); end
# Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.
sig { returns(T.nilable(::Stripe::QuoteService::UpdateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::QuoteService::UpdateParams::AutomaticTax)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or 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`.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# The tax rates that will apply to any line item that does not have `tax_rates` set.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# A description that will be displayed on the quote PDF.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The discounts applied to the quote.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::QuoteService::UpdateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::QuoteService::UpdateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::QuoteService::UpdateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
# A footer that will be displayed on the quote PDF.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# A header that will be displayed on the quote PDF.
sig { returns(T.nilable(String)) }
def header; end
sig { params(_header: T.nilable(String)).returns(T.nilable(String)) }
def header=(_header); end
# All invoices will be billed using the specified settings.
sig { returns(T.nilable(::Stripe::QuoteService::UpdateParams::InvoiceSettings)) }
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::QuoteService::UpdateParams::InvoiceSettings)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
sig { returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::LineItem])) }
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::LineItem])).returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::LineItem]))
}
def line_items=(_line_items); end
# A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
sig { returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line])) }
def lines; end
sig {
params(_lines: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line])).returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line]))
}
def lines=(_lines); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The account on behalf of which to charge.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.
sig { returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData)) }
def subscription_data; end
sig {
params(_subscription_data: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData)).returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData))
}
def subscription_data=(_subscription_data); end
# List representing overrides for `subscription_data` configurations for specific subscription schedules.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride])))
}
def subscription_data_overrides; end
sig {
params(_subscription_data_overrides: T.nilable(T.any(String, T::Array[::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride]))).returns(T.nilable(T.any(String, T::Array[::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride])))
}
def subscription_data_overrides=(_subscription_data_overrides); end
# The data with which to automatically create a Transfer for each of the invoices.
sig { returns(T.nilable(T.any(String, ::Stripe::QuoteService::UpdateParams::TransferData))) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(T.any(String, ::Stripe::QuoteService::UpdateParams::TransferData))).returns(T.nilable(T.any(String, ::Stripe::QuoteService::UpdateParams::TransferData)))
}
def transfer_data=(_transfer_data); end
sig {
params(allow_backdated_lines: T.nilable(T::Boolean), application_fee_amount: T.nilable(T.any(String, Integer)), application_fee_percent: T.nilable(T.any(String, Float)), automatic_tax: T.nilable(::Stripe::QuoteService::UpdateParams::AutomaticTax), collection_method: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), default_tax_rates: T.nilable(T.any(String, T::Array[String])), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::QuoteService::UpdateParams::Discount])), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), footer: T.nilable(String), header: T.nilable(String), invoice_settings: T.nilable(::Stripe::QuoteService::UpdateParams::InvoiceSettings), line_items: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::LineItem]), lines: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Line]), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), subscription_data: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData), subscription_data_overrides: T.nilable(T.any(String, T::Array[::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride])), transfer_data: T.nilable(T.any(String, ::Stripe::QuoteService::UpdateParams::TransferData))).void
}
def initialize(
allow_backdated_lines: nil,
application_fee_amount: nil,
application_fee_percent: nil,
automatic_tax: nil,
collection_method: nil,
customer: nil,
customer_account: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
expand: nil,
expires_at: nil,
footer: nil,
header: nil,
invoice_settings: nil,
line_items: nil,
lines: nil,
metadata: nil,
on_behalf_of: nil,
subscription_data: nil,
subscription_data_overrides: nil,
transfer_data: nil
); end
end
class AcceptParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class FinalizeQuoteParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
sig { params(expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer)).void }
def initialize(expand: nil, expires_at: nil); end
end
class MarkDraftParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class MarkStaleParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Reason the Quote is being marked stale.
sig { returns(T.nilable(String)) }
def reason; end
sig { params(_reason: T.nilable(String)).returns(T.nilable(String)) }
def reason=(_reason); end
sig { params(expand: T.nilable(T::Array[String]), reason: T.nilable(String)).void }
def initialize(expand: nil, reason: nil); end
end
class ReestimateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class PdfParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ListPreviewInvoiceLinesParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Accepts the specified quote.
sig {
params(quote: String, params: T.any(::Stripe::QuoteService::AcceptParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def accept(quote, params = {}, opts = {}); end
# Cancels the quote.
sig {
params(quote: String, params: T.any(::Stripe::QuoteService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def cancel(quote, params = {}, opts = {}); end
# A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the [quote template](https://dashboard.stripe.com/settings/billing/quote).
sig {
params(params: T.any(::Stripe::QuoteService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def create(params = {}, opts = {}); end
# Finalizes the quote.
sig {
params(quote: String, params: T.any(::Stripe::QuoteService::FinalizeQuoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def finalize_quote(quote, params = {}, opts = {}); end
# Returns a list of your quotes.
sig {
params(params: T.any(::Stripe::QuoteService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Preview the invoice line items that would be generated by accepting the quote.
sig {
params(quote: String, preview_invoice: String, params: T.any(::Stripe::QuoteService::ListPreviewInvoiceLinesParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list_preview_invoice_lines(quote, preview_invoice, params = {}, opts = {}); end
# Converts a stale quote to draft.
sig {
params(quote: String, params: T.any(::Stripe::QuoteService::MarkDraftParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def mark_draft(quote, params = {}, opts = {}); end
# Converts a draft or open quote to stale.
sig {
params(quote: String, params: T.any(::Stripe::QuoteService::MarkStaleParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def mark_stale(quote, params = {}, opts = {}); end
# Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
sig {
params(quote: String, params: T.any(::Stripe::QuoteService::PdfParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, read_body_chunk_block: T.untyped).returns(T.untyped)
}
def pdf(quote, params = {}, opts = {}, &read_body_chunk_block); end
# Recompute the upcoming invoice estimate for the quote.
sig {
params(quote: String, params: T.any(::Stripe::QuoteService::ReestimateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def reestimate(quote, params = {}, opts = {}); end
# Retrieves the quote with the given ID.
sig {
params(quote: String, params: T.any(::Stripe::QuoteService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def retrieve(quote, params = {}, opts = {}); end
# A quote models prices and services for a customer.
sig {
params(quote: String, params: T.any(::Stripe::QuoteService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
}
def update(quote, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class QuoteComputedUpfrontLineItemsService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# When retrieving a quote, there is an includable [computed.upfront.line_items](https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items) property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.
sig {
params(quote: String, params: T.any(::Stripe::QuoteComputedUpfrontLineItemsService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(quote, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class QuoteLineService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
sig {
params(quote: String, params: T.any(::Stripe::QuoteLineService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(quote, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class QuoteLineItemService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
sig {
params(quote: String, params: T.any(::Stripe::QuoteLineItemService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(quote, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class QuotePreviewInvoiceService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Preview the invoices that would be generated by accepting the quote.
sig {
params(quote: String, params: T.any(::Stripe::QuotePreviewInvoiceService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(quote, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class QuotePreviewSubscriptionScheduleService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Preview the schedules that would be generated by accepting the quote
sig {
params(quote: String, params: T.any(::Stripe::QuotePreviewSubscriptionScheduleService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(quote, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class RadarService < StripeService
attr_reader :early_fraud_warnings
attr_reader :value_lists
attr_reader :value_list_items
end
end
# typed: true
module Stripe
module Radar
class EarlyFraudWarningService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return early fraud warnings for the charge specified by this charge ID.
sig { returns(T.nilable(String)) }
def charge; end
sig { params(_charge: T.nilable(String)).returns(T.nilable(String)) }
def charge=(_charge); end
# Only return early fraud warnings that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Radar::EarlyFraudWarningService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Radar::EarlyFraudWarningService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Radar::EarlyFraudWarningService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(charge: T.nilable(String), created: T.nilable(T.any(::Stripe::Radar::EarlyFraudWarningService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_intent: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
charge: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
payment_intent: nil,
starting_after: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of early fraud warnings.
sig {
params(params: T.any(::Stripe::Radar::EarlyFraudWarningService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an early fraud warning that has previously been created.
#
# Please refer to the [early fraud warning](https://docs.stripe.com/api#early_fraud_warning_object) object reference for more details.
sig {
params(early_fraud_warning: String, params: T.any(::Stripe::Radar::EarlyFraudWarningService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Radar::EarlyFraudWarning)
}
def retrieve(early_fraud_warning, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Radar
class ValueListService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# The name of the value list for use in rules.
sig { returns(T.nilable(String)) }
def alias; end
sig { params(_alias: T.nilable(String)).returns(T.nilable(String)) }
def alias=(_alias); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The human-readable name of the value list.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(alias_: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: T.nilable(String)).void
}
def initialize(alias_: nil, expand: nil, metadata: nil, name: nil); end
end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# The alias used to reference the value list when writing rules.
sig { returns(T.nilable(String)) }
def alias; end
sig { params(_alias: T.nilable(String)).returns(T.nilable(String)) }
def alias=(_alias); end
# A value contained within a value list - returns all value lists containing this value.
sig { returns(T.nilable(String)) }
def contains; end
sig { params(_contains: T.nilable(String)).returns(T.nilable(String)) }
def contains=(_contains); end
# Only return value lists that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Radar::ValueListService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Radar::ValueListService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Radar::ValueListService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(alias_: T.nilable(String), contains: T.nilable(String), created: T.nilable(T.any(::Stripe::Radar::ValueListService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
alias_: nil,
contains: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# The name of the value list for use in rules.
sig { returns(String) }
def alias; end
sig { params(_alias: String).returns(String) }
def alias=(_alias); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, `customer_id`, `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`. Use `string` if the item type is unknown or mixed.
sig { returns(T.nilable(String)) }
def item_type; end
sig { params(_item_type: T.nilable(String)).returns(T.nilable(String)) }
def item_type=(_item_type); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The human-readable name of the value list.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
sig {
params(alias_: String, expand: T.nilable(T::Array[String]), item_type: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), name: String).void
}
def initialize(alias_: nil, expand: nil, item_type: nil, metadata: nil, name: nil); end
end
# Creates a new ValueList object, which can then be referenced in rules.
sig {
params(params: T.any(::Stripe::Radar::ValueListService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Radar::ValueList)
}
def create(params = {}, opts = {}); end
# Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
sig {
params(value_list: String, params: T.any(::Stripe::Radar::ValueListService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Radar::ValueList)
}
def delete(value_list, params = {}, opts = {}); end
# Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Radar::ValueListService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a ValueList object.
sig {
params(value_list: String, params: T.any(::Stripe::Radar::ValueListService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Radar::ValueList)
}
def retrieve(value_list, params = {}, opts = {}); end
# Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.
sig {
params(value_list: String, params: T.any(::Stripe::Radar::ValueListService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Radar::ValueList)
}
def update(value_list, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Radar
class ValueListItemService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return items that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Radar::ValueListItemService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Radar::ValueListItemService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Radar::ValueListItemService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Return items belonging to the parent list whose value matches the specified value (using an "is like" match).
sig { returns(T.nilable(String)) }
def value; end
sig { params(_value: T.nilable(String)).returns(T.nilable(String)) }
def value=(_value); end
# Identifier for the parent value list this item belongs to.
sig { returns(String) }
def value_list; end
sig { params(_value_list: String).returns(String) }
def value_list=(_value_list); end
sig {
params(created: T.nilable(T.any(::Stripe::Radar::ValueListItemService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), value: T.nilable(String), value_list: String).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
value: nil,
value_list: nil
); end
end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The value of the item (whose type must match the type of the parent value list).
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
# The identifier of the value list which the created item will be added to.
sig { returns(String) }
def value_list; end
sig { params(_value_list: String).returns(String) }
def value_list=(_value_list); end
sig { params(expand: T.nilable(T::Array[String]), value: String, value_list: String).void }
def initialize(expand: nil, value: nil, value_list: nil); end
end
# Creates a new ValueListItem object, which is added to the specified parent value list.
sig {
params(params: T.any(::Stripe::Radar::ValueListItemService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Radar::ValueListItem)
}
def create(params = {}, opts = {}); end
# Deletes a ValueListItem object, removing it from its parent value list.
sig {
params(item: String, params: T.any(::Stripe::Radar::ValueListItemService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Radar::ValueListItem)
}
def delete(item, params = {}, opts = {}); end
# Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::Radar::ValueListItemService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a ValueListItem object.
sig {
params(item: String, params: T.any(::Stripe::Radar::ValueListItemService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Radar::ValueListItem)
}
def retrieve(item, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class RefundService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return refunds for the charge specified by this charge ID.
sig { returns(T.nilable(String)) }
def charge; end
sig { params(_charge: T.nilable(String)).returns(T.nilable(String)) }
def charge=(_charge); end
# Only return refunds that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::RefundService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::RefundService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::RefundService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return refunds for the PaymentIntent specified by this ID.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(charge: T.nilable(String), created: T.nilable(T.any(::Stripe::RefundService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_intent: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
charge: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
payment_intent: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# Attribute for param field amount
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The identifier of the charge to refund.
sig { returns(T.nilable(String)) }
def charge; end
sig { params(_charge: T.nilable(String)).returns(T.nilable(String)) }
def charge=(_charge); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Customer whose customer balance to refund from.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.
sig { returns(T.nilable(String)) }
def instructions_email; end
sig { params(_instructions_email: T.nilable(String)).returns(T.nilable(String)) }
def instructions_email=(_instructions_email); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Origin of the refund
sig { returns(T.nilable(String)) }
def origin; end
sig { params(_origin: T.nilable(String)).returns(T.nilable(String)) }
def origin=(_origin); end
# The identifier of the PaymentIntent to refund.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms.
sig { returns(T.nilable(String)) }
def reason; end
sig { params(_reason: T.nilable(String)).returns(T.nilable(String)) }
def reason=(_reason); end
# Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.
sig { returns(T.nilable(T::Boolean)) }
def refund_application_fee; end
sig { params(_refund_application_fee: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refund_application_fee=(_refund_application_fee); end
# Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).
A transfer can be reversed only by the application that created the charge.
sig { returns(T.nilable(T::Boolean)) }
def reverse_transfer; end
sig { params(_reverse_transfer: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def reverse_transfer=(_reverse_transfer); end
sig {
params(amount: T.nilable(Integer), charge: T.nilable(String), currency: T.nilable(String), customer: T.nilable(String), expand: T.nilable(T::Array[String]), instructions_email: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), origin: T.nilable(String), payment_intent: T.nilable(String), reason: T.nilable(String), refund_application_fee: T.nilable(T::Boolean), reverse_transfer: T.nilable(T::Boolean)).void
}
def initialize(
amount: nil,
charge: nil,
currency: nil,
customer: nil,
expand: nil,
instructions_email: nil,
metadata: nil,
origin: nil,
payment_intent: nil,
reason: nil,
refund_application_fee: nil,
reverse_transfer: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, metadata: nil); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Cancels a refund with a status of requires_action.
#
# You can't cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.
sig {
params(refund: String, params: T.any(::Stripe::RefundService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Refund)
}
def cancel(refund, params = {}, opts = {}); end
# When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
#
# Creating a new refund will 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.
#
# You can optionally refund only part of a charge.
# You can do so multiple times, until the entire charge has been refunded.
#
# Once entirely refunded, a charge can't be refunded again.
# This method will raise an error when called on an already-refunded charge,
# or when trying to refund more money than is left on a charge.
sig {
params(params: T.any(::Stripe::RefundService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Refund)
}
def create(params = {}, opts = {}); end
# Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.
sig {
params(params: T.any(::Stripe::RefundService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing refund.
sig {
params(refund: String, params: T.any(::Stripe::RefundService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Refund)
}
def retrieve(refund, params = {}, opts = {}); end
# Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don't provide remain unchanged.
#
# This request only accepts metadata as an argument.
sig {
params(refund: String, params: T.any(::Stripe::RefundService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Refund)
}
def update(refund, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class ReportingService < StripeService
attr_reader :report_runs
attr_reader :report_types
end
end
# typed: true
module Stripe
module Reporting
class ReportRunService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return Report Runs that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Reporting::ReportRunService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Reporting::ReportRunService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Reporting::ReportRunService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::Reporting::ReportRunService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Parameters < Stripe::RequestParams
# The set of report columns to include in the report output. If omitted, the Report Type is run with its default column set.
sig { returns(T.nilable(T::Array[String])) }
def columns; end
sig { params(_columns: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def columns=(_columns); end
# Connected account ID to filter for in the report run.
sig { returns(T.nilable(String)) }
def connected_account; end
sig { params(_connected_account: T.nilable(String)).returns(T.nilable(String)) }
def connected_account=(_connected_account); end
# Currency of objects to be included in the report run.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Ending timestamp of data to be included in the report run (exclusive).
sig { returns(T.nilable(Integer)) }
def interval_end; end
sig { params(_interval_end: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_end=(_interval_end); end
# Starting timestamp of data to be included in the report run.
sig { returns(T.nilable(Integer)) }
def interval_start; end
sig { params(_interval_start: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_start=(_interval_start); end
# Payout ID by which to filter the report run.
sig { returns(T.nilable(String)) }
def payout; end
sig { params(_payout: T.nilable(String)).returns(T.nilable(String)) }
def payout=(_payout); end
# Category of balance transactions to be included in the report run.
sig { returns(T.nilable(String)) }
def reporting_category; end
sig { params(_reporting_category: T.nilable(String)).returns(T.nilable(String)) }
def reporting_category=(_reporting_category); end
# Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`.
sig { returns(T.nilable(String)) }
def timezone; end
sig { params(_timezone: T.nilable(String)).returns(T.nilable(String)) }
def timezone=(_timezone); end
sig {
params(columns: T.nilable(T::Array[String]), connected_account: T.nilable(String), currency: T.nilable(String), interval_end: T.nilable(Integer), interval_start: T.nilable(Integer), payout: T.nilable(String), reporting_category: T.nilable(String), timezone: T.nilable(String)).void
}
def initialize(
columns: nil,
connected_account: nil,
currency: nil,
interval_end: nil,
interval_start: nil,
payout: nil,
reporting_category: nil,
timezone: nil
); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://stripe.com/docs/reporting/statements/api) documentation.
sig { returns(T.nilable(::Stripe::Reporting::ReportRunService::CreateParams::Parameters)) }
def parameters; end
sig {
params(_parameters: T.nilable(::Stripe::Reporting::ReportRunService::CreateParams::Parameters)).returns(T.nilable(::Stripe::Reporting::ReportRunService::CreateParams::Parameters))
}
def parameters=(_parameters); end
# The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`.
sig { returns(String) }
def report_type; end
sig { params(_report_type: String).returns(String) }
def report_type=(_report_type); end
sig {
params(expand: T.nilable(T::Array[String]), parameters: T.nilable(::Stripe::Reporting::ReportRunService::CreateParams::Parameters), report_type: String).void
}
def initialize(expand: nil, parameters: nil, report_type: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Creates a new object and begin running the report. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)
sig {
params(params: T.any(::Stripe::Reporting::ReportRunService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Reporting::ReportRun)
}
def create(params = {}, opts = {}); end
# Returns a list of Report Runs, with the most recent appearing first.
sig {
params(params: T.any(::Stripe::Reporting::ReportRunService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing Report Run.
sig {
params(report_run: String, params: T.any(::Stripe::Reporting::ReportRunService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Reporting::ReportRun)
}
def retrieve(report_run, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Reporting
class ReportTypeService < StripeService
class ListParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a full list of Report Types.
sig {
params(params: T.any(::Stripe::Reporting::ReportTypeService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of a Report Type. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)
sig {
params(report_type: String, params: T.any(::Stripe::Reporting::ReportTypeService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Reporting::ReportType)
}
def retrieve(report_type, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class ReviewService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return reviews that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::ReviewService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::ReviewService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::ReviewService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::ReviewService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ApproveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Approves a Review object, closing it and removing it from the list of reviews.
sig {
params(review: String, params: T.any(::Stripe::ReviewService::ApproveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Review)
}
def approve(review, params = {}, opts = {}); end
# Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
sig {
params(params: T.any(::Stripe::ReviewService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a Review object.
sig {
params(review: String, params: T.any(::Stripe::ReviewService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Review)
}
def retrieve(review, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class SetupAttemptService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# A filter on the list, based on the object `created` field. The value
# can be a string with an integer Unix timestamp or a
# dictionary with a number of different query options.
sig { returns(T.nilable(T.any(::Stripe::SetupAttemptService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::SetupAttemptService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::SetupAttemptService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return SetupAttempts created by the SetupIntent specified by
# this ID.
sig { returns(String) }
def setup_intent; end
sig { params(_setup_intent: String).returns(String) }
def setup_intent=(_setup_intent); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(created: T.nilable(T.any(::Stripe::SetupAttemptService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), setup_intent: String, starting_after: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
setup_intent: nil,
starting_after: nil
); end
end
# Returns a list of SetupAttempts that associate with a provided SetupIntent.
sig {
params(params: T.any(::Stripe::SetupAttemptService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class SetupIntentService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
#
# It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
sig { returns(T.nilable(T::Boolean)) }
def attach_to_self; end
sig { params(_attach_to_self: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def attach_to_self=(_attach_to_self); end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
sig { returns(T.nilable(T.any(::Stripe::SetupIntentService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::SetupIntentService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::SetupIntentService::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return SetupIntents for the customer specified by this customer ID.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Only return SetupIntents for the account specified by this customer ID.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return SetupIntents that associate with the specified payment method.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(attach_to_self: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::SetupIntentService::ListParams::Created, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_method: T.nilable(String), starting_after: T.nilable(String)).void
}
def initialize(
attach_to_self: nil,
created: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
limit: nil,
payment_method: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class AutomaticPaymentMethods < Stripe::RequestParams
# Controls whether this SetupIntent will accept redirect-based payment methods.
#
# Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup.
sig { returns(T.nilable(String)) }
def allow_redirects; end
sig { params(_allow_redirects: T.nilable(String)).returns(T.nilable(String)) }
def allow_redirects=(_allow_redirects); end
# Whether this feature is enabled.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(allow_redirects: T.nilable(String), enabled: T::Boolean).void }
def initialize(allow_redirects: nil, enabled: nil); end
end
class MandateData < Stripe::RequestParams
class CustomerAcceptance < Stripe::RequestParams
class Offline < Stripe::RequestParams; end
class Online < Stripe::RequestParams
# The IP address from which the Mandate was accepted by the customer.
sig { returns(String) }
def ip_address; end
sig { params(_ip_address: String).returns(String) }
def ip_address=(_ip_address); end
# The user agent of the browser from which the Mandate was accepted by the customer.
sig { returns(String) }
def user_agent; end
sig { params(_user_agent: String).returns(String) }
def user_agent=(_user_agent); end
sig { params(ip_address: String, user_agent: String).void }
def initialize(ip_address: nil, user_agent: nil); end
end
# The time at which the customer accepted the Mandate.
sig { returns(T.nilable(Integer)) }
def accepted_at; end
sig { params(_accepted_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def accepted_at=(_accepted_at); end
# If this is a Mandate accepted offline, this hash contains details about the offline acceptance.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::MandateData::CustomerAcceptance::Offline))
}
def offline; end
sig {
params(_offline: T.nilable(::Stripe::SetupIntentService::CreateParams::MandateData::CustomerAcceptance::Offline)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::MandateData::CustomerAcceptance::Offline))
}
def offline=(_offline); end
# If this is a Mandate accepted online, this hash contains details about the online acceptance.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::MandateData::CustomerAcceptance::Online))
}
def online; end
sig {
params(_online: T.nilable(::Stripe::SetupIntentService::CreateParams::MandateData::CustomerAcceptance::Online)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::MandateData::CustomerAcceptance::Online))
}
def online=(_online); end
# The type of customer acceptance information included with the Mandate. One of `online` or `offline`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(accepted_at: T.nilable(Integer), offline: T.nilable(::Stripe::SetupIntentService::CreateParams::MandateData::CustomerAcceptance::Offline), online: T.nilable(::Stripe::SetupIntentService::CreateParams::MandateData::CustomerAcceptance::Online), type: String).void
}
def initialize(accepted_at: nil, offline: nil, online: nil, type: nil); end
end
# This hash contains details about the customer acceptance of the Mandate.
sig { returns(::Stripe::SetupIntentService::CreateParams::MandateData::CustomerAcceptance) }
def customer_acceptance; end
sig {
params(_customer_acceptance: ::Stripe::SetupIntentService::CreateParams::MandateData::CustomerAcceptance).returns(::Stripe::SetupIntentService::CreateParams::MandateData::CustomerAcceptance)
}
def customer_acceptance=(_customer_acceptance); end
sig {
params(customer_acceptance: ::Stripe::SetupIntentService::CreateParams::MandateData::CustomerAcceptance).void
}
def initialize(customer_acceptance: nil); end
end
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Institution number of the customer's bank.
sig { returns(String) }
def institution_number; end
sig { params(_institution_number: String).returns(String) }
def institution_number=(_institution_number); end
# Transit number of the customer's bank.
sig { returns(String) }
def transit_number; end
sig { params(_transit_number: String).returns(String) }
def transit_number=(_transit_number); end
sig {
params(account_number: String, institution_number: String, transit_number: String).void
}
def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(String) }
def bsb_number; end
sig { params(_bsb_number: String).returns(String) }
def bsb_number=(_bsb_number); end
sig { params(account_number: String, bsb_number: String).void }
def initialize(account_number: nil, bsb_number: nil); end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
sig { params(_sort_code: T.nilable(String)).returns(T.nilable(String)) }
def sort_code=(_sort_code); end
sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
def initialize(account_number: nil, sort_code: nil); end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::SetupIntentService::CreateParams::PaymentMethodData::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::SetupIntentService::CreateParams::PaymentMethodData::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::SetupIntentService::CreateParams::PaymentMethodData::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::SetupIntentService::CreateParams::PaymentMethodData::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
sig { params(_tax_id: String).returns(String) }
def tax_id=(_tax_id); end
sig { params(tax_id: String).void }
def initialize(tax_id: nil); end
end
class Cashapp < Stripe::RequestParams; end
class Crypto < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The customer's bank.
sig { returns(String) }
def bank; end
sig { params(_bank: String).returns(String) }
def bank=(_bank); end
sig { params(account_holder_type: T.nilable(String), bank: String).void }
def initialize(account_holder_type: nil, bank: nil); end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Klarna::Dob))
}
def dob; end
sig {
params(_dob: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Klarna::Dob)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Klarna::Dob))
}
def dob=(_dob); end
sig {
params(dob: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Klarna::Dob)).void
}
def initialize(dob: nil); end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
sig { returns(T.nilable(String)) }
def funding; end
sig { params(_funding: T.nilable(String)).returns(T.nilable(String)) }
def funding=(_funding); end
sig { params(funding: T.nilable(String)).void }
def initialize(funding: nil); end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
sig { params(_bank_code: String).returns(String) }
def bank_code=(_bank_code); end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
sig { params(_branch_code: String).returns(String) }
def branch_code=(_branch_code); end
# Attribute for param field reference
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# The suffix of the bank account number.
sig { returns(String) }
def suffix; end
sig { params(_suffix: String).returns(String) }
def suffix=(_suffix); end
sig {
params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
); end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Paypay < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Rechnung::Dob)
}
def dob; end
sig {
params(_dob: ::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Rechnung::Dob).returns(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Rechnung::Dob)
}
def dob=(_dob); end
sig {
params(dob: ::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Rechnung::Dob).void
}
def initialize(dob: nil); end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
sig { returns(String) }
def iban; end
sig { params(_iban: String).returns(String) }
def iban=(_iban); end
sig { params(iban: String).void }
def initialize(iban: nil); end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
sig { params(account: T.nilable(String), source_type: T.nilable(String)).void }
def initialize(account: nil, source_type: nil); end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig {
params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String))
}
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AcssDebit)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Affirm))
}
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Affirm)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Affirm))
}
def affirm=(_affirm); end
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AfterpayClearpay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Alipay))
}
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Alipay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Alipay))
}
def alipay=(_alipay); end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Alma))
}
def alma; end
sig {
params(_alma: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Alma)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Alma))
}
def alma=(_alma); end
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AmazonPay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AuBecsDebit)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::BacsDebit)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Bancontact)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Bancontact))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Billie))
}
def billie; end
sig {
params(_billie: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Billie)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Billie))
}
def billie=(_billie); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::BillingDetails)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Blik))
}
def blik; end
sig {
params(_blik: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Blik)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Blik))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Boleto))
}
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Boleto)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Boleto))
}
def boleto=(_boleto); end
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Cashapp))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Cashapp)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Cashapp))
}
def cashapp=(_cashapp); end
# If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Crypto))
}
def crypto; end
sig {
params(_crypto: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Crypto)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Crypto))
}
def crypto=(_crypto); end
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::CustomerBalance)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Eps))
}
def eps; end
sig {
params(_eps: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Eps)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Eps))
}
def eps=(_eps); end
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Fpx))
}
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Fpx)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Fpx))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Giropay))
}
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Giropay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Giropay))
}
def giropay=(_giropay); end
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Gopay))
}
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Gopay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Gopay))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Grabpay))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Grabpay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Grabpay))
}
def grabpay=(_grabpay); end
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::IdBankTransfer)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Ideal))
}
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Ideal)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Ideal))
}
def ideal=(_ideal); end
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::InteracPresent))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::InteracPresent)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::InteracPresent))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::KakaoPay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Klarna)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Klarna))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Konbini))
}
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Konbini)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Konbini))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::KrCard))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::KrCard)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::KrCard))
}
def kr_card=(_kr_card); end
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Link))
}
def link; end
sig {
params(_link: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Link)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Link))
}
def link=(_link); end
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::MbWay))
}
def mb_way; end
sig {
params(_mb_way: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::MbWay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::MbWay))
}
def mb_way=(_mb_way); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Mobilepay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Mobilepay))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Multibanco)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Multibanco))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::NaverPay))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::NaverPay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::NaverPay))
}
def naver_pay=(_naver_pay); end
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::NzBankAccount)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Oxxo))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Oxxo)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Oxxo))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::P24))
}
def p24; end
sig {
params(_p24: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::P24)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::P24))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::PayByBank)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Payco))
}
def payco; end
sig {
params(_payco: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Payco)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Payco))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Paynow))
}
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Paynow)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Paynow))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Paypal)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Paypal))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Paypay))
}
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Paypay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Paypay))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Payto))
}
def payto; end
sig {
params(_payto: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Payto)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Payto))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Pix))
}
def pix; end
sig {
params(_pix: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Pix)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Pix))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Promptpay))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Promptpay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Promptpay))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Qris))
}
def qris; end
sig {
params(_qris: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Qris)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Qris))
}
def qris=(_qris); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::RadarOptions))
}
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::RadarOptions)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::RadarOptions))
}
def radar_options=(_radar_options); end
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Rechnung))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Rechnung)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Rechnung))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::RevolutPay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::SamsungPay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Satispay))
}
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Satispay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Satispay))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::SepaDebit)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Shopeepay))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Shopeepay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Shopeepay))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Sofort))
}
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Sofort)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Sofort))
}
def sofort=(_sofort); end
# This hash contains details about the Stripe balance payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::StripeBalance)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Swish))
}
def swish; end
sig {
params(_swish: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Swish)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Swish))
}
def swish=(_swish); end
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Twint))
}
def twint; end
sig {
params(_twint: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Twint)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Twint))
}
def twint=(_twint); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::UsBankAccount)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::WechatPay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Zip))
}
def zip; end
sig {
params(_zip: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Zip)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Cashapp), crypto: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Crypto), customer_balance: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Giropay), gopay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Gopay), grabpay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Grabpay), id_bank_transfer: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::IdBankTransfer), ideal: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Link), mb_way: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::MbWay), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Paypal), paypay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Paypay), payto: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Payto), pix: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Promptpay), qris: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Qris), radar_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::RadarOptions), rechnung: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Rechnung), revolut_pay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::SepaDebit), shopeepay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Shopeepay), sofort: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Sofort), stripe_balance: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::StripeBalance), swish: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# List of Stripe products where this mandate can be selected automatically.
sig { returns(T.nilable(T::Array[String])) }
def default_for; end
sig {
params(_default_for: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def default_for=(_default_for); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), default_for: T.nilable(T::Array[String]), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
default_for: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(currency: T.nilable(String), mandate_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
}
def initialize(currency: nil, mandate_options: nil, verification_method: nil); end
end
class AmazonPay < Stripe::RequestParams; end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class Card < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(String) }
def amount_type; end
sig { params(_amount_type: String).returns(String) }
def amount_type=(_amount_type); end
# Currency in which future payments will be charged. 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Unique identifier for the mandate or subscription.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
sig { returns(Integer) }
def start_date; end
sig { params(_start_date: Integer).returns(Integer) }
def start_date=(_start_date); end
# Specifies the type of mandates supported. Possible values are `india`.
sig { returns(T.nilable(T::Array[String])) }
def supported_types; end
sig {
params(_supported_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def supported_types=(_supported_types); end
sig {
params(amount: Integer, amount_type: String, currency: String, description: T.nilable(String), end_date: T.nilable(Integer), interval: String, interval_count: T.nilable(Integer), reference: String, start_date: Integer, supported_types: T.nilable(T::Array[String])).void
}
def initialize(
amount: nil,
amount_type: nil,
currency: nil,
description: nil,
end_date: nil,
interval: nil,
interval_count: nil,
reference: nil,
start_date: nil,
supported_types: nil
); end
end
class ThreeDSecure < Stripe::RequestParams
class NetworkOptions < Stripe::RequestParams
class CartesBancaires < Stripe::RequestParams
# The cryptogram calculation algorithm used by the card Issuer's ACS
# to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
# messageExtension: CB-AVALGO
sig { returns(String) }
def cb_avalgo; end
sig { params(_cb_avalgo: String).returns(String) }
def cb_avalgo=(_cb_avalgo); end
# The exemption indicator returned from Cartes Bancaires in the ARes.
# message extension: CB-EXEMPTION; string (4 characters)
# This is a 3 byte bitmap (low significant byte first and most significant
# bit first) that has been Base64 encoded
sig { returns(T.nilable(String)) }
def cb_exemption; end
sig { params(_cb_exemption: T.nilable(String)).returns(T.nilable(String)) }
def cb_exemption=(_cb_exemption); end
# The risk score returned from Cartes Bancaires in the ARes.
# message extension: CB-SCORE; numeric value 0-99
sig { returns(T.nilable(Integer)) }
def cb_score; end
sig { params(_cb_score: T.nilable(Integer)).returns(T.nilable(Integer)) }
def cb_score=(_cb_score); end
sig {
params(cb_avalgo: String, cb_exemption: T.nilable(String), cb_score: T.nilable(Integer)).void
}
def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil); end
end
# Cartes Bancaires-specific 3DS fields.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires; end
sig {
params(_cartes_bancaires: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires=(_cartes_bancaires); end
sig {
params(cartes_bancaires: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).void
}
def initialize(cartes_bancaires: nil); end
end
# The `transStatus` returned from the card Issuer’s ACS in the ARes.
sig { returns(T.nilable(String)) }
def ares_trans_status; end
sig { params(_ares_trans_status: T.nilable(String)).returns(T.nilable(String)) }
def ares_trans_status=(_ares_trans_status); end
# The cryptogram, also known as the "authentication value" (AAV, CAVV or
# AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
# (Most 3D Secure providers will return the base64-encoded version, which
# is what you should specify here.)
sig { returns(T.nilable(String)) }
def cryptogram; end
sig { params(_cryptogram: T.nilable(String)).returns(T.nilable(String)) }
def cryptogram=(_cryptogram); end
# The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
# provider and indicates what degree of authentication was performed.
sig { returns(T.nilable(String)) }
def electronic_commerce_indicator; end
sig {
params(_electronic_commerce_indicator: T.nilable(String)).returns(T.nilable(String))
}
def electronic_commerce_indicator=(_electronic_commerce_indicator); end
# Network specific 3DS fields. Network specific arguments require an
# explicit card brand choice. The parameter `payment_method_options.card.network``
# must be populated accordingly
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options; end
sig {
params(_network_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options=(_network_options); end
# The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
# AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
sig { returns(T.nilable(String)) }
def requestor_challenge_indicator; end
sig {
params(_requestor_challenge_indicator: T.nilable(String)).returns(T.nilable(String))
}
def requestor_challenge_indicator=(_requestor_challenge_indicator); end
# For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
# Transaction ID (dsTransID).
sig { returns(T.nilable(String)) }
def transaction_id; end
sig { params(_transaction_id: T.nilable(String)).returns(T.nilable(String)) }
def transaction_id=(_transaction_id); end
# The version of 3D Secure that was performed.
sig { returns(T.nilable(String)) }
def version; end
sig { params(_version: T.nilable(String)).returns(T.nilable(String)) }
def version=(_version); end
sig {
params(ares_trans_status: T.nilable(String), cryptogram: T.nilable(String), electronic_commerce_indicator: T.nilable(String), network_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions), requestor_challenge_indicator: T.nilable(String), transaction_id: T.nilable(String), version: T.nilable(String)).void
}
def initialize(
ares_trans_status: nil,
cryptogram: nil,
electronic_commerce_indicator: nil,
network_options: nil,
requestor_challenge_indicator: nil,
transaction_id: nil,
version: nil
); end
end
# Configuration options for setting up an eMandate for cards issued in India.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options=(_mandate_options); end
# When specified, this parameter signals that a card has been collected
# as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
# parameter can only be provided during confirmation.
sig { returns(T.nilable(T::Boolean)) }
def moto; end
sig { params(_moto: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def moto=(_moto); end
# Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
# If 3D Secure authentication was performed with a third-party provider,
# the authentication details to use for this setup.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure; end
sig {
params(_three_d_secure: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure=(_three_d_secure); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card::MandateOptions), moto: T.nilable(T::Boolean), network: T.nilable(String), request_three_d_secure: T.nilable(String), three_d_secure: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card::ThreeDSecure)).void
}
def initialize(
mandate_options: nil,
moto: nil,
network: nil,
request_three_d_secure: nil,
three_d_secure: nil
); end
end
class CardPresent < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class OnDemand < Stripe::RequestParams
# Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def average_amount; end
sig { params(_average_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def average_amount=(_average_amount); end
# The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def maximum_amount; end
sig { params(_maximum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_amount=(_maximum_amount); end
# The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Interval at which the customer is making purchases
sig { returns(T.nilable(String)) }
def purchase_interval; end
sig { params(_purchase_interval: T.nilable(String)).returns(T.nilable(String)) }
def purchase_interval=(_purchase_interval); end
# The number of `purchase_interval` between charges
sig { returns(T.nilable(Integer)) }
def purchase_interval_count; end
sig { params(_purchase_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def purchase_interval_count=(_purchase_interval_count); end
sig {
params(average_amount: T.nilable(Integer), maximum_amount: T.nilable(Integer), minimum_amount: T.nilable(Integer), purchase_interval: T.nilable(String), purchase_interval_count: T.nilable(Integer)).void
}
def initialize(
average_amount: nil,
maximum_amount: nil,
minimum_amount: nil,
purchase_interval: nil,
purchase_interval_count: nil
); end
end
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
}
def next_billing; end
sig {
params(_next_billing: ::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling).returns(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: ::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling, reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# The currency of the SetupIntent. Three letter ISO currency code.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# On-demand details if setting up a payment method for on-demand payments.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand; end
sig {
params(_on_demand: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Klarna::OnDemand)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand=(_on_demand); end
# Preferred language of the Klarna authorization page that the customer is redirected to
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Subscription details if setting up or charging a subscription
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(currency: T.nilable(String), on_demand: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Klarna::OnDemand), preferred_locale: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(
currency: nil,
on_demand: nil,
preferred_locale: nil,
subscriptions: nil
); end
end
class Link < Stripe::RequestParams
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
sig { params(_persistent_token: T.nilable(String)).returns(T.nilable(String)) }
def persistent_token=(_persistent_token); end
sig { params(persistent_token: T.nilable(String)).void }
def initialize(persistent_token: nil); end
end
class Paypal < Stripe::RequestParams
# The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
sig { returns(T.nilable(String)) }
def billing_agreement_id; end
sig { params(_billing_agreement_id: T.nilable(String)).returns(T.nilable(String)) }
def billing_agreement_id=(_billing_agreement_id); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(billing_agreement_id: T.nilable(String), currency: T.nilable(String), subsellers: T.nilable(T::Array[String])).void
}
def initialize(billing_agreement_id: nil, currency: nil, subsellers: nil); end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
sig { params(_payments_per_period: T.nilable(Integer)).returns(T.nilable(Integer)) }
def payments_per_period=(_payments_per_period); end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
sig { params(_purpose: T.nilable(String)).returns(T.nilable(String)) }
def purpose=(_purpose); end
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), payments_per_period: T.nilable(Integer), purpose: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil,
start_date: nil
); end
end
# Additional fields for Mandate creation.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Payto::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Payto::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Type of amount. Defaults to `maximum`.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), amount_type: T.nilable(String), currency: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), reference: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
amount_type: nil,
currency: nil,
end_date: nil,
payment_schedule: nil,
reference: nil,
start_date: nil
); end
end
# Additional fields for mandate creation.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Pix::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
class ManualEntry < Stripe::RequestParams
# Settings for configuring manual entry of account details.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
sig { params(mode: String).void }
def initialize(mode: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# Customize manual entry behavior
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry; end
sig {
params(_manual_entry: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry=(_manual_entry); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(filters: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), manual_entry: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
}
def initialize(
filters: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
); end
end
class MandateOptions < Stripe::RequestParams
# The method used to collect offline mandate customer acceptance.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
sig { params(collection_method: T.nilable(String)).void }
def initialize(collection_method: nil); end
end
class Networks < Stripe::RequestParams
# Triggers validations to run across the selected networks
sig { returns(T.nilable(T::Array[String])) }
def requested; end
sig {
params(_requested: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested=(_requested); end
sig { params(requested: T.nilable(T::Array[String])).void }
def initialize(requested: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Additional fields for network related functions
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks; end
sig {
params(_networks: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::Networks)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks=(_networks); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount::Networks), verification_method: T.nilable(String)).void
}
def initialize(
financial_connections: nil,
mandate_options: nil,
networks: nil,
verification_method: nil
); end
end
# If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::AcssDebit)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::AmazonPay)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::BacsDebit)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# Configuration for any card setup attempted on this SetupIntent.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card))
}
def card=(_card); end
# If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::CardPresent))
}
def card_present=(_card_present); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Link))
}
def link; end
sig {
params(_link: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Link)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Link))
}
def link=(_link); end
# If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
# If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Payto))
}
def payto; end
sig {
params(_payto: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Payto)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Payto))
}
def payto=(_payto); end
# If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Pix))
}
def pix; end
sig {
params(_pix: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Pix)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Pix))
}
def pix=(_pix); end
# If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::SepaDebit)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
sig {
params(acss_debit: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::AcssDebit), amazon_pay: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::AmazonPay), bacs_debit: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::BacsDebit), card: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::CardPresent), klarna: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Klarna), link: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Link), paypal: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Paypal), payto: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Payto), pix: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::Pix), sepa_debit: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::SepaDebit), us_bank_account: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions::UsBankAccount)).void
}
def initialize(
acss_debit: nil,
amazon_pay: nil,
bacs_debit: nil,
card: nil,
card_present: nil,
klarna: nil,
link: nil,
paypal: nil,
payto: nil,
pix: nil,
sepa_debit: nil,
us_bank_account: nil
); end
end
class SingleUse < Stripe::RequestParams
# Amount the customer is granting permission to collect later. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
sig { params(amount: Integer, currency: String).void }
def initialize(amount: nil, currency: nil); end
end
# If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
#
# It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
sig { returns(T.nilable(T::Boolean)) }
def attach_to_self; end
sig { params(_attach_to_self: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def attach_to_self=(_attach_to_self); end
# When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters.
sig {
returns(T.nilable(::Stripe::SetupIntentService::CreateParams::AutomaticPaymentMethods))
}
def automatic_payment_methods; end
sig {
params(_automatic_payment_methods: T.nilable(::Stripe::SetupIntentService::CreateParams::AutomaticPaymentMethods)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::AutomaticPaymentMethods))
}
def automatic_payment_methods=(_automatic_payment_methods); end
# Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary.
sig { returns(T.nilable(T::Boolean)) }
def confirm; end
sig { params(_confirm: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def confirm=(_confirm); end
# ID of the ConfirmationToken used to confirm this SetupIntent.
#
# If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.
sig { returns(T.nilable(String)) }
def confirmation_token; end
sig { params(_confirmation_token: T.nilable(String)).returns(T.nilable(String)) }
def confirmation_token=(_confirmation_token); end
# ID of the Customer this SetupIntent belongs to, if one exists.
#
# If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# ID of the Account this SetupIntent belongs to, if one exists.
#
# If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Indicates the directions of money movement for which this payment method is intended to be used.
#
# Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.
sig { returns(T.nilable(T::Array[String])) }
def flow_directions; end
sig {
params(_flow_directions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def flow_directions=(_flow_directions); end
# This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm).
sig {
returns(T.nilable(T.any(String, ::Stripe::SetupIntentService::CreateParams::MandateData)))
}
def mandate_data; end
sig {
params(_mandate_data: T.nilable(T.any(String, ::Stripe::SetupIntentService::CreateParams::MandateData))).returns(T.nilable(T.any(String, ::Stripe::SetupIntentService::CreateParams::MandateData)))
}
def mandate_data=(_mandate_data); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The Stripe account ID created for this SetupIntent.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent.
sig { returns(T.nilable(String)) }
def payment_method_configuration; end
sig { params(_payment_method_configuration: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_configuration=(_payment_method_configuration); end
# When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)
# value in the SetupIntent.
sig { returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData)) }
def payment_method_data; end
sig {
params(_payment_method_data: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData))
}
def payment_method_data=(_payment_method_data); end
# Payment method-specific configuration for this SetupIntent.
sig { returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions)) }
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
# The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm).
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion.
#
# Single-use mandates are only valid for the following payment methods: `acss_debit`, `alipay`, `au_becs_debit`, `bacs_debit`, `bancontact`, `boleto`, `ideal`, `link`, `sepa_debit`, and `us_bank_account`.
sig { returns(T.nilable(::Stripe::SetupIntentService::CreateParams::SingleUse)) }
def single_use; end
sig {
params(_single_use: T.nilable(::Stripe::SetupIntentService::CreateParams::SingleUse)).returns(T.nilable(::Stripe::SetupIntentService::CreateParams::SingleUse))
}
def single_use=(_single_use); end
# Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`.
sig { returns(T.nilable(String)) }
def usage; end
sig { params(_usage: T.nilable(String)).returns(T.nilable(String)) }
def usage=(_usage); end
# Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
sig { returns(T.nilable(T::Boolean)) }
def use_stripe_sdk; end
sig { params(_use_stripe_sdk: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def use_stripe_sdk=(_use_stripe_sdk); end
sig {
params(attach_to_self: T.nilable(T::Boolean), automatic_payment_methods: T.nilable(::Stripe::SetupIntentService::CreateParams::AutomaticPaymentMethods), confirm: T.nilable(T::Boolean), confirmation_token: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), description: T.nilable(String), expand: T.nilable(T::Array[String]), flow_directions: T.nilable(T::Array[String]), mandate_data: T.nilable(T.any(String, ::Stripe::SetupIntentService::CreateParams::MandateData)), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), payment_method: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), return_url: T.nilable(String), single_use: T.nilable(::Stripe::SetupIntentService::CreateParams::SingleUse), usage: T.nilable(String), use_stripe_sdk: T.nilable(T::Boolean)).void
}
def initialize(
attach_to_self: nil,
automatic_payment_methods: nil,
confirm: nil,
confirmation_token: nil,
customer: nil,
customer_account: nil,
description: nil,
expand: nil,
flow_directions: nil,
mandate_data: nil,
metadata: nil,
on_behalf_of: nil,
payment_method: nil,
payment_method_configuration: nil,
payment_method_data: nil,
payment_method_options: nil,
payment_method_types: nil,
return_url: nil,
single_use: nil,
usage: nil,
use_stripe_sdk: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent.
sig { returns(T.nilable(String)) }
def client_secret; end
sig { params(_client_secret: T.nilable(String)).returns(T.nilable(String)) }
def client_secret=(_client_secret); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(client_secret: T.nilable(String), expand: T.nilable(T::Array[String])).void }
def initialize(client_secret: nil, expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Institution number of the customer's bank.
sig { returns(String) }
def institution_number; end
sig { params(_institution_number: String).returns(String) }
def institution_number=(_institution_number); end
# Transit number of the customer's bank.
sig { returns(String) }
def transit_number; end
sig { params(_transit_number: String).returns(String) }
def transit_number=(_transit_number); end
sig {
params(account_number: String, institution_number: String, transit_number: String).void
}
def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(String) }
def bsb_number; end
sig { params(_bsb_number: String).returns(String) }
def bsb_number=(_bsb_number); end
sig { params(account_number: String, bsb_number: String).void }
def initialize(account_number: nil, bsb_number: nil); end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
sig { params(_sort_code: T.nilable(String)).returns(T.nilable(String)) }
def sort_code=(_sort_code); end
sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
def initialize(account_number: nil, sort_code: nil); end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
sig { params(_tax_id: String).returns(String) }
def tax_id=(_tax_id); end
sig { params(tax_id: String).void }
def initialize(tax_id: nil); end
end
class Cashapp < Stripe::RequestParams; end
class Crypto < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The customer's bank.
sig { returns(String) }
def bank; end
sig { params(_bank: String).returns(String) }
def bank=(_bank); end
sig { params(account_holder_type: T.nilable(String), bank: String).void }
def initialize(account_holder_type: nil, bank: nil); end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Klarna::Dob))
}
def dob; end
sig {
params(_dob: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Klarna::Dob)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Klarna::Dob))
}
def dob=(_dob); end
sig {
params(dob: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Klarna::Dob)).void
}
def initialize(dob: nil); end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
sig { returns(T.nilable(String)) }
def funding; end
sig { params(_funding: T.nilable(String)).returns(T.nilable(String)) }
def funding=(_funding); end
sig { params(funding: T.nilable(String)).void }
def initialize(funding: nil); end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
sig { params(_bank_code: String).returns(String) }
def bank_code=(_bank_code); end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
sig { params(_branch_code: String).returns(String) }
def branch_code=(_branch_code); end
# Attribute for param field reference
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# The suffix of the bank account number.
sig { returns(String) }
def suffix; end
sig { params(_suffix: String).returns(String) }
def suffix=(_suffix); end
sig {
params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
); end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Paypay < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Rechnung::Dob)
}
def dob; end
sig {
params(_dob: ::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Rechnung::Dob).returns(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Rechnung::Dob)
}
def dob=(_dob); end
sig {
params(dob: ::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Rechnung::Dob).void
}
def initialize(dob: nil); end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
sig { returns(String) }
def iban; end
sig { params(_iban: String).returns(String) }
def iban=(_iban); end
sig { params(iban: String).void }
def initialize(iban: nil); end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
sig { params(account: T.nilable(String), source_type: T.nilable(String)).void }
def initialize(account: nil, source_type: nil); end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig {
params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String))
}
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AcssDebit)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Affirm))
}
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Affirm)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Affirm))
}
def affirm=(_affirm); end
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AfterpayClearpay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Alipay))
}
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Alipay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Alipay))
}
def alipay=(_alipay); end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Alma))
}
def alma; end
sig {
params(_alma: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Alma)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Alma))
}
def alma=(_alma); end
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AmazonPay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AuBecsDebit)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::BacsDebit)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Bancontact)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Bancontact))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Billie))
}
def billie; end
sig {
params(_billie: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Billie)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Billie))
}
def billie=(_billie); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::BillingDetails)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Blik))
}
def blik; end
sig {
params(_blik: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Blik)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Blik))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Boleto))
}
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Boleto)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Boleto))
}
def boleto=(_boleto); end
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Cashapp))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Cashapp)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Cashapp))
}
def cashapp=(_cashapp); end
# If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Crypto))
}
def crypto; end
sig {
params(_crypto: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Crypto)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Crypto))
}
def crypto=(_crypto); end
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::CustomerBalance)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Eps))
}
def eps; end
sig {
params(_eps: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Eps)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Eps))
}
def eps=(_eps); end
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Fpx))
}
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Fpx)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Fpx))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Giropay))
}
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Giropay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Giropay))
}
def giropay=(_giropay); end
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Gopay))
}
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Gopay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Gopay))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Grabpay))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Grabpay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Grabpay))
}
def grabpay=(_grabpay); end
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::IdBankTransfer)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Ideal))
}
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Ideal)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Ideal))
}
def ideal=(_ideal); end
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::InteracPresent))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::InteracPresent)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::InteracPresent))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::KakaoPay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Klarna)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Klarna))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Konbini))
}
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Konbini)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Konbini))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::KrCard))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::KrCard)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::KrCard))
}
def kr_card=(_kr_card); end
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Link))
}
def link; end
sig {
params(_link: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Link)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Link))
}
def link=(_link); end
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::MbWay))
}
def mb_way; end
sig {
params(_mb_way: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::MbWay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::MbWay))
}
def mb_way=(_mb_way); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Mobilepay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Mobilepay))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Multibanco)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Multibanco))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::NaverPay))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::NaverPay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::NaverPay))
}
def naver_pay=(_naver_pay); end
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::NzBankAccount)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Oxxo))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Oxxo)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Oxxo))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::P24))
}
def p24; end
sig {
params(_p24: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::P24)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::P24))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::PayByBank)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Payco))
}
def payco; end
sig {
params(_payco: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Payco)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Payco))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Paynow))
}
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Paynow)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Paynow))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Paypal)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Paypal))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Paypay))
}
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Paypay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Paypay))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Payto))
}
def payto; end
sig {
params(_payto: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Payto)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Payto))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Pix))
}
def pix; end
sig {
params(_pix: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Pix)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Pix))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Promptpay))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Promptpay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Promptpay))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Qris))
}
def qris; end
sig {
params(_qris: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Qris)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Qris))
}
def qris=(_qris); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::RadarOptions))
}
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::RadarOptions)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::RadarOptions))
}
def radar_options=(_radar_options); end
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Rechnung))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Rechnung)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Rechnung))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::RevolutPay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::SamsungPay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Satispay))
}
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Satispay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Satispay))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::SepaDebit)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Shopeepay))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Shopeepay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Shopeepay))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Sofort))
}
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Sofort)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Sofort))
}
def sofort=(_sofort); end
# This hash contains details about the Stripe balance payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::StripeBalance)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Swish))
}
def swish; end
sig {
params(_swish: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Swish)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Swish))
}
def swish=(_swish); end
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Twint))
}
def twint; end
sig {
params(_twint: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Twint)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Twint))
}
def twint=(_twint); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::UsBankAccount)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::WechatPay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Zip))
}
def zip; end
sig {
params(_zip: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Zip)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Cashapp), crypto: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Crypto), customer_balance: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Giropay), gopay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Gopay), grabpay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Grabpay), id_bank_transfer: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::IdBankTransfer), ideal: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Link), mb_way: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::MbWay), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Paypal), paypay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Paypay), payto: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Payto), pix: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Promptpay), qris: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Qris), radar_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::RadarOptions), rechnung: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Rechnung), revolut_pay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::SepaDebit), shopeepay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Shopeepay), sofort: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Sofort), stripe_balance: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::StripeBalance), swish: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# List of Stripe products where this mandate can be selected automatically.
sig { returns(T.nilable(T::Array[String])) }
def default_for; end
sig {
params(_default_for: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def default_for=(_default_for); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), default_for: T.nilable(T::Array[String]), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
default_for: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(currency: T.nilable(String), mandate_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
}
def initialize(currency: nil, mandate_options: nil, verification_method: nil); end
end
class AmazonPay < Stripe::RequestParams; end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class Card < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(String) }
def amount_type; end
sig { params(_amount_type: String).returns(String) }
def amount_type=(_amount_type); end
# Currency in which future payments will be charged. 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Unique identifier for the mandate or subscription.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
sig { returns(Integer) }
def start_date; end
sig { params(_start_date: Integer).returns(Integer) }
def start_date=(_start_date); end
# Specifies the type of mandates supported. Possible values are `india`.
sig { returns(T.nilable(T::Array[String])) }
def supported_types; end
sig {
params(_supported_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def supported_types=(_supported_types); end
sig {
params(amount: Integer, amount_type: String, currency: String, description: T.nilable(String), end_date: T.nilable(Integer), interval: String, interval_count: T.nilable(Integer), reference: String, start_date: Integer, supported_types: T.nilable(T::Array[String])).void
}
def initialize(
amount: nil,
amount_type: nil,
currency: nil,
description: nil,
end_date: nil,
interval: nil,
interval_count: nil,
reference: nil,
start_date: nil,
supported_types: nil
); end
end
class ThreeDSecure < Stripe::RequestParams
class NetworkOptions < Stripe::RequestParams
class CartesBancaires < Stripe::RequestParams
# The cryptogram calculation algorithm used by the card Issuer's ACS
# to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
# messageExtension: CB-AVALGO
sig { returns(String) }
def cb_avalgo; end
sig { params(_cb_avalgo: String).returns(String) }
def cb_avalgo=(_cb_avalgo); end
# The exemption indicator returned from Cartes Bancaires in the ARes.
# message extension: CB-EXEMPTION; string (4 characters)
# This is a 3 byte bitmap (low significant byte first and most significant
# bit first) that has been Base64 encoded
sig { returns(T.nilable(String)) }
def cb_exemption; end
sig { params(_cb_exemption: T.nilable(String)).returns(T.nilable(String)) }
def cb_exemption=(_cb_exemption); end
# The risk score returned from Cartes Bancaires in the ARes.
# message extension: CB-SCORE; numeric value 0-99
sig { returns(T.nilable(Integer)) }
def cb_score; end
sig { params(_cb_score: T.nilable(Integer)).returns(T.nilable(Integer)) }
def cb_score=(_cb_score); end
sig {
params(cb_avalgo: String, cb_exemption: T.nilable(String), cb_score: T.nilable(Integer)).void
}
def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil); end
end
# Cartes Bancaires-specific 3DS fields.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires; end
sig {
params(_cartes_bancaires: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires=(_cartes_bancaires); end
sig {
params(cartes_bancaires: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).void
}
def initialize(cartes_bancaires: nil); end
end
# The `transStatus` returned from the card Issuer’s ACS in the ARes.
sig { returns(T.nilable(String)) }
def ares_trans_status; end
sig { params(_ares_trans_status: T.nilable(String)).returns(T.nilable(String)) }
def ares_trans_status=(_ares_trans_status); end
# The cryptogram, also known as the "authentication value" (AAV, CAVV or
# AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
# (Most 3D Secure providers will return the base64-encoded version, which
# is what you should specify here.)
sig { returns(T.nilable(String)) }
def cryptogram; end
sig { params(_cryptogram: T.nilable(String)).returns(T.nilable(String)) }
def cryptogram=(_cryptogram); end
# The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
# provider and indicates what degree of authentication was performed.
sig { returns(T.nilable(String)) }
def electronic_commerce_indicator; end
sig {
params(_electronic_commerce_indicator: T.nilable(String)).returns(T.nilable(String))
}
def electronic_commerce_indicator=(_electronic_commerce_indicator); end
# Network specific 3DS fields. Network specific arguments require an
# explicit card brand choice. The parameter `payment_method_options.card.network``
# must be populated accordingly
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options; end
sig {
params(_network_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options=(_network_options); end
# The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
# AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
sig { returns(T.nilable(String)) }
def requestor_challenge_indicator; end
sig {
params(_requestor_challenge_indicator: T.nilable(String)).returns(T.nilable(String))
}
def requestor_challenge_indicator=(_requestor_challenge_indicator); end
# For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
# Transaction ID (dsTransID).
sig { returns(T.nilable(String)) }
def transaction_id; end
sig { params(_transaction_id: T.nilable(String)).returns(T.nilable(String)) }
def transaction_id=(_transaction_id); end
# The version of 3D Secure that was performed.
sig { returns(T.nilable(String)) }
def version; end
sig { params(_version: T.nilable(String)).returns(T.nilable(String)) }
def version=(_version); end
sig {
params(ares_trans_status: T.nilable(String), cryptogram: T.nilable(String), electronic_commerce_indicator: T.nilable(String), network_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions), requestor_challenge_indicator: T.nilable(String), transaction_id: T.nilable(String), version: T.nilable(String)).void
}
def initialize(
ares_trans_status: nil,
cryptogram: nil,
electronic_commerce_indicator: nil,
network_options: nil,
requestor_challenge_indicator: nil,
transaction_id: nil,
version: nil
); end
end
# Configuration options for setting up an eMandate for cards issued in India.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options=(_mandate_options); end
# When specified, this parameter signals that a card has been collected
# as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
# parameter can only be provided during confirmation.
sig { returns(T.nilable(T::Boolean)) }
def moto; end
sig { params(_moto: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def moto=(_moto); end
# Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
# If 3D Secure authentication was performed with a third-party provider,
# the authentication details to use for this setup.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure; end
sig {
params(_three_d_secure: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure=(_three_d_secure); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card::MandateOptions), moto: T.nilable(T::Boolean), network: T.nilable(String), request_three_d_secure: T.nilable(String), three_d_secure: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure)).void
}
def initialize(
mandate_options: nil,
moto: nil,
network: nil,
request_three_d_secure: nil,
three_d_secure: nil
); end
end
class CardPresent < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class OnDemand < Stripe::RequestParams
# Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def average_amount; end
sig { params(_average_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def average_amount=(_average_amount); end
# The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def maximum_amount; end
sig { params(_maximum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_amount=(_maximum_amount); end
# The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Interval at which the customer is making purchases
sig { returns(T.nilable(String)) }
def purchase_interval; end
sig { params(_purchase_interval: T.nilable(String)).returns(T.nilable(String)) }
def purchase_interval=(_purchase_interval); end
# The number of `purchase_interval` between charges
sig { returns(T.nilable(Integer)) }
def purchase_interval_count; end
sig { params(_purchase_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def purchase_interval_count=(_purchase_interval_count); end
sig {
params(average_amount: T.nilable(Integer), maximum_amount: T.nilable(Integer), minimum_amount: T.nilable(Integer), purchase_interval: T.nilable(String), purchase_interval_count: T.nilable(Integer)).void
}
def initialize(
average_amount: nil,
maximum_amount: nil,
minimum_amount: nil,
purchase_interval: nil,
purchase_interval_count: nil
); end
end
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
}
def next_billing; end
sig {
params(_next_billing: ::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling).returns(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: ::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling, reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# The currency of the SetupIntent. Three letter ISO currency code.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# On-demand details if setting up a payment method for on-demand payments.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand; end
sig {
params(_on_demand: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Klarna::OnDemand)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand=(_on_demand); end
# Preferred language of the Klarna authorization page that the customer is redirected to
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Subscription details if setting up or charging a subscription
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(currency: T.nilable(String), on_demand: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Klarna::OnDemand), preferred_locale: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(
currency: nil,
on_demand: nil,
preferred_locale: nil,
subscriptions: nil
); end
end
class Link < Stripe::RequestParams
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
sig { params(_persistent_token: T.nilable(String)).returns(T.nilable(String)) }
def persistent_token=(_persistent_token); end
sig { params(persistent_token: T.nilable(String)).void }
def initialize(persistent_token: nil); end
end
class Paypal < Stripe::RequestParams
# The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
sig { returns(T.nilable(String)) }
def billing_agreement_id; end
sig { params(_billing_agreement_id: T.nilable(String)).returns(T.nilable(String)) }
def billing_agreement_id=(_billing_agreement_id); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(billing_agreement_id: T.nilable(String), currency: T.nilable(String), subsellers: T.nilable(T::Array[String])).void
}
def initialize(billing_agreement_id: nil, currency: nil, subsellers: nil); end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
sig { params(_payments_per_period: T.nilable(Integer)).returns(T.nilable(Integer)) }
def payments_per_period=(_payments_per_period); end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
sig { params(_purpose: T.nilable(String)).returns(T.nilable(String)) }
def purpose=(_purpose); end
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), payments_per_period: T.nilable(Integer), purpose: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil,
start_date: nil
); end
end
# Additional fields for Mandate creation.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Payto::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Payto::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Type of amount. Defaults to `maximum`.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), amount_type: T.nilable(String), currency: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), reference: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
amount_type: nil,
currency: nil,
end_date: nil,
payment_schedule: nil,
reference: nil,
start_date: nil
); end
end
# Additional fields for mandate creation.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Pix::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
class ManualEntry < Stripe::RequestParams
# Settings for configuring manual entry of account details.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
sig { params(mode: String).void }
def initialize(mode: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# Customize manual entry behavior
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry; end
sig {
params(_manual_entry: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry=(_manual_entry); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(filters: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), manual_entry: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
}
def initialize(
filters: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
); end
end
class MandateOptions < Stripe::RequestParams
# The method used to collect offline mandate customer acceptance.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
sig { params(collection_method: T.nilable(String)).void }
def initialize(collection_method: nil); end
end
class Networks < Stripe::RequestParams
# Triggers validations to run across the selected networks
sig { returns(T.nilable(T::Array[String])) }
def requested; end
sig {
params(_requested: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested=(_requested); end
sig { params(requested: T.nilable(T::Array[String])).void }
def initialize(requested: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Additional fields for network related functions
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks; end
sig {
params(_networks: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks=(_networks); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks), verification_method: T.nilable(String)).void
}
def initialize(
financial_connections: nil,
mandate_options: nil,
networks: nil,
verification_method: nil
); end
end
# If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::AcssDebit)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::AmazonPay)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::BacsDebit)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# Configuration for any card setup attempted on this SetupIntent.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card))
}
def card=(_card); end
# If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::CardPresent))
}
def card_present=(_card_present); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Link))
}
def link; end
sig {
params(_link: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Link)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Link))
}
def link=(_link); end
# If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
# If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Payto))
}
def payto; end
sig {
params(_payto: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Payto)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Payto))
}
def payto=(_payto); end
# If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Pix))
}
def pix; end
sig {
params(_pix: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Pix)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Pix))
}
def pix=(_pix); end
# If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::SepaDebit)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
sig {
params(acss_debit: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::AcssDebit), amazon_pay: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::AmazonPay), bacs_debit: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::BacsDebit), card: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::CardPresent), klarna: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Klarna), link: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Link), paypal: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Paypal), payto: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Payto), pix: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::Pix), sepa_debit: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::SepaDebit), us_bank_account: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount)).void
}
def initialize(
acss_debit: nil,
amazon_pay: nil,
bacs_debit: nil,
card: nil,
card_present: nil,
klarna: nil,
link: nil,
paypal: nil,
payto: nil,
pix: nil,
sepa_debit: nil,
us_bank_account: nil
); end
end
# If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
#
# It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
sig { returns(T.nilable(T::Boolean)) }
def attach_to_self; end
sig { params(_attach_to_self: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def attach_to_self=(_attach_to_self); end
# ID of the Customer this SetupIntent belongs to, if one exists.
#
# If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# ID of the Account this SetupIntent belongs to, if one exists.
#
# If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Indicates the directions of money movement for which this payment method is intended to be used.
#
# Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.
sig { returns(T.nilable(T::Array[String])) }
def flow_directions; end
sig {
params(_flow_directions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def flow_directions=(_flow_directions); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. To unset this field to null, pass in an empty string.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent.
sig { returns(T.nilable(String)) }
def payment_method_configuration; end
sig { params(_payment_method_configuration: T.nilable(String)).returns(T.nilable(String)) }
def payment_method_configuration=(_payment_method_configuration); end
# When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)
# value in the SetupIntent.
sig { returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData)) }
def payment_method_data; end
sig {
params(_payment_method_data: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData))
}
def payment_method_data=(_payment_method_data); end
# Payment method-specific configuration for this SetupIntent.
sig { returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions)) }
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
sig { returns(T.nilable(T::Array[String])) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payment_method_types=(_payment_method_types); end
sig {
params(attach_to_self: T.nilable(T::Boolean), customer: T.nilable(String), customer_account: T.nilable(String), description: T.nilable(String), expand: T.nilable(T::Array[String]), flow_directions: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), payment_method: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String])).void
}
def initialize(
attach_to_self: nil,
customer: nil,
customer_account: nil,
description: nil,
expand: nil,
flow_directions: nil,
metadata: nil,
payment_method: nil,
payment_method_configuration: nil,
payment_method_data: nil,
payment_method_options: nil,
payment_method_types: nil
); end
end
class CancelParams < Stripe::RequestParams
# Reason for canceling this SetupIntent. Possible values are: `abandoned`, `requested_by_customer`, or `duplicate`
sig { returns(T.nilable(String)) }
def cancellation_reason; end
sig { params(_cancellation_reason: T.nilable(String)).returns(T.nilable(String)) }
def cancellation_reason=(_cancellation_reason); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(cancellation_reason: T.nilable(String), expand: T.nilable(T::Array[String])).void
}
def initialize(cancellation_reason: nil, expand: nil); end
end
class ConfirmParams < Stripe::RequestParams
class MandateData < Stripe::RequestParams
class CustomerAcceptance < Stripe::RequestParams
class Offline < Stripe::RequestParams; end
class Online < Stripe::RequestParams
# The IP address from which the Mandate was accepted by the customer.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# The user agent of the browser from which the Mandate was accepted by the customer.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig { params(ip_address: T.nilable(String), user_agent: T.nilable(String)).void }
def initialize(ip_address: nil, user_agent: nil); end
end
# The time at which the customer accepted the Mandate.
sig { returns(T.nilable(Integer)) }
def accepted_at; end
sig { params(_accepted_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def accepted_at=(_accepted_at); end
# If this is a Mandate accepted offline, this hash contains details about the offline acceptance.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::MandateData::CustomerAcceptance::Offline))
}
def offline; end
sig {
params(_offline: T.nilable(::Stripe::SetupIntentService::ConfirmParams::MandateData::CustomerAcceptance::Offline)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::MandateData::CustomerAcceptance::Offline))
}
def offline=(_offline); end
# If this is a Mandate accepted online, this hash contains details about the online acceptance.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::MandateData::CustomerAcceptance::Online))
}
def online; end
sig {
params(_online: T.nilable(::Stripe::SetupIntentService::ConfirmParams::MandateData::CustomerAcceptance::Online)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::MandateData::CustomerAcceptance::Online))
}
def online=(_online); end
# The type of customer acceptance information included with the Mandate. One of `online` or `offline`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(accepted_at: T.nilable(Integer), offline: T.nilable(::Stripe::SetupIntentService::ConfirmParams::MandateData::CustomerAcceptance::Offline), online: T.nilable(::Stripe::SetupIntentService::ConfirmParams::MandateData::CustomerAcceptance::Online), type: String).void
}
def initialize(accepted_at: nil, offline: nil, online: nil, type: nil); end
end
# This hash contains details about the customer acceptance of the Mandate.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::MandateData::CustomerAcceptance))
}
def customer_acceptance; end
sig {
params(_customer_acceptance: T.nilable(::Stripe::SetupIntentService::ConfirmParams::MandateData::CustomerAcceptance)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::MandateData::CustomerAcceptance))
}
def customer_acceptance=(_customer_acceptance); end
sig {
params(customer_acceptance: T.nilable(::Stripe::SetupIntentService::ConfirmParams::MandateData::CustomerAcceptance)).void
}
def initialize(customer_acceptance: nil); end
end
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Institution number of the customer's bank.
sig { returns(String) }
def institution_number; end
sig { params(_institution_number: String).returns(String) }
def institution_number=(_institution_number); end
# Transit number of the customer's bank.
sig { returns(String) }
def transit_number; end
sig { params(_transit_number: String).returns(String) }
def transit_number=(_transit_number); end
sig {
params(account_number: String, institution_number: String, transit_number: String).void
}
def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(String) }
def bsb_number; end
sig { params(_bsb_number: String).returns(String) }
def bsb_number=(_bsb_number); end
sig { params(account_number: String, bsb_number: String).void }
def initialize(account_number: nil, bsb_number: nil); end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
sig { params(_sort_code: T.nilable(String)).returns(T.nilable(String)) }
def sort_code=(_sort_code); end
sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
def initialize(account_number: nil, sort_code: nil); end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
sig { params(_tax_id: String).returns(String) }
def tax_id=(_tax_id); end
sig { params(tax_id: String).void }
def initialize(tax_id: nil); end
end
class Cashapp < Stripe::RequestParams; end
class Crypto < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The customer's bank.
sig { returns(String) }
def bank; end
sig { params(_bank: String).returns(String) }
def bank=(_bank); end
sig { params(account_holder_type: T.nilable(String), bank: String).void }
def initialize(account_holder_type: nil, bank: nil); end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Klarna::Dob))
}
def dob; end
sig {
params(_dob: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Klarna::Dob)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Klarna::Dob))
}
def dob=(_dob); end
sig {
params(dob: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Klarna::Dob)).void
}
def initialize(dob: nil); end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
sig { returns(T.nilable(String)) }
def funding; end
sig { params(_funding: T.nilable(String)).returns(T.nilable(String)) }
def funding=(_funding); end
sig { params(funding: T.nilable(String)).void }
def initialize(funding: nil); end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
sig { params(_bank_code: String).returns(String) }
def bank_code=(_bank_code); end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
sig { params(_branch_code: String).returns(String) }
def branch_code=(_branch_code); end
# Attribute for param field reference
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# The suffix of the bank account number.
sig { returns(String) }
def suffix; end
sig { params(_suffix: String).returns(String) }
def suffix=(_suffix); end
sig {
params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
); end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Paypay < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Rechnung::Dob)
}
def dob; end
sig {
params(_dob: ::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Rechnung::Dob).returns(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Rechnung::Dob)
}
def dob=(_dob); end
sig {
params(dob: ::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Rechnung::Dob).void
}
def initialize(dob: nil); end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
sig { returns(String) }
def iban; end
sig { params(_iban: String).returns(String) }
def iban=(_iban); end
sig { params(iban: String).void }
def initialize(iban: nil); end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
sig { params(account: T.nilable(String), source_type: T.nilable(String)).void }
def initialize(account: nil, source_type: nil); end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig {
params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String))
}
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AcssDebit)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Affirm))
}
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Affirm)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Affirm))
}
def affirm=(_affirm); end
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AfterpayClearpay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Alipay))
}
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Alipay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Alipay))
}
def alipay=(_alipay); end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Alma))
}
def alma; end
sig {
params(_alma: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Alma)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Alma))
}
def alma=(_alma); end
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AmazonPay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AuBecsDebit)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::BacsDebit)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Bancontact)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Bancontact))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Billie))
}
def billie; end
sig {
params(_billie: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Billie)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Billie))
}
def billie=(_billie); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::BillingDetails)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Blik))
}
def blik; end
sig {
params(_blik: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Blik)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Blik))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Boleto))
}
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Boleto)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Boleto))
}
def boleto=(_boleto); end
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Cashapp))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Cashapp)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Cashapp))
}
def cashapp=(_cashapp); end
# If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Crypto))
}
def crypto; end
sig {
params(_crypto: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Crypto)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Crypto))
}
def crypto=(_crypto); end
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::CustomerBalance)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Eps))
}
def eps; end
sig {
params(_eps: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Eps)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Eps))
}
def eps=(_eps); end
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Fpx))
}
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Fpx)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Fpx))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Giropay))
}
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Giropay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Giropay))
}
def giropay=(_giropay); end
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Gopay))
}
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Gopay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Gopay))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Grabpay))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Grabpay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Grabpay))
}
def grabpay=(_grabpay); end
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::IdBankTransfer)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Ideal))
}
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Ideal)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Ideal))
}
def ideal=(_ideal); end
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::InteracPresent))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::InteracPresent)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::InteracPresent))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::KakaoPay))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::KakaoPay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Klarna)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Klarna))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Konbini))
}
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Konbini)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Konbini))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::KrCard))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::KrCard)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::KrCard))
}
def kr_card=(_kr_card); end
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Link))
}
def link; end
sig {
params(_link: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Link)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Link))
}
def link=(_link); end
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::MbWay))
}
def mb_way; end
sig {
params(_mb_way: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::MbWay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::MbWay))
}
def mb_way=(_mb_way); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Mobilepay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Mobilepay))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Multibanco)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Multibanco))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::NaverPay))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::NaverPay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::NaverPay))
}
def naver_pay=(_naver_pay); end
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::NzBankAccount)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Oxxo))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Oxxo)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Oxxo))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::P24))
}
def p24; end
sig {
params(_p24: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::P24)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::P24))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::PayByBank)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Payco))
}
def payco; end
sig {
params(_payco: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Payco)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Payco))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Paynow))
}
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Paynow)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Paynow))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Paypal)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Paypal))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Paypay))
}
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Paypay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Paypay))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Payto))
}
def payto; end
sig {
params(_payto: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Payto)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Payto))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Pix))
}
def pix; end
sig {
params(_pix: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Pix)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Pix))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Promptpay))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Promptpay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Promptpay))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Qris))
}
def qris; end
sig {
params(_qris: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Qris)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Qris))
}
def qris=(_qris); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::RadarOptions))
}
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::RadarOptions)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::RadarOptions))
}
def radar_options=(_radar_options); end
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Rechnung))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Rechnung)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Rechnung))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::RevolutPay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::SamsungPay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Satispay))
}
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Satispay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Satispay))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::SepaDebit)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Shopeepay))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Shopeepay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Shopeepay))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Sofort))
}
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Sofort)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Sofort))
}
def sofort=(_sofort); end
# This hash contains details about the Stripe balance payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::StripeBalance))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::StripeBalance)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Swish))
}
def swish; end
sig {
params(_swish: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Swish)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Swish))
}
def swish=(_swish); end
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Twint))
}
def twint; end
sig {
params(_twint: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Twint)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Twint))
}
def twint=(_twint); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::UsBankAccount)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::WechatPay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Zip))
}
def zip; end
sig {
params(_zip: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Zip)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Cashapp), crypto: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Crypto), customer_balance: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Giropay), gopay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Gopay), grabpay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Grabpay), id_bank_transfer: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::IdBankTransfer), ideal: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Link), mb_way: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::MbWay), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Paypal), paypay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Paypay), payto: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Payto), pix: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Promptpay), qris: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Qris), radar_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::RadarOptions), rechnung: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Rechnung), revolut_pay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::SepaDebit), shopeepay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Shopeepay), sofort: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Sofort), stripe_balance: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::StripeBalance), swish: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
sig { returns(T.nilable(String)) }
def custom_mandate_url; end
sig { params(_custom_mandate_url: T.nilable(String)).returns(T.nilable(String)) }
def custom_mandate_url=(_custom_mandate_url); end
# List of Stripe products where this mandate can be selected automatically.
sig { returns(T.nilable(T::Array[String])) }
def default_for; end
sig {
params(_default_for: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def default_for=(_default_for); end
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
sig { returns(T.nilable(String)) }
def interval_description; end
sig { params(_interval_description: T.nilable(String)).returns(T.nilable(String)) }
def interval_description=(_interval_description); end
# Payment schedule for the mandate.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig {
params(custom_mandate_url: T.nilable(String), default_for: T.nilable(T::Array[String]), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
}
def initialize(
custom_mandate_url: nil,
default_for: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
); end
end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(currency: T.nilable(String), mandate_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
}
def initialize(currency: nil, mandate_options: nil, verification_method: nil); end
end
class AmazonPay < Stripe::RequestParams; end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class Card < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(String) }
def amount_type; end
sig { params(_amount_type: String).returns(String) }
def amount_type=(_amount_type); end
# Currency in which future payments will be charged. 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Unique identifier for the mandate or subscription.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
sig { returns(Integer) }
def start_date; end
sig { params(_start_date: Integer).returns(Integer) }
def start_date=(_start_date); end
# Specifies the type of mandates supported. Possible values are `india`.
sig { returns(T.nilable(T::Array[String])) }
def supported_types; end
sig {
params(_supported_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def supported_types=(_supported_types); end
sig {
params(amount: Integer, amount_type: String, currency: String, description: T.nilable(String), end_date: T.nilable(Integer), interval: String, interval_count: T.nilable(Integer), reference: String, start_date: Integer, supported_types: T.nilable(T::Array[String])).void
}
def initialize(
amount: nil,
amount_type: nil,
currency: nil,
description: nil,
end_date: nil,
interval: nil,
interval_count: nil,
reference: nil,
start_date: nil,
supported_types: nil
); end
end
class ThreeDSecure < Stripe::RequestParams
class NetworkOptions < Stripe::RequestParams
class CartesBancaires < Stripe::RequestParams
# The cryptogram calculation algorithm used by the card Issuer's ACS
# to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
# messageExtension: CB-AVALGO
sig { returns(String) }
def cb_avalgo; end
sig { params(_cb_avalgo: String).returns(String) }
def cb_avalgo=(_cb_avalgo); end
# The exemption indicator returned from Cartes Bancaires in the ARes.
# message extension: CB-EXEMPTION; string (4 characters)
# This is a 3 byte bitmap (low significant byte first and most significant
# bit first) that has been Base64 encoded
sig { returns(T.nilable(String)) }
def cb_exemption; end
sig { params(_cb_exemption: T.nilable(String)).returns(T.nilable(String)) }
def cb_exemption=(_cb_exemption); end
# The risk score returned from Cartes Bancaires in the ARes.
# message extension: CB-SCORE; numeric value 0-99
sig { returns(T.nilable(Integer)) }
def cb_score; end
sig { params(_cb_score: T.nilable(Integer)).returns(T.nilable(Integer)) }
def cb_score=(_cb_score); end
sig {
params(cb_avalgo: String, cb_exemption: T.nilable(String), cb_score: T.nilable(Integer)).void
}
def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil); end
end
# Cartes Bancaires-specific 3DS fields.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires; end
sig {
params(_cartes_bancaires: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
}
def cartes_bancaires=(_cartes_bancaires); end
sig {
params(cartes_bancaires: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).void
}
def initialize(cartes_bancaires: nil); end
end
# The `transStatus` returned from the card Issuer’s ACS in the ARes.
sig { returns(T.nilable(String)) }
def ares_trans_status; end
sig { params(_ares_trans_status: T.nilable(String)).returns(T.nilable(String)) }
def ares_trans_status=(_ares_trans_status); end
# The cryptogram, also known as the "authentication value" (AAV, CAVV or
# AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
# (Most 3D Secure providers will return the base64-encoded version, which
# is what you should specify here.)
sig { returns(T.nilable(String)) }
def cryptogram; end
sig { params(_cryptogram: T.nilable(String)).returns(T.nilable(String)) }
def cryptogram=(_cryptogram); end
# The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
# provider and indicates what degree of authentication was performed.
sig { returns(T.nilable(String)) }
def electronic_commerce_indicator; end
sig {
params(_electronic_commerce_indicator: T.nilable(String)).returns(T.nilable(String))
}
def electronic_commerce_indicator=(_electronic_commerce_indicator); end
# Network specific 3DS fields. Network specific arguments require an
# explicit card brand choice. The parameter `payment_method_options.card.network``
# must be populated accordingly
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options; end
sig {
params(_network_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
}
def network_options=(_network_options); end
# The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
# AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
sig { returns(T.nilable(String)) }
def requestor_challenge_indicator; end
sig {
params(_requestor_challenge_indicator: T.nilable(String)).returns(T.nilable(String))
}
def requestor_challenge_indicator=(_requestor_challenge_indicator); end
# For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
# Transaction ID (dsTransID).
sig { returns(T.nilable(String)) }
def transaction_id; end
sig { params(_transaction_id: T.nilable(String)).returns(T.nilable(String)) }
def transaction_id=(_transaction_id); end
# The version of 3D Secure that was performed.
sig { returns(T.nilable(String)) }
def version; end
sig { params(_version: T.nilable(String)).returns(T.nilable(String)) }
def version=(_version); end
sig {
params(ares_trans_status: T.nilable(String), cryptogram: T.nilable(String), electronic_commerce_indicator: T.nilable(String), network_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions), requestor_challenge_indicator: T.nilable(String), transaction_id: T.nilable(String), version: T.nilable(String)).void
}
def initialize(
ares_trans_status: nil,
cryptogram: nil,
electronic_commerce_indicator: nil,
network_options: nil,
requestor_challenge_indicator: nil,
transaction_id: nil,
version: nil
); end
end
# Configuration options for setting up an eMandate for cards issued in India.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options=(_mandate_options); end
# When specified, this parameter signals that a card has been collected
# as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
# parameter can only be provided during confirmation.
sig { returns(T.nilable(T::Boolean)) }
def moto; end
sig { params(_moto: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def moto=(_moto); end
# Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
# If 3D Secure authentication was performed with a third-party provider,
# the authentication details to use for this setup.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure; end
sig {
params(_three_d_secure: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure))
}
def three_d_secure=(_three_d_secure); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card::MandateOptions), moto: T.nilable(T::Boolean), network: T.nilable(String), request_three_d_secure: T.nilable(String), three_d_secure: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure)).void
}
def initialize(
mandate_options: nil,
moto: nil,
network: nil,
request_three_d_secure: nil,
three_d_secure: nil
); end
end
class CardPresent < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class OnDemand < Stripe::RequestParams
# Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def average_amount; end
sig { params(_average_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def average_amount=(_average_amount); end
# The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def maximum_amount; end
sig { params(_maximum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def maximum_amount=(_maximum_amount); end
# The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
sig { returns(T.nilable(Integer)) }
def minimum_amount; end
sig { params(_minimum_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minimum_amount=(_minimum_amount); end
# Interval at which the customer is making purchases
sig { returns(T.nilable(String)) }
def purchase_interval; end
sig { params(_purchase_interval: T.nilable(String)).returns(T.nilable(String)) }
def purchase_interval=(_purchase_interval); end
# The number of `purchase_interval` between charges
sig { returns(T.nilable(Integer)) }
def purchase_interval_count; end
sig { params(_purchase_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def purchase_interval_count=(_purchase_interval_count); end
sig {
params(average_amount: T.nilable(Integer), maximum_amount: T.nilable(Integer), minimum_amount: T.nilable(Integer), purchase_interval: T.nilable(String), purchase_interval_count: T.nilable(Integer)).void
}
def initialize(
average_amount: nil,
maximum_amount: nil,
minimum_amount: nil,
purchase_interval: nil,
purchase_interval_count: nil
); end
end
class Subscription < Stripe::RequestParams
class NextBilling < Stripe::RequestParams
# The amount of the next charge for the subscription.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The date of the next charge for the subscription in YYYY-MM-DD format.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
sig { params(amount: Integer, date: String).void }
def initialize(amount: nil, date: nil); end
end
# Unit of time between subscription charges.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
# Name for subscription.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Describes the upcoming charge for this subscription.
sig {
returns(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
}
def next_billing; end
sig {
params(_next_billing: ::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Klarna::Subscription::NextBilling).returns(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
}
def next_billing=(_next_billing); end
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: ::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Klarna::Subscription::NextBilling, reference: String).void
}
def initialize(
interval: nil,
interval_count: nil,
name: nil,
next_billing: nil,
reference: nil
); end
end
# The currency of the SetupIntent. Three letter ISO currency code.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# On-demand details if setting up a payment method for on-demand payments.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand; end
sig {
params(_on_demand: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Klarna::OnDemand)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Klarna::OnDemand))
}
def on_demand=(_on_demand); end
# Preferred language of the Klarna authorization page that the customer is redirected to
sig { returns(T.nilable(String)) }
def preferred_locale; end
sig { params(_preferred_locale: T.nilable(String)).returns(T.nilable(String)) }
def preferred_locale=(_preferred_locale); end
# Subscription details if setting up or charging a subscription
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions; end
sig {
params(_subscriptions: T.nilable(T.any(String, T::Array[::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Klarna::Subscription]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Klarna::Subscription])))
}
def subscriptions=(_subscriptions); end
sig {
params(currency: T.nilable(String), on_demand: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Klarna::OnDemand), preferred_locale: T.nilable(String), subscriptions: T.nilable(T.any(String, T::Array[::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Klarna::Subscription]))).void
}
def initialize(
currency: nil,
on_demand: nil,
preferred_locale: nil,
subscriptions: nil
); end
end
class Link < Stripe::RequestParams
# [Deprecated] This is a legacy parameter that no longer has any function.
sig { returns(T.nilable(String)) }
def persistent_token; end
sig { params(_persistent_token: T.nilable(String)).returns(T.nilable(String)) }
def persistent_token=(_persistent_token); end
sig { params(persistent_token: T.nilable(String)).void }
def initialize(persistent_token: nil); end
end
class Paypal < Stripe::RequestParams
# The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
sig { returns(T.nilable(String)) }
def billing_agreement_id; end
sig { params(_billing_agreement_id: T.nilable(String)).returns(T.nilable(String)) }
def billing_agreement_id=(_billing_agreement_id); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
sig { returns(T.nilable(T::Array[String])) }
def subsellers; end
sig {
params(_subsellers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def subsellers=(_subsellers); end
sig {
params(billing_agreement_id: T.nilable(String), currency: T.nilable(String), subsellers: T.nilable(T::Array[String])).void
}
def initialize(billing_agreement_id: nil, currency: nil, subsellers: nil); end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# The periodicity at which payments will be collected.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
sig { returns(T.nilable(Integer)) }
def payments_per_period; end
sig { params(_payments_per_period: T.nilable(Integer)).returns(T.nilable(Integer)) }
def payments_per_period=(_payments_per_period); end
# The purpose for which payments are made. Defaults to retail.
sig { returns(T.nilable(String)) }
def purpose; end
sig { params(_purpose: T.nilable(String)).returns(T.nilable(String)) }
def purpose=(_purpose); end
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), payments_per_period: T.nilable(Integer), purpose: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil,
start_date: nil
); end
end
# Additional fields for Mandate creation.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Payto::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Payto::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Payto::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Type of amount. Defaults to `maximum`.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
# Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
sig { returns(T.nilable(String)) }
def start_date; end
sig { params(_start_date: T.nilable(String)).returns(T.nilable(String)) }
def start_date=(_start_date); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), amount_type: T.nilable(String), currency: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String), reference: T.nilable(String), start_date: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
amount_type: nil,
currency: nil,
end_date: nil,
payment_schedule: nil,
reference: nil,
start_date: nil
); end
end
# Additional fields for mandate creation.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Pix::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
sig { returns(T.nilable(String)) }
def reference_prefix; end
sig { params(_reference_prefix: T.nilable(String)).returns(T.nilable(String)) }
def reference_prefix=(_reference_prefix); end
sig { params(reference_prefix: T.nilable(String)).void }
def initialize(reference_prefix: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
class ManualEntry < Stripe::RequestParams
# Settings for configuring manual entry of account details.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
sig { params(mode: String).void }
def initialize(mode: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# Customize manual entry behavior
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry; end
sig {
params(_manual_entry: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry))
}
def manual_entry=(_manual_entry); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(filters: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), manual_entry: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::ManualEntry), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
}
def initialize(
filters: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
); end
end
class MandateOptions < Stripe::RequestParams
# The method used to collect offline mandate customer acceptance.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
sig { params(collection_method: T.nilable(String)).void }
def initialize(collection_method: nil); end
end
class Networks < Stripe::RequestParams
# Triggers validations to run across the selected networks
sig { returns(T.nilable(T::Array[String])) }
def requested; end
sig {
params(_requested: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def requested=(_requested); end
sig { params(requested: T.nilable(T::Array[String])).void }
def initialize(requested: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Additional fields for network related functions
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks; end
sig {
params(_networks: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks))
}
def networks=(_networks); end
# Bank account verification method.
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks), verification_method: T.nilable(String)).void
}
def initialize(
financial_connections: nil,
mandate_options: nil,
networks: nil,
verification_method: nil
); end
end
# If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::AmazonPay)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# Configuration for any card setup attempted on this SetupIntent.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card))
}
def card=(_card); end
# If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::CardPresent))
}
def card_present=(_card_present); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Klarna))
}
def klarna=(_klarna); end
# If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Link))
}
def link; end
sig {
params(_link: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Link)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Link))
}
def link=(_link); end
# If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Paypal)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Paypal))
}
def paypal=(_paypal); end
# If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Payto))
}
def payto; end
sig {
params(_payto: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Payto)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Payto))
}
def payto=(_payto); end
# If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Pix))
}
def pix; end
sig {
params(_pix: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Pix)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Pix))
}
def pix=(_pix); end
# If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.
sig {
returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
sig {
params(acss_debit: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit), amazon_pay: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::AmazonPay), bacs_debit: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit), card: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::CardPresent), klarna: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Klarna), link: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Link), paypal: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Paypal), payto: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Payto), pix: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::Pix), sepa_debit: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit), us_bank_account: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount)).void
}
def initialize(
acss_debit: nil,
amazon_pay: nil,
bacs_debit: nil,
card: nil,
card_present: nil,
klarna: nil,
link: nil,
paypal: nil,
payto: nil,
pix: nil,
sepa_debit: nil,
us_bank_account: nil
); end
end
# ID of the ConfirmationToken used to confirm this SetupIntent.
#
# If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.
sig { returns(T.nilable(String)) }
def confirmation_token; end
sig { params(_confirmation_token: T.nilable(String)).returns(T.nilable(String)) }
def confirmation_token=(_confirmation_token); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Attribute for param field mandate_data
sig {
returns(T.nilable(T.any(String, ::Stripe::SetupIntentService::ConfirmParams::MandateData)))
}
def mandate_data; end
sig {
params(_mandate_data: T.nilable(T.any(String, ::Stripe::SetupIntentService::ConfirmParams::MandateData))).returns(T.nilable(T.any(String, ::Stripe::SetupIntentService::ConfirmParams::MandateData)))
}
def mandate_data=(_mandate_data); end
# ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)
# value in the SetupIntent.
sig { returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData)) }
def payment_method_data; end
sig {
params(_payment_method_data: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData))
}
def payment_method_data=(_payment_method_data); end
# Payment method-specific configuration for this SetupIntent.
sig { returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions)) }
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The URL to redirect your customer back to after they authenticate on the payment method's app or site.
# If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
# This parameter is only used for cards and other redirect-based payment methods.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
sig { returns(T.nilable(T::Boolean)) }
def use_stripe_sdk; end
sig { params(_use_stripe_sdk: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def use_stripe_sdk=(_use_stripe_sdk); end
sig {
params(confirmation_token: T.nilable(String), expand: T.nilable(T::Array[String]), mandate_data: T.nilable(T.any(String, ::Stripe::SetupIntentService::ConfirmParams::MandateData)), payment_method: T.nilable(String), payment_method_data: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodOptions), return_url: T.nilable(String), use_stripe_sdk: T.nilable(T::Boolean)).void
}
def initialize(
confirmation_token: nil,
expand: nil,
mandate_data: nil,
payment_method: nil,
payment_method_data: nil,
payment_method_options: nil,
return_url: nil,
use_stripe_sdk: nil
); end
end
class VerifyMicrodepositsParams < Stripe::RequestParams
# Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.
sig { returns(T.nilable(T::Array[Integer])) }
def amounts; end
sig { params(_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer])) }
def amounts=(_amounts); end
# A six-character code starting with SM present in the microdeposit sent to the bank account.
sig { returns(T.nilable(String)) }
def descriptor_code; end
sig { params(_descriptor_code: T.nilable(String)).returns(T.nilable(String)) }
def descriptor_code=(_descriptor_code); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(amounts: T.nilable(T::Array[Integer]), descriptor_code: T.nilable(String), expand: T.nilable(T::Array[String])).void
}
def initialize(amounts: nil, descriptor_code: nil, expand: nil); end
end
# You can cancel a SetupIntent object when it's in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
#
# After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead.
sig {
params(intent: String, params: T.any(::Stripe::SetupIntentService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
}
def cancel(intent, params = {}, opts = {}); end
# Confirm that your customer intends to set up the current or
# provided payment method. For example, you would confirm a SetupIntent
# when a customer hits the “Save” button on a payment method management
# page on your website.
#
# If the selected payment method does not require any additional
# steps from the customer, the SetupIntent will transition to the
# succeeded status.
#
# Otherwise, it will transition to the requires_action status and
# suggest additional actions via next_action. If setup fails,
# the SetupIntent will transition to the
# requires_payment_method status or the canceled status if the
# confirmation limit is reached.
sig {
params(intent: String, params: T.any(::Stripe::SetupIntentService::ConfirmParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
}
def confirm(intent, params = {}, opts = {}); end
# Creates a SetupIntent object.
#
# After you create the SetupIntent, attach a payment method and [confirm](https://docs.stripe.com/docs/api/setup_intents/confirm)
# it to collect any required permissions to charge the payment method later.
sig {
params(params: T.any(::Stripe::SetupIntentService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
}
def create(params = {}, opts = {}); end
# Returns a list of SetupIntents.
sig {
params(params: T.any(::Stripe::SetupIntentService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of a SetupIntent that has previously been created.
#
# Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.
#
# When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the [SetupIntent](https://docs.stripe.com/api#setup_intent_object) object reference for more details.
sig {
params(intent: String, params: T.any(::Stripe::SetupIntentService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
}
def retrieve(intent, params = {}, opts = {}); end
# Updates a SetupIntent object.
sig {
params(intent: String, params: T.any(::Stripe::SetupIntentService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
}
def update(intent, params = {}, opts = {}); end
# Verifies microdeposits on a SetupIntent object.
sig {
params(intent: String, params: T.any(::Stripe::SetupIntentService::VerifyMicrodepositsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
}
def verify_microdeposits(intent, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class ShippingRateService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return shipping rates that are active or inactive.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
sig { returns(T.nilable(T.any(::Stripe::ShippingRateService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::ShippingRateService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::ShippingRateService::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return shipping rates for the given currency.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::ShippingRateService::ListParams::Created, Integer)), currency: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
active: nil,
created: nil,
currency: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class DeliveryEstimate < Stripe::RequestParams
class Maximum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
class Minimum < Stripe::RequestParams
# A unit of time.
sig { returns(String) }
def unit; end
sig { params(_unit: String).returns(String) }
def unit=(_unit); end
# Must be greater than 0.
sig { returns(Integer) }
def value; end
sig { params(_value: Integer).returns(Integer) }
def value=(_value); end
sig { params(unit: String, value: Integer).void }
def initialize(unit: nil, value: nil); end
end
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
sig {
returns(T.nilable(::Stripe::ShippingRateService::CreateParams::DeliveryEstimate::Maximum))
}
def maximum; end
sig {
params(_maximum: T.nilable(::Stripe::ShippingRateService::CreateParams::DeliveryEstimate::Maximum)).returns(T.nilable(::Stripe::ShippingRateService::CreateParams::DeliveryEstimate::Maximum))
}
def maximum=(_maximum); end
# The lower bound of the estimated range. If empty, represents no lower bound.
sig {
returns(T.nilable(::Stripe::ShippingRateService::CreateParams::DeliveryEstimate::Minimum))
}
def minimum; end
sig {
params(_minimum: T.nilable(::Stripe::ShippingRateService::CreateParams::DeliveryEstimate::Minimum)).returns(T.nilable(::Stripe::ShippingRateService::CreateParams::DeliveryEstimate::Minimum))
}
def minimum=(_minimum); end
sig {
params(maximum: T.nilable(::Stripe::ShippingRateService::CreateParams::DeliveryEstimate::Maximum), minimum: T.nilable(::Stripe::ShippingRateService::CreateParams::DeliveryEstimate::Minimum)).void
}
def initialize(maximum: nil, minimum: nil); end
end
class FixedAmount < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig { params(amount: Integer, tax_behavior: T.nilable(String)).void }
def initialize(amount: nil, tax_behavior: nil); end
end
# A non-negative integer in cents representing how much to charge.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::ShippingRateService::CreateParams::FixedAmount::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::ShippingRateService::CreateParams::FixedAmount::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::ShippingRateService::CreateParams::FixedAmount::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(amount: Integer, currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::ShippingRateService::CreateParams::FixedAmount::CurrencyOptions])).void
}
def initialize(amount: nil, currency: nil, currency_options: nil); end
end
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(T.nilable(::Stripe::ShippingRateService::CreateParams::DeliveryEstimate)) }
def delivery_estimate; end
sig {
params(_delivery_estimate: T.nilable(::Stripe::ShippingRateService::CreateParams::DeliveryEstimate)).returns(T.nilable(::Stripe::ShippingRateService::CreateParams::DeliveryEstimate))
}
def delivery_estimate=(_delivery_estimate); end
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
sig { returns(T.nilable(::Stripe::ShippingRateService::CreateParams::FixedAmount)) }
def fixed_amount; end
sig {
params(_fixed_amount: T.nilable(::Stripe::ShippingRateService::CreateParams::FixedAmount)).returns(T.nilable(::Stripe::ShippingRateService::CreateParams::FixedAmount))
}
def fixed_amount=(_fixed_amount); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
# The type of calculation to use on the shipping rate.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(delivery_estimate: T.nilable(::Stripe::ShippingRateService::CreateParams::DeliveryEstimate), display_name: String, expand: T.nilable(T::Array[String]), fixed_amount: T.nilable(::Stripe::ShippingRateService::CreateParams::FixedAmount), metadata: T.nilable(T::Hash[String, String]), tax_behavior: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
delivery_estimate: nil,
display_name: nil,
expand: nil,
fixed_amount: nil,
metadata: nil,
tax_behavior: nil,
tax_code: nil,
type: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class FixedAmount < Stripe::RequestParams
class CurrencyOptions < Stripe::RequestParams
# A non-negative integer in cents representing how much to charge.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig { params(amount: T.nilable(Integer), tax_behavior: T.nilable(String)).void }
def initialize(amount: nil, tax_behavior: nil); end
end
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
sig {
returns(T.nilable(T::Hash[String, ::Stripe::ShippingRateService::UpdateParams::FixedAmount::CurrencyOptions]))
}
def currency_options; end
sig {
params(_currency_options: T.nilable(T::Hash[String, ::Stripe::ShippingRateService::UpdateParams::FixedAmount::CurrencyOptions])).returns(T.nilable(T::Hash[String, ::Stripe::ShippingRateService::UpdateParams::FixedAmount::CurrencyOptions]))
}
def currency_options=(_currency_options); end
sig {
params(currency_options: T.nilable(T::Hash[String, ::Stripe::ShippingRateService::UpdateParams::FixedAmount::CurrencyOptions])).void
}
def initialize(currency_options: nil); end
end
# Whether the shipping rate can be used for new purchases. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
sig { returns(T.nilable(::Stripe::ShippingRateService::UpdateParams::FixedAmount)) }
def fixed_amount; end
sig {
params(_fixed_amount: T.nilable(::Stripe::ShippingRateService::UpdateParams::FixedAmount)).returns(T.nilable(::Stripe::ShippingRateService::UpdateParams::FixedAmount))
}
def fixed_amount=(_fixed_amount); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
sig {
params(active: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), fixed_amount: T.nilable(::Stripe::ShippingRateService::UpdateParams::FixedAmount), metadata: T.nilable(T.any(String, T::Hash[String, String])), tax_behavior: T.nilable(String)).void
}
def initialize(
active: nil,
expand: nil,
fixed_amount: nil,
metadata: nil,
tax_behavior: nil
); end
end
# Creates a new shipping rate object.
sig {
params(params: T.any(::Stripe::ShippingRateService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ShippingRate)
}
def create(params = {}, opts = {}); end
# Returns a list of your shipping rates.
sig {
params(params: T.any(::Stripe::ShippingRateService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Returns the shipping rate object with the given ID.
sig {
params(shipping_rate_token: String, params: T.any(::Stripe::ShippingRateService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ShippingRate)
}
def retrieve(shipping_rate_token, params = {}, opts = {}); end
# Updates an existing shipping rate object.
sig {
params(shipping_rate_token: String, params: T.any(::Stripe::ShippingRateService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ShippingRate)
}
def update(shipping_rate_token, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class SigmaService < StripeService
attr_reader :scheduled_query_runs
end
end
# typed: true
module Stripe
module Sigma
class ScheduledQueryRunService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of scheduled query runs.
sig {
params(params: T.any(::Stripe::Sigma::ScheduledQueryRunService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an scheduled query run.
sig {
params(scheduled_query_run: String, params: T.any(::Stripe::Sigma::ScheduledQueryRunService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Sigma::ScheduledQueryRun)
}
def retrieve(scheduled_query_run, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class SourceService < StripeService
attr_reader :transactions
class DetachParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class RetrieveParams < Stripe::RequestParams
# The client secret of the source. Required if a publishable key is used to retrieve the source.
sig { returns(T.nilable(String)) }
def client_secret; end
sig { params(_client_secret: T.nilable(String)).returns(T.nilable(String)) }
def client_secret=(_client_secret); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(client_secret: T.nilable(String), expand: T.nilable(T::Array[String])).void }
def initialize(client_secret: nil, expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Mandate < Stripe::RequestParams
class Acceptance < Stripe::RequestParams
class Offline < Stripe::RequestParams
# An email to contact you with if a copy of the mandate is requested, required if `type` is `offline`.
sig { returns(String) }
def contact_email; end
sig { params(_contact_email: String).returns(String) }
def contact_email=(_contact_email); end
sig { params(contact_email: String).void }
def initialize(contact_email: nil); end
end
class Online < Stripe::RequestParams
# The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the mandate was accepted or refused by the customer.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the mandate was accepted or refused by the customer.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the mandate was accepted or refused by the customer.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`
sig {
returns(T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance::Offline))
}
def offline; end
sig {
params(_offline: T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance::Offline)).returns(T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance::Offline))
}
def offline=(_offline); end
# The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`
sig {
returns(T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance::Online))
}
def online; end
sig {
params(_online: T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance::Online)).returns(T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance::Online))
}
def online=(_online); end
# The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).
sig { returns(String) }
def status; end
sig { params(_status: String).returns(String) }
def status=(_status); end
# The type of acceptance information included with the mandate. Either `online` or `offline`
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# The user agent of the browser from which the mandate was accepted or refused by the customer.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), offline: T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance::Offline), online: T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance::Online), status: String, type: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(
date: nil,
ip: nil,
offline: nil,
online: nil,
status: nil,
type: nil,
user_agent: nil
); end
end
# The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
sig { returns(T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance)) }
def acceptance; end
sig {
params(_acceptance: T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance)).returns(T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance))
}
def acceptance=(_acceptance); end
# The amount specified by the mandate. (Leave null for a mandate covering all amounts)
sig { returns(T.nilable(T.any(String, Integer))) }
def amount; end
sig {
params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def amount=(_amount); end
# The currency specified by the mandate. (Must match `currency` of the source)
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency)
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification).
sig { returns(T.nilable(String)) }
def notification_method; end
sig { params(_notification_method: T.nilable(String)).returns(T.nilable(String)) }
def notification_method=(_notification_method); end
sig {
params(acceptance: T.nilable(::Stripe::SourceService::UpdateParams::Mandate::Acceptance), amount: T.nilable(T.any(String, Integer)), currency: T.nilable(String), interval: T.nilable(String), notification_method: T.nilable(String)).void
}
def initialize(
acceptance: nil,
amount: nil,
currency: nil,
interval: nil,
notification_method: nil
); end
end
class Owner < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Owner's address.
sig { returns(T.nilable(::Stripe::SourceService::UpdateParams::Owner::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::SourceService::UpdateParams::Owner::Address)).returns(T.nilable(::Stripe::SourceService::UpdateParams::Owner::Address))
}
def address=(_address); end
# Owner's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Owner's full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Owner's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::SourceService::UpdateParams::Owner::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil); end
end
class SourceOrder < Stripe::RequestParams
class Item < Stripe::RequestParams
# Attribute for param field amount
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Attribute for param field description
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The ID of the SKU being ordered.
sig { returns(T.nilable(String)) }
def parent; end
sig { params(_parent: T.nilable(String)).returns(T.nilable(String)) }
def parent=(_parent); end
# The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# Attribute for param field type
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(amount: T.nilable(Integer), currency: T.nilable(String), description: T.nilable(String), parent: T.nilable(String), quantity: T.nilable(Integer), type: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
parent: nil,
quantity: nil,
type: nil
); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(String) }
def line1; end
sig { params(_line1: String).returns(String) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: String, line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address.
sig { returns(::Stripe::SourceService::UpdateParams::SourceOrder::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::SourceService::UpdateParams::SourceOrder::Shipping::Address).returns(::Stripe::SourceService::UpdateParams::SourceOrder::Shipping::Address)
}
def address=(_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Recipient name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
sig { params(_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def tracking_number=(_tracking_number); end
sig {
params(address: ::Stripe::SourceService::UpdateParams::SourceOrder::Shipping::Address, carrier: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tracking_number: T.nilable(String)).void
}
def initialize(
address: nil,
carrier: nil,
name: nil,
phone: nil,
tracking_number: nil
); end
end
# List of items constituting the order.
sig {
returns(T.nilable(T::Array[::Stripe::SourceService::UpdateParams::SourceOrder::Item]))
}
def items; end
sig {
params(_items: T.nilable(T::Array[::Stripe::SourceService::UpdateParams::SourceOrder::Item])).returns(T.nilable(T::Array[::Stripe::SourceService::UpdateParams::SourceOrder::Item]))
}
def items=(_items); end
# Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.
sig { returns(T.nilable(::Stripe::SourceService::UpdateParams::SourceOrder::Shipping)) }
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::SourceService::UpdateParams::SourceOrder::Shipping)).returns(T.nilable(::Stripe::SourceService::UpdateParams::SourceOrder::Shipping))
}
def shipping=(_shipping); end
sig {
params(items: T.nilable(T::Array[::Stripe::SourceService::UpdateParams::SourceOrder::Item]), shipping: T.nilable(::Stripe::SourceService::UpdateParams::SourceOrder::Shipping)).void
}
def initialize(items: nil, shipping: nil); end
end
# Amount associated with the source.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
sig { returns(T.nilable(::Stripe::SourceService::UpdateParams::Mandate)) }
def mandate; end
sig {
params(_mandate: T.nilable(::Stripe::SourceService::UpdateParams::Mandate)).returns(T.nilable(::Stripe::SourceService::UpdateParams::Mandate))
}
def mandate=(_mandate); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Information about the owner of the payment instrument that may be used or required by particular source types.
sig { returns(T.nilable(::Stripe::SourceService::UpdateParams::Owner)) }
def owner; end
sig {
params(_owner: T.nilable(::Stripe::SourceService::UpdateParams::Owner)).returns(T.nilable(::Stripe::SourceService::UpdateParams::Owner))
}
def owner=(_owner); end
# Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.
sig { returns(T.nilable(::Stripe::SourceService::UpdateParams::SourceOrder)) }
def source_order; end
sig {
params(_source_order: T.nilable(::Stripe::SourceService::UpdateParams::SourceOrder)).returns(T.nilable(::Stripe::SourceService::UpdateParams::SourceOrder))
}
def source_order=(_source_order); end
sig {
params(amount: T.nilable(Integer), expand: T.nilable(T::Array[String]), mandate: T.nilable(::Stripe::SourceService::UpdateParams::Mandate), metadata: T.nilable(T.any(String, T::Hash[String, String])), owner: T.nilable(::Stripe::SourceService::UpdateParams::Owner), source_order: T.nilable(::Stripe::SourceService::UpdateParams::SourceOrder)).void
}
def initialize(
amount: nil,
expand: nil,
mandate: nil,
metadata: nil,
owner: nil,
source_order: nil
); end
end
class CreateParams < Stripe::RequestParams
class Mandate < Stripe::RequestParams
class Acceptance < Stripe::RequestParams
class Offline < Stripe::RequestParams
# An email to contact you with if a copy of the mandate is requested, required if `type` is `offline`.
sig { returns(String) }
def contact_email; end
sig { params(_contact_email: String).returns(String) }
def contact_email=(_contact_email); end
sig { params(contact_email: String).void }
def initialize(contact_email: nil); end
end
class Online < Stripe::RequestParams
# The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the mandate was accepted or refused by the customer.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the mandate was accepted or refused by the customer.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the mandate was accepted or refused by the customer.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`
sig {
returns(T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance::Offline))
}
def offline; end
sig {
params(_offline: T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance::Offline)).returns(T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance::Offline))
}
def offline=(_offline); end
# The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`
sig {
returns(T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance::Online))
}
def online; end
sig {
params(_online: T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance::Online)).returns(T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance::Online))
}
def online=(_online); end
# The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).
sig { returns(String) }
def status; end
sig { params(_status: String).returns(String) }
def status=(_status); end
# The type of acceptance information included with the mandate. Either `online` or `offline`
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# The user agent of the browser from which the mandate was accepted or refused by the customer.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), offline: T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance::Offline), online: T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance::Online), status: String, type: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(
date: nil,
ip: nil,
offline: nil,
online: nil,
status: nil,
type: nil,
user_agent: nil
); end
end
# The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
sig { returns(T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance)) }
def acceptance; end
sig {
params(_acceptance: T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance)).returns(T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance))
}
def acceptance=(_acceptance); end
# The amount specified by the mandate. (Leave null for a mandate covering all amounts)
sig { returns(T.nilable(T.any(String, Integer))) }
def amount; end
sig {
params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def amount=(_amount); end
# The currency specified by the mandate. (Must match `currency` of the source)
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency)
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification).
sig { returns(T.nilable(String)) }
def notification_method; end
sig { params(_notification_method: T.nilable(String)).returns(T.nilable(String)) }
def notification_method=(_notification_method); end
sig {
params(acceptance: T.nilable(::Stripe::SourceService::CreateParams::Mandate::Acceptance), amount: T.nilable(T.any(String, Integer)), currency: T.nilable(String), interval: T.nilable(String), notification_method: T.nilable(String)).void
}
def initialize(
acceptance: nil,
amount: nil,
currency: nil,
interval: nil,
notification_method: nil
); end
end
class Owner < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Owner's address.
sig { returns(T.nilable(::Stripe::SourceService::CreateParams::Owner::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::SourceService::CreateParams::Owner::Address)).returns(T.nilable(::Stripe::SourceService::CreateParams::Owner::Address))
}
def address=(_address); end
# Owner's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Owner's full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Owner's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::SourceService::CreateParams::Owner::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil); end
end
class Receiver < Stripe::RequestParams
# The method Stripe should use to request information needed to process a refund or mispayment. Either `email` (an email is sent directly to the customer) or `manual` (a `source.refund_attributes_required` event is sent to your webhooks endpoint). Refer to each payment method's documentation to learn which refund attributes may be required.
sig { returns(T.nilable(String)) }
def refund_attributes_method; end
sig { params(_refund_attributes_method: T.nilable(String)).returns(T.nilable(String)) }
def refund_attributes_method=(_refund_attributes_method); end
sig { params(refund_attributes_method: T.nilable(String)).void }
def initialize(refund_attributes_method: nil); end
end
class Redirect < Stripe::RequestParams
# The URL you provide to redirect the customer back to you after they authenticated their payment. It can use your application URI scheme in the context of a mobile application.
sig { returns(String) }
def return_url; end
sig { params(_return_url: String).returns(String) }
def return_url=(_return_url); end
sig { params(return_url: String).void }
def initialize(return_url: nil); end
end
class SourceOrder < Stripe::RequestParams
class Item < Stripe::RequestParams
# Attribute for param field amount
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Attribute for param field currency
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Attribute for param field description
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The ID of the SKU being ordered.
sig { returns(T.nilable(String)) }
def parent; end
sig { params(_parent: T.nilable(String)).returns(T.nilable(String)) }
def parent=(_parent); end
# The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# Attribute for param field type
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(amount: T.nilable(Integer), currency: T.nilable(String), description: T.nilable(String), parent: T.nilable(String), quantity: T.nilable(Integer), type: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
parent: nil,
quantity: nil,
type: nil
); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(String) }
def line1; end
sig { params(_line1: String).returns(String) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: String, line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address.
sig { returns(::Stripe::SourceService::CreateParams::SourceOrder::Shipping::Address) }
def address; end
sig {
params(_address: ::Stripe::SourceService::CreateParams::SourceOrder::Shipping::Address).returns(::Stripe::SourceService::CreateParams::SourceOrder::Shipping::Address)
}
def address=(_address); end
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# Recipient name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Recipient phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
sig { returns(T.nilable(String)) }
def tracking_number; end
sig { params(_tracking_number: T.nilable(String)).returns(T.nilable(String)) }
def tracking_number=(_tracking_number); end
sig {
params(address: ::Stripe::SourceService::CreateParams::SourceOrder::Shipping::Address, carrier: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tracking_number: T.nilable(String)).void
}
def initialize(
address: nil,
carrier: nil,
name: nil,
phone: nil,
tracking_number: nil
); end
end
# List of items constituting the order.
sig {
returns(T.nilable(T::Array[::Stripe::SourceService::CreateParams::SourceOrder::Item]))
}
def items; end
sig {
params(_items: T.nilable(T::Array[::Stripe::SourceService::CreateParams::SourceOrder::Item])).returns(T.nilable(T::Array[::Stripe::SourceService::CreateParams::SourceOrder::Item]))
}
def items=(_items); end
# Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.
sig { returns(T.nilable(::Stripe::SourceService::CreateParams::SourceOrder::Shipping)) }
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::SourceService::CreateParams::SourceOrder::Shipping)).returns(T.nilable(::Stripe::SourceService::CreateParams::SourceOrder::Shipping))
}
def shipping=(_shipping); end
sig {
params(items: T.nilable(T::Array[::Stripe::SourceService::CreateParams::SourceOrder::Item]), shipping: T.nilable(::Stripe::SourceService::CreateParams::SourceOrder::Shipping)).void
}
def initialize(items: nil, shipping: nil); end
end
# Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`).
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows.
sig { returns(T.nilable(String)) }
def flow; end
sig { params(_flow: T.nilable(String)).returns(T.nilable(String)) }
def flow=(_flow); end
# Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
sig { returns(T.nilable(::Stripe::SourceService::CreateParams::Mandate)) }
def mandate; end
sig {
params(_mandate: T.nilable(::Stripe::SourceService::CreateParams::Mandate)).returns(T.nilable(::Stripe::SourceService::CreateParams::Mandate))
}
def mandate=(_mandate); end
# Attribute for param field metadata
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The source to share.
sig { returns(T.nilable(String)) }
def original_source; end
sig { params(_original_source: T.nilable(String)).returns(T.nilable(String)) }
def original_source=(_original_source); end
# Information about the owner of the payment instrument that may be used or required by particular source types.
sig { returns(T.nilable(::Stripe::SourceService::CreateParams::Owner)) }
def owner; end
sig {
params(_owner: T.nilable(::Stripe::SourceService::CreateParams::Owner)).returns(T.nilable(::Stripe::SourceService::CreateParams::Owner))
}
def owner=(_owner); end
# Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`).
sig { returns(T.nilable(::Stripe::SourceService::CreateParams::Receiver)) }
def receiver; end
sig {
params(_receiver: T.nilable(::Stripe::SourceService::CreateParams::Receiver)).returns(T.nilable(::Stripe::SourceService::CreateParams::Receiver))
}
def receiver=(_receiver); end
# Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`).
sig { returns(T.nilable(::Stripe::SourceService::CreateParams::Redirect)) }
def redirect; end
sig {
params(_redirect: T.nilable(::Stripe::SourceService::CreateParams::Redirect)).returns(T.nilable(::Stripe::SourceService::CreateParams::Redirect))
}
def redirect=(_redirect); end
# Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.
sig { returns(T.nilable(::Stripe::SourceService::CreateParams::SourceOrder)) }
def source_order; end
sig {
params(_source_order: T.nilable(::Stripe::SourceService::CreateParams::SourceOrder)).returns(T.nilable(::Stripe::SourceService::CreateParams::SourceOrder))
}
def source_order=(_source_order); end
# An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# An optional token used to create the source. When passed, token properties will override source parameters.
sig { returns(T.nilable(String)) }
def token; end
sig { params(_token: T.nilable(String)).returns(T.nilable(String)) }
def token=(_token); end
# The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide)
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# Attribute for param field usage
sig { returns(T.nilable(String)) }
def usage; end
sig { params(_usage: T.nilable(String)).returns(T.nilable(String)) }
def usage=(_usage); end
sig {
params(amount: T.nilable(Integer), currency: T.nilable(String), customer: T.nilable(String), expand: T.nilable(T::Array[String]), flow: T.nilable(String), mandate: T.nilable(::Stripe::SourceService::CreateParams::Mandate), metadata: T.nilable(T::Hash[String, String]), original_source: T.nilable(String), owner: T.nilable(::Stripe::SourceService::CreateParams::Owner), receiver: T.nilable(::Stripe::SourceService::CreateParams::Receiver), redirect: T.nilable(::Stripe::SourceService::CreateParams::Redirect), source_order: T.nilable(::Stripe::SourceService::CreateParams::SourceOrder), statement_descriptor: T.nilable(String), token: T.nilable(String), type: T.nilable(String), usage: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
customer: nil,
expand: nil,
flow: nil,
mandate: nil,
metadata: nil,
original_source: nil,
owner: nil,
receiver: nil,
redirect: nil,
source_order: nil,
statement_descriptor: nil,
token: nil,
type: nil,
usage: nil
); end
end
class VerifyParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The values needed to verify the source.
sig { returns(T::Array[String]) }
def values; end
sig { params(_values: T::Array[String]).returns(T::Array[String]) }
def values=(_values); end
sig { params(expand: T.nilable(T::Array[String]), values: T::Array[String]).void }
def initialize(expand: nil, values: nil); end
end
# Creates a new source object.
sig {
params(params: T.any(::Stripe::SourceService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
}
def create(params = {}, opts = {}); end
# Delete a specified source for a given customer.
sig {
params(customer: String, id: String, params: T.any(::Stripe::SourceService::DetachParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source))
}
def detach(customer, id, params = {}, opts = {}); end
# Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.
sig {
params(source: String, params: T.any(::Stripe::SourceService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
}
def retrieve(source, params = {}, opts = {}); end
# Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
#
# This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment method guides](https://docs.stripe.com/docs/sources) for more detail.
sig {
params(source: String, params: T.any(::Stripe::SourceService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
}
def update(source, params = {}, opts = {}); end
# Verify a given source.
sig {
params(source: String, params: T.any(::Stripe::SourceService::VerifyParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
}
def verify(source, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class SourceTransactionService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# List source transactions for a given source.
sig {
params(source: String, params: T.any(::Stripe::SourceTransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(source, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class SubscriptionService < StripeService
class CancelParams < Stripe::RequestParams
class CancellationDetails < Stripe::RequestParams
# Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
sig { returns(T.nilable(String)) }
def comment; end
sig { params(_comment: T.nilable(String)).returns(T.nilable(String)) }
def comment=(_comment); end
# The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
sig { returns(T.nilable(T.any(String, String))) }
def feedback; end
sig {
params(_feedback: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def feedback=(_feedback); end
sig { params(comment: T.nilable(String), feedback: T.nilable(T.any(String, String))).void }
def initialize(comment: nil, feedback: nil); end
end
# Details about why this subscription was cancelled
sig { returns(T.nilable(::Stripe::SubscriptionService::CancelParams::CancellationDetails)) }
def cancellation_details; end
sig {
params(_cancellation_details: T.nilable(::Stripe::SubscriptionService::CancelParams::CancellationDetails)).returns(T.nilable(::Stripe::SubscriptionService::CancelParams::CancellationDetails))
}
def cancellation_details=(_cancellation_details); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def invoice_now; end
sig { params(_invoice_now: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def invoice_now=(_invoice_now); end
# Will generate a proration invoice item that credits remaining unused time until the subscription period end. Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def prorate; end
sig { params(_prorate: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def prorate=(_prorate); end
sig {
params(cancellation_details: T.nilable(::Stripe::SubscriptionService::CancelParams::CancellationDetails), expand: T.nilable(T::Array[String]), invoice_now: T.nilable(T::Boolean), prorate: T.nilable(T::Boolean)).void
}
def initialize(cancellation_details: nil, expand: nil, invoice_now: nil, prorate: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class AddInvoiceItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
class End < Stripe::RequestParams
# A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the end of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
class Start < Stripe::RequestParams
# A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the start of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
# End of the invoice item period.
sig { returns(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Period::End) }
def end; end
sig {
params(_end: ::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Period::End).returns(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Period::End)
}
def end=(_end); end
# Start of the invoice item period.
sig {
returns(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Period::Start)
}
def start; end
sig {
params(_start: ::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Period::Start).returns(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Period::Start)
}
def start=(_start); end
sig {
params(end_: ::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Period::End, start: ::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Period::Start).void
}
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# The coupons to redeem into discounts for the item.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount])).returns(T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Period))
}
def period; end
sig {
params(_period: T.nilable(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Period)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Period))
}
def period=(_period); end
# The ID of the price object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::PriceData)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::PriceData))
}
def price_data=(_price_data); end
# Quantity for this item. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount]), metadata: T.nilable(T::Hash[String, String]), period: T.nilable(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Period), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
discounts: nil,
metadata: nil,
period: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::SubscriptionService::UpdateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::SubscriptionService::UpdateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class BillingThresholds < Stripe::RequestParams
# Monetary threshold that triggers the subscription to advance to a new billing period
sig { returns(T.nilable(Integer)) }
def amount_gte; end
sig { params(_amount_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_gte=(_amount_gte); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
sig {
params(_reset_billing_cycle_anchor: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def reset_billing_cycle_anchor=(_reset_billing_cycle_anchor); end
sig {
params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
}
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
end
class CancellationDetails < Stripe::RequestParams
# Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
sig { returns(T.nilable(String)) }
def comment; end
sig { params(_comment: T.nilable(String)).returns(T.nilable(String)) }
def comment=(_comment); end
# The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
sig { returns(T.nilable(T.any(String, String))) }
def feedback; end
sig {
params(_feedback: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def feedback=(_feedback); end
sig { params(comment: T.nilable(String), feedback: T.nilable(T.any(String, String))).void }
def initialize(comment: nil, feedback: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionService::UpdateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionService::UpdateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionService::UpdateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionService::UpdateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::SubscriptionService::UpdateParams::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), issuer: T.nilable(::Stripe::SubscriptionService::UpdateParams::InvoiceSettings::Issuer)).void
}
def initialize(account_tax_ids: nil, issuer: nil); end
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))
sig { returns(Integer) }
def usage_gte; end
sig { params(_usage_gte: Integer).returns(Integer) }
def usage_gte=(_usage_gte); end
sig { params(usage_gte: Integer).void }
def initialize(usage_gte: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig { returns(::Stripe::SubscriptionService::UpdateParams::Item::PriceData::Recurring) }
def recurring; end
sig {
params(_recurring: ::Stripe::SubscriptionService::UpdateParams::Item::PriceData::Recurring).returns(::Stripe::SubscriptionService::UpdateParams::Item::PriceData::Recurring)
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: ::Stripe::SubscriptionService::UpdateParams::Item::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::Item::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::Item::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::Item::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def clear_usage; end
sig { params(_clear_usage: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def clear_usage=(_clear_usage); end
# A flag that, if set to `true`, will delete the specified item.
sig { returns(T.nilable(T::Boolean)) }
def deleted; end
sig { params(_deleted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def deleted=(_deleted); end
# The coupons to redeem into discounts for the subscription item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::UpdateParams::Item::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::UpdateParams::Item::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::UpdateParams::Item::Discount])))
}
def discounts=(_discounts); end
# Subscription item to update.
sig { returns(T.nilable(String)) }
def id; end
sig { params(_id: T.nilable(String)).returns(T.nilable(String)) }
def id=(_id); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Plan ID for this item, as a string.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig { returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::PriceData)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::PriceData))
}
def price_data=(_price_data); end
# Quantity for this item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::Item::BillingThresholds)), clear_usage: T.nilable(T::Boolean), deleted: T.nilable(T::Boolean), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::UpdateParams::Item::Discount])), id: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
billing_thresholds: nil,
clear_usage: nil,
deleted: nil,
discounts: nil,
id: nil,
metadata: nil,
plan: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class PauseCollection < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
# The time after which the subscription will resume collecting payments.
sig { returns(T.nilable(Integer)) }
def resumes_at; end
sig { params(_resumes_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def resumes_at=(_resumes_at); end
sig { params(behavior: String, resumes_at: T.nilable(Integer)).void }
def initialize(behavior: nil, resumes_at: nil); end
end
class PaymentSettings < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig { params(transaction_type: T.nilable(String)).void }
def initialize(transaction_type: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
}
def initialize(mandate_options: nil, verification_method: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
sig { params(preferred_language: T.nilable(String)).void }
def initialize(preferred_language: nil); end
end
class Card < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), description: T.nilable(String)).void
}
def initialize(amount: nil, amount_type: nil, description: nil); end
end
# Configuration options for setting up an eMandate for cards issued in India.
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
sig {
params(mandate_options: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions), network: T.nilable(String), request_three_d_secure: T.nilable(String)).void
}
def initialize(mandate_options: nil, network: nil, request_three_d_secure: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), type: T.nilable(String)).void
}
def initialize(eu_bank_transfer: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
sig {
params(bank_transfer: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil); end
end
class IdBankTransfer < Stripe::RequestParams; end
class Konbini < Stripe::RequestParams; end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. If not provided, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
end_date: nil,
payment_schedule: nil
); end
end
# Configuration options for setting up a mandate
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class SepaDebit < Stripe::RequestParams; end
class Upi < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), description: T.nilable(String), end_date: T.nilable(Integer)).void
}
def initialize(amount: nil, amount_type: nil, description: nil, end_date: nil); end
end
# Configuration options for setting up an eMandate
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
sig {
params(filters: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String])).void
}
def initialize(filters: nil, permissions: nil, prefetch: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections), verification_method: T.nilable(String)).void
}
def initialize(financial_connections: nil, verification_method: nil); end
end
# This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit=(_acss_debit); end
# This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact)))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact)))
}
def bancontact=(_bancontact); end
# This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card)))
}
def card; end
sig {
params(_card: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card)))
}
def card=(_card); end
# This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance=(_customer_balance); end
# This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer=(_id_bank_transfer); end
# This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini)))
}
def konbini; end
sig {
params(_konbini: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini)))
}
def konbini=(_konbini); end
# This sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix)))
}
def pix; end
sig {
params(_pix: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix)))
}
def pix=(_pix); end
# This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit=(_sepa_debit); end
# This sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi)))
}
def upi; end
sig {
params(_upi: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi)))
}
def upi=(_upi); end
# This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
sig {
params(acss_debit: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)), bancontact: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact)), card: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card)), customer_balance: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)), id_bank_transfer: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)), konbini: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini)), pix: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Pix)), sepa_debit: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)), upi: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Upi)), us_bank_account: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))).void
}
def initialize(
acss_debit: nil,
bancontact: nil,
card: nil,
customer_balance: nil,
id_bank_transfer: nil,
konbini: nil,
pix: nil,
sepa_debit: nil,
upi: nil,
us_bank_account: nil
); end
end
# Payment-method-specific configuration to provide to invoices created by the subscription.
sig {
returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def payment_method_types=(_payment_method_types); end
# Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.
sig { returns(T.nilable(String)) }
def save_default_payment_method; end
sig { params(_save_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def save_default_payment_method=(_save_default_payment_method); end
sig {
params(payment_method_options: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions), payment_method_types: T.nilable(T.any(String, T::Array[String])), save_default_payment_method: T.nilable(String)).void
}
def initialize(
payment_method_options: nil,
payment_method_types: nil,
save_default_payment_method: nil
); end
end
class PendingInvoiceItemInterval < Stripe::RequestParams
# Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
class Prebilling < Stripe::RequestParams
# This is used to determine the number of billing cycles to prebill.
sig { returns(Integer) }
def iterations; end
sig { params(_iterations: Integer).returns(Integer) }
def iterations=(_iterations); end
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
sig { returns(T.nilable(String)) }
def update_behavior; end
sig { params(_update_behavior: T.nilable(String)).returns(T.nilable(String)) }
def update_behavior=(_update_behavior); end
sig { params(iterations: Integer, update_behavior: T.nilable(String)).void }
def initialize(iterations: nil, update_behavior: nil); end
end
class TransferData < Stripe::RequestParams
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount_percent: T.nilable(Float), destination: String).void }
def initialize(amount_percent: nil, destination: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
sig { returns(String) }
def missing_payment_method; end
sig { params(_missing_payment_method: String).returns(String) }
def missing_payment_method=(_missing_payment_method); end
sig { params(missing_payment_method: String).void }
def initialize(missing_payment_method: nil); end
end
# Defines how the subscription should behave when the user's free trial ends.
sig { returns(::Stripe::SubscriptionService::UpdateParams::TrialSettings::EndBehavior) }
def end_behavior; end
sig {
params(_end_behavior: ::Stripe::SubscriptionService::UpdateParams::TrialSettings::EndBehavior).returns(::Stripe::SubscriptionService::UpdateParams::TrialSettings::EndBehavior)
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: ::Stripe::SubscriptionService::UpdateParams::TrialSettings::EndBehavior).void
}
def initialize(end_behavior: nil); end
end
# A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem]))
}
def add_invoice_items; end
sig {
params(_add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem])).returns(T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem]))
}
def add_invoice_items=(_add_invoice_items); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
sig { returns(T.nilable(T.any(String, Float))) }
def application_fee_percent; end
sig {
params(_application_fee_percent: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def application_fee_percent=(_application_fee_percent); end
# Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
sig { returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::SubscriptionService::UpdateParams::AutomaticTax)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(T.any(String, T.any(Integer, String)))) }
def cancel_at; end
sig {
params(_cancel_at: T.nilable(T.any(String, T.any(Integer, String)))).returns(T.nilable(T.any(String, T.any(Integer, String))))
}
def cancel_at=(_cancel_at); end
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def cancel_at_period_end; end
sig { params(_cancel_at_period_end: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def cancel_at_period_end=(_cancel_at_period_end); end
# Details about why this subscription was cancelled
sig { returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::CancellationDetails)) }
def cancellation_details; end
sig {
params(_cancellation_details: T.nilable(::Stripe::SubscriptionService::UpdateParams::CancellationDetails)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::CancellationDetails))
}
def cancellation_details=(_cancellation_details); end
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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`.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
sig { returns(T.nilable(String)) }
def default_source; end
sig { params(_default_source: T.nilable(String)).returns(T.nilable(String)) }
def default_source=(_default_source); end
# The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::UpdateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::UpdateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::UpdateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# All invoices will be billed using the specified settings.
sig { returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::InvoiceSettings)) }
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::SubscriptionService::UpdateParams::InvoiceSettings)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# A list of up to 20 subscription items, each with an attached price.
sig { returns(T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::Item])) }
def items; end
sig {
params(_items: T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::Item])).returns(T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::Item]))
}
def items=(_items); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
sig { returns(T.nilable(T::Boolean)) }
def off_session; end
sig { params(_off_session: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def off_session=(_off_session); end
# The account on behalf of which to charge, for each of the subscription's invoices.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PauseCollection)))
}
def pause_collection; end
sig {
params(_pause_collection: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PauseCollection))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PauseCollection)))
}
def pause_collection=(_pause_collection); end
# Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
#
# Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
#
# Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
#
# Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
sig { returns(T.nilable(String)) }
def payment_behavior; end
sig { params(_payment_behavior: T.nilable(String)).returns(T.nilable(String)) }
def payment_behavior=(_payment_behavior); end
# Payment settings to pass to invoices created by the subscription.
sig { returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings)) }
def payment_settings; end
sig {
params(_payment_settings: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings))
}
def payment_settings=(_payment_settings); end
# Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PendingInvoiceItemInterval)))
}
def pending_invoice_item_interval; end
sig {
params(_pending_invoice_item_interval: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PendingInvoiceItemInterval))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PendingInvoiceItemInterval)))
}
def pending_invoice_item_interval=(_pending_invoice_item_interval); end
# If specified, the invoicing for the given billing cycle iterations will be processed now.
sig { returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::Prebilling)) }
def prebilling; end
sig {
params(_prebilling: T.nilable(::Stripe::SubscriptionService::UpdateParams::Prebilling)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::Prebilling))
}
def prebilling=(_prebilling); end
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
sig { returns(T.nilable(Integer)) }
def proration_date; end
sig { params(_proration_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def proration_date=(_proration_date); end
# If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::TransferData)))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::TransferData))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::TransferData)))
}
def transfer_data=(_transfer_data); end
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, `trial_end` will override the default trial period of the plan the customer is being subscribed to. The `billing_cycle_anchor` will be updated to the `trial_end` value. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
sig { returns(T.nilable(T.any(String, Integer))) }
def trial_end; end
sig {
params(_trial_end: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def trial_end=(_trial_end); end
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
sig { returns(T.nilable(T::Boolean)) }
def trial_from_plan; end
sig { params(_trial_from_plan: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def trial_from_plan=(_trial_from_plan); end
# Settings related to subscription trials.
sig { returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::TrialSettings)) }
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::SubscriptionService::UpdateParams::TrialSettings)).returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem]), application_fee_percent: T.nilable(T.any(String, Float)), automatic_tax: T.nilable(::Stripe::SubscriptionService::UpdateParams::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::BillingThresholds)), cancel_at: T.nilable(T.any(String, T.any(Integer, String))), cancel_at_period_end: T.nilable(T::Boolean), cancellation_details: T.nilable(::Stripe::SubscriptionService::UpdateParams::CancellationDetails), collection_method: T.nilable(String), days_until_due: T.nilable(Integer), default_payment_method: T.nilable(String), default_source: T.nilable(String), default_tax_rates: T.nilable(T.any(String, T::Array[String])), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::UpdateParams::Discount])), expand: T.nilable(T::Array[String]), invoice_settings: T.nilable(::Stripe::SubscriptionService::UpdateParams::InvoiceSettings), items: T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::Item]), metadata: T.nilable(T.any(String, T::Hash[String, String])), off_session: T.nilable(T::Boolean), on_behalf_of: T.nilable(String), pause_collection: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PauseCollection)), payment_behavior: T.nilable(String), payment_settings: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings), pending_invoice_item_interval: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PendingInvoiceItemInterval)), prebilling: T.nilable(::Stripe::SubscriptionService::UpdateParams::Prebilling), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), transfer_data: T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::TransferData)), trial_end: T.nilable(T.any(String, Integer)), trial_from_plan: T.nilable(T::Boolean), trial_settings: T.nilable(::Stripe::SubscriptionService::UpdateParams::TrialSettings)).void
}
def initialize(
add_invoice_items: nil,
application_fee_percent: nil,
automatic_tax: nil,
billing_cycle_anchor: nil,
billing_thresholds: nil,
cancel_at: nil,
cancel_at_period_end: nil,
cancellation_details: nil,
collection_method: nil,
days_until_due: nil,
default_payment_method: nil,
default_source: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
expand: nil,
invoice_settings: nil,
items: nil,
metadata: nil,
off_session: nil,
on_behalf_of: nil,
pause_collection: nil,
payment_behavior: nil,
payment_settings: nil,
pending_invoice_item_interval: nil,
prebilling: nil,
proration_behavior: nil,
proration_date: nil,
transfer_data: nil,
trial_end: nil,
trial_from_plan: nil,
trial_settings: nil
); end
end
class DeleteDiscountParams < Stripe::RequestParams; end
class ListParams < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class CurrentPeriodEnd < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class CurrentPeriodStart < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Filter subscriptions by their automatic tax settings.
sig { returns(T.nilable(::Stripe::SubscriptionService::ListParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::SubscriptionService::ListParams::AutomaticTax)).returns(T.nilable(::Stripe::SubscriptionService::ListParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# Only return subscriptions that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::SubscriptionService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::SubscriptionService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::SubscriptionService::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return subscriptions whose minimum item current_period_end falls within the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::SubscriptionService::ListParams::CurrentPeriodEnd, Integer)))
}
def current_period_end; end
sig {
params(_current_period_end: T.nilable(T.any(::Stripe::SubscriptionService::ListParams::CurrentPeriodEnd, Integer))).returns(T.nilable(T.any(::Stripe::SubscriptionService::ListParams::CurrentPeriodEnd, Integer)))
}
def current_period_end=(_current_period_end); end
# Only return subscriptions whose maximum item current_period_start falls within the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::SubscriptionService::ListParams::CurrentPeriodStart, Integer)))
}
def current_period_start; end
sig {
params(_current_period_start: T.nilable(T.any(::Stripe::SubscriptionService::ListParams::CurrentPeriodStart, Integer))).returns(T.nilable(T.any(::Stripe::SubscriptionService::ListParams::CurrentPeriodStart, Integer)))
}
def current_period_start=(_current_period_start); end
# The ID of the customer whose subscriptions will be retrieved.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The ID of the account whose subscriptions will be retrieved.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The ID of the plan whose subscriptions will be retrieved.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# Filter for subscriptions that contain this recurring price ID.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.
sig { returns(T.nilable(String)) }
def test_clock; end
sig { params(_test_clock: T.nilable(String)).returns(T.nilable(String)) }
def test_clock=(_test_clock); end
sig {
params(automatic_tax: T.nilable(::Stripe::SubscriptionService::ListParams::AutomaticTax), collection_method: T.nilable(String), created: T.nilable(T.any(::Stripe::SubscriptionService::ListParams::Created, Integer)), current_period_end: T.nilable(T.any(::Stripe::SubscriptionService::ListParams::CurrentPeriodEnd, Integer)), current_period_start: T.nilable(T.any(::Stripe::SubscriptionService::ListParams::CurrentPeriodStart, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), plan: T.nilable(String), price: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String), test_clock: T.nilable(String)).void
}
def initialize(
automatic_tax: nil,
collection_method: nil,
created: nil,
current_period_end: nil,
current_period_start: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
limit: nil,
plan: nil,
price: nil,
starting_after: nil,
status: nil,
test_clock: nil
); end
end
class CreateParams < Stripe::RequestParams
class AddInvoiceItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
class End < Stripe::RequestParams
# A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the end of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
class Start < Stripe::RequestParams
# A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the start of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
# End of the invoice item period.
sig { returns(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Period::End) }
def end; end
sig {
params(_end: ::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Period::End).returns(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Period::End)
}
def end=(_end); end
# Start of the invoice item period.
sig {
returns(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Period::Start)
}
def start; end
sig {
params(_start: ::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Period::Start).returns(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Period::Start)
}
def start=(_start); end
sig {
params(end_: ::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Period::End, start: ::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Period::Start).void
}
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# The coupons to redeem into discounts for the item.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount])).returns(T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Period))
}
def period; end
sig {
params(_period: T.nilable(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Period)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Period))
}
def period=(_period); end
# The ID of the price object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::PriceData)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::PriceData))
}
def price_data=(_price_data); end
# Quantity for this item. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount]), metadata: T.nilable(T::Hash[String, String]), period: T.nilable(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Period), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
discounts: nil,
metadata: nil,
period: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::SubscriptionService::CreateParams::AutomaticTax::Liability)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::SubscriptionService::CreateParams::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class BillingCycleAnchorConfig < Stripe::RequestParams
# The day of the month the anchor should be. Ranges from 1 to 31.
sig { returns(Integer) }
def day_of_month; end
sig { params(_day_of_month: Integer).returns(Integer) }
def day_of_month=(_day_of_month); end
# The hour of the day the anchor should be. Ranges from 0 to 23.
sig { returns(T.nilable(Integer)) }
def hour; end
sig { params(_hour: T.nilable(Integer)).returns(T.nilable(Integer)) }
def hour=(_hour); end
# The minute of the hour the anchor should be. Ranges from 0 to 59.
sig { returns(T.nilable(Integer)) }
def minute; end
sig { params(_minute: T.nilable(Integer)).returns(T.nilable(Integer)) }
def minute=(_minute); end
# The month to start full cycle periods. Ranges from 1 to 12.
sig { returns(T.nilable(Integer)) }
def month; end
sig { params(_month: T.nilable(Integer)).returns(T.nilable(Integer)) }
def month=(_month); end
# The second of the minute the anchor should be. Ranges from 0 to 59.
sig { returns(T.nilable(Integer)) }
def second; end
sig { params(_second: T.nilable(Integer)).returns(T.nilable(Integer)) }
def second=(_second); end
sig {
params(day_of_month: Integer, hour: T.nilable(Integer), minute: T.nilable(Integer), month: T.nilable(Integer), second: T.nilable(Integer)).void
}
def initialize(day_of_month: nil, hour: nil, minute: nil, month: nil, second: nil); end
end
class BillingMode < Stripe::RequestParams
class Flexible < Stripe::RequestParams
# Set to `true` to display gross amounts, net amounts, and discount amounts consistently between prorations and non-proration items on invoices, line items, and invoice items. Once set to `true`, you can't change it back to `false`.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
sig {
params(_consistent_proration_discount_amounts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consistent_proration_discount_amounts=(_consistent_proration_discount_amounts); end
sig { params(consistent_proration_discount_amounts: T.nilable(T::Boolean)).void }
def initialize(consistent_proration_discount_amounts: nil); end
end
# Configure behavior for flexible billing mode.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::BillingMode::Flexible))
}
def flexible; end
sig {
params(_flexible: T.nilable(::Stripe::SubscriptionService::CreateParams::BillingMode::Flexible)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::BillingMode::Flexible))
}
def flexible=(_flexible); end
# Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(flexible: T.nilable(::Stripe::SubscriptionService::CreateParams::BillingMode::Flexible), type: String).void
}
def initialize(flexible: nil, type: nil); end
end
class BillingThresholds < Stripe::RequestParams
# Monetary threshold that triggers the subscription to advance to a new billing period
sig { returns(T.nilable(Integer)) }
def amount_gte; end
sig { params(_amount_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_gte=(_amount_gte); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
sig {
params(_reset_billing_cycle_anchor: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def reset_billing_cycle_anchor=(_reset_billing_cycle_anchor); end
sig {
params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
}
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionService::CreateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionService::CreateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionService::CreateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionService::CreateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::SubscriptionService::CreateParams::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), issuer: T.nilable(::Stripe::SubscriptionService::CreateParams::InvoiceSettings::Issuer)).void
}
def initialize(account_tax_ids: nil, issuer: nil); end
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))
sig { returns(Integer) }
def usage_gte; end
sig { params(_usage_gte: Integer).returns(Integer) }
def usage_gte=(_usage_gte); end
sig { params(usage_gte: Integer).void }
def initialize(usage_gte: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::Item::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionService::CreateParams::Item::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::Item::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionService::CreateParams::Item::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::Item::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionService::CreateParams::Item::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::Item::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionService::CreateParams::Item::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig { returns(::Stripe::SubscriptionService::CreateParams::Item::PriceData::Recurring) }
def recurring; end
sig {
params(_recurring: ::Stripe::SubscriptionService::CreateParams::Item::PriceData::Recurring).returns(::Stripe::SubscriptionService::CreateParams::Item::PriceData::Recurring)
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: ::Stripe::SubscriptionService::CreateParams::Item::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::Item::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::Item::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::Item::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# The coupons to redeem into discounts for the subscription item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::CreateParams::Item::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::CreateParams::Item::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::CreateParams::Item::Discount])))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Plan ID for this item, as a string.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig { returns(T.nilable(::Stripe::SubscriptionService::CreateParams::Item::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::SubscriptionService::CreateParams::Item::PriceData)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::Item::PriceData))
}
def price_data=(_price_data); end
# Quantity for this item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# Define options to configure the trial on the subscription item.
sig { returns(T.nilable(::Stripe::SubscriptionService::CreateParams::Item::Trial)) }
def trial; end
sig {
params(_trial: T.nilable(::Stripe::SubscriptionService::CreateParams::Item::Trial)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::Item::Trial))
}
def trial=(_trial); end
sig {
params(billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::Item::BillingThresholds)), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::CreateParams::Item::Discount])), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionService::CreateParams::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String])), trial: T.nilable(::Stripe::SubscriptionService::CreateParams::Item::Trial)).void
}
def initialize(
billing_thresholds: nil,
discounts: nil,
metadata: nil,
plan: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
class PaymentSettings < Stripe::RequestParams
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Transaction type of the mandate.
sig { returns(T.nilable(String)) }
def transaction_type; end
sig { params(_transaction_type: T.nilable(String)).returns(T.nilable(String)) }
def transaction_type=(_transaction_type); end
sig { params(transaction_type: T.nilable(String)).void }
def initialize(transaction_type: nil); end
end
# Additional fields for Mandate creation
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(mandate_options: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
}
def initialize(mandate_options: nil, verification_method: nil); end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
sig { returns(T.nilable(String)) }
def preferred_language; end
sig { params(_preferred_language: T.nilable(String)).returns(T.nilable(String)) }
def preferred_language=(_preferred_language); end
sig { params(preferred_language: T.nilable(String)).void }
def initialize(preferred_language: nil); end
end
class Card < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), description: T.nilable(String)).void
}
def initialize(amount: nil, amount_type: nil, description: nil); end
end
# Configuration options for setting up an eMandate for cards issued in India.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions))
}
def mandate_options=(_mandate_options); end
# Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
sig { returns(T.nilable(String)) }
def request_three_d_secure; end
sig { params(_request_three_d_secure: T.nilable(String)).returns(T.nilable(String)) }
def request_three_d_secure=(_request_three_d_secure); end
sig {
params(mandate_options: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions), network: T.nilable(String), request_three_d_secure: T.nilable(String)).void
}
def initialize(mandate_options: nil, network: nil, request_three_d_secure: nil); end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
# Configuration for eu_bank_transfer funding type.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer; end
sig {
params(_eu_bank_transfer: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
}
def eu_bank_transfer=(_eu_bank_transfer); end
# The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(eu_bank_transfer: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), type: T.nilable(String)).void
}
def initialize(eu_bank_transfer: nil, type: nil); end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer; end
sig {
params(_bank_transfer: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer))
}
def bank_transfer=(_bank_transfer); end
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
sig { returns(T.nilable(String)) }
def funding_type; end
sig { params(_funding_type: T.nilable(String)).returns(T.nilable(String)) }
def funding_type=(_funding_type); end
sig {
params(bank_transfer: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String)).void
}
def initialize(bank_transfer: nil, funding_type: nil); end
end
class IdBankTransfer < Stripe::RequestParams; end
class Konbini < Stripe::RequestParams; end
class Pix < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments. If not provided, defaults to 40000.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Determines if the amount includes the IOF tax. Defaults to `never`.
sig { returns(T.nilable(String)) }
def amount_includes_iof; end
sig { params(_amount_includes_iof: T.nilable(String)).returns(T.nilable(String)) }
def amount_includes_iof=(_amount_includes_iof); end
# Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled.
sig { returns(T.nilable(String)) }
def end_date; end
sig { params(_end_date: T.nilable(String)).returns(T.nilable(String)) }
def end_date=(_end_date); end
# Schedule at which the future payments will be charged. Defaults to `weekly`.
sig { returns(T.nilable(String)) }
def payment_schedule; end
sig { params(_payment_schedule: T.nilable(String)).returns(T.nilable(String)) }
def payment_schedule=(_payment_schedule); end
sig {
params(amount: T.nilable(Integer), amount_includes_iof: T.nilable(String), end_date: T.nilable(String), payment_schedule: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_includes_iof: nil,
end_date: nil,
payment_schedule: nil
); end
end
# Configuration options for setting up a mandate
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Pix::MandateOptions)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Pix::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Pix::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class SepaDebit < Stripe::RequestParams; end
class Upi < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
sig { returns(T.nilable(String)) }
def amount_type; end
sig { params(_amount_type: T.nilable(String)).returns(T.nilable(String)) }
def amount_type=(_amount_type); end
# A description of the mandate or subscription that is meant to be displayed to the customer.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
sig {
params(amount: T.nilable(Integer), amount_type: T.nilable(String), description: T.nilable(String), end_date: T.nilable(Integer)).void
}
def initialize(amount: nil, amount_type: nil, description: nil, end_date: nil); end
end
# Configuration options for setting up an eMandate
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions))
}
def mandate_options; end
sig {
params(_mandate_options: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions))
}
def mandate_options=(_mandate_options); end
sig {
params(mandate_options: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Upi::MandateOptions)).void
}
def initialize(mandate_options: nil); end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
sig { returns(T.nilable(T::Array[String])) }
def account_subcategories; end
sig {
params(_account_subcategories: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def account_subcategories=(_account_subcategories); end
# ID of the institution to use to filter for selectable accounts.
sig { returns(T.nilable(String)) }
def institution; end
sig { params(_institution: T.nilable(String)).returns(T.nilable(String)) }
def institution=(_institution); end
sig {
params(account_subcategories: T.nilable(T::Array[String]), institution: T.nilable(String)).void
}
def initialize(account_subcategories: nil, institution: nil); end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters; end
sig {
params(_filters: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
}
def filters=(_filters); end
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
sig { returns(T.nilable(T::Array[String])) }
def permissions; end
sig {
params(_permissions: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def permissions=(_permissions); end
# List of data features that you would like to retrieve upon account creation.
sig { returns(T.nilable(T::Array[String])) }
def prefetch; end
sig {
params(_prefetch: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def prefetch=(_prefetch); end
sig {
params(filters: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String])).void
}
def initialize(filters: nil, permissions: nil, prefetch: nil); end
end
# Additional fields for Financial Connections Session creation
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections; end
sig {
params(_financial_connections: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections))
}
def financial_connections=(_financial_connections); end
# Verification method for the intent
sig { returns(T.nilable(String)) }
def verification_method; end
sig { params(_verification_method: T.nilable(String)).returns(T.nilable(String)) }
def verification_method=(_verification_method); end
sig {
params(financial_connections: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections), verification_method: T.nilable(String)).void
}
def initialize(financial_connections: nil, verification_method: nil); end
end
# This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)))
}
def acss_debit=(_acss_debit); end
# This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact)))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact)))
}
def bancontact=(_bancontact); end
# This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Card)))
}
def card; end
sig {
params(_card: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Card))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Card)))
}
def card=(_card); end
# This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)))
}
def customer_balance=(_customer_balance); end
# This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)))
}
def id_bank_transfer=(_id_bank_transfer); end
# This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini)))
}
def konbini; end
sig {
params(_konbini: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini)))
}
def konbini=(_konbini); end
# This sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Pix)))
}
def pix; end
sig {
params(_pix: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Pix))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Pix)))
}
def pix=(_pix); end
# This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)))
}
def sepa_debit=(_sepa_debit); end
# This sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Upi)))
}
def upi; end
sig {
params(_upi: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Upi))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Upi)))
}
def upi=(_upi); end
# This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
sig {
params(acss_debit: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit)), bancontact: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact)), card: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Card)), customer_balance: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance)), id_bank_transfer: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer)), konbini: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini)), pix: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Pix)), sepa_debit: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit)), upi: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Upi)), us_bank_account: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))).void
}
def initialize(
acss_debit: nil,
bancontact: nil,
card: nil,
customer_balance: nil,
id_bank_transfer: nil,
konbini: nil,
pix: nil,
sepa_debit: nil,
upi: nil,
us_bank_account: nil
); end
end
# Payment-method-specific configuration to provide to invoices created by the subscription.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def payment_method_types; end
sig {
params(_payment_method_types: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def payment_method_types=(_payment_method_types); end
# Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.
sig { returns(T.nilable(String)) }
def save_default_payment_method; end
sig { params(_save_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def save_default_payment_method=(_save_default_payment_method); end
sig {
params(payment_method_options: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions), payment_method_types: T.nilable(T.any(String, T::Array[String])), save_default_payment_method: T.nilable(String)).void
}
def initialize(
payment_method_options: nil,
payment_method_types: nil,
save_default_payment_method: nil
); end
end
class PendingInvoiceItemInterval < Stripe::RequestParams
# Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
class Prebilling < Stripe::RequestParams
# This is used to determine the number of billing cycles to prebill.
sig { returns(Integer) }
def iterations; end
sig { params(_iterations: Integer).returns(Integer) }
def iterations=(_iterations); end
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
sig { returns(T.nilable(String)) }
def update_behavior; end
sig { params(_update_behavior: T.nilable(String)).returns(T.nilable(String)) }
def update_behavior=(_update_behavior); end
sig { params(iterations: Integer, update_behavior: T.nilable(String)).void }
def initialize(iterations: nil, update_behavior: nil); end
end
class TransferData < Stripe::RequestParams
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount_percent: T.nilable(Float), destination: String).void }
def initialize(amount_percent: nil, destination: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
sig { returns(String) }
def missing_payment_method; end
sig { params(_missing_payment_method: String).returns(String) }
def missing_payment_method=(_missing_payment_method); end
sig { params(missing_payment_method: String).void }
def initialize(missing_payment_method: nil); end
end
# Defines how the subscription should behave when the user's free trial ends.
sig { returns(::Stripe::SubscriptionService::CreateParams::TrialSettings::EndBehavior) }
def end_behavior; end
sig {
params(_end_behavior: ::Stripe::SubscriptionService::CreateParams::TrialSettings::EndBehavior).returns(::Stripe::SubscriptionService::CreateParams::TrialSettings::EndBehavior)
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: ::Stripe::SubscriptionService::CreateParams::TrialSettings::EndBehavior).void
}
def initialize(end_behavior: nil); end
end
# A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem]))
}
def add_invoice_items; end
sig {
params(_add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem])).returns(T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem]))
}
def add_invoice_items=(_add_invoice_items); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
sig { returns(T.nilable(T.any(String, Float))) }
def application_fee_percent; end
sig {
params(_application_fee_percent: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def application_fee_percent=(_application_fee_percent); end
# Automatic tax settings for this subscription.
sig { returns(T.nilable(::Stripe::SubscriptionService::CreateParams::AutomaticTax)) }
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::SubscriptionService::CreateParams::AutomaticTax)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
sig { returns(T.nilable(Integer)) }
def backdate_start_date; end
sig { params(_backdate_start_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def backdate_start_date=(_backdate_start_date); end
# A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.
sig { returns(T.nilable(Integer)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(Integer)).returns(T.nilable(Integer)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurrence of the day_of_month at the hour, minute, and second UTC.
sig {
returns(T.nilable(::Stripe::SubscriptionService::CreateParams::BillingCycleAnchorConfig))
}
def billing_cycle_anchor_config; end
sig {
params(_billing_cycle_anchor_config: T.nilable(::Stripe::SubscriptionService::CreateParams::BillingCycleAnchorConfig)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::BillingCycleAnchorConfig))
}
def billing_cycle_anchor_config=(_billing_cycle_anchor_config); end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig { returns(T.nilable(::Stripe::SubscriptionService::CreateParams::BillingMode)) }
def billing_mode; end
sig {
params(_billing_mode: T.nilable(::Stripe::SubscriptionService::CreateParams::BillingMode)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::BillingMode))
}
def billing_mode=(_billing_mode); end
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(T.any(Integer, String))) }
def cancel_at; end
sig {
params(_cancel_at: T.nilable(T.any(Integer, String))).returns(T.nilable(T.any(Integer, String)))
}
def cancel_at=(_cancel_at); end
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def cancel_at_period_end; end
sig { params(_cancel_at_period_end: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def cancel_at_period_end=(_cancel_at_period_end); end
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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`.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The identifier of the customer to subscribe.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The identifier of the account to subscribe.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
sig { returns(T.nilable(String)) }
def default_source; end
sig { params(_default_source: T.nilable(String)).returns(T.nilable(String)) }
def default_source=(_default_source); end
# The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::CreateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::CreateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::CreateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# All invoices will be billed using the specified settings.
sig { returns(T.nilable(::Stripe::SubscriptionService::CreateParams::InvoiceSettings)) }
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::SubscriptionService::CreateParams::InvoiceSettings)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# A list of up to 20 subscription items, each with an attached price.
sig { returns(T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::Item])) }
def items; end
sig {
params(_items: T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::Item])).returns(T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::Item]))
}
def items=(_items); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
sig { returns(T.nilable(T::Boolean)) }
def off_session; end
sig { params(_off_session: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def off_session=(_off_session); end
# The account on behalf of which to charge, for each of the subscription's invoices.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# Only applies to subscriptions with `collection_method=charge_automatically`.
#
# Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
#
# Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state.
#
# Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.
#
# `pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription.
#
# Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status.
sig { returns(T.nilable(String)) }
def payment_behavior; end
sig { params(_payment_behavior: T.nilable(String)).returns(T.nilable(String)) }
def payment_behavior=(_payment_behavior); end
# Payment settings to pass to invoices created by the subscription.
sig { returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings)) }
def payment_settings; end
sig {
params(_payment_settings: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings))
}
def payment_settings=(_payment_settings); end
# Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PendingInvoiceItemInterval)))
}
def pending_invoice_item_interval; end
sig {
params(_pending_invoice_item_interval: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PendingInvoiceItemInterval))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PendingInvoiceItemInterval)))
}
def pending_invoice_item_interval=(_pending_invoice_item_interval); end
# If specified, the invoicing for the given billing cycle iterations will be processed now.
sig { returns(T.nilable(::Stripe::SubscriptionService::CreateParams::Prebilling)) }
def prebilling; end
sig {
params(_prebilling: T.nilable(::Stripe::SubscriptionService::CreateParams::Prebilling)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::Prebilling))
}
def prebilling=(_prebilling); end
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
sig { returns(T.nilable(::Stripe::SubscriptionService::CreateParams::TransferData)) }
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::SubscriptionService::CreateParams::TransferData)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::TransferData))
}
def transfer_data=(_transfer_data); end
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
sig { returns(T.nilable(T.any(String, Integer))) }
def trial_end; end
sig {
params(_trial_end: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def trial_end=(_trial_end); end
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
sig { returns(T.nilable(T::Boolean)) }
def trial_from_plan; end
sig { params(_trial_from_plan: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def trial_from_plan=(_trial_from_plan); end
# Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
sig { returns(T.nilable(Integer)) }
def trial_period_days; end
sig { params(_trial_period_days: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_period_days=(_trial_period_days); end
# Settings related to subscription trials.
sig { returns(T.nilable(::Stripe::SubscriptionService::CreateParams::TrialSettings)) }
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::SubscriptionService::CreateParams::TrialSettings)).returns(T.nilable(::Stripe::SubscriptionService::CreateParams::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem]), application_fee_percent: T.nilable(T.any(String, Float)), automatic_tax: T.nilable(::Stripe::SubscriptionService::CreateParams::AutomaticTax), backdate_start_date: T.nilable(Integer), billing_cycle_anchor: T.nilable(Integer), billing_cycle_anchor_config: T.nilable(::Stripe::SubscriptionService::CreateParams::BillingCycleAnchorConfig), billing_mode: T.nilable(::Stripe::SubscriptionService::CreateParams::BillingMode), billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::BillingThresholds)), cancel_at: T.nilable(T.any(Integer, String)), cancel_at_period_end: T.nilable(T::Boolean), collection_method: T.nilable(String), currency: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), days_until_due: T.nilable(Integer), default_payment_method: T.nilable(String), default_source: T.nilable(String), default_tax_rates: T.nilable(T.any(String, T::Array[String])), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::CreateParams::Discount])), expand: T.nilable(T::Array[String]), invoice_settings: T.nilable(::Stripe::SubscriptionService::CreateParams::InvoiceSettings), items: T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::Item]), metadata: T.nilable(T.any(String, T::Hash[String, String])), off_session: T.nilable(T::Boolean), on_behalf_of: T.nilable(String), payment_behavior: T.nilable(String), payment_settings: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings), pending_invoice_item_interval: T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PendingInvoiceItemInterval)), prebilling: T.nilable(::Stripe::SubscriptionService::CreateParams::Prebilling), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::SubscriptionService::CreateParams::TransferData), trial_end: T.nilable(T.any(String, Integer)), trial_from_plan: T.nilable(T::Boolean), trial_period_days: T.nilable(Integer), trial_settings: T.nilable(::Stripe::SubscriptionService::CreateParams::TrialSettings)).void
}
def initialize(
add_invoice_items: nil,
application_fee_percent: nil,
automatic_tax: nil,
backdate_start_date: nil,
billing_cycle_anchor: nil,
billing_cycle_anchor_config: nil,
billing_mode: nil,
billing_thresholds: nil,
cancel_at: nil,
cancel_at_period_end: nil,
collection_method: nil,
currency: nil,
customer: nil,
customer_account: nil,
days_until_due: nil,
default_payment_method: nil,
default_source: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
expand: nil,
invoice_settings: nil,
items: nil,
metadata: nil,
off_session: nil,
on_behalf_of: nil,
payment_behavior: nil,
payment_settings: nil,
pending_invoice_item_interval: nil,
prebilling: nil,
proration_behavior: nil,
transfer_data: nil,
trial_end: nil,
trial_from_plan: nil,
trial_period_days: nil,
trial_settings: nil
); end
end
class SearchParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
sig { returns(T.nilable(String)) }
def page; end
sig { params(_page: T.nilable(String)).returns(T.nilable(String)) }
def page=(_page); end
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions).
sig { returns(String) }
def query; end
sig { params(_query: String).returns(String) }
def query=(_query); end
sig {
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
}
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
end
class MigrateParams < Stripe::RequestParams
class BillingMode < Stripe::RequestParams
class Flexible < Stripe::RequestParams
# Set to `true` to display gross amounts, net amounts, and discount amounts consistently between prorations and non-proration items on invoices, line items, and invoice items. Once set to `true`, you can't change it back to `false`.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
sig {
params(_consistent_proration_discount_amounts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consistent_proration_discount_amounts=(_consistent_proration_discount_amounts); end
sig { params(consistent_proration_discount_amounts: T.nilable(T::Boolean)).void }
def initialize(consistent_proration_discount_amounts: nil); end
end
# Configure behavior for flexible billing mode.
sig {
returns(T.nilable(::Stripe::SubscriptionService::MigrateParams::BillingMode::Flexible))
}
def flexible; end
sig {
params(_flexible: T.nilable(::Stripe::SubscriptionService::MigrateParams::BillingMode::Flexible)).returns(T.nilable(::Stripe::SubscriptionService::MigrateParams::BillingMode::Flexible))
}
def flexible=(_flexible); end
# Controls the calculation and orchestration of prorations and invoices for subscriptions.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(flexible: T.nilable(::Stripe::SubscriptionService::MigrateParams::BillingMode::Flexible), type: String).void
}
def initialize(flexible: nil, type: nil); end
end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig { returns(::Stripe::SubscriptionService::MigrateParams::BillingMode) }
def billing_mode; end
sig {
params(_billing_mode: ::Stripe::SubscriptionService::MigrateParams::BillingMode).returns(::Stripe::SubscriptionService::MigrateParams::BillingMode)
}
def billing_mode=(_billing_mode); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig {
params(billing_mode: ::Stripe::SubscriptionService::MigrateParams::BillingMode, expand: T.nilable(T::Array[String])).void
}
def initialize(billing_mode: nil, expand: nil); end
end
class ResumeParams < Stripe::RequestParams
# The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint.
sig { returns(T.nilable(Integer)) }
def proration_date; end
sig { params(_proration_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def proration_date=(_proration_date); end
sig {
params(billing_cycle_anchor: T.nilable(String), expand: T.nilable(T::Array[String]), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer)).void
}
def initialize(
billing_cycle_anchor: nil,
expand: nil,
proration_behavior: nil,
proration_date: nil
); end
end
# Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata).
#
# Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true.
#
# By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
sig {
params(subscription_exposed_id: String, params: T.any(::Stripe::SubscriptionService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
}
def cancel(subscription_exposed_id, params = {}, opts = {}); end
# Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.
#
# When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.
# The payment_behavior parameter determines the exact behavior of the initial payment.
#
# To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://docs.stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead.
# Schedules provide the flexibility to model more complex billing configurations that change over time.
sig {
params(params: T.any(::Stripe::SubscriptionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
}
def create(params = {}, opts = {}); end
# Removes the currently applied discount on a subscription.
sig {
params(subscription_exposed_id: String, params: T.any(::Stripe::SubscriptionService::DeleteDiscountParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Discount)
}
def delete_discount(subscription_exposed_id, params = {}, opts = {}); end
# By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.
sig {
params(params: T.any(::Stripe::SubscriptionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Upgrade the billing_mode of an existing subscription.
sig {
params(subscription: String, params: T.any(::Stripe::SubscriptionService::MigrateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
}
def migrate(subscription, params = {}, opts = {}); end
# Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.
sig {
params(subscription: String, params: T.any(::Stripe::SubscriptionService::ResumeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
}
def resume(subscription, params = {}, opts = {}); end
# Retrieves the subscription with the given ID.
sig {
params(subscription_exposed_id: String, params: T.any(::Stripe::SubscriptionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
}
def retrieve(subscription_exposed_id, params = {}, opts = {}); end
# Search for subscriptions 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.
sig {
params(params: T.any(::Stripe::SubscriptionService::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
}
def search(params = {}, opts = {}); end
# Updates an existing subscription to match the specified parameters.
# When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.
# To preview how the proration is calculated, use the [create preview](https://docs.stripe.com/docs/api/invoices/create_preview) endpoint.
#
# By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.
#
# Switching prices does not normally change the billing date or generate an immediate charge unless:
#
#
# The billing interval is changed (for example, from monthly to yearly).
# The subscription moves from free to paid.
# A trial starts or ends.
#
#
# In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://docs.stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment).
#
# If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://docs.stripe.com/docs/api/invoices/create).
#
# If you don't want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don't generate any credits for the old subscription's unused time. We still reset the billing date and bill immediately for the new subscription.
#
# Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing](https://docs.stripe.com/docs/rate-limits) instead.
sig {
params(subscription_exposed_id: String, params: T.any(::Stripe::SubscriptionService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
}
def update(subscription_exposed_id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class SubscriptionItemService < StripeService
class DeleteParams < Stripe::RequestParams
# Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`.
sig { returns(T.nilable(T::Boolean)) }
def clear_usage; end
sig { params(_clear_usage: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def clear_usage=(_clear_usage); end
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
sig { returns(T.nilable(Integer)) }
def proration_date; end
sig { params(_proration_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def proration_date=(_proration_date); end
sig {
params(clear_usage: T.nilable(T::Boolean), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer)).void
}
def initialize(clear_usage: nil, proration_behavior: nil, proration_date: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < 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))
sig { returns(Integer) }
def usage_gte; end
sig { params(_usage_gte: Integer).returns(Integer) }
def usage_gte=(_usage_gte); end
sig { params(usage_gte: Integer).void }
def initialize(usage_gte: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionItemService::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionItemService::UpdateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionItemService::UpdateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionItemService::UpdateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionItemService::UpdateParams::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionItemService::UpdateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionItemService::UpdateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionItemService::UpdateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig { returns(::Stripe::SubscriptionItemService::UpdateParams::PriceData::Recurring) }
def recurring; end
sig {
params(_recurring: ::Stripe::SubscriptionItemService::UpdateParams::PriceData::Recurring).returns(::Stripe::SubscriptionItemService::UpdateParams::PriceData::Recurring)
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: ::Stripe::SubscriptionItemService::UpdateParams::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionItemService::UpdateParams::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionItemService::UpdateParams::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionItemService::UpdateParams::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# The coupons to redeem into discounts for the subscription item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItemService::UpdateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItemService::UpdateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItemService::UpdateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
sig { returns(T.nilable(T::Boolean)) }
def off_session; end
sig { params(_off_session: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def off_session=(_off_session); end
# Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
#
# Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
#
# Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
#
# Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
sig { returns(T.nilable(String)) }
def payment_behavior; end
sig { params(_payment_behavior: T.nilable(String)).returns(T.nilable(String)) }
def payment_behavior=(_payment_behavior); end
# The identifier of the new plan for this subscription item.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig { returns(T.nilable(::Stripe::SubscriptionItemService::UpdateParams::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::SubscriptionItemService::UpdateParams::PriceData)).returns(T.nilable(::Stripe::SubscriptionItemService::UpdateParams::PriceData))
}
def price_data=(_price_data); end
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
sig { returns(T.nilable(Integer)) }
def proration_date; end
sig { params(_proration_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def proration_date=(_proration_date); end
# The quantity you'd like to apply to the subscription item you're creating.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionItemService::UpdateParams::BillingThresholds)), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItemService::UpdateParams::Discount])), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), off_session: T.nilable(T::Boolean), payment_behavior: T.nilable(String), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionItemService::UpdateParams::PriceData), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
billing_thresholds: nil,
discounts: nil,
expand: nil,
metadata: nil,
off_session: nil,
payment_behavior: nil,
plan: nil,
price: nil,
price_data: nil,
proration_behavior: nil,
proration_date: nil,
quantity: nil,
tax_rates: nil
); end
end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# The ID of the subscription whose items will be retrieved.
sig { returns(String) }
def subscription; end
sig { params(_subscription: String).returns(String) }
def subscription=(_subscription); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), subscription: String).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
subscription: nil
); end
end
class CreateParams < 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))
sig { returns(Integer) }
def usage_gte; end
sig { params(_usage_gte: Integer).returns(Integer) }
def usage_gte=(_usage_gte); end
sig { params(usage_gte: Integer).void }
def initialize(usage_gte: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionItemService::CreateParams::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionItemService::CreateParams::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionItemService::CreateParams::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionItemService::CreateParams::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionItemService::CreateParams::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionItemService::CreateParams::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionItemService::CreateParams::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionItemService::CreateParams::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig { returns(::Stripe::SubscriptionItemService::CreateParams::PriceData::Recurring) }
def recurring; end
sig {
params(_recurring: ::Stripe::SubscriptionItemService::CreateParams::PriceData::Recurring).returns(::Stripe::SubscriptionItemService::CreateParams::PriceData::Recurring)
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: ::Stripe::SubscriptionItemService::CreateParams::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionItemService::CreateParams::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionItemService::CreateParams::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionItemService::CreateParams::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# The coupons to redeem into discounts for the subscription item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItemService::CreateParams::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItemService::CreateParams::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItemService::CreateParams::Discount])))
}
def discounts=(_discounts); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
#
# Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
#
# Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
#
# Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
sig { returns(T.nilable(String)) }
def payment_behavior; end
sig { params(_payment_behavior: T.nilable(String)).returns(T.nilable(String)) }
def payment_behavior=(_payment_behavior); end
# The identifier of the plan to add to the subscription.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig { returns(T.nilable(::Stripe::SubscriptionItemService::CreateParams::PriceData)) }
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::SubscriptionItemService::CreateParams::PriceData)).returns(T.nilable(::Stripe::SubscriptionItemService::CreateParams::PriceData))
}
def price_data=(_price_data); end
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
sig { returns(T.nilable(Integer)) }
def proration_date; end
sig { params(_proration_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def proration_date=(_proration_date); end
# The quantity you'd like to apply to the subscription item you're creating.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The identifier of the subscription to modify.
sig { returns(String) }
def subscription; end
sig { params(_subscription: String).returns(String) }
def subscription=(_subscription); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# Options that configure the trial on the subscription item.
sig { returns(T.nilable(::Stripe::SubscriptionItemService::CreateParams::Trial)) }
def trial; end
sig {
params(_trial: T.nilable(::Stripe::SubscriptionItemService::CreateParams::Trial)).returns(T.nilable(::Stripe::SubscriptionItemService::CreateParams::Trial))
}
def trial=(_trial); end
sig {
params(billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionItemService::CreateParams::BillingThresholds)), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItemService::CreateParams::Discount])), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), payment_behavior: T.nilable(String), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionItemService::CreateParams::PriceData), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), quantity: T.nilable(Integer), subscription: String, tax_rates: T.nilable(T.any(String, T::Array[String])), trial: T.nilable(::Stripe::SubscriptionItemService::CreateParams::Trial)).void
}
def initialize(
billing_thresholds: nil,
discounts: nil,
expand: nil,
metadata: nil,
payment_behavior: nil,
plan: nil,
price: nil,
price_data: nil,
proration_behavior: nil,
proration_date: nil,
quantity: nil,
subscription: nil,
tax_rates: nil,
trial: nil
); end
end
# Adds a new item to an existing subscription. No existing items will be changed or replaced.
sig {
params(params: T.any(::Stripe::SubscriptionItemService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionItem)
}
def create(params = {}, opts = {}); end
# Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.
sig {
params(item: String, params: T.any(::Stripe::SubscriptionItemService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionItem)
}
def delete(item, params = {}, opts = {}); end
# Returns a list of your subscription items for a given subscription.
sig {
params(params: T.any(::Stripe::SubscriptionItemService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the subscription item with the given ID.
sig {
params(item: String, params: T.any(::Stripe::SubscriptionItemService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionItem)
}
def retrieve(item, params = {}, opts = {}); end
# Updates the plan or quantity of an item on a current subscription.
sig {
params(item: String, params: T.any(::Stripe::SubscriptionItemService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionItem)
}
def update(item, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class SubscriptionScheduleService < StripeService
class ListParams < Stripe::RequestParams
class CanceledAt < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class CompletedAt < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class ReleasedAt < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return subscription schedules that were created canceled the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::CanceledAt, Integer)))
}
def canceled_at; end
sig {
params(_canceled_at: T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::CanceledAt, Integer))).returns(T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::CanceledAt, Integer)))
}
def canceled_at=(_canceled_at); end
# Only return subscription schedules that completed during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::CompletedAt, Integer)))
}
def completed_at; end
sig {
params(_completed_at: T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::CompletedAt, Integer))).returns(T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::CompletedAt, Integer)))
}
def completed_at=(_completed_at); end
# Only return subscription schedules that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return subscription schedules for the given customer.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Only return subscription schedules for the given account.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return subscription schedules that were released during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::ReleasedAt, Integer)))
}
def released_at; end
sig {
params(_released_at: T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::ReleasedAt, Integer))).returns(T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::ReleasedAt, Integer)))
}
def released_at=(_released_at); end
# Only return subscription schedules that have not started yet.
sig { returns(T.nilable(T::Boolean)) }
def scheduled; end
sig { params(_scheduled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def scheduled=(_scheduled); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(canceled_at: T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::CanceledAt, Integer)), completed_at: T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::CompletedAt, Integer)), created: T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::Created, Integer)), customer: T.nilable(String), customer_account: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), released_at: T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::ReleasedAt, Integer)), scheduled: T.nilable(T::Boolean), starting_after: T.nilable(String)).void
}
def initialize(
canceled_at: nil,
completed_at: nil,
created: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
limit: nil,
released_at: nil,
scheduled: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class BillingMode < Stripe::RequestParams
class Flexible < Stripe::RequestParams
# Set to `true` to display gross amounts, net amounts, and discount amounts consistently between prorations and non-proration items on invoices, line items, and invoice items. Once set to `true`, you can't change it back to `false`.
sig { returns(T.nilable(T::Boolean)) }
def consistent_proration_discount_amounts; end
sig {
params(_consistent_proration_discount_amounts: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def consistent_proration_discount_amounts=(_consistent_proration_discount_amounts); end
sig { params(consistent_proration_discount_amounts: T.nilable(T::Boolean)).void }
def initialize(consistent_proration_discount_amounts: nil); end
end
# Configure behavior for flexible billing mode.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::BillingMode::Flexible))
}
def flexible; end
sig {
params(_flexible: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::BillingMode::Flexible)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::BillingMode::Flexible))
}
def flexible=(_flexible); end
# Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(flexible: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::BillingMode::Flexible), type: String).void
}
def initialize(flexible: nil, type: nil); end
end
class DefaultSettings < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax::Liability)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class BillingThresholds < Stripe::RequestParams
# Monetary threshold that triggers the subscription to advance to a new billing period
sig { returns(T.nilable(Integer)) }
def amount_gte; end
sig { params(_amount_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_gte=(_amount_gte); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
sig {
params(_reset_billing_cycle_anchor: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def reset_billing_cycle_anchor=(_reset_billing_cycle_anchor); end
sig {
params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
}
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings::Issuer)).void
}
def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end
end
class TransferData < Stripe::RequestParams
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount_percent: T.nilable(Float), destination: String).void }
def initialize(amount_percent: nil, destination: nil); end
end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
sig { params(_application_fee_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def application_fee_percent=(_application_fee_percent); end
# Default settings for automatic tax computation.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax))
}
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# 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).
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# The account on behalf of which to charge, for each of the associated subscription's invoices.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::TransferData)))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::TransferData))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::TransferData)))
}
def transfer_data=(_transfer_data); end
sig {
params(application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::BillingThresholds)), collection_method: T.nilable(String), default_payment_method: T.nilable(String), description: T.nilable(String), invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings), on_behalf_of: T.nilable(String), transfer_data: T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::TransferData))).void
}
def initialize(
application_fee_percent: nil,
automatic_tax: nil,
billing_cycle_anchor: nil,
billing_thresholds: nil,
collection_method: nil,
default_payment_method: nil,
description: nil,
invoice_settings: nil,
on_behalf_of: nil,
transfer_data: nil
); end
end
class Phase < Stripe::RequestParams
class AddInvoiceItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
class End < Stripe::RequestParams
# A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the end of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
class Start < Stripe::RequestParams
# A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the start of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
# End of the invoice item period.
sig {
returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Period::End)
}
def end; end
sig {
params(_end: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Period::End).returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Period::End)
}
def end=(_end); end
# Start of the invoice item period.
sig {
returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Period::Start)
}
def start; end
sig {
params(_start: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Period::Start).returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Period::Start)
}
def start=(_start); end
sig {
params(end_: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Period::End, start: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Period::Start).void
}
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# The coupons to redeem into discounts for the item.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount])).returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Period))
}
def period; end
sig {
params(_period: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Period)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Period))
}
def period=(_period); end
# The ID of the price object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::PriceData)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::PriceData))
}
def price_data=(_price_data); end
# Quantity for this item. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount]), metadata: T.nilable(T::Hash[String, String]), period: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Period), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
discounts: nil,
metadata: nil,
period: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax::Liability)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class BillingThresholds < Stripe::RequestParams
# Monetary threshold that triggers the subscription to advance to a new billing period
sig { returns(T.nilable(Integer)) }
def amount_gte; end
sig { params(_amount_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_gte=(_amount_gte); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
sig {
params(_reset_billing_cycle_anchor: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def reset_billing_cycle_anchor=(_reset_billing_cycle_anchor); end
sig {
params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
}
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Duration < Stripe::RequestParams
# Specifies phase duration. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The multiplier applied to the interval.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings::Issuer)).void
}
def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end
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))
sig { returns(Integer) }
def usage_gte; end
sig { params(_usage_gte: Integer).returns(Integer) }
def usage_gte=(_usage_gte); end
sig { params(usage_gte: Integer).void }
def initialize(usage_gte: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData::Recurring)
}
def recurring; end
sig {
params(_recurring: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData::Recurring).returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData::Recurring)
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# The coupons to redeem into discounts for the subscription item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount])))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData))
}
def price_data=(_price_data); end
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# Options that configure the trial on the subscription item.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Trial)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Trial))
}
def trial=(_trial); end
sig {
params(billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::BillingThresholds)), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount])), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String])), trial: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Trial)).void
}
def initialize(
billing_thresholds: nil,
discounts: nil,
metadata: nil,
plan: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
class PauseCollection < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(behavior: String).void }
def initialize(behavior: nil); end
end
class TransferData < Stripe::RequestParams
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount_percent: T.nilable(Float), destination: String).void }
def initialize(amount_percent: nil, destination: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
sig { params(_prorate_up_front: T.nilable(String)).returns(T.nilable(String)) }
def prorate_up_front=(_prorate_up_front); end
sig { params(prorate_up_front: T.nilable(String)).void }
def initialize(prorate_up_front: nil); end
end
# Defines how the subscription should behave when a trial ends.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TrialSettings::EndBehavior))
}
def end_behavior; end
sig {
params(_end_behavior: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TrialSettings::EndBehavior)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TrialSettings::EndBehavior))
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TrialSettings::EndBehavior)).void
}
def initialize(end_behavior: nil); end
end
# A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem]))
}
def add_invoice_items; end
sig {
params(_add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem])).returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem]))
}
def add_invoice_items=(_add_invoice_items); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
sig { params(_application_fee_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def application_fee_percent=(_application_fee_percent); end
# Automatic tax settings for this phase.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax))
}
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# 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).
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::Phase::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::Phase::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::Phase::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount])))
}
def discounts=(_discounts); end
# The number of intervals the phase should last. If set, `end_date` must not be set.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Duration)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Duration))
}
def duration=(_duration); end
# The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
sig { returns(T.nilable(Integer)) }
def end_date; end
sig { params(_end_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def end_date=(_end_date); end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
sig { returns(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item]) }
def items; end
sig {
params(_items: T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item]).returns(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item])
}
def items=(_items); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The account on behalf of which to charge, for each of the associated subscription's invoices.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::PauseCollection))
}
def pause_collection; end
sig {
params(_pause_collection: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::PauseCollection)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::PauseCollection))
}
def pause_collection=(_pause_collection); end
# 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.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TransferData))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TransferData)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TransferData))
}
def transfer_data=(_transfer_data); end
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
sig { returns(T.nilable(T::Boolean)) }
def trial; end
sig { params(_trial: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def trial=(_trial); end
# Specify trial behavior when crossing phase boundaries
sig { returns(T.nilable(String)) }
def trial_continuation; end
sig { params(_trial_continuation: T.nilable(String)).returns(T.nilable(String)) }
def trial_continuation=(_trial_continuation); end
# Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
sig { returns(T.nilable(Integer)) }
def trial_end; end
sig { params(_trial_end: T.nilable(Integer)).returns(T.nilable(Integer)) }
def trial_end=(_trial_end); end
# Settings related to subscription trials.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TrialSettings))
}
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TrialSettings)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::Phase::BillingThresholds)), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.any(String, T::Array[String])), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount])), duration: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Duration), end_date: T.nilable(Integer), invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings), items: T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item], metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), pause_collection: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::PauseCollection), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TransferData), trial: T.nilable(T::Boolean), trial_continuation: T.nilable(String), trial_end: T.nilable(Integer), trial_settings: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TrialSettings)).void
}
def initialize(
add_invoice_items: nil,
application_fee_percent: nil,
automatic_tax: nil,
billing_cycle_anchor: nil,
billing_thresholds: nil,
collection_method: nil,
currency: nil,
default_payment_method: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
duration: nil,
end_date: nil,
invoice_settings: nil,
items: nil,
metadata: nil,
on_behalf_of: nil,
pause_collection: nil,
proration_behavior: nil,
transfer_data: nil,
trial: nil,
trial_continuation: nil,
trial_end: nil,
trial_settings: nil
); end
end
class Prebilling < Stripe::RequestParams
# This is used to determine the number of billing cycles to prebill.
sig { returns(Integer) }
def iterations; end
sig { params(_iterations: Integer).returns(Integer) }
def iterations=(_iterations); end
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
sig { returns(T.nilable(String)) }
def update_behavior; end
sig { params(_update_behavior: T.nilable(String)).returns(T.nilable(String)) }
def update_behavior=(_update_behavior); end
sig { params(iterations: Integer, update_behavior: T.nilable(String)).void }
def initialize(iterations: nil, update_behavior: nil); end
end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
sig { params(_billing_behavior: T.nilable(String)).returns(T.nilable(String)) }
def billing_behavior=(_billing_behavior); end
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
sig { returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::BillingMode)) }
def billing_mode; end
sig {
params(_billing_mode: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::BillingMode)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::BillingMode))
}
def billing_mode=(_billing_mode); end
# The identifier of the customer to create the subscription schedule for.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The identifier of the account to create the subscription schedule for.
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Object representing the subscription schedule's default settings.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings))
}
def default_settings; end
sig {
params(_default_settings: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings))
}
def default_settings=(_default_settings); end
# Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
sig { returns(T.nilable(String)) }
def end_behavior; end
sig { params(_end_behavior: T.nilable(String)).returns(T.nilable(String)) }
def end_behavior=(_end_behavior); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
sig { returns(T.nilable(String)) }
def from_subscription; end
sig { params(_from_subscription: T.nilable(String)).returns(T.nilable(String)) }
def from_subscription=(_from_subscription); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase]))
}
def phases; end
sig {
params(_phases: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase])).returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase]))
}
def phases=(_phases); end
# If specified, the invoicing for the given billing cycle iterations will be processed now.
sig { returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Prebilling)) }
def prebilling; end
sig {
params(_prebilling: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Prebilling)).returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Prebilling))
}
def prebilling=(_prebilling); end
# When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
sig { returns(T.nilable(T.any(Integer, String))) }
def start_date; end
sig {
params(_start_date: T.nilable(T.any(Integer, String))).returns(T.nilable(T.any(Integer, String)))
}
def start_date=(_start_date); end
sig {
params(billing_behavior: T.nilable(String), billing_mode: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::BillingMode), customer: T.nilable(String), customer_account: T.nilable(String), default_settings: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings), end_behavior: T.nilable(String), expand: T.nilable(T::Array[String]), from_subscription: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), phases: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase]), prebilling: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Prebilling), start_date: T.nilable(T.any(Integer, String))).void
}
def initialize(
billing_behavior: nil,
billing_mode: nil,
customer: nil,
customer_account: nil,
default_settings: nil,
end_behavior: nil,
expand: nil,
from_subscription: nil,
metadata: nil,
phases: nil,
prebilling: nil,
start_date: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class DefaultSettings < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax::Liability)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class BillingThresholds < Stripe::RequestParams
# Monetary threshold that triggers the subscription to advance to a new billing period
sig { returns(T.nilable(Integer)) }
def amount_gte; end
sig { params(_amount_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_gte=(_amount_gte); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
sig {
params(_reset_billing_cycle_anchor: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def reset_billing_cycle_anchor=(_reset_billing_cycle_anchor); end
sig {
params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
}
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings::Issuer)).void
}
def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end
end
class TransferData < Stripe::RequestParams
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount_percent: T.nilable(Float), destination: String).void }
def initialize(amount_percent: nil, destination: nil); end
end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
sig { params(_application_fee_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def application_fee_percent=(_application_fee_percent); end
# Default settings for automatic tax computation.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax))
}
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# 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).
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# The account on behalf of which to charge, for each of the associated subscription's invoices.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::TransferData)))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::TransferData))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::TransferData)))
}
def transfer_data=(_transfer_data); end
sig {
params(application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::BillingThresholds)), collection_method: T.nilable(String), default_payment_method: T.nilable(String), description: T.nilable(String), invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings), on_behalf_of: T.nilable(String), transfer_data: T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::TransferData))).void
}
def initialize(
application_fee_percent: nil,
automatic_tax: nil,
billing_cycle_anchor: nil,
billing_thresholds: nil,
collection_method: nil,
default_payment_method: nil,
description: nil,
invoice_settings: nil,
on_behalf_of: nil,
transfer_data: nil
); end
end
class Phase < Stripe::RequestParams
class AddInvoiceItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Period < Stripe::RequestParams
class End < Stripe::RequestParams
# A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the end of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
class Start < Stripe::RequestParams
# A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select how to calculate the start of the invoice item period.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(timestamp: T.nilable(Integer), type: String).void }
def initialize(timestamp: nil, type: nil); end
end
# End of the invoice item period.
sig {
returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Period::End)
}
def end; end
sig {
params(_end: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Period::End).returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Period::End)
}
def end=(_end); end
# Start of the invoice item period.
sig {
returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Period::Start)
}
def start; end
sig {
params(_start: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Period::Start).returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Period::Start)
}
def start=(_start); end
sig {
params(end_: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Period::End, start: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Period::Start).void
}
def initialize(end_: nil, start: nil); end
end
class PriceData < Stripe::RequestParams
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
# The coupons to redeem into discounts for the item.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount])).returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Period))
}
def period; end
sig {
params(_period: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Period)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Period))
}
def period=(_period); end
# The ID of the price object. One of `price` or `price_data` is required.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::PriceData)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::PriceData))
}
def price_data=(_price_data); end
# Quantity for this item. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount]), metadata: T.nilable(T::Hash[String, String]), period: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Period), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
}
def initialize(
discounts: nil,
metadata: nil,
period: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil
); end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax::Liability))
}
def liability; end
sig {
params(_liability: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax::Liability)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax::Liability))
}
def liability=(_liability); end
sig {
params(enabled: T::Boolean, liability: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax::Liability)).void
}
def initialize(enabled: nil, liability: nil); end
end
class BillingThresholds < Stripe::RequestParams
# Monetary threshold that triggers the subscription to advance to a new billing period
sig { returns(T.nilable(Integer)) }
def amount_gte; end
sig { params(_amount_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_gte=(_amount_gte); end
# 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.
sig { returns(T.nilable(T::Boolean)) }
def reset_billing_cycle_anchor; end
sig {
params(_reset_billing_cycle_anchor: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def reset_billing_cycle_anchor=(_reset_billing_cycle_anchor); end
sig {
params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
}
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class Duration < Stripe::RequestParams
# Specifies phase duration. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The multiplier applied to the interval.
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Type of the account referenced in the request.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(account: T.nilable(String), type: String).void }
def initialize(account: nil, type: nil); end
end
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def account_tax_ids; end
sig {
params(_account_tax_ids: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def account_tax_ids=(_account_tax_ids); end
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
sig { returns(T.nilable(Integer)) }
def days_until_due; end
sig { params(_days_until_due: T.nilable(Integer)).returns(T.nilable(Integer)) }
def days_until_due=(_days_until_due); end
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings::Issuer))
}
def issuer; end
sig {
params(_issuer: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings::Issuer)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings::Issuer))
}
def issuer=(_issuer); end
sig {
params(account_tax_ids: T.nilable(T.any(String, T::Array[String])), days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings::Issuer)).void
}
def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end
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))
sig { returns(Integer) }
def usage_gte; end
sig { params(_usage_gte: Integer).returns(Integer) }
def usage_gte=(_usage_gte); end
sig { params(usage_gte: Integer).void }
def initialize(usage_gte: nil); end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
sig { returns(T.nilable(Integer)) }
def interval_count; end
sig { params(_interval_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: T.nilable(Integer)).void }
def initialize(interval: nil, interval_count: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
sig { returns(String) }
def product; end
sig { params(_product: String).returns(String) }
def product=(_product); end
# The recurring components of a price such as `interval` and `interval_count`.
sig {
returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData::Recurring)
}
def recurring; end
sig {
params(_recurring: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData::Recurring).returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData::Recurring)
}
def recurring=(_recurring); end
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
sig { returns(T.nilable(Integer)) }
def unit_amount; end
sig { params(_unit_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_amount=(_unit_amount); end
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
sig { returns(T.nilable(String)) }
def unit_amount_decimal; end
sig { params(_unit_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_amount_decimal=(_unit_amount_decimal); end
sig {
params(currency: String, product: String, recurring: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
}
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# The coupons to redeem into discounts for the subscription item.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount])))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
sig { returns(T.nilable(String)) }
def plan; end
sig { params(_plan: T.nilable(String)).returns(T.nilable(String)) }
def plan=(_plan); end
# The ID of the price object.
sig { returns(T.nilable(String)) }
def price; end
sig { params(_price: T.nilable(String)).returns(T.nilable(String)) }
def price=(_price); end
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData))
}
def price_data; end
sig {
params(_price_data: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData))
}
def price_data=(_price_data); end
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def tax_rates=(_tax_rates); end
# Options that configure the trial on the subscription item.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Trial)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Trial))
}
def trial=(_trial); end
sig {
params(billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::BillingThresholds)), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount])), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String])), trial: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Trial)).void
}
def initialize(
billing_thresholds: nil,
discounts: nil,
metadata: nil,
plan: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
class PauseCollection < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(behavior: String).void }
def initialize(behavior: nil); end
end
class TransferData < Stripe::RequestParams
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
sig { returns(T.nilable(Float)) }
def amount_percent; end
sig { params(_amount_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def amount_percent=(_amount_percent); end
# ID of an existing, connected Stripe account.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount_percent: T.nilable(Float), destination: String).void }
def initialize(amount_percent: nil, destination: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
sig { params(_prorate_up_front: T.nilable(String)).returns(T.nilable(String)) }
def prorate_up_front=(_prorate_up_front); end
sig { params(prorate_up_front: T.nilable(String)).void }
def initialize(prorate_up_front: nil); end
end
# Defines how the subscription should behave when a trial ends.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TrialSettings::EndBehavior))
}
def end_behavior; end
sig {
params(_end_behavior: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TrialSettings::EndBehavior)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TrialSettings::EndBehavior))
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TrialSettings::EndBehavior)).void
}
def initialize(end_behavior: nil); end
end
# A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem]))
}
def add_invoice_items; end
sig {
params(_add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem])).returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem]))
}
def add_invoice_items=(_add_invoice_items); end
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
sig { returns(T.nilable(Float)) }
def application_fee_percent; end
sig { params(_application_fee_percent: T.nilable(Float)).returns(T.nilable(Float)) }
def application_fee_percent=(_application_fee_percent); end
# Automatic tax settings for this phase.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax))
}
def automatic_tax; end
sig {
params(_automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax))
}
def automatic_tax=(_automatic_tax); end
# 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).
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); 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.
sig {
returns(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::BillingThresholds)))
}
def billing_thresholds; end
sig {
params(_billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::BillingThresholds))).returns(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::BillingThresholds)))
}
def billing_thresholds=(_billing_thresholds); end
# 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.
sig { returns(T.nilable(String)) }
def collection_method; end
sig { params(_collection_method: T.nilable(String)).returns(T.nilable(String)) }
def collection_method=(_collection_method); end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig { params(_default_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def default_payment_method=(_default_payment_method); end
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def default_tax_rates; end
sig {
params(_default_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def default_tax_rates=(_default_tax_rates); end
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount])))
}
def discounts; end
sig {
params(_discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount])))
}
def discounts=(_discounts); end
# The number of intervals the phase should last. If set, `end_date` must not be set.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Duration)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Duration))
}
def duration=(_duration); end
# The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
sig { returns(T.nilable(T.any(Integer, String))) }
def end_date; end
sig {
params(_end_date: T.nilable(T.any(Integer, String))).returns(T.nilable(T.any(Integer, String)))
}
def end_date=(_end_date); end
# All invoices will be billed using the specified settings.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings))
}
def invoice_settings; end
sig {
params(_invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings))
}
def invoice_settings=(_invoice_settings); end
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
sig { returns(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item]) }
def items; end
sig {
params(_items: T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item]).returns(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item])
}
def items=(_items); end
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The account on behalf of which to charge, for each of the associated subscription's invoices.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::PauseCollection))
}
def pause_collection; end
sig {
params(_pause_collection: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::PauseCollection)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::PauseCollection))
}
def pause_collection=(_pause_collection); end
# 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.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
sig { returns(T.nilable(T.any(Integer, String))) }
def start_date; end
sig {
params(_start_date: T.nilable(T.any(Integer, String))).returns(T.nilable(T.any(Integer, String)))
}
def start_date=(_start_date); end
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TransferData))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TransferData)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TransferData))
}
def transfer_data=(_transfer_data); end
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
sig { returns(T.nilable(T::Boolean)) }
def trial; end
sig { params(_trial: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def trial=(_trial); end
# Specify trial behavior when crossing phase boundaries
sig { returns(T.nilable(String)) }
def trial_continuation; end
sig { params(_trial_continuation: T.nilable(String)).returns(T.nilable(String)) }
def trial_continuation=(_trial_continuation); end
# Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
sig { returns(T.nilable(T.any(Integer, String))) }
def trial_end; end
sig {
params(_trial_end: T.nilable(T.any(Integer, String))).returns(T.nilable(T.any(Integer, String)))
}
def trial_end=(_trial_end); end
# Settings related to subscription trials.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TrialSettings))
}
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TrialSettings)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::BillingThresholds)), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.any(String, T::Array[String])), description: T.nilable(String), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount])), duration: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Duration), end_date: T.nilable(T.any(Integer, String)), invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings), items: T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item], metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), pause_collection: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::PauseCollection), proration_behavior: T.nilable(String), start_date: T.nilable(T.any(Integer, String)), transfer_data: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TransferData), trial: T.nilable(T::Boolean), trial_continuation: T.nilable(String), trial_end: T.nilable(T.any(Integer, String)), trial_settings: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TrialSettings)).void
}
def initialize(
add_invoice_items: nil,
application_fee_percent: nil,
automatic_tax: nil,
billing_cycle_anchor: nil,
billing_thresholds: nil,
collection_method: nil,
currency: nil,
default_payment_method: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
duration: nil,
end_date: nil,
invoice_settings: nil,
items: nil,
metadata: nil,
on_behalf_of: nil,
pause_collection: nil,
proration_behavior: nil,
start_date: nil,
transfer_data: nil,
trial: nil,
trial_continuation: nil,
trial_end: nil,
trial_settings: nil
); end
end
class Prebilling < Stripe::RequestParams
# This is used to determine the number of billing cycles to prebill.
sig { returns(Integer) }
def iterations; end
sig { params(_iterations: Integer).returns(Integer) }
def iterations=(_iterations); end
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
sig { returns(T.nilable(String)) }
def update_behavior; end
sig { params(_update_behavior: T.nilable(String)).returns(T.nilable(String)) }
def update_behavior=(_update_behavior); end
sig { params(iterations: Integer, update_behavior: T.nilable(String)).void }
def initialize(iterations: nil, update_behavior: nil); end
end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
sig { returns(T.nilable(String)) }
def billing_behavior; end
sig { params(_billing_behavior: T.nilable(String)).returns(T.nilable(String)) }
def billing_behavior=(_billing_behavior); end
# Object representing the subscription schedule's default settings.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings))
}
def default_settings; end
sig {
params(_default_settings: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings))
}
def default_settings=(_default_settings); end
# Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
sig { returns(T.nilable(String)) }
def end_behavior; end
sig { params(_end_behavior: T.nilable(String)).returns(T.nilable(String)) }
def end_behavior=(_end_behavior); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase]))
}
def phases; end
sig {
params(_phases: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase])).returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase]))
}
def phases=(_phases); end
# If specified, the invoicing for the given billing cycle iterations will be processed now.
sig { returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Prebilling)) }
def prebilling; end
sig {
params(_prebilling: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Prebilling)).returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Prebilling))
}
def prebilling=(_prebilling); end
# If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
sig {
params(billing_behavior: T.nilable(String), default_settings: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings), end_behavior: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), phases: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase]), prebilling: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Prebilling), proration_behavior: T.nilable(String)).void
}
def initialize(
billing_behavior: nil,
default_settings: nil,
end_behavior: nil,
expand: nil,
metadata: nil,
phases: nil,
prebilling: nil,
proration_behavior: nil
); end
end
class AmendParams < Stripe::RequestParams
class Amendment < Stripe::RequestParams
class AmendmentEnd < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
sig { returns(String) }
def discount; end
sig { params(_discount: String).returns(String) }
def discount=(_discount); end
sig { params(discount: String).void }
def initialize(discount: nil); end
end
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Use the `end` time of a given discount.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd::DiscountEnd))
}
def discount_end=(_discount_end); end
# Time span for the amendment starting from the `amendment_start`.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select one of three ways to pass the `amendment_end`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(discount_end: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd::DiscountEnd), duration: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(discount_end: nil, duration: nil, timestamp: nil, type: nil); end
end
class AmendmentStart < Stripe::RequestParams
class AmendmentEnd < Stripe::RequestParams
# The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array.
sig { returns(Integer) }
def index; end
sig { params(_index: Integer).returns(Integer) }
def index=(_index); end
sig { params(index: Integer).void }
def initialize(index: nil); end
end
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
sig { returns(String) }
def discount; end
sig { params(_discount: String).returns(String) }
def discount=(_discount); end
sig { params(discount: String).void }
def initialize(discount: nil); end
end
# Details of another amendment in the same array, immediately after which this amendment should begin.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart::AmendmentEnd))
}
def amendment_end; end
sig {
params(_amendment_end: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart::AmendmentEnd)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart::AmendmentEnd))
}
def amendment_end=(_amendment_end); end
# Use the `end` time of a given discount.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart::DiscountEnd))
}
def discount_end=(_discount_end); end
# A precise Unix timestamp for the amendment to start.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select one of three ways to pass the `amendment_start`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(amendment_end: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart::AmendmentEnd), discount_end: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart::DiscountEnd), timestamp: T.nilable(Integer), type: String).void
}
def initialize(amendment_end: nil, discount_end: nil, timestamp: nil, type: nil); end
end
class DiscountAction < Stripe::RequestParams
class Add < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
# The coupon code to redeem.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# An ID of an existing discount for a coupon that was already redeemed.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Add::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Add::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Add::DiscountEnd))
}
def discount_end=(_discount_end); end
# The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
sig { returns(T.nilable(Integer)) }
def index; end
sig { params(_index: T.nilable(Integer)).returns(T.nilable(Integer)) }
def index=(_index); end
# The promotion code to redeem.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Add::DiscountEnd), index: T.nilable(Integer), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
index: nil,
promotion_code: nil
); end
end
class Remove < Stripe::RequestParams
# The coupon code to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# The ID of a discount to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# The ID of a promotion code to remove from the `discounts` array.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
class Set < Stripe::RequestParams
# The coupon code to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# An ID of an existing discount to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# An ID of an existing promotion code to replace the `discounts` array with.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
}
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
end
# Details of the discount to add.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Add))
}
def add; end
sig {
params(_add: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Add)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Add))
}
def add=(_add); end
# Details of the discount to remove.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Remove))
}
def remove; end
sig {
params(_remove: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Remove)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Remove))
}
def remove=(_remove); end
# Details of the discount to replace the existing discounts with.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Set))
}
def set; end
sig {
params(_set: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Set)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Set))
}
def set=(_set); end
# Determines the type of discount action.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(add: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Add), remove: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Remove), set: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Set), type: String).void
}
def initialize(add: nil, remove: nil, set: nil, type: nil); end
end
class ItemAction < Stripe::RequestParams
class Add < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); end
end
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount])).returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount]))
}
def discounts=(_discounts); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# Quantity for this item.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
# Options that configure the trial on the subscription item.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Trial)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Trial))
}
def trial=(_trial); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount]), metadata: T.nilable(T::Hash[String, String]), price: String, quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String]), trial: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Trial)).void
}
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
class Remove < Stripe::RequestParams
# ID of a price to remove.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
sig { params(price: String).void }
def initialize(price: nil); end
end
class Set < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# Time span for the redeemed discount.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration))
}
def duration=(_duration); end
# A precise Unix timestamp for the discount to end. Must be in the future.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# The type of calculation made to determine when the discount ends.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(duration: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(duration: nil, timestamp: nil, type: nil); end
end
# ID of the coupon to create a new discount for.
sig { returns(T.nilable(String)) }
def coupon; end
sig { params(_coupon: T.nilable(String)).returns(T.nilable(String)) }
def coupon=(_coupon); end
# ID of an existing discount on the object (or one of its ancestors) to reuse.
sig { returns(T.nilable(String)) }
def discount; end
sig { params(_discount: T.nilable(String)).returns(T.nilable(String)) }
def discount=(_discount); end
# Details to determine how long the discount should be applied for.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd))
}
def discount_end; end
sig {
params(_discount_end: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd))
}
def discount_end=(_discount_end); end
# ID of the promotion code to create a new discount for.
sig { returns(T.nilable(String)) }
def promotion_code; end
sig { params(_promotion_code: T.nilable(String)).returns(T.nilable(String)) }
def promotion_code=(_promotion_code); end
sig {
params(coupon: T.nilable(String), discount: T.nilable(String), discount_end: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd), promotion_code: T.nilable(String)).void
}
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
promotion_code: nil
); end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
sig { returns(T.nilable(T::Array[String])) }
def converts_to; end
sig {
params(_converts_to: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def converts_to=(_converts_to); end
# Determines the type of trial for this item.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(converts_to: T.nilable(T::Array[String]), type: String).void }
def initialize(converts_to: nil, type: nil); end
end
# If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount]))
}
def discounts; end
sig {
params(_discounts: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount])).returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount]))
}
def discounts=(_discounts); end
# If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ID of the price object.
sig { returns(String) }
def price; end
sig { params(_price: String).returns(String) }
def price=(_price); end
# If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
sig { returns(T.nilable(T::Array[String])) }
def tax_rates; end
sig {
params(_tax_rates: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def tax_rates=(_tax_rates); end
# If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Trial))
}
def trial; end
sig {
params(_trial: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Trial)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Trial))
}
def trial=(_trial); end
sig {
params(discounts: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount]), metadata: T.nilable(T::Hash[String, String]), price: String, quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String]), trial: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Trial)).void
}
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
); end
end
# Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add))
}
def add; end
sig {
params(_add: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add))
}
def add=(_add); end
# Details of the subscription item to remove.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Remove))
}
def remove; end
sig {
params(_remove: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Remove)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Remove))
}
def remove=(_remove); end
# Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set))
}
def set; end
sig {
params(_set: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set))
}
def set=(_set); end
# Determines the type of item action.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(add: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add), remove: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Remove), set: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set), type: String).void
}
def initialize(add: nil, remove: nil, set: nil, type: nil); end
end
class MetadataAction < Stripe::RequestParams
# Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
sig { returns(T.nilable(T::Hash[String, String])) }
def add; end
sig {
params(_add: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def add=(_add); end
# Keys to remove from schedule phase metadata.
sig { returns(T.nilable(T::Array[String])) }
def remove; end
sig { params(_remove: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def remove=(_remove); end
# Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def set; end
sig {
params(_set: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def set=(_set); end
# Select one of three ways to update phase-level `metadata` on subscription schedules.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(add: T.nilable(T::Hash[String, String]), remove: T.nilable(T::Array[String]), set: T.nilable(T.any(String, T::Hash[String, String])), type: String).void
}
def initialize(add: nil, remove: nil, set: nil, type: nil); end
end
class SetPauseCollection < Stripe::RequestParams
class Set < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
sig { returns(String) }
def behavior; end
sig { params(_behavior: String).returns(String) }
def behavior=(_behavior); end
sig { params(behavior: String).void }
def initialize(behavior: nil); end
end
# Details of the pause_collection behavior to apply to the amendment.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::SetPauseCollection::Set))
}
def set; end
sig {
params(_set: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::SetPauseCollection::Set)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::SetPauseCollection::Set))
}
def set=(_set); end
# Determines the type of the pause_collection amendment.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(set: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::SetPauseCollection::Set), type: String).void
}
def initialize(set: nil, type: nil); end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
sig { returns(T.nilable(String)) }
def prorate_up_front; end
sig { params(_prorate_up_front: T.nilable(String)).returns(T.nilable(String)) }
def prorate_up_front=(_prorate_up_front); end
sig { params(prorate_up_front: T.nilable(String)).void }
def initialize(prorate_up_front: nil); end
end
# Defines how the subscription should behave when a trial ends.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::TrialSettings::EndBehavior))
}
def end_behavior; end
sig {
params(_end_behavior: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::TrialSettings::EndBehavior)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::TrialSettings::EndBehavior))
}
def end_behavior=(_end_behavior); end
sig {
params(end_behavior: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::TrialSettings::EndBehavior)).void
}
def initialize(end_behavior: nil); end
end
# Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd))
}
def amendment_end; end
sig {
params(_amendment_end: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd))
}
def amendment_end=(_amendment_end); end
# Details to identify the earliest timestamp where the proposed change should take effect.
sig {
returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart)
}
def amendment_start; end
sig {
params(_amendment_start: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart).returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart)
}
def amendment_start=(_amendment_start); end
# For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
sig { returns(T.nilable(String)) }
def billing_cycle_anchor; end
sig { params(_billing_cycle_anchor: T.nilable(String)).returns(T.nilable(String)) }
def billing_cycle_anchor=(_billing_cycle_anchor); end
# Changes to the coupons being redeemed or discounts being applied during the amendment time span.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction]))
}
def discount_actions; end
sig {
params(_discount_actions: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction])).returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction]))
}
def discount_actions=(_discount_actions); end
# Changes to the subscription items during the amendment time span.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction]))
}
def item_actions; end
sig {
params(_item_actions: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction])).returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction]))
}
def item_actions=(_item_actions); end
# Instructions for how to modify phase metadata
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::MetadataAction]))
}
def metadata_actions; end
sig {
params(_metadata_actions: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::MetadataAction])).returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::MetadataAction]))
}
def metadata_actions=(_metadata_actions); end
# Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::SetPauseCollection))
}
def set_pause_collection; end
sig {
params(_set_pause_collection: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::SetPauseCollection)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::SetPauseCollection))
}
def set_pause_collection=(_set_pause_collection); end
# Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
sig { returns(T.nilable(String)) }
def set_schedule_end; end
sig { params(_set_schedule_end: T.nilable(String)).returns(T.nilable(String)) }
def set_schedule_end=(_set_schedule_end); end
# Settings related to subscription trials.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::TrialSettings))
}
def trial_settings; end
sig {
params(_trial_settings: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::TrialSettings)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::TrialSettings))
}
def trial_settings=(_trial_settings); end
sig {
params(amendment_end: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd), amendment_start: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart, billing_cycle_anchor: T.nilable(String), discount_actions: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction]), item_actions: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction]), metadata_actions: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::MetadataAction]), proration_behavior: T.nilable(String), set_pause_collection: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::SetPauseCollection), set_schedule_end: T.nilable(String), trial_settings: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::TrialSettings)).void
}
def initialize(
amendment_end: nil,
amendment_start: nil,
billing_cycle_anchor: nil,
discount_actions: nil,
item_actions: nil,
metadata_actions: nil,
proration_behavior: nil,
set_pause_collection: nil,
set_schedule_end: nil,
trial_settings: nil
); end
end
class Prebilling < Stripe::RequestParams
class BillFrom < Stripe::RequestParams
class AmendmentStart < Stripe::RequestParams
# The position of the amendment in the `amendments` array with which prebilling should begin. Indexes start from 0 and must be less than the total number of supplied amendments.
sig { returns(Integer) }
def index; end
sig { params(_index: Integer).returns(Integer) }
def index=(_index); end
sig { params(index: Integer).void }
def initialize(index: nil); end
end
# Start the prebilled period when a specified amendment begins.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillFrom::AmendmentStart))
}
def amendment_start; end
sig {
params(_amendment_start: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillFrom::AmendmentStart)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillFrom::AmendmentStart))
}
def amendment_start=(_amendment_start); end
# Start the prebilled period at a precise integer timestamp, starting from the Unix epoch.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select one of several ways to pass the `bill_from` value.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(amendment_start: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillFrom::AmendmentStart), timestamp: T.nilable(Integer), type: String).void
}
def initialize(amendment_start: nil, timestamp: nil, type: nil); end
end
class BillUntil < Stripe::RequestParams
class AmendmentEnd < Stripe::RequestParams
# The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments.
sig { returns(Integer) }
def index; end
sig { params(_index: Integer).returns(Integer) }
def index=(_index); end
sig { params(index: Integer).void }
def initialize(index: nil); end
end
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
sig { returns(String) }
def interval; end
sig { params(_interval: String).returns(String) }
def interval=(_interval); end
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
sig { returns(Integer) }
def interval_count; end
sig { params(_interval_count: Integer).returns(Integer) }
def interval_count=(_interval_count); end
sig { params(interval: String, interval_count: Integer).void }
def initialize(interval: nil, interval_count: nil); end
end
# End the prebilled period when a specified amendment ends.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil::AmendmentEnd))
}
def amendment_end; end
sig {
params(_amendment_end: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil::AmendmentEnd)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil::AmendmentEnd))
}
def amendment_end=(_amendment_end); end
# Time span for prebilling, starting from `bill_from`.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil::Duration))
}
def duration; end
sig {
params(_duration: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil::Duration)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil::Duration))
}
def duration=(_duration); end
# End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
sig { returns(T.nilable(Integer)) }
def timestamp; end
sig { params(_timestamp: T.nilable(Integer)).returns(T.nilable(Integer)) }
def timestamp=(_timestamp); end
# Select one of several ways to pass the `bill_until` value.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(amendment_end: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil::AmendmentEnd), duration: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil::Duration), timestamp: T.nilable(Integer), type: String).void
}
def initialize(amendment_end: nil, duration: nil, timestamp: nil, type: nil); end
end
# The beginning of the prebilled time period. The default value is `now`.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillFrom))
}
def bill_from; end
sig {
params(_bill_from: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillFrom)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillFrom))
}
def bill_from=(_bill_from); end
# The end of the prebilled time period.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil))
}
def bill_until; end
sig {
params(_bill_until: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil))
}
def bill_until=(_bill_until); end
# When the prebilling invoice should be created. The default value is `now`.
sig { returns(T.nilable(String)) }
def invoice_at; end
sig { params(_invoice_at: T.nilable(String)).returns(T.nilable(String)) }
def invoice_at=(_invoice_at); end
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
sig { returns(T.nilable(String)) }
def update_behavior; end
sig { params(_update_behavior: T.nilable(String)).returns(T.nilable(String)) }
def update_behavior=(_update_behavior); end
sig {
params(bill_from: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillFrom), bill_until: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil), invoice_at: T.nilable(String), update_behavior: T.nilable(String)).void
}
def initialize(bill_from: nil, bill_until: nil, invoice_at: nil, update_behavior: nil); end
end
class ScheduleSettings < Stripe::RequestParams
# Behavior of the subscription schedule and underlying subscription when it ends.
sig { returns(T.nilable(String)) }
def end_behavior; end
sig { params(_end_behavior: T.nilable(String)).returns(T.nilable(String)) }
def end_behavior=(_end_behavior); end
sig { params(end_behavior: T.nilable(String)).void }
def initialize(end_behavior: nil); end
end
# Changes to apply to the phases of the subscription schedule, in the order provided.
sig {
returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment]))
}
def amendments; end
sig {
params(_amendments: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment])).returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment]))
}
def amendments=(_amendments); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Provide any time periods to bill in advance.
sig {
returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Prebilling])))
}
def prebilling; end
sig {
params(_prebilling: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Prebilling]))).returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Prebilling])))
}
def prebilling=(_prebilling); end
# In cases where the amendment changes the currently active phase,
# specifies if and how to prorate at the time of the request.
sig { returns(T.nilable(String)) }
def proration_behavior; end
sig { params(_proration_behavior: T.nilable(String)).returns(T.nilable(String)) }
def proration_behavior=(_proration_behavior); end
# Changes to apply to the subscription schedule.
sig {
returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::ScheduleSettings))
}
def schedule_settings; end
sig {
params(_schedule_settings: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::ScheduleSettings)).returns(T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::ScheduleSettings))
}
def schedule_settings=(_schedule_settings); end
sig {
params(amendments: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment]), expand: T.nilable(T::Array[String]), prebilling: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Prebilling])), proration_behavior: T.nilable(String), schedule_settings: T.nilable(::Stripe::SubscriptionScheduleService::AmendParams::ScheduleSettings)).void
}
def initialize(
amendments: nil,
expand: nil,
prebilling: nil,
proration_behavior: nil,
schedule_settings: nil
); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def invoice_now; end
sig { params(_invoice_now: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def invoice_now=(_invoice_now); end
# If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.
sig { returns(T.nilable(T::Boolean)) }
def prorate; end
sig { params(_prorate: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def prorate=(_prorate); end
sig {
params(expand: T.nilable(T::Array[String]), invoice_now: T.nilable(T::Boolean), prorate: T.nilable(T::Boolean)).void
}
def initialize(expand: nil, invoice_now: nil, prorate: nil); end
end
class ReleaseParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Keep any cancellation on the subscription that the schedule has set
sig { returns(T.nilable(T::Boolean)) }
def preserve_cancel_date; end
sig { params(_preserve_cancel_date: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def preserve_cancel_date=(_preserve_cancel_date); end
sig {
params(expand: T.nilable(T::Array[String]), preserve_cancel_date: T.nilable(T::Boolean)).void
}
def initialize(expand: nil, preserve_cancel_date: nil); end
end
# Amends an existing subscription schedule.
sig {
params(schedule: String, params: T.any(::Stripe::SubscriptionScheduleService::AmendParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
}
def amend(schedule, params = {}, opts = {}); end
# Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
sig {
params(schedule: String, params: T.any(::Stripe::SubscriptionScheduleService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
}
def cancel(schedule, params = {}, opts = {}); end
# Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.
sig {
params(params: T.any(::Stripe::SubscriptionScheduleService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
}
def create(params = {}, opts = {}); end
# Retrieves the list of your subscription schedules.
sig {
params(params: T.any(::Stripe::SubscriptionScheduleService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
sig {
params(schedule: String, params: T.any(::Stripe::SubscriptionScheduleService::ReleaseParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
}
def release(schedule, params = {}, opts = {}); end
# Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.
sig {
params(schedule: String, params: T.any(::Stripe::SubscriptionScheduleService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
}
def retrieve(schedule, params = {}, opts = {}); end
# Updates an existing subscription schedule.
sig {
params(schedule: String, params: T.any(::Stripe::SubscriptionScheduleService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
}
def update(schedule, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class TaxService < StripeService
attr_reader :associations
attr_reader :calculations
attr_reader :forms
attr_reader :registrations
attr_reader :settings
attr_reader :transactions
end
end
# typed: true
module Stripe
module Tax
class AssociationService < StripeService
class FindParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Valid [PaymentIntent](https://stripe.com/docs/api/payment_intents/object) id
sig { returns(String) }
def payment_intent; end
sig { params(_payment_intent: String).returns(String) }
def payment_intent=(_payment_intent); end
sig { params(expand: T.nilable(T::Array[String]), payment_intent: String).void }
def initialize(expand: nil, payment_intent: nil); end
end
# Finds a tax association object by PaymentIntent id.
sig {
params(params: T.any(::Stripe::Tax::AssociationService::FindParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Association)
}
def find(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Tax
class CalculationService < StripeService
attr_reader :line_items
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class CreateParams < Stripe::RequestParams
class CustomerDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region. We recommend sending [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code value when possible.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class TaxId < Stripe::RequestParams
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Value of the tax ID.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(type: String, value: String).void }
def initialize(type: nil, value: nil); end
end
# The customer's postal address (for example, home or business location).
sig {
returns(T.nilable(::Stripe::Tax::CalculationService::CreateParams::CustomerDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::Tax::CalculationService::CreateParams::CustomerDetails::Address)).returns(T.nilable(::Stripe::Tax::CalculationService::CreateParams::CustomerDetails::Address))
}
def address=(_address); end
# The type of customer address provided.
sig { returns(T.nilable(String)) }
def address_source; end
sig { params(_address_source: T.nilable(String)).returns(T.nilable(String)) }
def address_source=(_address_source); end
# The customer's IP address (IPv4 or IPv6).
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# The customer's tax IDs. Stripe Tax might consider a transaction with applicable tax IDs to be B2B, which might affect the tax calculation result. Stripe Tax doesn't validate tax IDs for correctness.
sig {
returns(T.nilable(T::Array[::Stripe::Tax::CalculationService::CreateParams::CustomerDetails::TaxId]))
}
def tax_ids; end
sig {
params(_tax_ids: T.nilable(T::Array[::Stripe::Tax::CalculationService::CreateParams::CustomerDetails::TaxId])).returns(T.nilable(T::Array[::Stripe::Tax::CalculationService::CreateParams::CustomerDetails::TaxId]))
}
def tax_ids=(_tax_ids); end
# Overrides the tax calculation result to allow you to not collect tax from your customer. Use this if you've manually checked your customer's tax exemptions. Prefer providing the customer's `tax_ids` where possible, which automatically determines whether `reverse_charge` applies.
sig { returns(T.nilable(String)) }
def taxability_override; end
sig { params(_taxability_override: T.nilable(String)).returns(T.nilable(String)) }
def taxability_override=(_taxability_override); end
sig {
params(address: T.nilable(::Stripe::Tax::CalculationService::CreateParams::CustomerDetails::Address), address_source: T.nilable(String), ip_address: T.nilable(String), tax_ids: T.nilable(T::Array[::Stripe::Tax::CalculationService::CreateParams::CustomerDetails::TaxId]), taxability_override: T.nilable(String)).void
}
def initialize(
address: nil,
address_source: nil,
ip_address: nil,
tax_ids: nil,
taxability_override: nil
); end
end
class LineItem < Stripe::RequestParams
# A positive integer representing the line item's total price in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
# If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If provided, the product's `tax_code` will be used as the line item's `tax_code`.
sig { returns(T.nilable(String)) }
def product; end
sig { params(_product: T.nilable(String)).returns(T.nilable(String)) }
def product=(_product); end
# The number of units of the item being purchased. Used to calculate the per-unit price from the total `amount` for the line. For example, if `amount=100` and `quantity=4`, the calculated unit price is 25.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A custom identifier for this line item, which must be unique across the line items in the calculation. The reference helps identify each line item in exported [tax reports](https://stripe.com/docs/tax/reports).
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# Specifies whether the `amount` includes taxes. Defaults to `exclusive`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID to use for this line item. If not provided, we will use the tax code from the provided `product` param. If neither `tax_code` nor `product` is provided, we will use the default tax code from your Tax Settings.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
sig {
params(amount: Integer, metadata: T.nilable(T::Hash[String, String]), product: T.nilable(String), quantity: T.nilable(Integer), reference: T.nilable(String), tax_behavior: T.nilable(String), tax_code: T.nilable(String)).void
}
def initialize(
amount: nil,
metadata: nil,
product: nil,
quantity: nil,
reference: nil,
tax_behavior: nil,
tax_code: nil
); end
end
class ShipFromDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The address from which the goods are being shipped from.
sig { returns(::Stripe::Tax::CalculationService::CreateParams::ShipFromDetails::Address) }
def address; end
sig {
params(_address: ::Stripe::Tax::CalculationService::CreateParams::ShipFromDetails::Address).returns(::Stripe::Tax::CalculationService::CreateParams::ShipFromDetails::Address)
}
def address=(_address); end
sig {
params(address: ::Stripe::Tax::CalculationService::CreateParams::ShipFromDetails::Address).void
}
def initialize(address: nil); end
end
class ShippingCost < Stripe::RequestParams
# A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing the shipping charge. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# If provided, the [shipping rate](https://stripe.com/docs/api/shipping_rates/object)'s `amount`, `tax_code` and `tax_behavior` are used. If you provide a shipping rate, then you cannot pass the `amount`, `tax_code`, or `tax_behavior` parameters.
sig { returns(T.nilable(String)) }
def shipping_rate; end
sig { params(_shipping_rate: T.nilable(String)).returns(T.nilable(String)) }
def shipping_rate=(_shipping_rate); end
# Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. Defaults to `exclusive`.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# The [tax code](https://stripe.com/docs/tax/tax-categories) used to calculate tax on shipping. If not provided, the default shipping tax code from your [Tax Settings](https://dashboard.stripe.com/settings/tax) is used.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
sig {
params(amount: T.nilable(Integer), shipping_rate: T.nilable(String), tax_behavior: T.nilable(String), tax_code: T.nilable(String)).void
}
def initialize(amount: nil, shipping_rate: nil, tax_behavior: nil, tax_code: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of an existing customer to use for this calculation. If provided, the customer's address and tax IDs are copied to `customer_details`.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# Details about the customer, including address and tax IDs.
sig { returns(T.nilable(::Stripe::Tax::CalculationService::CreateParams::CustomerDetails)) }
def customer_details; end
sig {
params(_customer_details: T.nilable(::Stripe::Tax::CalculationService::CreateParams::CustomerDetails)).returns(T.nilable(::Stripe::Tax::CalculationService::CreateParams::CustomerDetails))
}
def customer_details=(_customer_details); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A list of items the customer is purchasing.
sig { returns(T::Array[::Stripe::Tax::CalculationService::CreateParams::LineItem]) }
def line_items; end
sig {
params(_line_items: T::Array[::Stripe::Tax::CalculationService::CreateParams::LineItem]).returns(T::Array[::Stripe::Tax::CalculationService::CreateParams::LineItem])
}
def line_items=(_line_items); end
# Details about the address from which the goods are being shipped.
sig { returns(T.nilable(::Stripe::Tax::CalculationService::CreateParams::ShipFromDetails)) }
def ship_from_details; end
sig {
params(_ship_from_details: T.nilable(::Stripe::Tax::CalculationService::CreateParams::ShipFromDetails)).returns(T.nilable(::Stripe::Tax::CalculationService::CreateParams::ShipFromDetails))
}
def ship_from_details=(_ship_from_details); end
# Shipping cost details to be used for the calculation.
sig { returns(T.nilable(::Stripe::Tax::CalculationService::CreateParams::ShippingCost)) }
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(::Stripe::Tax::CalculationService::CreateParams::ShippingCost)).returns(T.nilable(::Stripe::Tax::CalculationService::CreateParams::ShippingCost))
}
def shipping_cost=(_shipping_cost); end
# Timestamp of date at which the tax rules and rates in effect applies for the calculation. Measured in seconds since the Unix epoch. Can be up to 48 hours in the past, and up to 48 hours in the future.
sig { returns(T.nilable(Integer)) }
def tax_date; end
sig { params(_tax_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def tax_date=(_tax_date); end
sig {
params(currency: String, customer: T.nilable(String), customer_details: T.nilable(::Stripe::Tax::CalculationService::CreateParams::CustomerDetails), expand: T.nilable(T::Array[String]), line_items: T::Array[::Stripe::Tax::CalculationService::CreateParams::LineItem], ship_from_details: T.nilable(::Stripe::Tax::CalculationService::CreateParams::ShipFromDetails), shipping_cost: T.nilable(::Stripe::Tax::CalculationService::CreateParams::ShippingCost), tax_date: T.nilable(Integer)).void
}
def initialize(
currency: nil,
customer: nil,
customer_details: nil,
expand: nil,
line_items: nil,
ship_from_details: nil,
shipping_cost: nil,
tax_date: nil
); end
end
# Calculates tax based on the input and returns a Tax Calculation object.
sig {
params(params: T.any(::Stripe::Tax::CalculationService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Calculation)
}
def create(params = {}, opts = {}); end
# Retrieves a Tax Calculation object, if the calculation hasn't expired.
sig {
params(calculation: String, params: T.any(::Stripe::Tax::CalculationService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Calculation)
}
def retrieve(calculation, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Tax
class CalculationLineItemService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Retrieves the line items of a tax calculation as a collection, if the calculation hasn't expired.
sig {
params(calculation: String, params: T.any(::Stripe::Tax::CalculationLineItemService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(calculation, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Tax
class FormService < StripeService
class ListParams < Stripe::RequestParams
class Payee < Stripe::RequestParams
# The ID of the Stripe account whose forms will be retrieved.
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The external reference to the payee whose forms will be retrieved.
sig { returns(T.nilable(String)) }
def external_reference; end
sig { params(_external_reference: T.nilable(String)).returns(T.nilable(String)) }
def external_reference=(_external_reference); end
# Specifies the payee type. Either `account` or `external_reference`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(account: T.nilable(String), external_reference: T.nilable(String), type: T.nilable(String)).void
}
def initialize(account: nil, external_reference: nil, type: nil); end
end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The payee whose volume is represented on the tax form.
sig { returns(::Stripe::Tax::FormService::ListParams::Payee) }
def payee; end
sig {
params(_payee: ::Stripe::Tax::FormService::ListParams::Payee).returns(::Stripe::Tax::FormService::ListParams::Payee)
}
def payee=(_payee); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future tax form types. If your integration expects only one type of tax form in the response, make sure to provide a type value in the request.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payee: ::Stripe::Tax::FormService::ListParams::Payee, starting_after: T.nilable(String), type: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
payee: nil,
starting_after: nil,
type: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class PdfParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
sig {
params(params: T.any(::Stripe::Tax::FormService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Download the PDF for a tax form.
sig {
params(id: String, params: T.any(::Stripe::Tax::FormService::PdfParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, read_body_chunk_block: T.untyped).returns(T.untyped)
}
def pdf(id, params = {}, opts = {}, &read_body_chunk_block); end
# Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.
sig {
params(id: String, params: T.any(::Stripe::Tax::FormService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Form)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Tax
class RegistrationService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# The status of the Tax Registration.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class CountryOptions < Stripe::RequestParams
class Ae < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ae::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ae::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ae::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ae::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Al < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Al::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Al::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Al::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Al::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Am < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ao < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ao::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ao::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ao::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ao::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class At < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::At::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::At::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::At::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::At::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Au < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Au::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Au::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Au::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Au::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Aw < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Aw::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Aw::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Aw::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Aw::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Az < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ba < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ba::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ba::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ba::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ba::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Bb < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bb::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bb::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bb::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bb::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Bd < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bd::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bd::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bd::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bd::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Be < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Be::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Be::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Be::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Be::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Bf < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bf::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bf::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bf::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bf::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Bg < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bg::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bg::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bg::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bg::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Bh < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bh::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bh::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bh::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bh::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Bj < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Bs < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bs::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bs::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bs::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bs::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class By < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ca < Stripe::RequestParams
class ProvinceStandard < Stripe::RequestParams
# Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
sig { returns(String) }
def province; end
sig { params(_province: String).returns(String) }
def province=(_province); end
sig { params(province: String).void }
def initialize(province: nil); end
end
# Options for the provincial tax registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ca::ProvinceStandard))
}
def province_standard; end
sig {
params(_province_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ca::ProvinceStandard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ca::ProvinceStandard))
}
def province_standard=(_province_standard); end
# Type of registration to be created in Canada.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(province_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ca::ProvinceStandard), type: String).void
}
def initialize(province_standard: nil, type: nil); end
end
class Cd < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cd::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cd::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cd::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cd::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Ch < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ch::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ch::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ch::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ch::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Cl < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Cm < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Co < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Cr < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Cv < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Cy < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cy::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cy::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cy::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cy::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Cz < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cz::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cz::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cz::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cz::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class De < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::De::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::De::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::De::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::De::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Dk < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Dk::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Dk::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Dk::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Dk::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Ec < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ee < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ee::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ee::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ee::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ee::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Eg < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Es < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Es::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Es::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Es::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Es::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Et < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Et::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Et::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Et::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Et::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Fi < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Fi::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Fi::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Fi::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Fi::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Fr < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Fr::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Fr::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Fr::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Fr::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Gb < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gb::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gb::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gb::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gb::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Ge < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Gn < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gn::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gn::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gn::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gn::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Gr < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gr::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gr::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gr::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gr::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Hr < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Hr::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Hr::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Hr::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Hr::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Hu < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Hu::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Hu::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Hu::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Hu::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Id < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ie < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ie::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ie::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ie::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ie::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class In < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Is < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Is::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Is::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Is::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Is::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class It < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::It::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::It::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::It::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::It::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Jp < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Jp::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Jp::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Jp::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Jp::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Ke < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Kg < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Kh < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Kr < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Kz < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class La < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Lt < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lt::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lt::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lt::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lt::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Lu < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lu::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lu::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lu::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lu::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Lv < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lv::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lv::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lv::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lv::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Ma < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Md < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Me < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Me::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Me::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Me::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Me::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Mk < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mk::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mk::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mk::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mk::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Mr < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mr::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mr::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mr::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mr::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Mt < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mt::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mt::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mt::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mt::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Mx < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class My < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ng < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Nl < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Nl::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Nl::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Nl::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Nl::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class No < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::No::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::No::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::No::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::No::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Np < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Nz < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Nz::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Nz::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Nz::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Nz::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Om < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Om::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Om::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Om::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Om::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Pe < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ph < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Pl < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pl::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pl::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pl::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pl::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Pt < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pt::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pt::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pt::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pt::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Ro < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ro::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ro::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ro::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ro::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Rs < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Rs::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Rs::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Rs::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Rs::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Ru < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Sa < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Se < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Se::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Se::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Se::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Se::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Sg < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sg::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sg::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sg::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sg::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Si < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Si::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Si::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Si::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Si::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Sk < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an EU standard registration.
sig { returns(String) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: String).returns(String) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: String).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sk::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sk::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sk::Standard))
}
def standard=(_standard); end
# Type of registration to be created in an EU country.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sk::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Sn < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Sr < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sr::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sr::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sr::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sr::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Th < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Tj < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Tr < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Tz < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ua < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Ug < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Us < Stripe::RequestParams
class LocalAmusementTax < Stripe::RequestParams
# A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), and `68081` (Schiller Park).
sig { returns(String) }
def jurisdiction; end
sig { params(_jurisdiction: String).returns(String) }
def jurisdiction=(_jurisdiction); end
sig { params(jurisdiction: String).void }
def initialize(jurisdiction: nil); end
end
class LocalLeaseTax < Stripe::RequestParams
# A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago).
sig { returns(String) }
def jurisdiction; end
sig { params(_jurisdiction: String).returns(String) }
def jurisdiction=(_jurisdiction); end
sig { params(jurisdiction: String).void }
def initialize(jurisdiction: nil); end
end
class StateSalesTax < Stripe::RequestParams
class Election < Stripe::RequestParams
# A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `003` (Allegheny County) and `60000` (Philadelphia City).
sig { returns(T.nilable(String)) }
def jurisdiction; end
sig { params(_jurisdiction: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction=(_jurisdiction); end
# The type of the election for the state sales tax registration.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(jurisdiction: T.nilable(String), type: String).void }
def initialize(jurisdiction: nil, type: nil); end
end
# Elections for the state sales tax registration.
sig {
returns(T::Array[::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us::StateSalesTax::Election])
}
def elections; end
sig {
params(_elections: T::Array[::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us::StateSalesTax::Election]).returns(T::Array[::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us::StateSalesTax::Election])
}
def elections=(_elections); end
sig {
params(elections: T::Array[::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us::StateSalesTax::Election]).void
}
def initialize(elections: nil); end
end
# Options for the local amusement tax registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us::LocalAmusementTax))
}
def local_amusement_tax; end
sig {
params(_local_amusement_tax: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us::LocalAmusementTax)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us::LocalAmusementTax))
}
def local_amusement_tax=(_local_amusement_tax); end
# Options for the local lease tax registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us::LocalLeaseTax))
}
def local_lease_tax; end
sig {
params(_local_lease_tax: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us::LocalLeaseTax)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us::LocalLeaseTax))
}
def local_lease_tax=(_local_lease_tax); end
# Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
sig { returns(String) }
def state; end
sig { params(_state: String).returns(String) }
def state=(_state); end
# Options for the state sales tax registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us::StateSalesTax))
}
def state_sales_tax; end
sig {
params(_state_sales_tax: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us::StateSalesTax)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us::StateSalesTax))
}
def state_sales_tax=(_state_sales_tax); end
# Type of registration to be created in the US.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(local_amusement_tax: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us::LocalAmusementTax), local_lease_tax: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us::LocalLeaseTax), state: String, state_sales_tax: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us::StateSalesTax), type: String).void
}
def initialize(
local_amusement_tax: nil,
local_lease_tax: nil,
state: nil,
state_sales_tax: nil,
type: nil
); end
end
class Uy < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Uy::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Uy::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Uy::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Uy::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Uz < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Vn < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Za < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Za::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Za::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Za::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Za::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
class Zm < Stripe::RequestParams
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(type: String).void }
def initialize(type: nil); end
end
class Zw < Stripe::RequestParams
class Standard < Stripe::RequestParams
# Place of supply scheme used in an standard registration.
sig { returns(T.nilable(String)) }
def place_of_supply_scheme; end
sig { params(_place_of_supply_scheme: T.nilable(String)).returns(T.nilable(String)) }
def place_of_supply_scheme=(_place_of_supply_scheme); end
sig { params(place_of_supply_scheme: T.nilable(String)).void }
def initialize(place_of_supply_scheme: nil); end
end
# Options for the standard registration.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Zw::Standard))
}
def standard; end
sig {
params(_standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Zw::Standard)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Zw::Standard))
}
def standard=(_standard); end
# Type of registration to be created in `country`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(standard: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Zw::Standard), type: String).void
}
def initialize(standard: nil, type: nil); end
end
# Options for the registration in AE.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ae))
}
def ae; end
sig {
params(_ae: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ae)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ae))
}
def ae=(_ae); end
# Options for the registration in AL.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Al))
}
def al; end
sig {
params(_al: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Al)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Al))
}
def al=(_al); end
# Options for the registration in AM.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Am))
}
def am; end
sig {
params(_am: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Am)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Am))
}
def am=(_am); end
# Options for the registration in AO.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ao))
}
def ao; end
sig {
params(_ao: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ao)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ao))
}
def ao=(_ao); end
# Options for the registration in AT.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::At))
}
def at; end
sig {
params(_at: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::At)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::At))
}
def at=(_at); end
# Options for the registration in AU.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Au))
}
def au; end
sig {
params(_au: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Au)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Au))
}
def au=(_au); end
# Options for the registration in AW.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Aw))
}
def aw; end
sig {
params(_aw: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Aw)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Aw))
}
def aw=(_aw); end
# Options for the registration in AZ.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Az))
}
def az; end
sig {
params(_az: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Az)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Az))
}
def az=(_az); end
# Options for the registration in BA.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ba))
}
def ba; end
sig {
params(_ba: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ba)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ba))
}
def ba=(_ba); end
# Options for the registration in BB.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bb))
}
def bb; end
sig {
params(_bb: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bb)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bb))
}
def bb=(_bb); end
# Options for the registration in BD.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bd))
}
def bd; end
sig {
params(_bd: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bd)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bd))
}
def bd=(_bd); end
# Options for the registration in BE.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Be))
}
def be; end
sig {
params(_be: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Be)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Be))
}
def be=(_be); end
# Options for the registration in BF.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bf))
}
def bf; end
sig {
params(_bf: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bf)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bf))
}
def bf=(_bf); end
# Options for the registration in BG.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bg))
}
def bg; end
sig {
params(_bg: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bg)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bg))
}
def bg=(_bg); end
# Options for the registration in BH.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bh))
}
def bh; end
sig {
params(_bh: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bh)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bh))
}
def bh=(_bh); end
# Options for the registration in BJ.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bj))
}
def bj; end
sig {
params(_bj: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bj)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bj))
}
def bj=(_bj); end
# Options for the registration in BS.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bs))
}
def bs; end
sig {
params(_bs: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bs)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bs))
}
def bs=(_bs); end
# Options for the registration in BY.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::By))
}
def by; end
sig {
params(_by: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::By)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::By))
}
def by=(_by); end
# Options for the registration in CA.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ca))
}
def ca; end
sig {
params(_ca: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ca)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ca))
}
def ca=(_ca); end
# Options for the registration in CD.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cd))
}
def cd; end
sig {
params(_cd: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cd)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cd))
}
def cd=(_cd); end
# Options for the registration in CH.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ch))
}
def ch; end
sig {
params(_ch: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ch)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ch))
}
def ch=(_ch); end
# Options for the registration in CL.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cl))
}
def cl; end
sig {
params(_cl: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cl)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cl))
}
def cl=(_cl); end
# Options for the registration in CM.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cm))
}
def cm; end
sig {
params(_cm: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cm)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cm))
}
def cm=(_cm); end
# Options for the registration in CO.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Co))
}
def co; end
sig {
params(_co: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Co)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Co))
}
def co=(_co); end
# Options for the registration in CR.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cr))
}
def cr; end
sig {
params(_cr: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cr)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cr))
}
def cr=(_cr); end
# Options for the registration in CV.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cv))
}
def cv; end
sig {
params(_cv: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cv)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cv))
}
def cv=(_cv); end
# Options for the registration in CY.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cy))
}
def cy; end
sig {
params(_cy: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cy)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cy))
}
def cy=(_cy); end
# Options for the registration in CZ.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cz))
}
def cz; end
sig {
params(_cz: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cz)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cz))
}
def cz=(_cz); end
# Options for the registration in DE.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::De))
}
def de; end
sig {
params(_de: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::De)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::De))
}
def de=(_de); end
# Options for the registration in DK.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Dk))
}
def dk; end
sig {
params(_dk: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Dk)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Dk))
}
def dk=(_dk); end
# Options for the registration in EC.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ec))
}
def ec; end
sig {
params(_ec: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ec)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ec))
}
def ec=(_ec); end
# Options for the registration in EE.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ee))
}
def ee; end
sig {
params(_ee: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ee)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ee))
}
def ee=(_ee); end
# Options for the registration in EG.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Eg))
}
def eg; end
sig {
params(_eg: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Eg)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Eg))
}
def eg=(_eg); end
# Options for the registration in ES.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Es))
}
def es; end
sig {
params(_es: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Es)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Es))
}
def es=(_es); end
# Options for the registration in ET.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Et))
}
def et; end
sig {
params(_et: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Et)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Et))
}
def et=(_et); end
# Options for the registration in FI.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Fi))
}
def fi; end
sig {
params(_fi: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Fi)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Fi))
}
def fi=(_fi); end
# Options for the registration in FR.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Fr))
}
def fr; end
sig {
params(_fr: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Fr)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Fr))
}
def fr=(_fr); end
# Options for the registration in GB.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gb))
}
def gb; end
sig {
params(_gb: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gb)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gb))
}
def gb=(_gb); end
# Options for the registration in GE.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ge))
}
def ge; end
sig {
params(_ge: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ge)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ge))
}
def ge=(_ge); end
# Options for the registration in GN.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gn))
}
def gn; end
sig {
params(_gn: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gn)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gn))
}
def gn=(_gn); end
# Options for the registration in GR.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gr))
}
def gr; end
sig {
params(_gr: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gr)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gr))
}
def gr=(_gr); end
# Options for the registration in HR.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Hr))
}
def hr; end
sig {
params(_hr: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Hr)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Hr))
}
def hr=(_hr); end
# Options for the registration in HU.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Hu))
}
def hu; end
sig {
params(_hu: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Hu)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Hu))
}
def hu=(_hu); end
# Options for the registration in ID.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Id))
}
def id; end
sig {
params(_id: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Id)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Id))
}
def id=(_id); end
# Options for the registration in IE.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ie))
}
def ie; end
sig {
params(_ie: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ie)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ie))
}
def ie=(_ie); end
# Options for the registration in IN.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::In))
}
def in; end
sig {
params(_in: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::In)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::In))
}
def in=(_in); end
# Options for the registration in IS.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Is))
}
def is; end
sig {
params(_is: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Is)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Is))
}
def is=(_is); end
# Options for the registration in IT.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::It))
}
def it; end
sig {
params(_it: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::It)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::It))
}
def it=(_it); end
# Options for the registration in JP.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Jp))
}
def jp; end
sig {
params(_jp: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Jp)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Jp))
}
def jp=(_jp); end
# Options for the registration in KE.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ke))
}
def ke; end
sig {
params(_ke: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ke)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ke))
}
def ke=(_ke); end
# Options for the registration in KG.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Kg))
}
def kg; end
sig {
params(_kg: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Kg)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Kg))
}
def kg=(_kg); end
# Options for the registration in KH.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Kh))
}
def kh; end
sig {
params(_kh: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Kh)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Kh))
}
def kh=(_kh); end
# Options for the registration in KR.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Kr))
}
def kr; end
sig {
params(_kr: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Kr)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Kr))
}
def kr=(_kr); end
# Options for the registration in KZ.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Kz))
}
def kz; end
sig {
params(_kz: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Kz)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Kz))
}
def kz=(_kz); end
# Options for the registration in LA.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::La))
}
def la; end
sig {
params(_la: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::La)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::La))
}
def la=(_la); end
# Options for the registration in LT.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lt))
}
def lt; end
sig {
params(_lt: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lt)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lt))
}
def lt=(_lt); end
# Options for the registration in LU.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lu))
}
def lu; end
sig {
params(_lu: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lu)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lu))
}
def lu=(_lu); end
# Options for the registration in LV.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lv))
}
def lv; end
sig {
params(_lv: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lv)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lv))
}
def lv=(_lv); end
# Options for the registration in MA.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ma))
}
def ma; end
sig {
params(_ma: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ma)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ma))
}
def ma=(_ma); end
# Options for the registration in MD.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Md))
}
def md; end
sig {
params(_md: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Md)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Md))
}
def md=(_md); end
# Options for the registration in ME.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Me))
}
def me; end
sig {
params(_me: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Me)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Me))
}
def me=(_me); end
# Options for the registration in MK.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mk))
}
def mk; end
sig {
params(_mk: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mk)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mk))
}
def mk=(_mk); end
# Options for the registration in MR.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mr))
}
def mr; end
sig {
params(_mr: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mr)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mr))
}
def mr=(_mr); end
# Options for the registration in MT.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mt))
}
def mt; end
sig {
params(_mt: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mt)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mt))
}
def mt=(_mt); end
# Options for the registration in MX.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mx))
}
def mx; end
sig {
params(_mx: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mx)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mx))
}
def mx=(_mx); end
# Options for the registration in MY.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::My))
}
def my; end
sig {
params(_my: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::My)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::My))
}
def my=(_my); end
# Options for the registration in NG.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ng))
}
def ng; end
sig {
params(_ng: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ng)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ng))
}
def ng=(_ng); end
# Options for the registration in NL.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Nl))
}
def nl; end
sig {
params(_nl: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Nl)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Nl))
}
def nl=(_nl); end
# Options for the registration in NO.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::No))
}
def no; end
sig {
params(_no: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::No)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::No))
}
def no=(_no); end
# Options for the registration in NP.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Np))
}
def np; end
sig {
params(_np: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Np)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Np))
}
def np=(_np); end
# Options for the registration in NZ.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Nz))
}
def nz; end
sig {
params(_nz: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Nz)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Nz))
}
def nz=(_nz); end
# Options for the registration in OM.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Om))
}
def om; end
sig {
params(_om: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Om)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Om))
}
def om=(_om); end
# Options for the registration in PE.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pe))
}
def pe; end
sig {
params(_pe: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pe)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pe))
}
def pe=(_pe); end
# Options for the registration in PH.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ph))
}
def ph; end
sig {
params(_ph: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ph)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ph))
}
def ph=(_ph); end
# Options for the registration in PL.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pl))
}
def pl; end
sig {
params(_pl: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pl)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pl))
}
def pl=(_pl); end
# Options for the registration in PT.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pt))
}
def pt; end
sig {
params(_pt: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pt)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pt))
}
def pt=(_pt); end
# Options for the registration in RO.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ro))
}
def ro; end
sig {
params(_ro: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ro)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ro))
}
def ro=(_ro); end
# Options for the registration in RS.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Rs))
}
def rs; end
sig {
params(_rs: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Rs)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Rs))
}
def rs=(_rs); end
# Options for the registration in RU.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ru))
}
def ru; end
sig {
params(_ru: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ru)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ru))
}
def ru=(_ru); end
# Options for the registration in SA.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sa))
}
def sa; end
sig {
params(_sa: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sa)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sa))
}
def sa=(_sa); end
# Options for the registration in SE.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Se))
}
def se; end
sig {
params(_se: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Se)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Se))
}
def se=(_se); end
# Options for the registration in SG.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sg))
}
def sg; end
sig {
params(_sg: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sg)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sg))
}
def sg=(_sg); end
# Options for the registration in SI.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Si))
}
def si; end
sig {
params(_si: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Si)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Si))
}
def si=(_si); end
# Options for the registration in SK.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sk))
}
def sk; end
sig {
params(_sk: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sk)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sk))
}
def sk=(_sk); end
# Options for the registration in SN.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sn))
}
def sn; end
sig {
params(_sn: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sn)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sn))
}
def sn=(_sn); end
# Options for the registration in SR.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sr))
}
def sr; end
sig {
params(_sr: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sr)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sr))
}
def sr=(_sr); end
# Options for the registration in TH.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Th))
}
def th; end
sig {
params(_th: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Th)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Th))
}
def th=(_th); end
# Options for the registration in TJ.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Tj))
}
def tj; end
sig {
params(_tj: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Tj)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Tj))
}
def tj=(_tj); end
# Options for the registration in TR.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Tr))
}
def tr; end
sig {
params(_tr: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Tr)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Tr))
}
def tr=(_tr); end
# Options for the registration in TZ.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Tz))
}
def tz; end
sig {
params(_tz: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Tz)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Tz))
}
def tz=(_tz); end
# Options for the registration in UA.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ua))
}
def ua; end
sig {
params(_ua: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ua)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ua))
}
def ua=(_ua); end
# Options for the registration in UG.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ug))
}
def ug; end
sig {
params(_ug: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ug)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ug))
}
def ug=(_ug); end
# Options for the registration in US.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us))
}
def us; end
sig {
params(_us: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us))
}
def us=(_us); end
# Options for the registration in UY.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Uy))
}
def uy; end
sig {
params(_uy: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Uy)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Uy))
}
def uy=(_uy); end
# Options for the registration in UZ.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Uz))
}
def uz; end
sig {
params(_uz: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Uz)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Uz))
}
def uz=(_uz); end
# Options for the registration in VN.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Vn))
}
def vn; end
sig {
params(_vn: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Vn)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Vn))
}
def vn=(_vn); end
# Options for the registration in ZA.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Za))
}
def za; end
sig {
params(_za: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Za)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Za))
}
def za=(_za); end
# Options for the registration in ZM.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Zm))
}
def zm; end
sig {
params(_zm: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Zm)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Zm))
}
def zm=(_zm); end
# Options for the registration in ZW.
sig {
returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Zw))
}
def zw; end
sig {
params(_zw: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Zw)).returns(T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Zw))
}
def zw=(_zw); end
sig {
params(ae: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ae), al: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Al), am: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Am), ao: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ao), at: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::At), au: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Au), aw: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Aw), az: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Az), ba: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ba), bb: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bb), bd: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bd), be: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Be), bf: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bf), bg: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bg), bh: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bh), bj: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bj), bs: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Bs), by: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::By), ca: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ca), cd: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cd), ch: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ch), cl: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cl), cm: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cm), co: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Co), cr: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cr), cv: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cv), cy: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cy), cz: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Cz), de: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::De), dk: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Dk), ec: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ec), ee: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ee), eg: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Eg), es: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Es), et: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Et), fi: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Fi), fr: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Fr), gb: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gb), ge: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ge), gn: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gn), gr: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Gr), hr: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Hr), hu: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Hu), id: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Id), ie: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ie), in_: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::In), is: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Is), it: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::It), jp: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Jp), ke: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ke), kg: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Kg), kh: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Kh), kr: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Kr), kz: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Kz), la: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::La), lt: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lt), lu: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lu), lv: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Lv), ma: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ma), md: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Md), me: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Me), mk: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mk), mr: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mr), mt: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mt), mx: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Mx), my: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::My), ng: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ng), nl: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Nl), no: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::No), np: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Np), nz: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Nz), om: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Om), pe: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pe), ph: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ph), pl: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pl), pt: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Pt), ro: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ro), rs: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Rs), ru: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ru), sa: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sa), se: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Se), sg: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sg), si: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Si), sk: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sk), sn: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sn), sr: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Sr), th: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Th), tj: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Tj), tr: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Tr), tz: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Tz), ua: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ua), ug: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Ug), us: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Us), uy: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Uy), uz: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Uz), vn: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Vn), za: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Za), zm: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Zm), zw: T.nilable(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions::Zw)).void
}
def initialize(
ae: nil,
al: nil,
am: nil,
ao: nil,
at: nil,
au: nil,
aw: nil,
az: nil,
ba: nil,
bb: nil,
bd: nil,
be: nil,
bf: nil,
bg: nil,
bh: nil,
bj: nil,
bs: nil,
by: nil,
ca: nil,
cd: nil,
ch: nil,
cl: nil,
cm: nil,
co: nil,
cr: nil,
cv: nil,
cy: nil,
cz: nil,
de: nil,
dk: nil,
ec: nil,
ee: nil,
eg: nil,
es: nil,
et: nil,
fi: nil,
fr: nil,
gb: nil,
ge: nil,
gn: nil,
gr: nil,
hr: nil,
hu: nil,
id: nil,
ie: nil,
in_: nil,
is: nil,
it: nil,
jp: nil,
ke: nil,
kg: nil,
kh: nil,
kr: nil,
kz: nil,
la: nil,
lt: nil,
lu: nil,
lv: nil,
ma: nil,
md: nil,
me: nil,
mk: nil,
mr: nil,
mt: nil,
mx: nil,
my: nil,
ng: nil,
nl: nil,
no: nil,
np: nil,
nz: nil,
om: nil,
pe: nil,
ph: nil,
pl: nil,
pt: nil,
ro: nil,
rs: nil,
ru: nil,
sa: nil,
se: nil,
sg: nil,
si: nil,
sk: nil,
sn: nil,
sr: nil,
th: nil,
tj: nil,
tr: nil,
tz: nil,
ua: nil,
ug: nil,
us: nil,
uy: nil,
uz: nil,
vn: nil,
za: nil,
zm: nil,
zw: nil
); end
end
# Time at which the Tax Registration becomes active. It can be either `now` to indicate the current time, or a future timestamp measured in seconds since the Unix epoch.
sig { returns(T.any(String, Integer)) }
def active_from; end
sig { params(_active_from: T.any(String, Integer)).returns(T.any(String, Integer)) }
def active_from=(_active_from); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Specific options for a registration in the specified `country`.
sig { returns(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions) }
def country_options; end
sig {
params(_country_options: ::Stripe::Tax::RegistrationService::CreateParams::CountryOptions).returns(::Stripe::Tax::RegistrationService::CreateParams::CountryOptions)
}
def country_options=(_country_options); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch.
sig { returns(T.nilable(Integer)) }
def expires_at; end
sig { params(_expires_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def expires_at=(_expires_at); end
sig {
params(active_from: T.any(String, Integer), country: String, country_options: ::Stripe::Tax::RegistrationService::CreateParams::CountryOptions, expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer)).void
}
def initialize(
active_from: nil,
country: nil,
country_options: nil,
expand: nil,
expires_at: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Time at which the registration becomes active. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch.
sig { returns(T.nilable(T.any(String, Integer))) }
def active_from; end
sig {
params(_active_from: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer)))
}
def active_from=(_active_from); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch.
sig { returns(T.nilable(T.any(String, T.any(String, Integer)))) }
def expires_at; end
sig {
params(_expires_at: T.nilable(T.any(String, T.any(String, Integer)))).returns(T.nilable(T.any(String, T.any(String, Integer))))
}
def expires_at=(_expires_at); end
sig {
params(active_from: T.nilable(T.any(String, Integer)), expand: T.nilable(T::Array[String]), expires_at: T.nilable(T.any(String, T.any(String, Integer)))).void
}
def initialize(active_from: nil, expand: nil, expires_at: nil); end
end
# Creates a new Tax Registration object.
sig {
params(params: T.any(::Stripe::Tax::RegistrationService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Registration)
}
def create(params = {}, opts = {}); end
# Returns a list of Tax Registration objects.
sig {
params(params: T.any(::Stripe::Tax::RegistrationService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Returns a Tax Registration object.
sig {
params(id: String, params: T.any(::Stripe::Tax::RegistrationService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Registration)
}
def retrieve(id, params = {}, opts = {}); end
# Updates an existing Tax Registration object.
#
# A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.
sig {
params(id: String, params: T.any(::Stripe::Tax::RegistrationService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Registration)
}
def update(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Tax
class SettingsService < StripeService
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Defaults < Stripe::RequestParams
# Specifies the default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) to be used when the item's price has unspecified tax behavior. One of inclusive, exclusive, or inferred_by_currency. Once specified, it cannot be changed back to null.
sig { returns(T.nilable(String)) }
def tax_behavior; end
sig { params(_tax_behavior: T.nilable(String)).returns(T.nilable(String)) }
def tax_behavior=(_tax_behavior); end
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
sig { returns(T.nilable(String)) }
def tax_code; end
sig { params(_tax_code: T.nilable(String)).returns(T.nilable(String)) }
def tax_code=(_tax_code); end
sig { params(tax_behavior: T.nilable(String), tax_code: T.nilable(String)).void }
def initialize(tax_behavior: nil, tax_code: nil); end
end
class HeadOffice < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# The location of the business for tax purposes.
sig { returns(::Stripe::Tax::SettingsService::UpdateParams::HeadOffice::Address) }
def address; end
sig {
params(_address: ::Stripe::Tax::SettingsService::UpdateParams::HeadOffice::Address).returns(::Stripe::Tax::SettingsService::UpdateParams::HeadOffice::Address)
}
def address=(_address); end
sig {
params(address: ::Stripe::Tax::SettingsService::UpdateParams::HeadOffice::Address).void
}
def initialize(address: nil); end
end
# Default configuration to be used on Stripe Tax calculations.
sig { returns(T.nilable(::Stripe::Tax::SettingsService::UpdateParams::Defaults)) }
def defaults; end
sig {
params(_defaults: T.nilable(::Stripe::Tax::SettingsService::UpdateParams::Defaults)).returns(T.nilable(::Stripe::Tax::SettingsService::UpdateParams::Defaults))
}
def defaults=(_defaults); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The place where your business is located.
sig { returns(T.nilable(::Stripe::Tax::SettingsService::UpdateParams::HeadOffice)) }
def head_office; end
sig {
params(_head_office: T.nilable(::Stripe::Tax::SettingsService::UpdateParams::HeadOffice)).returns(T.nilable(::Stripe::Tax::SettingsService::UpdateParams::HeadOffice))
}
def head_office=(_head_office); end
sig {
params(defaults: T.nilable(::Stripe::Tax::SettingsService::UpdateParams::Defaults), expand: T.nilable(T::Array[String]), head_office: T.nilable(::Stripe::Tax::SettingsService::UpdateParams::HeadOffice)).void
}
def initialize(defaults: nil, expand: nil, head_office: nil); end
end
# Retrieves Tax Settings for a merchant.
sig {
params(params: T.any(::Stripe::Tax::SettingsService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Settings)
}
def retrieve(params = {}, opts = {}); end
# Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.
sig {
params(params: T.any(::Stripe::Tax::SettingsService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Settings)
}
def update(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Tax
class TransactionService < StripeService
attr_reader :line_items
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class CreateFromCalculationParams < Stripe::RequestParams
# Tax Calculation ID to be used as input when creating the transaction.
sig { returns(String) }
def calculation; end
sig { params(_calculation: String).returns(String) }
def calculation=(_calculation); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the `tax_date` and the current time, unless the `tax_date` is scheduled in advance. Defaults to the current time.
sig { returns(T.nilable(Integer)) }
def posted_at; end
sig { params(_posted_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def posted_at=(_posted_at); end
# A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(calculation: String, expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), posted_at: T.nilable(Integer), reference: String).void
}
def initialize(
calculation: nil,
expand: nil,
metadata: nil,
posted_at: nil,
reference: nil
); end
end
class CreateReversalParams < Stripe::RequestParams
class LineItem < Stripe::RequestParams
# The amount to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The amount of tax to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative.
sig { returns(Integer) }
def amount_tax; end
sig { params(_amount_tax: Integer).returns(Integer) }
def amount_tax=(_amount_tax); end
# 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The `id` of the line item to reverse in the original transaction.
sig { returns(String) }
def original_line_item; end
sig { params(_original_line_item: String).returns(String) }
def original_line_item=(_original_line_item); end
# The quantity reversed. Appears in [tax exports](https://stripe.com/docs/tax/reports), but does not affect the amount of tax reversed.
sig { returns(T.nilable(Integer)) }
def quantity; end
sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) }
def quantity=(_quantity); end
# A custom identifier for this line item in the reversal transaction, such as 'L1-refund'.
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
sig {
params(amount: Integer, amount_tax: Integer, metadata: T.nilable(T::Hash[String, String]), original_line_item: String, quantity: T.nilable(Integer), reference: String).void
}
def initialize(
amount: nil,
amount_tax: nil,
metadata: nil,
original_line_item: nil,
quantity: nil,
reference: nil
); end
end
class ShippingCost < Stripe::RequestParams
# The amount to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The amount of tax to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative.
sig { returns(Integer) }
def amount_tax; end
sig { params(_amount_tax: Integer).returns(Integer) }
def amount_tax=(_amount_tax); end
sig { params(amount: Integer, amount_tax: Integer).void }
def initialize(amount: nil, amount_tax: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes.
sig { returns(T.nilable(Integer)) }
def flat_amount; end
sig { params(_flat_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def flat_amount=(_flat_amount); end
# The line item amounts to reverse.
sig {
returns(T.nilable(T::Array[::Stripe::Tax::TransactionService::CreateReversalParams::LineItem]))
}
def line_items; end
sig {
params(_line_items: T.nilable(T::Array[::Stripe::Tax::TransactionService::CreateReversalParams::LineItem])).returns(T.nilable(T::Array[::Stripe::Tax::TransactionService::CreateReversalParams::LineItem]))
}
def line_items=(_line_items); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If `partial`, the provided line item or shipping cost amounts are reversed. If `full`, the original transaction is fully reversed.
sig { returns(String) }
def mode; end
sig { params(_mode: String).returns(String) }
def mode=(_mode); end
# The ID of the Transaction to partially or fully reverse.
sig { returns(String) }
def original_transaction; end
sig { params(_original_transaction: String).returns(String) }
def original_transaction=(_original_transaction); end
# A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://stripe.com/docs/tax/reports).
sig { returns(String) }
def reference; end
sig { params(_reference: String).returns(String) }
def reference=(_reference); end
# The shipping cost to reverse.
sig {
returns(T.nilable(::Stripe::Tax::TransactionService::CreateReversalParams::ShippingCost))
}
def shipping_cost; end
sig {
params(_shipping_cost: T.nilable(::Stripe::Tax::TransactionService::CreateReversalParams::ShippingCost)).returns(T.nilable(::Stripe::Tax::TransactionService::CreateReversalParams::ShippingCost))
}
def shipping_cost=(_shipping_cost); end
sig {
params(expand: T.nilable(T::Array[String]), flat_amount: T.nilable(Integer), line_items: T.nilable(T::Array[::Stripe::Tax::TransactionService::CreateReversalParams::LineItem]), metadata: T.nilable(T::Hash[String, String]), mode: String, original_transaction: String, reference: String, shipping_cost: T.nilable(::Stripe::Tax::TransactionService::CreateReversalParams::ShippingCost)).void
}
def initialize(
expand: nil,
flat_amount: nil,
line_items: nil,
metadata: nil,
mode: nil,
original_transaction: nil,
reference: nil,
shipping_cost: nil
); end
end
# Creates a Tax Transaction from a calculation, if that calculation hasn't expired. Calculations expire after 90 days.
sig {
params(params: T.any(::Stripe::Tax::TransactionService::CreateFromCalculationParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Transaction)
}
def create_from_calculation(params = {}, opts = {}); end
# Partially or fully reverses a previously created Transaction.
sig {
params(params: T.any(::Stripe::Tax::TransactionService::CreateReversalParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Transaction)
}
def create_reversal(params = {}, opts = {}); end
# Retrieves a Tax Transaction object.
sig {
params(transaction: String, params: T.any(::Stripe::Tax::TransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Tax::Transaction)
}
def retrieve(transaction, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Tax
class TransactionLineItemService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
# Retrieves the line items of a committed standalone transaction as a collection.
sig {
params(transaction: String, params: T.any(::Stripe::Tax::TransactionLineItemService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(transaction, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class TaxCodeService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# A list of [all tax codes available](https://stripe.com/docs/tax/tax-categories) to add to Products in order to allow specific tax calculations.
sig {
params(params: T.any(::Stripe::TaxCodeService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.
sig {
params(id: String, params: T.any(::Stripe::TaxCodeService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TaxCode)
}
def retrieve(id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class TaxIdService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ListParams < Stripe::RequestParams
class Owner < Stripe::RequestParams
# Account the tax ID belongs to. Required when `type=account`
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Customer the tax ID belongs to. Required when `type=customer`
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# v2 Account the tax ID belongs to. Can be used in place of `customer` when `type=customer`
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Type of owner referenced.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(account: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), type: String).void
}
def initialize(account: nil, customer: nil, customer_account: nil, type: nil); end
end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.
sig { returns(T.nilable(::Stripe::TaxIdService::ListParams::Owner)) }
def owner; end
sig {
params(_owner: T.nilable(::Stripe::TaxIdService::ListParams::Owner)).returns(T.nilable(::Stripe::TaxIdService::ListParams::Owner))
}
def owner=(_owner); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), owner: T.nilable(::Stripe::TaxIdService::ListParams::Owner), starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
limit: nil,
owner: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class Owner < Stripe::RequestParams
# Account the tax ID belongs to. Required when `type=account`
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# Customer the tax ID belongs to. Required when `type=customer`
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# v2 Account the tax ID belongs to. Can be used in place of `customer` when `type=customer`
sig { returns(T.nilable(String)) }
def customer_account; end
sig { params(_customer_account: T.nilable(String)).returns(T.nilable(String)) }
def customer_account=(_customer_account); end
# Type of owner referenced.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(account: T.nilable(String), customer: T.nilable(String), customer_account: T.nilable(String), type: String).void
}
def initialize(account: nil, customer: nil, customer_account: nil, type: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.
sig { returns(T.nilable(::Stripe::TaxIdService::CreateParams::Owner)) }
def owner; end
sig {
params(_owner: T.nilable(::Stripe::TaxIdService::CreateParams::Owner)).returns(T.nilable(::Stripe::TaxIdService::CreateParams::Owner))
}
def owner=(_owner); end
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Value of the tax ID.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig {
params(expand: T.nilable(T::Array[String]), owner: T.nilable(::Stripe::TaxIdService::CreateParams::Owner), type: String, value: String).void
}
def initialize(expand: nil, owner: nil, type: nil, value: nil); end
end
# Creates a new account or customer tax_id object.
sig {
params(params: T.any(::Stripe::TaxIdService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TaxId)
}
def create(params = {}, opts = {}); end
# Deletes an existing account or customer tax_id object.
sig {
params(id: String, params: T.any(::Stripe::TaxIdService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TaxId)
}
def delete(id, params = {}, opts = {}); end
# Returns a list of tax IDs.
sig {
params(params: T.any(::Stripe::TaxIdService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves an account or customer tax_id object.
sig {
params(id: String, params: T.any(::Stripe::TaxIdService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TaxId)
}
def retrieve(id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class TaxRateService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Optional flag to filter by tax rates that are either active or inactive (archived).
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Optional range for filtering created date.
sig { returns(T.nilable(T.any(::Stripe::TaxRateService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::TaxRateService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::TaxRateService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Optional flag to filter by tax rates that are inclusive (or those that are not inclusive).
sig { returns(T.nilable(T::Boolean)) }
def inclusive; end
sig { params(_inclusive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def inclusive=(_inclusive); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::TaxRateService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), inclusive: T.nilable(T::Boolean), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
active: nil,
created: nil,
ending_before: nil,
expand: nil,
inclusive: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
# Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The display name of the tax rate, which will be shown to users.
sig { returns(String) }
def display_name; end
sig { params(_display_name: String).returns(String) }
def display_name=(_display_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# This specifies if the tax rate is inclusive or exclusive.
sig { returns(T::Boolean) }
def inclusive; end
sig { params(_inclusive: T::Boolean).returns(T::Boolean) }
def inclusive=(_inclusive); end
# The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
sig { returns(T.nilable(String)) }
def jurisdiction; end
sig { params(_jurisdiction: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction=(_jurisdiction); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# This represents the tax rate percent out of 100.
sig { returns(Float) }
def percentage; end
sig { params(_percentage: Float).returns(Float) }
def percentage=(_percentage); end
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# The high-level tax type, such as `vat` or `sales_tax`.
sig { returns(T.nilable(String)) }
def tax_type; end
sig { params(_tax_type: T.nilable(String)).returns(T.nilable(String)) }
def tax_type=(_tax_type); end
sig {
params(active: T.nilable(T::Boolean), country: T.nilable(String), description: T.nilable(String), display_name: String, expand: T.nilable(T::Array[String]), inclusive: T::Boolean, jurisdiction: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), percentage: Float, state: T.nilable(String), tax_type: T.nilable(String)).void
}
def initialize(
active: nil,
country: nil,
description: nil,
display_name: nil,
expand: nil,
inclusive: nil,
jurisdiction: nil,
metadata: nil,
percentage: nil,
state: nil,
tax_type: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
sig { returns(T.nilable(T::Boolean)) }
def active; end
sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def active=(_active); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The display name of the tax rate, which will be shown to users.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
sig { returns(T.nilable(String)) }
def jurisdiction; end
sig { params(_jurisdiction: T.nilable(String)).returns(T.nilable(String)) }
def jurisdiction=(_jurisdiction); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# The high-level tax type, such as `vat` or `sales_tax`.
sig { returns(T.nilable(String)) }
def tax_type; end
sig { params(_tax_type: T.nilable(String)).returns(T.nilable(String)) }
def tax_type=(_tax_type); end
sig {
params(active: T.nilable(T::Boolean), country: T.nilable(String), description: T.nilable(String), display_name: T.nilable(String), expand: T.nilable(T::Array[String]), jurisdiction: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), state: T.nilable(String), tax_type: T.nilable(String)).void
}
def initialize(
active: nil,
country: nil,
description: nil,
display_name: nil,
expand: nil,
jurisdiction: nil,
metadata: nil,
state: nil,
tax_type: nil
); end
end
# Creates a new tax rate.
sig {
params(params: T.any(::Stripe::TaxRateService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TaxRate)
}
def create(params = {}, opts = {}); end
# Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.
sig {
params(params: T.any(::Stripe::TaxRateService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a tax rate with the given ID
sig {
params(tax_rate: String, params: T.any(::Stripe::TaxRateService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TaxRate)
}
def retrieve(tax_rate, params = {}, opts = {}); end
# Updates an existing tax rate.
sig {
params(tax_rate: String, params: T.any(::Stripe::TaxRateService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TaxRate)
}
def update(tax_rate, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class TerminalService < StripeService
attr_reader :configurations
attr_reader :connection_tokens
attr_reader :locations
attr_reader :onboarding_links
attr_reader :readers
attr_reader :reader_collected_data
end
end
# typed: true
module Stripe
module Terminal
class ConfigurationService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class BbposWisepad3 < Stripe::RequestParams
# A File ID representing an image you would like displayed on the reader.
sig { returns(T.nilable(String)) }
def splashscreen; end
sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) }
def splashscreen=(_splashscreen); end
sig { params(splashscreen: T.nilable(String)).void }
def initialize(splashscreen: nil); end
end
class BbposWiseposE < Stripe::RequestParams
# A File ID representing an image to display on the reader
sig { returns(T.nilable(String)) }
def splashscreen; end
sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) }
def splashscreen=(_splashscreen); end
sig { params(splashscreen: T.nilable(String)).void }
def initialize(splashscreen: nil); end
end
class Offline < Stripe::RequestParams
# Determines whether to allow transactions to be collected while reader is offline. Defaults to false.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class ReaderSecurity < Stripe::RequestParams
# Passcode used to access a reader's admin menu.
sig { returns(T.nilable(String)) }
def admin_menu_passcode; end
sig { params(_admin_menu_passcode: T.nilable(String)).returns(T.nilable(String)) }
def admin_menu_passcode=(_admin_menu_passcode); end
sig { params(admin_menu_passcode: T.nilable(String)).void }
def initialize(admin_menu_passcode: nil); end
end
class RebootWindow < Stripe::RequestParams
# Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.
sig { returns(Integer) }
def end_hour; end
sig { params(_end_hour: Integer).returns(Integer) }
def end_hour=(_end_hour); end
# Integer between 0 to 23 that represents the start hour of the reboot time window.
sig { returns(Integer) }
def start_hour; end
sig { params(_start_hour: Integer).returns(Integer) }
def start_hour=(_start_hour); end
sig { params(end_hour: Integer, start_hour: Integer).void }
def initialize(end_hour: nil, start_hour: nil); end
end
class StripeS700 < Stripe::RequestParams
# A File ID representing an image you would like displayed on the reader.
sig { returns(T.nilable(String)) }
def splashscreen; end
sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) }
def splashscreen=(_splashscreen); end
sig { params(splashscreen: T.nilable(String)).void }
def initialize(splashscreen: nil); end
end
class Tipping < Stripe::RequestParams
class Aed < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Aud < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Bgn < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Cad < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Chf < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Czk < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Dkk < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Eur < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Gbp < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Hkd < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Huf < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Jpy < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Mxn < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Myr < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Nok < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Nzd < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Pln < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Ron < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Sek < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Sgd < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Usd < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
# Tipping configuration for AED
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Aed))
}
def aed; end
sig {
params(_aed: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Aed)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Aed))
}
def aed=(_aed); end
# Tipping configuration for AUD
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Aud))
}
def aud; end
sig {
params(_aud: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Aud)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Aud))
}
def aud=(_aud); end
# Tipping configuration for BGN
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Bgn))
}
def bgn; end
sig {
params(_bgn: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Bgn)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Bgn))
}
def bgn=(_bgn); end
# Tipping configuration for CAD
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Cad))
}
def cad; end
sig {
params(_cad: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Cad)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Cad))
}
def cad=(_cad); end
# Tipping configuration for CHF
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Chf))
}
def chf; end
sig {
params(_chf: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Chf)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Chf))
}
def chf=(_chf); end
# Tipping configuration for CZK
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Czk))
}
def czk; end
sig {
params(_czk: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Czk)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Czk))
}
def czk=(_czk); end
# Tipping configuration for DKK
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Dkk))
}
def dkk; end
sig {
params(_dkk: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Dkk)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Dkk))
}
def dkk=(_dkk); end
# Tipping configuration for EUR
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Eur))
}
def eur; end
sig {
params(_eur: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Eur)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Eur))
}
def eur=(_eur); end
# Tipping configuration for GBP
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Gbp))
}
def gbp; end
sig {
params(_gbp: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Gbp)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Gbp))
}
def gbp=(_gbp); end
# Tipping configuration for HKD
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Hkd))
}
def hkd; end
sig {
params(_hkd: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Hkd)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Hkd))
}
def hkd=(_hkd); end
# Tipping configuration for HUF
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Huf))
}
def huf; end
sig {
params(_huf: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Huf)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Huf))
}
def huf=(_huf); end
# Tipping configuration for JPY
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Jpy))
}
def jpy; end
sig {
params(_jpy: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Jpy)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Jpy))
}
def jpy=(_jpy); end
# Tipping configuration for MXN
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Mxn))
}
def mxn; end
sig {
params(_mxn: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Mxn)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Mxn))
}
def mxn=(_mxn); end
# Tipping configuration for MYR
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Myr))
}
def myr; end
sig {
params(_myr: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Myr)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Myr))
}
def myr=(_myr); end
# Tipping configuration for NOK
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Nok))
}
def nok; end
sig {
params(_nok: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Nok)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Nok))
}
def nok=(_nok); end
# Tipping configuration for NZD
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Nzd))
}
def nzd; end
sig {
params(_nzd: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Nzd)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Nzd))
}
def nzd=(_nzd); end
# Tipping configuration for PLN
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Pln))
}
def pln; end
sig {
params(_pln: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Pln)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Pln))
}
def pln=(_pln); end
# Tipping configuration for RON
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Ron))
}
def ron; end
sig {
params(_ron: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Ron)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Ron))
}
def ron=(_ron); end
# Tipping configuration for SEK
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Sek))
}
def sek; end
sig {
params(_sek: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Sek)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Sek))
}
def sek=(_sek); end
# Tipping configuration for SGD
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Sgd))
}
def sgd; end
sig {
params(_sgd: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Sgd)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Sgd))
}
def sgd=(_sgd); end
# Tipping configuration for USD
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Usd))
}
def usd; end
sig {
params(_usd: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Usd)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Usd))
}
def usd=(_usd); end
sig {
params(aed: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Aed), aud: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Aud), bgn: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Bgn), cad: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Cad), chf: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Chf), czk: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Czk), dkk: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Dkk), eur: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Eur), gbp: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Gbp), hkd: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Hkd), huf: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Huf), jpy: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Jpy), mxn: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Mxn), myr: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Myr), nok: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Nok), nzd: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Nzd), pln: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Pln), ron: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Ron), sek: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Sek), sgd: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Sgd), usd: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping::Usd)).void
}
def initialize(
aed: nil,
aud: nil,
bgn: nil,
cad: nil,
chf: nil,
czk: nil,
dkk: nil,
eur: nil,
gbp: nil,
hkd: nil,
huf: nil,
jpy: nil,
mxn: nil,
myr: nil,
nok: nil,
nzd: nil,
pln: nil,
ron: nil,
sek: nil,
sgd: nil,
usd: nil
); end
end
class VerifoneP400 < Stripe::RequestParams
# A File ID representing an image you would like displayed on the reader.
sig { returns(T.nilable(String)) }
def splashscreen; end
sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) }
def splashscreen=(_splashscreen); end
sig { params(splashscreen: T.nilable(String)).void }
def initialize(splashscreen: nil); end
end
class Wifi < Stripe::RequestParams
class EnterpriseEapPeap < Stripe::RequestParams
# A File ID representing a PEM file containing the server certificate
sig { returns(T.nilable(String)) }
def ca_certificate_file; end
sig { params(_ca_certificate_file: T.nilable(String)).returns(T.nilable(String)) }
def ca_certificate_file=(_ca_certificate_file); end
# Password for connecting to the WiFi network
sig { returns(String) }
def password; end
sig { params(_password: String).returns(String) }
def password=(_password); end
# Name of the WiFi network
sig { returns(String) }
def ssid; end
sig { params(_ssid: String).returns(String) }
def ssid=(_ssid); end
# Username for connecting to the WiFi network
sig { returns(String) }
def username; end
sig { params(_username: String).returns(String) }
def username=(_username); end
sig {
params(ca_certificate_file: T.nilable(String), password: String, ssid: String, username: String).void
}
def initialize(ca_certificate_file: nil, password: nil, ssid: nil, username: nil); end
end
class EnterpriseEapTls < Stripe::RequestParams
# A File ID representing a PEM file containing the server certificate
sig { returns(T.nilable(String)) }
def ca_certificate_file; end
sig { params(_ca_certificate_file: T.nilable(String)).returns(T.nilable(String)) }
def ca_certificate_file=(_ca_certificate_file); end
# A File ID representing a PEM file containing the client certificate
sig { returns(String) }
def client_certificate_file; end
sig { params(_client_certificate_file: String).returns(String) }
def client_certificate_file=(_client_certificate_file); end
# A File ID representing a PEM file containing the client RSA private key
sig { returns(String) }
def private_key_file; end
sig { params(_private_key_file: String).returns(String) }
def private_key_file=(_private_key_file); end
# Password for the private key file
sig { returns(T.nilable(String)) }
def private_key_file_password; end
sig { params(_private_key_file_password: T.nilable(String)).returns(T.nilable(String)) }
def private_key_file_password=(_private_key_file_password); end
# Name of the WiFi network
sig { returns(String) }
def ssid; end
sig { params(_ssid: String).returns(String) }
def ssid=(_ssid); end
sig {
params(ca_certificate_file: T.nilable(String), client_certificate_file: String, private_key_file: String, private_key_file_password: T.nilable(String), ssid: String).void
}
def initialize(
ca_certificate_file: nil,
client_certificate_file: nil,
private_key_file: nil,
private_key_file_password: nil,
ssid: nil
); end
end
class PersonalPsk < Stripe::RequestParams
# Password for connecting to the WiFi network
sig { returns(String) }
def password; end
sig { params(_password: String).returns(String) }
def password=(_password); end
# Name of the WiFi network
sig { returns(String) }
def ssid; end
sig { params(_ssid: String).returns(String) }
def ssid=(_ssid); end
sig { params(password: String, ssid: String).void }
def initialize(password: nil, ssid: nil); end
end
# Credentials for a WPA-Enterprise WiFi network using the EAP-PEAP authentication method.
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Wifi::EnterpriseEapPeap))
}
def enterprise_eap_peap; end
sig {
params(_enterprise_eap_peap: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Wifi::EnterpriseEapPeap)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Wifi::EnterpriseEapPeap))
}
def enterprise_eap_peap=(_enterprise_eap_peap); end
# Credentials for a WPA-Enterprise WiFi network using the EAP-TLS authentication method.
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Wifi::EnterpriseEapTls))
}
def enterprise_eap_tls; end
sig {
params(_enterprise_eap_tls: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Wifi::EnterpriseEapTls)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Wifi::EnterpriseEapTls))
}
def enterprise_eap_tls=(_enterprise_eap_tls); end
# Credentials for a WPA-Personal WiFi network.
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Wifi::PersonalPsk))
}
def personal_psk; end
sig {
params(_personal_psk: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Wifi::PersonalPsk)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Wifi::PersonalPsk))
}
def personal_psk=(_personal_psk); end
# Security type of the WiFi network. Fill out the hash with the corresponding name to provide the set of credentials for this security type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(enterprise_eap_peap: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Wifi::EnterpriseEapPeap), enterprise_eap_tls: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Wifi::EnterpriseEapTls), personal_psk: T.nilable(::Stripe::Terminal::ConfigurationService::UpdateParams::Wifi::PersonalPsk), type: String).void
}
def initialize(
enterprise_eap_peap: nil,
enterprise_eap_tls: nil,
personal_psk: nil,
type: nil
); end
end
# An object containing device type specific settings for BBPOS WisePad 3 readers
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::BbposWisepad3)))
}
def bbpos_wisepad3; end
sig {
params(_bbpos_wisepad3: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::BbposWisepad3))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::BbposWisepad3)))
}
def bbpos_wisepad3=(_bbpos_wisepad3); end
# An object containing device type specific settings for BBPOS WisePOS E readers
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::BbposWiseposE)))
}
def bbpos_wisepos_e; end
sig {
params(_bbpos_wisepos_e: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::BbposWiseposE))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::BbposWiseposE)))
}
def bbpos_wisepos_e=(_bbpos_wisepos_e); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Name of the configuration
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Configurations for collecting transactions offline.
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::Offline)))
}
def offline; end
sig {
params(_offline: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::Offline))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::Offline)))
}
def offline=(_offline); end
# Configurations for reader security settings.
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::ReaderSecurity)))
}
def reader_security; end
sig {
params(_reader_security: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::ReaderSecurity))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::ReaderSecurity)))
}
def reader_security=(_reader_security); end
# Reboot time settings for readers that support customized reboot time configuration.
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::RebootWindow)))
}
def reboot_window; end
sig {
params(_reboot_window: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::RebootWindow))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::RebootWindow)))
}
def reboot_window=(_reboot_window); end
# An object containing device type specific settings for Stripe S700 readers
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::StripeS700)))
}
def stripe_s700; end
sig {
params(_stripe_s700: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::StripeS700))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::StripeS700)))
}
def stripe_s700=(_stripe_s700); end
# Tipping configurations for readers supporting on-reader tips
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping)))
}
def tipping; end
sig {
params(_tipping: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping)))
}
def tipping=(_tipping); end
# An object containing device type specific settings for Verifone P400 readers
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::VerifoneP400)))
}
def verifone_p400; end
sig {
params(_verifone_p400: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::VerifoneP400))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::VerifoneP400)))
}
def verifone_p400=(_verifone_p400); end
# Configurations for connecting to a WiFi network.
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::Wifi)))
}
def wifi; end
sig {
params(_wifi: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::Wifi))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::Wifi)))
}
def wifi=(_wifi); end
sig {
params(bbpos_wisepad3: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::BbposWisepad3)), bbpos_wisepos_e: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::BbposWiseposE)), expand: T.nilable(T::Array[String]), name: T.nilable(String), offline: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::Offline)), reader_security: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::ReaderSecurity)), reboot_window: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::RebootWindow)), stripe_s700: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::StripeS700)), tipping: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::Tipping)), verifone_p400: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::VerifoneP400)), wifi: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::UpdateParams::Wifi))).void
}
def initialize(
bbpos_wisepad3: nil,
bbpos_wisepos_e: nil,
expand: nil,
name: nil,
offline: nil,
reader_security: nil,
reboot_window: nil,
stripe_s700: nil,
tipping: nil,
verifone_p400: nil,
wifi: nil
); end
end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# if present, only return the account default or non-default configurations.
sig { returns(T.nilable(T::Boolean)) }
def is_account_default; end
sig { params(_is_account_default: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def is_account_default=(_is_account_default); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), is_account_default: T.nilable(T::Boolean), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
is_account_default: nil,
limit: nil,
starting_after: nil
); end
end
class CreateParams < Stripe::RequestParams
class BbposWisepad3 < Stripe::RequestParams
# A File ID representing an image you would like displayed on the reader.
sig { returns(T.nilable(String)) }
def splashscreen; end
sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) }
def splashscreen=(_splashscreen); end
sig { params(splashscreen: T.nilable(String)).void }
def initialize(splashscreen: nil); end
end
class BbposWiseposE < Stripe::RequestParams
# A File ID representing an image to display on the reader
sig { returns(T.nilable(String)) }
def splashscreen; end
sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) }
def splashscreen=(_splashscreen); end
sig { params(splashscreen: T.nilable(String)).void }
def initialize(splashscreen: nil); end
end
class Offline < Stripe::RequestParams
# Determines whether to allow transactions to be collected while reader is offline. Defaults to false.
sig { returns(T::Boolean) }
def enabled; end
sig { params(_enabled: T::Boolean).returns(T::Boolean) }
def enabled=(_enabled); end
sig { params(enabled: T::Boolean).void }
def initialize(enabled: nil); end
end
class ReaderSecurity < Stripe::RequestParams
# Passcode used to access a reader's admin menu.
sig { returns(T.nilable(String)) }
def admin_menu_passcode; end
sig { params(_admin_menu_passcode: T.nilable(String)).returns(T.nilable(String)) }
def admin_menu_passcode=(_admin_menu_passcode); end
sig { params(admin_menu_passcode: T.nilable(String)).void }
def initialize(admin_menu_passcode: nil); end
end
class RebootWindow < Stripe::RequestParams
# Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.
sig { returns(Integer) }
def end_hour; end
sig { params(_end_hour: Integer).returns(Integer) }
def end_hour=(_end_hour); end
# Integer between 0 to 23 that represents the start hour of the reboot time window.
sig { returns(Integer) }
def start_hour; end
sig { params(_start_hour: Integer).returns(Integer) }
def start_hour=(_start_hour); end
sig { params(end_hour: Integer, start_hour: Integer).void }
def initialize(end_hour: nil, start_hour: nil); end
end
class StripeS700 < Stripe::RequestParams
# A File ID representing an image you would like displayed on the reader.
sig { returns(T.nilable(String)) }
def splashscreen; end
sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) }
def splashscreen=(_splashscreen); end
sig { params(splashscreen: T.nilable(String)).void }
def initialize(splashscreen: nil); end
end
class Tipping < Stripe::RequestParams
class Aed < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Aud < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Bgn < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Cad < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Chf < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Czk < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Dkk < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Eur < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Gbp < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Hkd < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Huf < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Jpy < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Mxn < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Myr < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Nok < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Nzd < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Pln < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Ron < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Sek < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Sgd < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
class Usd < Stripe::RequestParams
# Fixed amounts displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def fixed_amounts; end
sig {
params(_fixed_amounts: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def fixed_amounts=(_fixed_amounts); end
# Percentages displayed when collecting a tip
sig { returns(T.nilable(T::Array[Integer])) }
def percentages; end
sig {
params(_percentages: T.nilable(T::Array[Integer])).returns(T.nilable(T::Array[Integer]))
}
def percentages=(_percentages); end
# Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
sig { returns(T.nilable(Integer)) }
def smart_tip_threshold; end
sig { params(_smart_tip_threshold: T.nilable(Integer)).returns(T.nilable(Integer)) }
def smart_tip_threshold=(_smart_tip_threshold); end
sig {
params(fixed_amounts: T.nilable(T::Array[Integer]), percentages: T.nilable(T::Array[Integer]), smart_tip_threshold: T.nilable(Integer)).void
}
def initialize(fixed_amounts: nil, percentages: nil, smart_tip_threshold: nil); end
end
# Tipping configuration for AED
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Aed))
}
def aed; end
sig {
params(_aed: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Aed)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Aed))
}
def aed=(_aed); end
# Tipping configuration for AUD
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Aud))
}
def aud; end
sig {
params(_aud: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Aud)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Aud))
}
def aud=(_aud); end
# Tipping configuration for BGN
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Bgn))
}
def bgn; end
sig {
params(_bgn: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Bgn)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Bgn))
}
def bgn=(_bgn); end
# Tipping configuration for CAD
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Cad))
}
def cad; end
sig {
params(_cad: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Cad)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Cad))
}
def cad=(_cad); end
# Tipping configuration for CHF
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Chf))
}
def chf; end
sig {
params(_chf: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Chf)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Chf))
}
def chf=(_chf); end
# Tipping configuration for CZK
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Czk))
}
def czk; end
sig {
params(_czk: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Czk)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Czk))
}
def czk=(_czk); end
# Tipping configuration for DKK
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Dkk))
}
def dkk; end
sig {
params(_dkk: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Dkk)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Dkk))
}
def dkk=(_dkk); end
# Tipping configuration for EUR
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Eur))
}
def eur; end
sig {
params(_eur: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Eur)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Eur))
}
def eur=(_eur); end
# Tipping configuration for GBP
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Gbp))
}
def gbp; end
sig {
params(_gbp: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Gbp)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Gbp))
}
def gbp=(_gbp); end
# Tipping configuration for HKD
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Hkd))
}
def hkd; end
sig {
params(_hkd: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Hkd)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Hkd))
}
def hkd=(_hkd); end
# Tipping configuration for HUF
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Huf))
}
def huf; end
sig {
params(_huf: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Huf)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Huf))
}
def huf=(_huf); end
# Tipping configuration for JPY
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Jpy))
}
def jpy; end
sig {
params(_jpy: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Jpy)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Jpy))
}
def jpy=(_jpy); end
# Tipping configuration for MXN
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Mxn))
}
def mxn; end
sig {
params(_mxn: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Mxn)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Mxn))
}
def mxn=(_mxn); end
# Tipping configuration for MYR
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Myr))
}
def myr; end
sig {
params(_myr: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Myr)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Myr))
}
def myr=(_myr); end
# Tipping configuration for NOK
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Nok))
}
def nok; end
sig {
params(_nok: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Nok)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Nok))
}
def nok=(_nok); end
# Tipping configuration for NZD
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Nzd))
}
def nzd; end
sig {
params(_nzd: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Nzd)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Nzd))
}
def nzd=(_nzd); end
# Tipping configuration for PLN
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Pln))
}
def pln; end
sig {
params(_pln: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Pln)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Pln))
}
def pln=(_pln); end
# Tipping configuration for RON
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Ron))
}
def ron; end
sig {
params(_ron: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Ron)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Ron))
}
def ron=(_ron); end
# Tipping configuration for SEK
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Sek))
}
def sek; end
sig {
params(_sek: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Sek)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Sek))
}
def sek=(_sek); end
# Tipping configuration for SGD
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Sgd))
}
def sgd; end
sig {
params(_sgd: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Sgd)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Sgd))
}
def sgd=(_sgd); end
# Tipping configuration for USD
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Usd))
}
def usd; end
sig {
params(_usd: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Usd)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Usd))
}
def usd=(_usd); end
sig {
params(aed: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Aed), aud: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Aud), bgn: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Bgn), cad: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Cad), chf: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Chf), czk: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Czk), dkk: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Dkk), eur: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Eur), gbp: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Gbp), hkd: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Hkd), huf: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Huf), jpy: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Jpy), mxn: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Mxn), myr: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Myr), nok: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Nok), nzd: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Nzd), pln: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Pln), ron: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Ron), sek: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Sek), sgd: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Sgd), usd: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Tipping::Usd)).void
}
def initialize(
aed: nil,
aud: nil,
bgn: nil,
cad: nil,
chf: nil,
czk: nil,
dkk: nil,
eur: nil,
gbp: nil,
hkd: nil,
huf: nil,
jpy: nil,
mxn: nil,
myr: nil,
nok: nil,
nzd: nil,
pln: nil,
ron: nil,
sek: nil,
sgd: nil,
usd: nil
); end
end
class VerifoneP400 < Stripe::RequestParams
# A File ID representing an image you would like displayed on the reader.
sig { returns(T.nilable(String)) }
def splashscreen; end
sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) }
def splashscreen=(_splashscreen); end
sig { params(splashscreen: T.nilable(String)).void }
def initialize(splashscreen: nil); end
end
class Wifi < Stripe::RequestParams
class EnterpriseEapPeap < Stripe::RequestParams
# A File ID representing a PEM file containing the server certificate
sig { returns(T.nilable(String)) }
def ca_certificate_file; end
sig { params(_ca_certificate_file: T.nilable(String)).returns(T.nilable(String)) }
def ca_certificate_file=(_ca_certificate_file); end
# Password for connecting to the WiFi network
sig { returns(String) }
def password; end
sig { params(_password: String).returns(String) }
def password=(_password); end
# Name of the WiFi network
sig { returns(String) }
def ssid; end
sig { params(_ssid: String).returns(String) }
def ssid=(_ssid); end
# Username for connecting to the WiFi network
sig { returns(String) }
def username; end
sig { params(_username: String).returns(String) }
def username=(_username); end
sig {
params(ca_certificate_file: T.nilable(String), password: String, ssid: String, username: String).void
}
def initialize(ca_certificate_file: nil, password: nil, ssid: nil, username: nil); end
end
class EnterpriseEapTls < Stripe::RequestParams
# A File ID representing a PEM file containing the server certificate
sig { returns(T.nilable(String)) }
def ca_certificate_file; end
sig { params(_ca_certificate_file: T.nilable(String)).returns(T.nilable(String)) }
def ca_certificate_file=(_ca_certificate_file); end
# A File ID representing a PEM file containing the client certificate
sig { returns(String) }
def client_certificate_file; end
sig { params(_client_certificate_file: String).returns(String) }
def client_certificate_file=(_client_certificate_file); end
# A File ID representing a PEM file containing the client RSA private key
sig { returns(String) }
def private_key_file; end
sig { params(_private_key_file: String).returns(String) }
def private_key_file=(_private_key_file); end
# Password for the private key file
sig { returns(T.nilable(String)) }
def private_key_file_password; end
sig { params(_private_key_file_password: T.nilable(String)).returns(T.nilable(String)) }
def private_key_file_password=(_private_key_file_password); end
# Name of the WiFi network
sig { returns(String) }
def ssid; end
sig { params(_ssid: String).returns(String) }
def ssid=(_ssid); end
sig {
params(ca_certificate_file: T.nilable(String), client_certificate_file: String, private_key_file: String, private_key_file_password: T.nilable(String), ssid: String).void
}
def initialize(
ca_certificate_file: nil,
client_certificate_file: nil,
private_key_file: nil,
private_key_file_password: nil,
ssid: nil
); end
end
class PersonalPsk < Stripe::RequestParams
# Password for connecting to the WiFi network
sig { returns(String) }
def password; end
sig { params(_password: String).returns(String) }
def password=(_password); end
# Name of the WiFi network
sig { returns(String) }
def ssid; end
sig { params(_ssid: String).returns(String) }
def ssid=(_ssid); end
sig { params(password: String, ssid: String).void }
def initialize(password: nil, ssid: nil); end
end
# Credentials for a WPA-Enterprise WiFi network using the EAP-PEAP authentication method.
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Wifi::EnterpriseEapPeap))
}
def enterprise_eap_peap; end
sig {
params(_enterprise_eap_peap: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Wifi::EnterpriseEapPeap)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Wifi::EnterpriseEapPeap))
}
def enterprise_eap_peap=(_enterprise_eap_peap); end
# Credentials for a WPA-Enterprise WiFi network using the EAP-TLS authentication method.
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Wifi::EnterpriseEapTls))
}
def enterprise_eap_tls; end
sig {
params(_enterprise_eap_tls: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Wifi::EnterpriseEapTls)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Wifi::EnterpriseEapTls))
}
def enterprise_eap_tls=(_enterprise_eap_tls); end
# Credentials for a WPA-Personal WiFi network.
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Wifi::PersonalPsk))
}
def personal_psk; end
sig {
params(_personal_psk: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Wifi::PersonalPsk)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Wifi::PersonalPsk))
}
def personal_psk=(_personal_psk); end
# Security type of the WiFi network. Fill out the hash with the corresponding name to provide the set of credentials for this security type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(enterprise_eap_peap: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Wifi::EnterpriseEapPeap), enterprise_eap_tls: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Wifi::EnterpriseEapTls), personal_psk: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::Wifi::PersonalPsk), type: String).void
}
def initialize(
enterprise_eap_peap: nil,
enterprise_eap_tls: nil,
personal_psk: nil,
type: nil
); end
end
# An object containing device type specific settings for BBPOS WisePad 3 readers
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::BbposWisepad3))
}
def bbpos_wisepad3; end
sig {
params(_bbpos_wisepad3: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::BbposWisepad3)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::BbposWisepad3))
}
def bbpos_wisepad3=(_bbpos_wisepad3); end
# An object containing device type specific settings for BBPOS WisePOS E readers
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::BbposWiseposE))
}
def bbpos_wisepos_e; end
sig {
params(_bbpos_wisepos_e: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::BbposWiseposE)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::BbposWiseposE))
}
def bbpos_wisepos_e=(_bbpos_wisepos_e); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Name of the configuration
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Configurations for collecting transactions offline.
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::CreateParams::Offline)))
}
def offline; end
sig {
params(_offline: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::CreateParams::Offline))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::CreateParams::Offline)))
}
def offline=(_offline); end
# Configurations for reader security settings.
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::CreateParams::ReaderSecurity)))
}
def reader_security; end
sig {
params(_reader_security: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::CreateParams::ReaderSecurity))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::CreateParams::ReaderSecurity)))
}
def reader_security=(_reader_security); end
# Reboot time settings for readers that support customized reboot time configuration.
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::RebootWindow))
}
def reboot_window; end
sig {
params(_reboot_window: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::RebootWindow)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::RebootWindow))
}
def reboot_window=(_reboot_window); end
# An object containing device type specific settings for Stripe S700 readers
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::StripeS700))
}
def stripe_s700; end
sig {
params(_stripe_s700: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::StripeS700)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::StripeS700))
}
def stripe_s700=(_stripe_s700); end
# Tipping configurations for readers supporting on-reader tips
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::CreateParams::Tipping)))
}
def tipping; end
sig {
params(_tipping: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::CreateParams::Tipping))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::CreateParams::Tipping)))
}
def tipping=(_tipping); end
# An object containing device type specific settings for Verifone P400 readers
sig {
returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::VerifoneP400))
}
def verifone_p400; end
sig {
params(_verifone_p400: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::VerifoneP400)).returns(T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::VerifoneP400))
}
def verifone_p400=(_verifone_p400); end
# Configurations for connecting to a WiFi network.
sig {
returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::CreateParams::Wifi)))
}
def wifi; end
sig {
params(_wifi: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::CreateParams::Wifi))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::CreateParams::Wifi)))
}
def wifi=(_wifi); end
sig {
params(bbpos_wisepad3: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::BbposWisepad3), bbpos_wisepos_e: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::BbposWiseposE), expand: T.nilable(T::Array[String]), name: T.nilable(String), offline: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::CreateParams::Offline)), reader_security: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::CreateParams::ReaderSecurity)), reboot_window: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::RebootWindow), stripe_s700: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::StripeS700), tipping: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::CreateParams::Tipping)), verifone_p400: T.nilable(::Stripe::Terminal::ConfigurationService::CreateParams::VerifoneP400), wifi: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationService::CreateParams::Wifi))).void
}
def initialize(
bbpos_wisepad3: nil,
bbpos_wisepos_e: nil,
expand: nil,
name: nil,
offline: nil,
reader_security: nil,
reboot_window: nil,
stripe_s700: nil,
tipping: nil,
verifone_p400: nil,
wifi: nil
); end
end
# Creates a new Configuration object.
sig {
params(params: T.any(::Stripe::Terminal::ConfigurationService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Configuration)
}
def create(params = {}, opts = {}); end
# Deletes a Configuration object.
sig {
params(configuration: String, params: T.any(::Stripe::Terminal::ConfigurationService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Configuration)
}
def delete(configuration, params = {}, opts = {}); end
# Returns a list of Configuration objects.
sig {
params(params: T.any(::Stripe::Terminal::ConfigurationService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a Configuration object.
sig {
params(configuration: String, params: T.any(::Stripe::Terminal::ConfigurationService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Configuration)
}
def retrieve(configuration, params = {}, opts = {}); end
# Updates a new Configuration object.
sig {
params(configuration: String, params: T.any(::Stripe::Terminal::ConfigurationService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Configuration)
}
def update(configuration, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Terminal
class ConnectionTokenService < StripeService
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).
sig { returns(T.nilable(String)) }
def location; end
sig { params(_location: T.nilable(String)).returns(T.nilable(String)) }
def location=(_location); end
sig { params(expand: T.nilable(T::Array[String]), location: T.nilable(String)).void }
def initialize(expand: nil, location: nil); end
end
# To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.
sig {
params(params: T.any(::Stripe::Terminal::ConnectionTokenService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::ConnectionToken)
}
def create(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Terminal
class LocationService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
# The full address of the location. You can't change the location's `country`. If you need to modify the `country` field, create a new `Location` object and re-register any existing readers to that location.
sig { returns(T.nilable(::Stripe::Terminal::LocationService::UpdateParams::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::Terminal::LocationService::UpdateParams::Address)).returns(T.nilable(::Stripe::Terminal::LocationService::UpdateParams::Address))
}
def address=(_address); end
# The Kana variation of the full address of the location (Japan only).
sig { returns(T.nilable(::Stripe::Terminal::LocationService::UpdateParams::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::Terminal::LocationService::UpdateParams::AddressKana)).returns(T.nilable(::Stripe::Terminal::LocationService::UpdateParams::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the full address of the location (Japan only).
sig { returns(T.nilable(::Stripe::Terminal::LocationService::UpdateParams::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::Terminal::LocationService::UpdateParams::AddressKanji)).returns(T.nilable(::Stripe::Terminal::LocationService::UpdateParams::AddressKanji))
}
def address_kanji=(_address_kanji); end
# The ID of a configuration that will be used to customize all readers in this location.
sig { returns(T.nilable(String)) }
def configuration_overrides; end
sig { params(_configuration_overrides: T.nilable(String)).returns(T.nilable(String)) }
def configuration_overrides=(_configuration_overrides); end
# A name for the location.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# The Kana variation of the name for the location (Japan only).
sig { returns(T.nilable(String)) }
def display_name_kana; end
sig { params(_display_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def display_name_kana=(_display_name_kana); end
# The Kanji variation of the name for the location (Japan only).
sig { returns(T.nilable(String)) }
def display_name_kanji; end
sig { params(_display_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def display_name_kanji=(_display_name_kanji); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The phone number for the location.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::Terminal::LocationService::UpdateParams::Address), address_kana: T.nilable(::Stripe::Terminal::LocationService::UpdateParams::AddressKana), address_kanji: T.nilable(::Stripe::Terminal::LocationService::UpdateParams::AddressKanji), configuration_overrides: T.nilable(String), display_name: T.nilable(String), display_name_kana: T.nilable(String), display_name_kanji: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), phone: T.nilable(String)).void
}
def initialize(
address: nil,
address_kana: nil,
address_kanji: nil,
configuration_overrides: nil,
display_name: nil,
display_name_kana: nil,
display_name_kanji: nil,
expand: nil,
metadata: nil,
phone: nil
); end
end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateParams < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
# The full address of the location.
sig { returns(T.nilable(::Stripe::Terminal::LocationService::CreateParams::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::Terminal::LocationService::CreateParams::Address)).returns(T.nilable(::Stripe::Terminal::LocationService::CreateParams::Address))
}
def address=(_address); end
# The Kana variation of the full address of the location (Japan only).
sig { returns(T.nilable(::Stripe::Terminal::LocationService::CreateParams::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::Terminal::LocationService::CreateParams::AddressKana)).returns(T.nilable(::Stripe::Terminal::LocationService::CreateParams::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the full address of the location (Japan only).
sig { returns(T.nilable(::Stripe::Terminal::LocationService::CreateParams::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::Terminal::LocationService::CreateParams::AddressKanji)).returns(T.nilable(::Stripe::Terminal::LocationService::CreateParams::AddressKanji))
}
def address_kanji=(_address_kanji); end
# The ID of a configuration that will be used to customize all readers in this location.
sig { returns(T.nilable(String)) }
def configuration_overrides; end
sig { params(_configuration_overrides: T.nilable(String)).returns(T.nilable(String)) }
def configuration_overrides=(_configuration_overrides); end
# A name for the location. Maximum length is 1000 characters.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# The Kana variation of the name for the location (Japan only). Maximum length is 1000 characters.
sig { returns(T.nilable(String)) }
def display_name_kana; end
sig { params(_display_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def display_name_kana=(_display_name_kana); end
# The Kanji variation of the name for the location (Japan only). Maximum length is 1000 characters.
sig { returns(T.nilable(String)) }
def display_name_kanji; end
sig { params(_display_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def display_name_kanji=(_display_name_kanji); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The phone number for the location.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::Terminal::LocationService::CreateParams::Address), address_kana: T.nilable(::Stripe::Terminal::LocationService::CreateParams::AddressKana), address_kanji: T.nilable(::Stripe::Terminal::LocationService::CreateParams::AddressKanji), configuration_overrides: T.nilable(String), display_name: T.nilable(String), display_name_kana: T.nilable(String), display_name_kanji: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), phone: T.nilable(String)).void
}
def initialize(
address: nil,
address_kana: nil,
address_kanji: nil,
configuration_overrides: nil,
display_name: nil,
display_name_kana: nil,
display_name_kanji: nil,
expand: nil,
metadata: nil,
phone: nil
); end
end
# Creates a new Location object.
# For further details, including which address fields are required in each country, see the [Manage locations](https://docs.stripe.com/docs/terminal/fleet/locations) guide.
sig {
params(params: T.any(::Stripe::Terminal::LocationService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Location)
}
def create(params = {}, opts = {}); end
# Deletes a Location object.
sig {
params(location: String, params: T.any(::Stripe::Terminal::LocationService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Location)
}
def delete(location, params = {}, opts = {}); end
# Returns a list of Location objects.
sig {
params(params: T.any(::Stripe::Terminal::LocationService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a Location object.
sig {
params(location: String, params: T.any(::Stripe::Terminal::LocationService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Location)
}
def retrieve(location, params = {}, opts = {}); end
# Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(location: String, params: T.any(::Stripe::Terminal::LocationService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Location)
}
def update(location, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Terminal
class OnboardingLinkService < StripeService
class CreateParams < Stripe::RequestParams
class LinkOptions < Stripe::RequestParams
class AppleTermsAndConditions < Stripe::RequestParams
# Whether the link should also support users relinking their Apple account.
sig { returns(T.nilable(T::Boolean)) }
def allow_relinking; end
sig { params(_allow_relinking: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def allow_relinking=(_allow_relinking); end
# The business name of the merchant accepting Apple's Terms and Conditions.
sig { returns(String) }
def merchant_display_name; end
sig { params(_merchant_display_name: String).returns(String) }
def merchant_display_name=(_merchant_display_name); end
sig {
params(allow_relinking: T.nilable(T::Boolean), merchant_display_name: String).void
}
def initialize(allow_relinking: nil, merchant_display_name: nil); end
end
# The options associated with the Apple Terms and Conditions link type.
sig {
returns(T.nilable(::Stripe::Terminal::OnboardingLinkService::CreateParams::LinkOptions::AppleTermsAndConditions))
}
def apple_terms_and_conditions; end
sig {
params(_apple_terms_and_conditions: T.nilable(::Stripe::Terminal::OnboardingLinkService::CreateParams::LinkOptions::AppleTermsAndConditions)).returns(T.nilable(::Stripe::Terminal::OnboardingLinkService::CreateParams::LinkOptions::AppleTermsAndConditions))
}
def apple_terms_and_conditions=(_apple_terms_and_conditions); end
sig {
params(apple_terms_and_conditions: T.nilable(::Stripe::Terminal::OnboardingLinkService::CreateParams::LinkOptions::AppleTermsAndConditions)).void
}
def initialize(apple_terms_and_conditions: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Specific fields needed to generate the desired link type.
sig { returns(::Stripe::Terminal::OnboardingLinkService::CreateParams::LinkOptions) }
def link_options; end
sig {
params(_link_options: ::Stripe::Terminal::OnboardingLinkService::CreateParams::LinkOptions).returns(::Stripe::Terminal::OnboardingLinkService::CreateParams::LinkOptions)
}
def link_options=(_link_options); end
# The type of link being generated.
sig { returns(String) }
def link_type; end
sig { params(_link_type: String).returns(String) }
def link_type=(_link_type); end
# Stripe account ID to generate the link for.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
sig {
params(expand: T.nilable(T::Array[String]), link_options: ::Stripe::Terminal::OnboardingLinkService::CreateParams::LinkOptions, link_type: String, on_behalf_of: T.nilable(String)).void
}
def initialize(expand: nil, link_options: nil, link_type: nil, on_behalf_of: nil); end
end
# Creates a new OnboardingLink object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.
sig {
params(params: T.any(::Stripe::Terminal::OnboardingLinkService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::OnboardingLink)
}
def create(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Terminal
class ReaderService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The new label of the reader.
sig { returns(T.nilable(String)) }
def label; end
sig { params(_label: T.nilable(String)).returns(T.nilable(String)) }
def label=(_label); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), label: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, label: nil, metadata: nil); end
end
class ListParams < Stripe::RequestParams
# Filters readers by device type
sig { returns(T.nilable(String)) }
def device_type; end
sig { params(_device_type: T.nilable(String)).returns(T.nilable(String)) }
def device_type=(_device_type); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A location ID to filter the response list to only readers at the specific location
sig { returns(T.nilable(String)) }
def location; end
sig { params(_location: T.nilable(String)).returns(T.nilable(String)) }
def location=(_location); end
# Filters readers by serial number
sig { returns(T.nilable(String)) }
def serial_number; end
sig { params(_serial_number: T.nilable(String)).returns(T.nilable(String)) }
def serial_number=(_serial_number); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# A status filter to filter readers to only offline or online readers
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(device_type: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), location: T.nilable(String), serial_number: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
device_type: nil,
ending_before: nil,
expand: nil,
limit: nil,
location: nil,
serial_number: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Custom label given to the reader for easier identification. If no label is specified, the registration code will be used.
sig { returns(T.nilable(String)) }
def label; end
sig { params(_label: T.nilable(String)).returns(T.nilable(String)) }
def label=(_label); end
# The location to assign the reader to.
sig { returns(T.nilable(String)) }
def location; end
sig { params(_location: T.nilable(String)).returns(T.nilable(String)) }
def location=(_location); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# A code generated by the reader used for registering to an account.
sig { returns(String) }
def registration_code; end
sig { params(_registration_code: String).returns(String) }
def registration_code=(_registration_code); end
sig {
params(expand: T.nilable(T::Array[String]), label: T.nilable(String), location: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), registration_code: String).void
}
def initialize(
expand: nil,
label: nil,
location: nil,
metadata: nil,
registration_code: nil
); end
end
class CancelActionParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class CollectInputsParams < Stripe::RequestParams
class Input < Stripe::RequestParams
class CustomText < Stripe::RequestParams
# The description which will be displayed when collecting this input
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The skip button text
sig { returns(T.nilable(String)) }
def skip_button; end
sig { params(_skip_button: T.nilable(String)).returns(T.nilable(String)) }
def skip_button=(_skip_button); end
# The submit button text
sig { returns(T.nilable(String)) }
def submit_button; end
sig { params(_submit_button: T.nilable(String)).returns(T.nilable(String)) }
def submit_button=(_submit_button); end
# The title which will be displayed when collecting this input
sig { returns(String) }
def title; end
sig { params(_title: String).returns(String) }
def title=(_title); end
sig {
params(description: T.nilable(String), skip_button: T.nilable(String), submit_button: T.nilable(String), title: String).void
}
def initialize(description: nil, skip_button: nil, submit_button: nil, title: nil); end
end
class Selection < Stripe::RequestParams
class Choice < Stripe::RequestParams
# The unique identifier for this choice
sig { returns(String) }
def id; end
sig { params(_id: String).returns(String) }
def id=(_id); end
# The style of the button which will be shown for this choice
sig { returns(T.nilable(String)) }
def style; end
sig { params(_style: T.nilable(String)).returns(T.nilable(String)) }
def style=(_style); end
# The text which will be shown on the button for this choice
sig { returns(String) }
def text; end
sig { params(_text: String).returns(String) }
def text=(_text); end
sig { params(id: String, style: T.nilable(String), text: String).void }
def initialize(id: nil, style: nil, text: nil); end
end
# List of choices for the `selection` input
sig {
returns(T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Selection::Choice])
}
def choices; end
sig {
params(_choices: T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Selection::Choice]).returns(T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Selection::Choice])
}
def choices=(_choices); end
sig {
params(choices: T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Selection::Choice]).void
}
def initialize(choices: nil); end
end
class Toggle < Stripe::RequestParams
# The default value of the toggle
sig { returns(T.nilable(String)) }
def default_value; end
sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) }
def default_value=(_default_value); end
# The description which will be displayed for the toggle
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The title which will be displayed for the toggle
sig { returns(T.nilable(String)) }
def title; end
sig { params(_title: T.nilable(String)).returns(T.nilable(String)) }
def title=(_title); end
sig {
params(default_value: T.nilable(String), description: T.nilable(String), title: T.nilable(String)).void
}
def initialize(default_value: nil, description: nil, title: nil); end
end
# Customize the text which will be displayed while collecting this input
sig { returns(::Stripe::Terminal::ReaderService::CollectInputsParams::Input::CustomText) }
def custom_text; end
sig {
params(_custom_text: ::Stripe::Terminal::ReaderService::CollectInputsParams::Input::CustomText).returns(::Stripe::Terminal::ReaderService::CollectInputsParams::Input::CustomText)
}
def custom_text=(_custom_text); end
# Indicate that this input is required, disabling the skip button
sig { returns(T.nilable(T::Boolean)) }
def required; end
sig { params(_required: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def required=(_required); end
# Options for the `selection` input
sig {
returns(T.nilable(::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Selection))
}
def selection; end
sig {
params(_selection: T.nilable(::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Selection)).returns(T.nilable(::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Selection))
}
def selection=(_selection); end
# List of toggles to be displayed and customization for the toggles
sig {
returns(T.nilable(T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Toggle]))
}
def toggles; end
sig {
params(_toggles: T.nilable(T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Toggle])).returns(T.nilable(T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Toggle]))
}
def toggles=(_toggles); end
# The type of input to collect
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(custom_text: ::Stripe::Terminal::ReaderService::CollectInputsParams::Input::CustomText, required: T.nilable(T::Boolean), selection: T.nilable(::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Selection), toggles: T.nilable(T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Toggle]), type: String).void
}
def initialize(
custom_text: nil,
required: nil,
selection: nil,
toggles: nil,
type: nil
); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# List of inputs to be collected using the Reader
sig { returns(T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input]) }
def inputs; end
sig {
params(_inputs: T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input]).returns(T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input])
}
def inputs=(_inputs); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), inputs: T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input], metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(expand: nil, inputs: nil, metadata: nil); end
end
class CollectPaymentMethodParams < Stripe::RequestParams
class CollectConfig < Stripe::RequestParams
class Tipping < Stripe::RequestParams
# Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).
sig { returns(T.nilable(Integer)) }
def amount_eligible; end
sig { params(_amount_eligible: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_eligible=(_amount_eligible); end
sig { params(amount_eligible: T.nilable(Integer)).void }
def initialize(amount_eligible: nil); end
end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# Enables cancel button on transaction screens.
sig { returns(T.nilable(T::Boolean)) }
def enable_customer_cancellation; end
sig {
params(_enable_customer_cancellation: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def enable_customer_cancellation=(_enable_customer_cancellation); end
# Override showing a tipping selection screen on this transaction.
sig { returns(T.nilable(T::Boolean)) }
def skip_tipping; end
sig { params(_skip_tipping: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def skip_tipping=(_skip_tipping); end
# Tipping configuration for this transaction.
sig {
returns(T.nilable(::Stripe::Terminal::ReaderService::CollectPaymentMethodParams::CollectConfig::Tipping))
}
def tipping; end
sig {
params(_tipping: T.nilable(::Stripe::Terminal::ReaderService::CollectPaymentMethodParams::CollectConfig::Tipping)).returns(T.nilable(::Stripe::Terminal::ReaderService::CollectPaymentMethodParams::CollectConfig::Tipping))
}
def tipping=(_tipping); end
sig {
params(allow_redisplay: T.nilable(String), enable_customer_cancellation: T.nilable(T::Boolean), skip_tipping: T.nilable(T::Boolean), tipping: T.nilable(::Stripe::Terminal::ReaderService::CollectPaymentMethodParams::CollectConfig::Tipping)).void
}
def initialize(
allow_redisplay: nil,
enable_customer_cancellation: nil,
skip_tipping: nil,
tipping: nil
); end
end
# Configuration overrides.
sig {
returns(T.nilable(::Stripe::Terminal::ReaderService::CollectPaymentMethodParams::CollectConfig))
}
def collect_config; end
sig {
params(_collect_config: T.nilable(::Stripe::Terminal::ReaderService::CollectPaymentMethodParams::CollectConfig)).returns(T.nilable(::Stripe::Terminal::ReaderService::CollectPaymentMethodParams::CollectConfig))
}
def collect_config=(_collect_config); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# PaymentIntent ID.
sig { returns(String) }
def payment_intent; end
sig { params(_payment_intent: String).returns(String) }
def payment_intent=(_payment_intent); end
sig {
params(collect_config: T.nilable(::Stripe::Terminal::ReaderService::CollectPaymentMethodParams::CollectConfig), expand: T.nilable(T::Array[String]), payment_intent: String).void
}
def initialize(collect_config: nil, expand: nil, payment_intent: nil); end
end
class ConfirmPaymentIntentParams < Stripe::RequestParams
class ConfirmConfig < Stripe::RequestParams
# The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig { params(return_url: T.nilable(String)).void }
def initialize(return_url: nil); end
end
# Configuration overrides.
sig {
returns(T.nilable(::Stripe::Terminal::ReaderService::ConfirmPaymentIntentParams::ConfirmConfig))
}
def confirm_config; end
sig {
params(_confirm_config: T.nilable(::Stripe::Terminal::ReaderService::ConfirmPaymentIntentParams::ConfirmConfig)).returns(T.nilable(::Stripe::Terminal::ReaderService::ConfirmPaymentIntentParams::ConfirmConfig))
}
def confirm_config=(_confirm_config); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# PaymentIntent ID.
sig { returns(String) }
def payment_intent; end
sig { params(_payment_intent: String).returns(String) }
def payment_intent=(_payment_intent); end
sig {
params(confirm_config: T.nilable(::Stripe::Terminal::ReaderService::ConfirmPaymentIntentParams::ConfirmConfig), expand: T.nilable(T::Array[String]), payment_intent: String).void
}
def initialize(confirm_config: nil, expand: nil, payment_intent: nil); end
end
class ProcessPaymentIntentParams < Stripe::RequestParams
class ProcessConfig < Stripe::RequestParams
class Tipping < Stripe::RequestParams
# Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).
sig { returns(T.nilable(Integer)) }
def amount_eligible; end
sig { params(_amount_eligible: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_eligible=(_amount_eligible); end
sig { params(amount_eligible: T.nilable(Integer)).void }
def initialize(amount_eligible: nil); end
end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# Enables cancel button on transaction screens.
sig { returns(T.nilable(T::Boolean)) }
def enable_customer_cancellation; end
sig {
params(_enable_customer_cancellation: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def enable_customer_cancellation=(_enable_customer_cancellation); end
# The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# Override showing a tipping selection screen on this transaction.
sig { returns(T.nilable(T::Boolean)) }
def skip_tipping; end
sig { params(_skip_tipping: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def skip_tipping=(_skip_tipping); end
# Tipping configuration for this transaction.
sig {
returns(T.nilable(::Stripe::Terminal::ReaderService::ProcessPaymentIntentParams::ProcessConfig::Tipping))
}
def tipping; end
sig {
params(_tipping: T.nilable(::Stripe::Terminal::ReaderService::ProcessPaymentIntentParams::ProcessConfig::Tipping)).returns(T.nilable(::Stripe::Terminal::ReaderService::ProcessPaymentIntentParams::ProcessConfig::Tipping))
}
def tipping=(_tipping); end
sig {
params(allow_redisplay: T.nilable(String), enable_customer_cancellation: T.nilable(T::Boolean), return_url: T.nilable(String), skip_tipping: T.nilable(T::Boolean), tipping: T.nilable(::Stripe::Terminal::ReaderService::ProcessPaymentIntentParams::ProcessConfig::Tipping)).void
}
def initialize(
allow_redisplay: nil,
enable_customer_cancellation: nil,
return_url: nil,
skip_tipping: nil,
tipping: nil
); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# PaymentIntent ID
sig { returns(String) }
def payment_intent; end
sig { params(_payment_intent: String).returns(String) }
def payment_intent=(_payment_intent); end
# Configuration overrides
sig {
returns(T.nilable(::Stripe::Terminal::ReaderService::ProcessPaymentIntentParams::ProcessConfig))
}
def process_config; end
sig {
params(_process_config: T.nilable(::Stripe::Terminal::ReaderService::ProcessPaymentIntentParams::ProcessConfig)).returns(T.nilable(::Stripe::Terminal::ReaderService::ProcessPaymentIntentParams::ProcessConfig))
}
def process_config=(_process_config); end
sig {
params(expand: T.nilable(T::Array[String]), payment_intent: String, process_config: T.nilable(::Stripe::Terminal::ReaderService::ProcessPaymentIntentParams::ProcessConfig)).void
}
def initialize(expand: nil, payment_intent: nil, process_config: nil); end
end
class ProcessSetupIntentParams < Stripe::RequestParams
class ProcessConfig < Stripe::RequestParams
# Enables cancel button on transaction screens.
sig { returns(T.nilable(T::Boolean)) }
def enable_customer_cancellation; end
sig {
params(_enable_customer_cancellation: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def enable_customer_cancellation=(_enable_customer_cancellation); end
sig { params(enable_customer_cancellation: T.nilable(T::Boolean)).void }
def initialize(enable_customer_cancellation: nil); end
end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
sig { returns(String) }
def allow_redisplay; end
sig { params(_allow_redisplay: String).returns(String) }
def allow_redisplay=(_allow_redisplay); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Configuration overrides
sig {
returns(T.nilable(::Stripe::Terminal::ReaderService::ProcessSetupIntentParams::ProcessConfig))
}
def process_config; end
sig {
params(_process_config: T.nilable(::Stripe::Terminal::ReaderService::ProcessSetupIntentParams::ProcessConfig)).returns(T.nilable(::Stripe::Terminal::ReaderService::ProcessSetupIntentParams::ProcessConfig))
}
def process_config=(_process_config); end
# SetupIntent ID
sig { returns(String) }
def setup_intent; end
sig { params(_setup_intent: String).returns(String) }
def setup_intent=(_setup_intent); end
sig {
params(allow_redisplay: String, expand: T.nilable(T::Array[String]), process_config: T.nilable(::Stripe::Terminal::ReaderService::ProcessSetupIntentParams::ProcessConfig), setup_intent: String).void
}
def initialize(
allow_redisplay: nil,
expand: nil,
process_config: nil,
setup_intent: nil
); end
end
class RefundPaymentParams < Stripe::RequestParams
class RefundPaymentConfig < Stripe::RequestParams
# Enables cancel button on transaction screens.
sig { returns(T.nilable(T::Boolean)) }
def enable_customer_cancellation; end
sig {
params(_enable_customer_cancellation: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def enable_customer_cancellation=(_enable_customer_cancellation); end
sig { params(enable_customer_cancellation: T.nilable(T::Boolean)).void }
def initialize(enable_customer_cancellation: nil); end
end
# A positive integer in __cents__ representing how much of this charge to refund.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# ID of the Charge to refund.
sig { returns(T.nilable(String)) }
def charge; end
sig { params(_charge: T.nilable(String)).returns(T.nilable(String)) }
def charge=(_charge); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# ID of the PaymentIntent to refund.
sig { returns(T.nilable(String)) }
def payment_intent; end
sig { params(_payment_intent: T.nilable(String)).returns(T.nilable(String)) }
def payment_intent=(_payment_intent); end
# Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.
sig { returns(T.nilable(T::Boolean)) }
def refund_application_fee; end
sig {
params(_refund_application_fee: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def refund_application_fee=(_refund_application_fee); end
# Configuration overrides
sig {
returns(T.nilable(::Stripe::Terminal::ReaderService::RefundPaymentParams::RefundPaymentConfig))
}
def refund_payment_config; end
sig {
params(_refund_payment_config: T.nilable(::Stripe::Terminal::ReaderService::RefundPaymentParams::RefundPaymentConfig)).returns(T.nilable(::Stripe::Terminal::ReaderService::RefundPaymentParams::RefundPaymentConfig))
}
def refund_payment_config=(_refund_payment_config); end
# Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.
sig { returns(T.nilable(T::Boolean)) }
def reverse_transfer; end
sig { params(_reverse_transfer: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def reverse_transfer=(_reverse_transfer); end
sig {
params(amount: T.nilable(Integer), charge: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), payment_intent: T.nilable(String), refund_application_fee: T.nilable(T::Boolean), refund_payment_config: T.nilable(::Stripe::Terminal::ReaderService::RefundPaymentParams::RefundPaymentConfig), reverse_transfer: T.nilable(T::Boolean)).void
}
def initialize(
amount: nil,
charge: nil,
expand: nil,
metadata: nil,
payment_intent: nil,
refund_application_fee: nil,
refund_payment_config: nil,
reverse_transfer: nil
); end
end
class SetReaderDisplayParams < Stripe::RequestParams
class Cart < Stripe::RequestParams
class LineItem < Stripe::RequestParams
# The price of the item in cents.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# The description or name of the item.
sig { returns(String) }
def description; end
sig { params(_description: String).returns(String) }
def description=(_description); end
# The quantity of the line item being purchased.
sig { returns(Integer) }
def quantity; end
sig { params(_quantity: Integer).returns(Integer) }
def quantity=(_quantity); end
sig { params(amount: Integer, description: String, quantity: Integer).void }
def initialize(amount: nil, description: nil, quantity: nil); end
end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Array of line items that were purchased.
sig {
returns(T::Array[::Stripe::Terminal::ReaderService::SetReaderDisplayParams::Cart::LineItem])
}
def line_items; end
sig {
params(_line_items: T::Array[::Stripe::Terminal::ReaderService::SetReaderDisplayParams::Cart::LineItem]).returns(T::Array[::Stripe::Terminal::ReaderService::SetReaderDisplayParams::Cart::LineItem])
}
def line_items=(_line_items); end
# The amount of tax in cents.
sig { returns(T.nilable(Integer)) }
def tax; end
sig { params(_tax: T.nilable(Integer)).returns(T.nilable(Integer)) }
def tax=(_tax); end
# Total balance of cart due in cents.
sig { returns(Integer) }
def total; end
sig { params(_total: Integer).returns(Integer) }
def total=(_total); end
sig {
params(currency: String, line_items: T::Array[::Stripe::Terminal::ReaderService::SetReaderDisplayParams::Cart::LineItem], tax: T.nilable(Integer), total: Integer).void
}
def initialize(currency: nil, line_items: nil, tax: nil, total: nil); end
end
# Cart
sig { returns(T.nilable(::Stripe::Terminal::ReaderService::SetReaderDisplayParams::Cart)) }
def cart; end
sig {
params(_cart: T.nilable(::Stripe::Terminal::ReaderService::SetReaderDisplayParams::Cart)).returns(T.nilable(::Stripe::Terminal::ReaderService::SetReaderDisplayParams::Cart))
}
def cart=(_cart); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Type
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(cart: T.nilable(::Stripe::Terminal::ReaderService::SetReaderDisplayParams::Cart), expand: T.nilable(T::Array[String]), type: String).void
}
def initialize(cart: nil, expand: nil, type: nil); end
end
# Cancels the current reader action.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::ReaderService::CancelActionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def cancel_action(reader, params = {}, opts = {}); end
# Initiates an input collection flow on a Reader.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::ReaderService::CollectInputsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def collect_inputs(reader, params = {}, opts = {}); end
# Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::ReaderService::CollectPaymentMethodParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def collect_payment_method(reader, params = {}, opts = {}); end
# Finalizes a payment on a Reader.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::ReaderService::ConfirmPaymentIntentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def confirm_payment_intent(reader, params = {}, opts = {}); end
# Creates a new Reader object.
sig {
params(params: T.any(::Stripe::Terminal::ReaderService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def create(params = {}, opts = {}); end
# Deletes a Reader object.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::ReaderService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def delete(reader, params = {}, opts = {}); end
# Returns a list of Reader objects.
sig {
params(params: T.any(::Stripe::Terminal::ReaderService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Initiates a payment flow on a Reader.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::ReaderService::ProcessPaymentIntentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def process_payment_intent(reader, params = {}, opts = {}); end
# Initiates a setup intent flow on a Reader.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::ReaderService::ProcessSetupIntentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def process_setup_intent(reader, params = {}, opts = {}); end
# Initiates a refund on a Reader
sig {
params(reader: String, params: T.any(::Stripe::Terminal::ReaderService::RefundPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def refund_payment(reader, params = {}, opts = {}); end
# Retrieves a Reader object.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::ReaderService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def retrieve(reader, params = {}, opts = {}); end
# Sets reader display to show cart details.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::ReaderService::SetReaderDisplayParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def set_reader_display(reader, params = {}, opts = {}); end
# Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
sig {
params(reader: String, params: T.any(::Stripe::Terminal::ReaderService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def update(reader, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Terminal
class ReaderCollectedDataService < StripeService
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Retrieve data collected using Reader hardware.
sig {
params(reader_collected_data: String, params: T.any(::Stripe::Terminal::ReaderCollectedDataService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::ReaderCollectedData)
}
def retrieve(reader_collected_data, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class TestHelpersService < StripeService
attr_reader :confirmation_tokens
attr_reader :customers
attr_reader :issuing
attr_reader :refunds
attr_reader :terminal
attr_reader :test_clocks
attr_reader :treasury
end
end
# typed: true
module Stripe
module TestHelpers
class ConfirmationTokenService < StripeService
class CreateParams < Stripe::RequestParams
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Institution number of the customer's bank.
sig { returns(String) }
def institution_number; end
sig { params(_institution_number: String).returns(String) }
def institution_number=(_institution_number); end
# Transit number of the customer's bank.
sig { returns(String) }
def transit_number; end
sig { params(_transit_number: String).returns(String) }
def transit_number=(_transit_number); end
sig {
params(account_number: String, institution_number: String, transit_number: String).void
}
def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(String) }
def bsb_number; end
sig { params(_bsb_number: String).returns(String) }
def bsb_number=(_bsb_number); end
sig { params(account_number: String, bsb_number: String).void }
def initialize(account_number: nil, bsb_number: nil); end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Sort code of the bank account. (e.g., `10-20-30`)
sig { returns(T.nilable(String)) }
def sort_code; end
sig { params(_sort_code: T.nilable(String)).returns(T.nilable(String)) }
def sort_code=(_sort_code); end
sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
def initialize(account_number: nil, sort_code: nil); end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tax_id: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
sig { returns(String) }
def tax_id; end
sig { params(_tax_id: String).returns(String) }
def tax_id=(_tax_id); end
sig { params(tax_id: String).void }
def initialize(tax_id: nil); end
end
class Cashapp < Stripe::RequestParams; end
class Crypto < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The customer's bank.
sig { returns(String) }
def bank; end
sig { params(_bank: String).returns(String) }
def bank=(_bank); end
sig { params(account_holder_type: T.nilable(String), bank: String).void }
def initialize(account_holder_type: nil, bank: nil); end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Klarna::Dob))
}
def dob; end
sig {
params(_dob: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Klarna::Dob)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Klarna::Dob))
}
def dob=(_dob); end
sig {
params(dob: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Klarna::Dob)).void
}
def initialize(dob: nil); end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
sig { returns(T.nilable(String)) }
def funding; end
sig { params(_funding: T.nilable(String)).returns(T.nilable(String)) }
def funding=(_funding); end
sig { params(funding: T.nilable(String)).void }
def initialize(funding: nil); end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The account number for the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The numeric code for the bank account's bank.
sig { returns(String) }
def bank_code; end
sig { params(_bank_code: String).returns(String) }
def bank_code=(_bank_code); end
# The numeric code for the bank account's bank branch.
sig { returns(String) }
def branch_code; end
sig { params(_branch_code: String).returns(String) }
def branch_code=(_branch_code); end
# Attribute for param field reference
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
# The suffix of the bank account number.
sig { returns(String) }
def suffix; end
sig { params(_suffix: String).returns(String) }
def suffix=(_suffix); end
sig {
params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
); end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
sig { params(bank: T.nilable(String)).void }
def initialize(bank: nil); end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Paypay < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Bank-State-Branch number of the bank account.
sig { returns(T.nilable(String)) }
def bsb_number; end
sig { params(_bsb_number: T.nilable(String)).returns(T.nilable(String)) }
def bsb_number=(_bsb_number); end
# The PayID alias for the bank account.
sig { returns(T.nilable(String)) }
def pay_id; end
sig { params(_pay_id: T.nilable(String)).returns(T.nilable(String)) }
def pay_id=(_pay_id); end
sig {
params(account_number: T.nilable(String), bsb_number: T.nilable(String), pay_id: T.nilable(String)).void
}
def initialize(account_number: nil, bsb_number: nil, pay_id: nil); end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sig { returns(T.nilable(String)) }
def session; end
sig { params(_session: T.nilable(String)).returns(T.nilable(String)) }
def session=(_session); end
sig { params(session: T.nilable(String)).void }
def initialize(session: nil); end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
# Customer's date of birth
sig {
returns(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Rechnung::Dob)
}
def dob; end
sig {
params(_dob: ::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Rechnung::Dob).returns(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Rechnung::Dob)
}
def dob=(_dob); end
sig {
params(dob: ::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Rechnung::Dob).void
}
def initialize(dob: nil); end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
sig { returns(String) }
def iban; end
sig { params(_iban: String).returns(String) }
def iban=(_iban); end
sig { params(iban: String).void }
def initialize(iban: nil); end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
sig { params(country: String).void }
def initialize(country: nil); end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
sig { returns(T.nilable(String)) }
def account; end
sig { params(_account: T.nilable(String)).returns(T.nilable(String)) }
def account=(_account); end
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
sig { params(account: T.nilable(String), source_type: T.nilable(String)).void }
def initialize(account: nil, source_type: nil); end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig {
params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String))
}
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AcssDebit))
}
def acss_debit; end
sig {
params(_acss_debit: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AcssDebit)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AcssDebit))
}
def acss_debit=(_acss_debit); end
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Affirm))
}
def affirm; end
sig {
params(_affirm: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Affirm)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Affirm))
}
def affirm=(_affirm); end
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay; end
sig {
params(_afterpay_clearpay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AfterpayClearpay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AfterpayClearpay))
}
def afterpay_clearpay=(_afterpay_clearpay); end
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Alipay))
}
def alipay; end
sig {
params(_alipay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Alipay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Alipay))
}
def alipay=(_alipay); end
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
sig { returns(T.nilable(String)) }
def allow_redisplay; end
sig { params(_allow_redisplay: T.nilable(String)).returns(T.nilable(String)) }
def allow_redisplay=(_allow_redisplay); end
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Alma))
}
def alma; end
sig {
params(_alma: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Alma)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Alma))
}
def alma=(_alma); end
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay; end
sig {
params(_amazon_pay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AmazonPay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AmazonPay))
}
def amazon_pay=(_amazon_pay); end
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit; end
sig {
params(_au_becs_debit: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AuBecsDebit)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AuBecsDebit))
}
def au_becs_debit=(_au_becs_debit); end
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit; end
sig {
params(_bacs_debit: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::BacsDebit)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::BacsDebit))
}
def bacs_debit=(_bacs_debit); end
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Bancontact))
}
def bancontact; end
sig {
params(_bancontact: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Bancontact)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Bancontact))
}
def bancontact=(_bancontact); end
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Billie))
}
def billie; end
sig {
params(_billie: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Billie)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Billie))
}
def billie=(_billie); end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::BillingDetails)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::BillingDetails))
}
def billing_details=(_billing_details); end
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Blik))
}
def blik; end
sig {
params(_blik: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Blik)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Blik))
}
def blik=(_blik); end
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Boleto))
}
def boleto; end
sig {
params(_boleto: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Boleto)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Boleto))
}
def boleto=(_boleto); end
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Cashapp))
}
def cashapp; end
sig {
params(_cashapp: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Cashapp)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Cashapp))
}
def cashapp=(_cashapp); end
# If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Crypto))
}
def crypto; end
sig {
params(_crypto: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Crypto)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Crypto))
}
def crypto=(_crypto); end
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance; end
sig {
params(_customer_balance: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::CustomerBalance)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::CustomerBalance))
}
def customer_balance=(_customer_balance); end
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Eps))
}
def eps; end
sig {
params(_eps: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Eps)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Eps))
}
def eps=(_eps); end
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Fpx))
}
def fpx; end
sig {
params(_fpx: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Fpx)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Fpx))
}
def fpx=(_fpx); end
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Giropay))
}
def giropay; end
sig {
params(_giropay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Giropay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Giropay))
}
def giropay=(_giropay); end
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Gopay))
}
def gopay; end
sig {
params(_gopay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Gopay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Gopay))
}
def gopay=(_gopay); end
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Grabpay))
}
def grabpay; end
sig {
params(_grabpay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Grabpay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Grabpay))
}
def grabpay=(_grabpay); end
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer; end
sig {
params(_id_bank_transfer: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::IdBankTransfer)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::IdBankTransfer))
}
def id_bank_transfer=(_id_bank_transfer); end
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Ideal))
}
def ideal; end
sig {
params(_ideal: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Ideal)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Ideal))
}
def ideal=(_ideal); end
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::InteracPresent))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::InteracPresent)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::InteracPresent))
}
def interac_present=(_interac_present); end
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay; end
sig {
params(_kakao_pay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::KakaoPay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::KakaoPay))
}
def kakao_pay=(_kakao_pay); end
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Klarna))
}
def klarna; end
sig {
params(_klarna: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Klarna)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Klarna))
}
def klarna=(_klarna); end
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Konbini))
}
def konbini; end
sig {
params(_konbini: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Konbini)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Konbini))
}
def konbini=(_konbini); end
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::KrCard))
}
def kr_card; end
sig {
params(_kr_card: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::KrCard)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::KrCard))
}
def kr_card=(_kr_card); end
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Link))
}
def link; end
sig {
params(_link: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Link)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Link))
}
def link=(_link); end
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::MbWay))
}
def mb_way; end
sig {
params(_mb_way: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::MbWay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::MbWay))
}
def mb_way=(_mb_way); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Mobilepay))
}
def mobilepay; end
sig {
params(_mobilepay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Mobilepay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Mobilepay))
}
def mobilepay=(_mobilepay); end
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Multibanco))
}
def multibanco; end
sig {
params(_multibanco: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Multibanco)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Multibanco))
}
def multibanco=(_multibanco); end
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::NaverPay))
}
def naver_pay; end
sig {
params(_naver_pay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::NaverPay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::NaverPay))
}
def naver_pay=(_naver_pay); end
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account; end
sig {
params(_nz_bank_account: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::NzBankAccount)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::NzBankAccount))
}
def nz_bank_account=(_nz_bank_account); end
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Oxxo))
}
def oxxo; end
sig {
params(_oxxo: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Oxxo)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Oxxo))
}
def oxxo=(_oxxo); end
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::P24))
}
def p24; end
sig {
params(_p24: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::P24)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::P24))
}
def p24=(_p24); end
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank; end
sig {
params(_pay_by_bank: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::PayByBank)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::PayByBank))
}
def pay_by_bank=(_pay_by_bank); end
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Payco))
}
def payco; end
sig {
params(_payco: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Payco)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Payco))
}
def payco=(_payco); end
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Paynow))
}
def paynow; end
sig {
params(_paynow: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Paynow)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Paynow))
}
def paynow=(_paynow); end
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Paypal))
}
def paypal; end
sig {
params(_paypal: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Paypal)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Paypal))
}
def paypal=(_paypal); end
# If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Paypay))
}
def paypay; end
sig {
params(_paypay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Paypay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Paypay))
}
def paypay=(_paypay); end
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Payto))
}
def payto; end
sig {
params(_payto: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Payto)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Payto))
}
def payto=(_payto); end
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Pix))
}
def pix; end
sig {
params(_pix: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Pix)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Pix))
}
def pix=(_pix); end
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Promptpay))
}
def promptpay; end
sig {
params(_promptpay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Promptpay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Promptpay))
}
def promptpay=(_promptpay); end
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Qris))
}
def qris; end
sig {
params(_qris: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Qris)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Qris))
}
def qris=(_qris); end
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::RadarOptions))
}
def radar_options; end
sig {
params(_radar_options: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::RadarOptions)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::RadarOptions))
}
def radar_options=(_radar_options); end
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Rechnung))
}
def rechnung; end
sig {
params(_rechnung: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Rechnung)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Rechnung))
}
def rechnung=(_rechnung); end
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay; end
sig {
params(_revolut_pay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::RevolutPay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::RevolutPay))
}
def revolut_pay=(_revolut_pay); end
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay; end
sig {
params(_samsung_pay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::SamsungPay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::SamsungPay))
}
def samsung_pay=(_samsung_pay); end
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Satispay))
}
def satispay; end
sig {
params(_satispay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Satispay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Satispay))
}
def satispay=(_satispay); end
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit; end
sig {
params(_sepa_debit: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::SepaDebit)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::SepaDebit))
}
def sepa_debit=(_sepa_debit); end
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Shopeepay))
}
def shopeepay; end
sig {
params(_shopeepay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Shopeepay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Shopeepay))
}
def shopeepay=(_shopeepay); end
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Sofort))
}
def sofort; end
sig {
params(_sofort: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Sofort)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Sofort))
}
def sofort=(_sofort); end
# This hash contains details about the Stripe balance payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::StripeBalance)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Swish))
}
def swish; end
sig {
params(_swish: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Swish)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Swish))
}
def swish=(_swish); end
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Twint))
}
def twint; end
sig {
params(_twint: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Twint)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Twint))
}
def twint=(_twint); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::UsBankAccount)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::WechatPay))
}
def wechat_pay; end
sig {
params(_wechat_pay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::WechatPay)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::WechatPay))
}
def wechat_pay=(_wechat_pay); end
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Zip))
}
def zip; end
sig {
params(_zip: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Zip)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Zip))
}
def zip=(_zip); end
sig {
params(acss_debit: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Cashapp), crypto: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Crypto), customer_balance: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Giropay), gopay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Gopay), grabpay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Grabpay), id_bank_transfer: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::IdBankTransfer), ideal: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Link), mb_way: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::MbWay), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Paypal), paypay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Paypay), payto: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Payto), pix: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Promptpay), qris: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Qris), radar_options: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::RadarOptions), rechnung: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Rechnung), revolut_pay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::SepaDebit), shopeepay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Shopeepay), sofort: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Sofort), stripe_balance: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::StripeBalance), swish: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::Zip)).void
}
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
crypto: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
paypay: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
); end
end
class PaymentMethodOptions < Stripe::RequestParams
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
class Plan < Stripe::RequestParams
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
sig { returns(T.nilable(Integer)) }
def count; end
sig { params(_count: T.nilable(Integer)).returns(T.nilable(Integer)) }
def count=(_count); end
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
# One of `month`.
sig { returns(T.nilable(String)) }
def interval; end
sig { params(_interval: T.nilable(String)).returns(T.nilable(String)) }
def interval=(_interval); end
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(count: T.nilable(Integer), interval: T.nilable(String), type: String).void
}
def initialize(count: nil, interval: nil, type: nil); end
end
# The selected installment plan to use for this payment attempt.
# This parameter can only be provided during confirmation.
sig {
returns(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodOptions::Card::Installments::Plan)
}
def plan; end
sig {
params(_plan: ::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodOptions::Card::Installments::Plan).returns(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodOptions::Card::Installments::Plan)
}
def plan=(_plan); end
sig {
params(plan: ::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodOptions::Card::Installments::Plan).void
}
def initialize(plan: nil); end
end
# Installment configuration for payments confirmed using this ConfirmationToken.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodOptions::Card::Installments))
}
def installments; end
sig {
params(_installments: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodOptions::Card::Installments)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodOptions::Card::Installments))
}
def installments=(_installments); end
sig {
params(installments: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodOptions::Card::Installments)).void
}
def initialize(installments: nil); end
end
# Configuration for any card payments confirmed using this ConfirmationToken.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodOptions::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodOptions::Card))
}
def card=(_card); end
sig {
params(card: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodOptions::Card)).void
}
def initialize(card: nil); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Shipping address
sig {
returns(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::Shipping::Address)
}
def address; end
sig {
params(_address: ::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::Shipping::Address).returns(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::Shipping::Address)
}
def address=(_address); end
# Recipient name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# Recipient phone (including extension)
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: ::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::Shipping::Address, name: String, phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# ID of an existing PaymentMethod.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# If provided, this hash will be used to create a PaymentMethod.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData))
}
def payment_method_data; end
sig {
params(_payment_method_data: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData))
}
def payment_method_data=(_payment_method_data); end
# Payment-method-specific configuration for this ConfirmationToken.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodOptions))
}
def payment_method_options; end
sig {
params(_payment_method_options: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodOptions)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodOptions))
}
def payment_method_options=(_payment_method_options); end
# Return URL used to confirm the Intent.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
# Indicates that you intend to make future payments with this ConfirmationToken's payment method.
#
# The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.
sig { returns(T.nilable(String)) }
def setup_future_usage; end
sig { params(_setup_future_usage: T.nilable(String)).returns(T.nilable(String)) }
def setup_future_usage=(_setup_future_usage); end
# Shipping information for this ConfirmationToken.
sig {
returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::Shipping))
}
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::Shipping)).returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::Shipping))
}
def shipping=(_shipping); end
sig {
params(expand: T.nilable(T::Array[String]), payment_method: T.nilable(String), payment_method_data: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodOptions), return_url: T.nilable(String), setup_future_usage: T.nilable(String), shipping: T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::Shipping)).void
}
def initialize(
expand: nil,
payment_method: nil,
payment_method_data: nil,
payment_method_options: nil,
return_url: nil,
setup_future_usage: nil,
shipping: nil
); end
end
# Creates a test mode Confirmation Token server side for your integration tests.
sig {
params(params: T.any(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ConfirmationToken)
}
def create(params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module TestHelpers
class CustomerService < StripeService
class FundCashBalanceParams < Stripe::RequestParams
# Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's [reconciliation algorithm](https://stripe.com/docs/payments/customer-balance/reconciliation) applies to different user inputs.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
sig {
params(amount: Integer, currency: String, expand: T.nilable(T::Array[String]), reference: T.nilable(String)).void
}
def initialize(amount: nil, currency: nil, expand: nil, reference: nil); end
end
# Create an incoming testmode bank transfer
sig {
params(customer: String, params: T.any(::Stripe::TestHelpers::CustomerService::FundCashBalanceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerCashBalanceTransaction)
}
def fund_cash_balance(customer, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module TestHelpers
class IssuingService < StripeService
attr_reader :authorizations
attr_reader :cards
attr_reader :personalization_designs
attr_reader :transactions
end
end
end
# typed: true
module Stripe
module TestHelpers
module Issuing
class AuthorizationService < StripeService
class CreateParams < Stripe::RequestParams
class AmountDetails < Stripe::RequestParams
# The ATM withdrawal fee.
sig { returns(T.nilable(Integer)) }
def atm_fee; end
sig { params(_atm_fee: T.nilable(Integer)).returns(T.nilable(Integer)) }
def atm_fee=(_atm_fee); end
# The amount of cash requested by the cardholder.
sig { returns(T.nilable(Integer)) }
def cashback_amount; end
sig { params(_cashback_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def cashback_amount=(_cashback_amount); end
sig { params(atm_fee: T.nilable(Integer), cashback_amount: T.nilable(Integer)).void }
def initialize(atm_fee: nil, cashback_amount: nil); end
end
class Fleet < Stripe::RequestParams
class CardholderPromptData < Stripe::RequestParams
# Driver ID.
sig { returns(T.nilable(String)) }
def driver_id; end
sig { params(_driver_id: T.nilable(String)).returns(T.nilable(String)) }
def driver_id=(_driver_id); end
# Odometer reading.
sig { returns(T.nilable(Integer)) }
def odometer; end
sig { params(_odometer: T.nilable(Integer)).returns(T.nilable(Integer)) }
def odometer=(_odometer); end
# An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
sig { returns(T.nilable(String)) }
def unspecified_id; end
sig { params(_unspecified_id: T.nilable(String)).returns(T.nilable(String)) }
def unspecified_id=(_unspecified_id); end
# User ID.
sig { returns(T.nilable(String)) }
def user_id; end
sig { params(_user_id: T.nilable(String)).returns(T.nilable(String)) }
def user_id=(_user_id); end
# Vehicle number.
sig { returns(T.nilable(String)) }
def vehicle_number; end
sig { params(_vehicle_number: T.nilable(String)).returns(T.nilable(String)) }
def vehicle_number=(_vehicle_number); end
sig {
params(driver_id: T.nilable(String), odometer: T.nilable(Integer), unspecified_id: T.nilable(String), user_id: T.nilable(String), vehicle_number: T.nilable(String)).void
}
def initialize(
driver_id: nil,
odometer: nil,
unspecified_id: nil,
user_id: nil,
vehicle_number: nil
); end
end
class ReportedBreakdown < Stripe::RequestParams
class Fuel < Stripe::RequestParams
# Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig { params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class NonFuel < Stripe::RequestParams
# Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig { params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class Tax < Stripe::RequestParams
# Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def local_amount_decimal; end
sig { params(_local_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def local_amount_decimal=(_local_amount_decimal); end
# Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def national_amount_decimal; end
sig {
params(_national_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def national_amount_decimal=(_national_amount_decimal); end
sig {
params(local_amount_decimal: T.nilable(String), national_amount_decimal: T.nilable(String)).void
}
def initialize(local_amount_decimal: nil, national_amount_decimal: nil); end
end
# Breakdown of fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::ReportedBreakdown::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::ReportedBreakdown::Fuel)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::ReportedBreakdown::Fuel))
}
def fuel=(_fuel); end
# Breakdown of non-fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel; end
sig {
params(_non_fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::ReportedBreakdown::NonFuel)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel=(_non_fuel); end
# Information about tax included in this transaction.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::ReportedBreakdown::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::ReportedBreakdown::Tax)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::ReportedBreakdown::Tax))
}
def tax=(_tax); end
sig {
params(fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::ReportedBreakdown::Fuel), non_fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::ReportedBreakdown::NonFuel), tax: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::ReportedBreakdown::Tax)).void
}
def initialize(fuel: nil, non_fuel: nil, tax: nil); end
end
# Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::CardholderPromptData))
}
def cardholder_prompt_data; end
sig {
params(_cardholder_prompt_data: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::CardholderPromptData)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::CardholderPromptData))
}
def cardholder_prompt_data=(_cardholder_prompt_data); end
# The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
sig { returns(T.nilable(String)) }
def purchase_type; end
sig { params(_purchase_type: T.nilable(String)).returns(T.nilable(String)) }
def purchase_type=(_purchase_type); end
# More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::ReportedBreakdown))
}
def reported_breakdown; end
sig {
params(_reported_breakdown: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::ReportedBreakdown)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::ReportedBreakdown))
}
def reported_breakdown=(_reported_breakdown); end
# The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
sig { returns(T.nilable(String)) }
def service_type; end
sig { params(_service_type: T.nilable(String)).returns(T.nilable(String)) }
def service_type=(_service_type); end
sig {
params(cardholder_prompt_data: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::CardholderPromptData), purchase_type: T.nilable(String), reported_breakdown: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet::ReportedBreakdown), service_type: T.nilable(String)).void
}
def initialize(
cardholder_prompt_data: nil,
purchase_type: nil,
reported_breakdown: nil,
service_type: nil
); end
end
class Fuel < Stripe::RequestParams
# [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
sig { returns(T.nilable(String)) }
def industry_product_code; end
sig { params(_industry_product_code: T.nilable(String)).returns(T.nilable(String)) }
def industry_product_code=(_industry_product_code); end
# The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def quantity_decimal; end
sig { params(_quantity_decimal: T.nilable(String)).returns(T.nilable(String)) }
def quantity_decimal=(_quantity_decimal); end
# The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
# The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_cost_decimal; end
sig { params(_unit_cost_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_cost_decimal=(_unit_cost_decimal); end
sig {
params(industry_product_code: T.nilable(String), quantity_decimal: T.nilable(String), type: T.nilable(String), unit: T.nilable(String), unit_cost_decimal: T.nilable(String)).void
}
def initialize(
industry_product_code: nil,
quantity_decimal: nil,
type: nil,
unit: nil,
unit_cost_decimal: nil
); end
end
class MerchantData < Stripe::RequestParams
# A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# City where the seller is located
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Country where the seller is located
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Name of the seller
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
sig { returns(T.nilable(String)) }
def network_id; end
sig { params(_network_id: T.nilable(String)).returns(T.nilable(String)) }
def network_id=(_network_id); end
# Postal code where the seller is located
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State where the seller is located
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# An ID assigned by the seller to the location of the sale.
sig { returns(T.nilable(String)) }
def terminal_id; end
sig { params(_terminal_id: T.nilable(String)).returns(T.nilable(String)) }
def terminal_id=(_terminal_id); end
# URL provided by the merchant on a 3DS request
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(category: T.nilable(String), city: T.nilable(String), country: T.nilable(String), name: T.nilable(String), network_id: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), terminal_id: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
category: nil,
city: nil,
country: nil,
name: nil,
network_id: nil,
postal_code: nil,
state: nil,
terminal_id: nil,
url: nil
); end
end
class NetworkData < Stripe::RequestParams
# Identifier assigned to the acquirer by the card network.
sig { returns(T.nilable(String)) }
def acquiring_institution_id; end
sig { params(_acquiring_institution_id: T.nilable(String)).returns(T.nilable(String)) }
def acquiring_institution_id=(_acquiring_institution_id); end
sig { params(acquiring_institution_id: T.nilable(String)).void }
def initialize(acquiring_institution_id: nil); end
end
class RiskAssessment < Stripe::RequestParams
class CardTestingRisk < Stripe::RequestParams
# The % of declines due to a card number not existing in the past hour, taking place at the same merchant. Higher rates correspond to a greater probability of card testing activity, meaning bad actors may be attempting different card number combinations to guess a correct one. Takes on values between 0 and 100.
sig { returns(T.nilable(Integer)) }
def invalid_account_number_decline_rate_past_hour; end
sig {
params(_invalid_account_number_decline_rate_past_hour: T.nilable(Integer)).returns(T.nilable(Integer))
}
def invalid_account_number_decline_rate_past_hour=(
_invalid_account_number_decline_rate_past_hour
); end
# The % of declines due to incorrect verification data (like CVV or expiry) in the past hour, taking place at the same merchant. Higher rates correspond to a greater probability of bad actors attempting to utilize valid card credentials at merchants with verification requirements. Takes on values between 0 and 100.
sig { returns(T.nilable(Integer)) }
def invalid_credentials_decline_rate_past_hour; end
sig {
params(_invalid_credentials_decline_rate_past_hour: T.nilable(Integer)).returns(T.nilable(Integer))
}
def invalid_credentials_decline_rate_past_hour=(
_invalid_credentials_decline_rate_past_hour
); end
# The likelihood that this authorization is associated with card testing activity. This is assessed by evaluating decline activity over the last hour.
sig { returns(String) }
def risk_level; end
sig { params(_risk_level: String).returns(String) }
def risk_level=(_risk_level); end
sig {
params(invalid_account_number_decline_rate_past_hour: T.nilable(Integer), invalid_credentials_decline_rate_past_hour: T.nilable(Integer), risk_level: String).void
}
def initialize(
invalid_account_number_decline_rate_past_hour: nil,
invalid_credentials_decline_rate_past_hour: nil,
risk_level: nil
); end
end
class MerchantDisputeRisk < Stripe::RequestParams
# The dispute rate observed across all Stripe Issuing authorizations for this merchant. For example, a value of 50 means 50% of authorizations from this merchant on Stripe Issuing have resulted in a dispute. Higher values mean a higher likelihood the authorization is disputed. Takes on values between 0 and 100.
sig { returns(T.nilable(Integer)) }
def dispute_rate; end
sig { params(_dispute_rate: T.nilable(Integer)).returns(T.nilable(Integer)) }
def dispute_rate=(_dispute_rate); end
# The likelihood that authorizations from this merchant will result in a dispute based on their history on Stripe Issuing.
sig { returns(String) }
def risk_level; end
sig { params(_risk_level: String).returns(String) }
def risk_level=(_risk_level); end
sig { params(dispute_rate: T.nilable(Integer), risk_level: String).void }
def initialize(dispute_rate: nil, risk_level: nil); end
end
# Stripe's assessment of this authorization's likelihood of being card testing activity.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::RiskAssessment::CardTestingRisk))
}
def card_testing_risk; end
sig {
params(_card_testing_risk: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::RiskAssessment::CardTestingRisk)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::RiskAssessment::CardTestingRisk))
}
def card_testing_risk=(_card_testing_risk); end
# The dispute risk of the merchant (the seller on a purchase) on an authorization based on all Stripe Issuing activity.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::RiskAssessment::MerchantDisputeRisk))
}
def merchant_dispute_risk; end
sig {
params(_merchant_dispute_risk: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::RiskAssessment::MerchantDisputeRisk)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::RiskAssessment::MerchantDisputeRisk))
}
def merchant_dispute_risk=(_merchant_dispute_risk); end
sig {
params(card_testing_risk: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::RiskAssessment::CardTestingRisk), merchant_dispute_risk: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::RiskAssessment::MerchantDisputeRisk)).void
}
def initialize(card_testing_risk: nil, merchant_dispute_risk: nil); end
end
class VerificationData < Stripe::RequestParams
class AuthenticationExemption < Stripe::RequestParams
# The entity that requested the exemption, either the acquiring merchant or the Issuing user.
sig { returns(String) }
def claimed_by; end
sig { params(_claimed_by: String).returns(String) }
def claimed_by=(_claimed_by); end
# The specific exemption claimed for this authorization.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(claimed_by: String, type: String).void }
def initialize(claimed_by: nil, type: nil); end
end
class ThreeDSecure < Stripe::RequestParams
# The outcome of the 3D Secure authentication request.
sig { returns(String) }
def result; end
sig { params(_result: String).returns(String) }
def result=(_result); end
sig { params(result: String).void }
def initialize(result: nil); end
end
# Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`.
sig { returns(T.nilable(String)) }
def address_line1_check; end
sig { params(_address_line1_check: T.nilable(String)).returns(T.nilable(String)) }
def address_line1_check=(_address_line1_check); end
# Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`.
sig { returns(T.nilable(String)) }
def address_postal_code_check; end
sig { params(_address_postal_code_check: T.nilable(String)).returns(T.nilable(String)) }
def address_postal_code_check=(_address_postal_code_check); end
# The exemption applied to this authorization.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::VerificationData::AuthenticationExemption))
}
def authentication_exemption; end
sig {
params(_authentication_exemption: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::VerificationData::AuthenticationExemption)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::VerificationData::AuthenticationExemption))
}
def authentication_exemption=(_authentication_exemption); end
# Whether the cardholder provided a CVC and if it matched Stripe’s record.
sig { returns(T.nilable(String)) }
def cvc_check; end
sig { params(_cvc_check: T.nilable(String)).returns(T.nilable(String)) }
def cvc_check=(_cvc_check); end
# Whether the cardholder provided an expiry date and if it matched Stripe’s record.
sig { returns(T.nilable(String)) }
def expiry_check; end
sig { params(_expiry_check: T.nilable(String)).returns(T.nilable(String)) }
def expiry_check=(_expiry_check); end
# 3D Secure details.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::VerificationData::ThreeDSecure))
}
def three_d_secure; end
sig {
params(_three_d_secure: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::VerificationData::ThreeDSecure)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::VerificationData::ThreeDSecure))
}
def three_d_secure=(_three_d_secure); end
sig {
params(address_line1_check: T.nilable(String), address_postal_code_check: T.nilable(String), authentication_exemption: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::VerificationData::AuthenticationExemption), cvc_check: T.nilable(String), expiry_check: T.nilable(String), three_d_secure: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::VerificationData::ThreeDSecure)).void
}
def initialize(
address_line1_check: nil,
address_postal_code_check: nil,
authentication_exemption: nil,
cvc_check: nil,
expiry_check: nil,
three_d_secure: nil
); end
end
# The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::AmountDetails))
}
def amount_details; end
sig {
params(_amount_details: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::AmountDetails)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::AmountDetails))
}
def amount_details=(_amount_details); end
# How the card details were provided. Defaults to online.
sig { returns(T.nilable(String)) }
def authorization_method; end
sig { params(_authorization_method: T.nilable(String)).returns(T.nilable(String)) }
def authorization_method=(_authorization_method); end
# Card associated with this authorization.
sig { returns(String) }
def card; end
sig { params(_card: String).returns(String) }
def card=(_card); end
# The currency of the authorization. If not provided, defaults to the currency of the card. 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Fleet-specific information for authorizations using Fleet cards.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet))
}
def fleet; end
sig {
params(_fleet: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet))
}
def fleet=(_fleet); end
# Probability that this transaction can be disputed in the event of fraud. Assessed by comparing the characteristics of the authorization to card network rules.
sig { returns(T.nilable(String)) }
def fraud_disputability_likelihood; end
sig {
params(_fraud_disputability_likelihood: T.nilable(String)).returns(T.nilable(String))
}
def fraud_disputability_likelihood=(_fraud_disputability_likelihood); end
# Information about fuel that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fuel)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fuel))
}
def fuel=(_fuel); end
# If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.
sig { returns(T.nilable(T::Boolean)) }
def is_amount_controllable; end
sig {
params(_is_amount_controllable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def is_amount_controllable=(_is_amount_controllable); end
# The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(Integer)) }
def merchant_amount; end
sig { params(_merchant_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def merchant_amount=(_merchant_amount); end
# The currency of the authorization. If not provided, defaults to the currency of the card. 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(T.nilable(String)) }
def merchant_currency; end
sig { params(_merchant_currency: T.nilable(String)).returns(T.nilable(String)) }
def merchant_currency=(_merchant_currency); end
# Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::MerchantData))
}
def merchant_data; end
sig {
params(_merchant_data: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::MerchantData)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::MerchantData))
}
def merchant_data=(_merchant_data); end
# Details about the authorization, such as identifiers, set by the card network.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::NetworkData))
}
def network_data; end
sig {
params(_network_data: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::NetworkData)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::NetworkData))
}
def network_data=(_network_data); end
# Stripe’s assessment of the fraud risk for this authorization.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::RiskAssessment))
}
def risk_assessment; end
sig {
params(_risk_assessment: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::RiskAssessment)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::RiskAssessment))
}
def risk_assessment=(_risk_assessment); end
# Verifications that Stripe performed on information that the cardholder provided to the merchant.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::VerificationData))
}
def verification_data; end
sig {
params(_verification_data: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::VerificationData)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::VerificationData))
}
def verification_data=(_verification_data); end
# The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.
sig { returns(T.nilable(String)) }
def wallet; end
sig { params(_wallet: T.nilable(String)).returns(T.nilable(String)) }
def wallet=(_wallet); end
sig {
params(amount: T.nilable(Integer), amount_details: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::AmountDetails), authorization_method: T.nilable(String), card: String, currency: T.nilable(String), expand: T.nilable(T::Array[String]), fleet: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fleet), fraud_disputability_likelihood: T.nilable(String), fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::Fuel), is_amount_controllable: T.nilable(T::Boolean), merchant_amount: T.nilable(Integer), merchant_currency: T.nilable(String), merchant_data: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::MerchantData), network_data: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::NetworkData), risk_assessment: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::RiskAssessment), verification_data: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams::VerificationData), wallet: T.nilable(String)).void
}
def initialize(
amount: nil,
amount_details: nil,
authorization_method: nil,
card: nil,
currency: nil,
expand: nil,
fleet: nil,
fraud_disputability_likelihood: nil,
fuel: nil,
is_amount_controllable: nil,
merchant_amount: nil,
merchant_currency: nil,
merchant_data: nil,
network_data: nil,
risk_assessment: nil,
verification_data: nil,
wallet: nil
); end
end
class CaptureParams < Stripe::RequestParams
class PurchaseDetails < Stripe::RequestParams
class Fleet < Stripe::RequestParams
class CardholderPromptData < Stripe::RequestParams
# Driver ID.
sig { returns(T.nilable(String)) }
def driver_id; end
sig { params(_driver_id: T.nilable(String)).returns(T.nilable(String)) }
def driver_id=(_driver_id); end
# Odometer reading.
sig { returns(T.nilable(Integer)) }
def odometer; end
sig { params(_odometer: T.nilable(Integer)).returns(T.nilable(Integer)) }
def odometer=(_odometer); end
# An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
sig { returns(T.nilable(String)) }
def unspecified_id; end
sig { params(_unspecified_id: T.nilable(String)).returns(T.nilable(String)) }
def unspecified_id=(_unspecified_id); end
# User ID.
sig { returns(T.nilable(String)) }
def user_id; end
sig { params(_user_id: T.nilable(String)).returns(T.nilable(String)) }
def user_id=(_user_id); end
# Vehicle number.
sig { returns(T.nilable(String)) }
def vehicle_number; end
sig { params(_vehicle_number: T.nilable(String)).returns(T.nilable(String)) }
def vehicle_number=(_vehicle_number); end
sig {
params(driver_id: T.nilable(String), odometer: T.nilable(Integer), unspecified_id: T.nilable(String), user_id: T.nilable(String), vehicle_number: T.nilable(String)).void
}
def initialize(
driver_id: nil,
odometer: nil,
unspecified_id: nil,
user_id: nil,
vehicle_number: nil
); end
end
class ReportedBreakdown < Stripe::RequestParams
class Fuel < Stripe::RequestParams
# Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig {
params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class NonFuel < Stripe::RequestParams
# Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig {
params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class Tax < Stripe::RequestParams
# Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def local_amount_decimal; end
sig {
params(_local_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def local_amount_decimal=(_local_amount_decimal); end
# Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def national_amount_decimal; end
sig {
params(_national_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def national_amount_decimal=(_national_amount_decimal); end
sig {
params(local_amount_decimal: T.nilable(String), national_amount_decimal: T.nilable(String)).void
}
def initialize(local_amount_decimal: nil, national_amount_decimal: nil); end
end
# Breakdown of fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel))
}
def fuel=(_fuel); end
# Breakdown of non-fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel; end
sig {
params(_non_fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel=(_non_fuel); end
# Information about tax included in this transaction.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax))
}
def tax=(_tax); end
sig {
params(fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel), non_fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel), tax: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax)).void
}
def initialize(fuel: nil, non_fuel: nil, tax: nil); end
end
# Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::CardholderPromptData))
}
def cardholder_prompt_data; end
sig {
params(_cardholder_prompt_data: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::CardholderPromptData)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::CardholderPromptData))
}
def cardholder_prompt_data=(_cardholder_prompt_data); end
# The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
sig { returns(T.nilable(String)) }
def purchase_type; end
sig { params(_purchase_type: T.nilable(String)).returns(T.nilable(String)) }
def purchase_type=(_purchase_type); end
# More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown))
}
def reported_breakdown; end
sig {
params(_reported_breakdown: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown))
}
def reported_breakdown=(_reported_breakdown); end
# The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
sig { returns(T.nilable(String)) }
def service_type; end
sig { params(_service_type: T.nilable(String)).returns(T.nilable(String)) }
def service_type=(_service_type); end
sig {
params(cardholder_prompt_data: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::CardholderPromptData), purchase_type: T.nilable(String), reported_breakdown: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet::ReportedBreakdown), service_type: T.nilable(String)).void
}
def initialize(
cardholder_prompt_data: nil,
purchase_type: nil,
reported_breakdown: nil,
service_type: nil
); end
end
class Flight < Stripe::RequestParams
class Segment < Stripe::RequestParams
# The three-letter IATA airport code of the flight's destination.
sig { returns(T.nilable(String)) }
def arrival_airport_code; end
sig { params(_arrival_airport_code: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport_code=(_arrival_airport_code); end
# The airline carrier code.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The three-letter IATA airport code that the flight departed from.
sig { returns(T.nilable(String)) }
def departure_airport_code; end
sig {
params(_departure_airport_code: T.nilable(String)).returns(T.nilable(String))
}
def departure_airport_code=(_departure_airport_code); end
# The flight number.
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The flight's service class.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
# Whether a stopover is allowed on this flight.
sig { returns(T.nilable(T::Boolean)) }
def stopover_allowed; end
sig {
params(_stopover_allowed: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def stopover_allowed=(_stopover_allowed); end
sig {
params(arrival_airport_code: T.nilable(String), carrier: T.nilable(String), departure_airport_code: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String), stopover_allowed: T.nilable(T::Boolean)).void
}
def initialize(
arrival_airport_code: nil,
carrier: nil,
departure_airport_code: nil,
flight_number: nil,
service_class: nil,
stopover_allowed: nil
); end
end
# The time that the flight departed.
sig { returns(T.nilable(Integer)) }
def departure_at; end
sig { params(_departure_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def departure_at=(_departure_at); end
# The name of the passenger.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# Whether the ticket is refundable.
sig { returns(T.nilable(T::Boolean)) }
def refundable; end
sig { params(_refundable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refundable=(_refundable); end
# The legs of the trip.
sig {
returns(T.nilable(T::Array[::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Flight::Segment]))
}
def segments; end
sig {
params(_segments: T.nilable(T::Array[::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Flight::Segment])).returns(T.nilable(T::Array[::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Flight::Segment]))
}
def segments=(_segments); end
# The travel agency that issued the ticket.
sig { returns(T.nilable(String)) }
def travel_agency; end
sig { params(_travel_agency: T.nilable(String)).returns(T.nilable(String)) }
def travel_agency=(_travel_agency); end
sig {
params(departure_at: T.nilable(Integer), passenger_name: T.nilable(String), refundable: T.nilable(T::Boolean), segments: T.nilable(T::Array[::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Flight::Segment]), travel_agency: T.nilable(String)).void
}
def initialize(
departure_at: nil,
passenger_name: nil,
refundable: nil,
segments: nil,
travel_agency: nil
); end
end
class Fuel < Stripe::RequestParams
# [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
sig { returns(T.nilable(String)) }
def industry_product_code; end
sig { params(_industry_product_code: T.nilable(String)).returns(T.nilable(String)) }
def industry_product_code=(_industry_product_code); end
# The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def quantity_decimal; end
sig { params(_quantity_decimal: T.nilable(String)).returns(T.nilable(String)) }
def quantity_decimal=(_quantity_decimal); end
# The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
# The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_cost_decimal; end
sig { params(_unit_cost_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_cost_decimal=(_unit_cost_decimal); end
sig {
params(industry_product_code: T.nilable(String), quantity_decimal: T.nilable(String), type: T.nilable(String), unit: T.nilable(String), unit_cost_decimal: T.nilable(String)).void
}
def initialize(
industry_product_code: nil,
quantity_decimal: nil,
type: nil,
unit: nil,
unit_cost_decimal: nil
); end
end
class Lodging < Stripe::RequestParams
# The time of checking into the lodging.
sig { returns(T.nilable(Integer)) }
def check_in_at; end
sig { params(_check_in_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def check_in_at=(_check_in_at); end
# The number of nights stayed at the lodging.
sig { returns(T.nilable(Integer)) }
def nights; end
sig { params(_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def nights=(_nights); end
sig { params(check_in_at: T.nilable(Integer), nights: T.nilable(Integer)).void }
def initialize(check_in_at: nil, nights: nil); end
end
class Receipt < Stripe::RequestParams
# Attribute for param field description
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Attribute for param field quantity
sig { returns(T.nilable(String)) }
def quantity; end
sig { params(_quantity: T.nilable(String)).returns(T.nilable(String)) }
def quantity=(_quantity); end
# Attribute for param field total
sig { returns(T.nilable(Integer)) }
def total; end
sig { params(_total: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total=(_total); end
# Attribute for param field unit_cost
sig { returns(T.nilable(Integer)) }
def unit_cost; end
sig { params(_unit_cost: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_cost=(_unit_cost); end
sig {
params(description: T.nilable(String), quantity: T.nilable(String), total: T.nilable(Integer), unit_cost: T.nilable(Integer)).void
}
def initialize(description: nil, quantity: nil, total: nil, unit_cost: nil); end
end
# Fleet-specific information for transactions using Fleet cards.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet))
}
def fleet; end
sig {
params(_fleet: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet))
}
def fleet=(_fleet); end
# Information about the flight that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Flight))
}
def flight; end
sig {
params(_flight: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Flight)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Flight))
}
def flight=(_flight); end
# Information about fuel that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fuel)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fuel))
}
def fuel=(_fuel); end
# Information about lodging that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Lodging))
}
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Lodging)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Lodging))
}
def lodging=(_lodging); end
# The line items in the purchase.
sig {
returns(T.nilable(T::Array[::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Receipt]))
}
def receipt; end
sig {
params(_receipt: T.nilable(T::Array[::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Receipt])).returns(T.nilable(T::Array[::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Receipt]))
}
def receipt=(_receipt); end
# A merchant-specific order number.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
sig {
params(fleet: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fleet), flight: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Flight), fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Fuel), lodging: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Lodging), receipt: T.nilable(T::Array[::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails::Receipt]), reference: T.nilable(String)).void
}
def initialize(
fleet: nil,
flight: nil,
fuel: nil,
lodging: nil,
receipt: nil,
reference: nil
); end
end
# The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(Integer)) }
def capture_amount; end
sig { params(_capture_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def capture_amount=(_capture_amount); end
# Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.
sig { returns(T.nilable(T::Boolean)) }
def close_authorization; end
sig { params(_close_authorization: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def close_authorization=(_close_authorization); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Additional purchase information that is optionally provided by the merchant.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails))
}
def purchase_details; end
sig {
params(_purchase_details: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails))
}
def purchase_details=(_purchase_details); end
sig {
params(capture_amount: T.nilable(Integer), close_authorization: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), purchase_details: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams::PurchaseDetails)).void
}
def initialize(
capture_amount: nil,
close_authorization: nil,
expand: nil,
purchase_details: nil
); end
end
class ExpireParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class FinalizeAmountParams < Stripe::RequestParams
class Fleet < Stripe::RequestParams
class CardholderPromptData < Stripe::RequestParams
# Driver ID.
sig { returns(T.nilable(String)) }
def driver_id; end
sig { params(_driver_id: T.nilable(String)).returns(T.nilable(String)) }
def driver_id=(_driver_id); end
# Odometer reading.
sig { returns(T.nilable(Integer)) }
def odometer; end
sig { params(_odometer: T.nilable(Integer)).returns(T.nilable(Integer)) }
def odometer=(_odometer); end
# An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
sig { returns(T.nilable(String)) }
def unspecified_id; end
sig { params(_unspecified_id: T.nilable(String)).returns(T.nilable(String)) }
def unspecified_id=(_unspecified_id); end
# User ID.
sig { returns(T.nilable(String)) }
def user_id; end
sig { params(_user_id: T.nilable(String)).returns(T.nilable(String)) }
def user_id=(_user_id); end
# Vehicle number.
sig { returns(T.nilable(String)) }
def vehicle_number; end
sig { params(_vehicle_number: T.nilable(String)).returns(T.nilable(String)) }
def vehicle_number=(_vehicle_number); end
sig {
params(driver_id: T.nilable(String), odometer: T.nilable(Integer), unspecified_id: T.nilable(String), user_id: T.nilable(String), vehicle_number: T.nilable(String)).void
}
def initialize(
driver_id: nil,
odometer: nil,
unspecified_id: nil,
user_id: nil,
vehicle_number: nil
); end
end
class ReportedBreakdown < Stripe::RequestParams
class Fuel < Stripe::RequestParams
# Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig { params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class NonFuel < Stripe::RequestParams
# Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig { params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class Tax < Stripe::RequestParams
# Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def local_amount_decimal; end
sig { params(_local_amount_decimal: T.nilable(String)).returns(T.nilable(String)) }
def local_amount_decimal=(_local_amount_decimal); end
# Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def national_amount_decimal; end
sig {
params(_national_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def national_amount_decimal=(_national_amount_decimal); end
sig {
params(local_amount_decimal: T.nilable(String), national_amount_decimal: T.nilable(String)).void
}
def initialize(local_amount_decimal: nil, national_amount_decimal: nil); end
end
# Breakdown of fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::ReportedBreakdown::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::ReportedBreakdown::Fuel)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::ReportedBreakdown::Fuel))
}
def fuel=(_fuel); end
# Breakdown of non-fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel; end
sig {
params(_non_fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::ReportedBreakdown::NonFuel)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel=(_non_fuel); end
# Information about tax included in this transaction.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::ReportedBreakdown::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::ReportedBreakdown::Tax)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::ReportedBreakdown::Tax))
}
def tax=(_tax); end
sig {
params(fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::ReportedBreakdown::Fuel), non_fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::ReportedBreakdown::NonFuel), tax: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::ReportedBreakdown::Tax)).void
}
def initialize(fuel: nil, non_fuel: nil, tax: nil); end
end
# Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::CardholderPromptData))
}
def cardholder_prompt_data; end
sig {
params(_cardholder_prompt_data: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::CardholderPromptData)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::CardholderPromptData))
}
def cardholder_prompt_data=(_cardholder_prompt_data); end
# The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
sig { returns(T.nilable(String)) }
def purchase_type; end
sig { params(_purchase_type: T.nilable(String)).returns(T.nilable(String)) }
def purchase_type=(_purchase_type); end
# More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::ReportedBreakdown))
}
def reported_breakdown; end
sig {
params(_reported_breakdown: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::ReportedBreakdown)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::ReportedBreakdown))
}
def reported_breakdown=(_reported_breakdown); end
# The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
sig { returns(T.nilable(String)) }
def service_type; end
sig { params(_service_type: T.nilable(String)).returns(T.nilable(String)) }
def service_type=(_service_type); end
sig {
params(cardholder_prompt_data: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::CardholderPromptData), purchase_type: T.nilable(String), reported_breakdown: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet::ReportedBreakdown), service_type: T.nilable(String)).void
}
def initialize(
cardholder_prompt_data: nil,
purchase_type: nil,
reported_breakdown: nil,
service_type: nil
); end
end
class Fuel < Stripe::RequestParams
# [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
sig { returns(T.nilable(String)) }
def industry_product_code; end
sig { params(_industry_product_code: T.nilable(String)).returns(T.nilable(String)) }
def industry_product_code=(_industry_product_code); end
# The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def quantity_decimal; end
sig { params(_quantity_decimal: T.nilable(String)).returns(T.nilable(String)) }
def quantity_decimal=(_quantity_decimal); end
# The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
# The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_cost_decimal; end
sig { params(_unit_cost_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_cost_decimal=(_unit_cost_decimal); end
sig {
params(industry_product_code: T.nilable(String), quantity_decimal: T.nilable(String), type: T.nilable(String), unit: T.nilable(String), unit_cost_decimal: T.nilable(String)).void
}
def initialize(
industry_product_code: nil,
quantity_decimal: nil,
type: nil,
unit: nil,
unit_cost_decimal: nil
); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def final_amount; end
sig { params(_final_amount: Integer).returns(Integer) }
def final_amount=(_final_amount); end
# Fleet-specific information for authorizations using Fleet cards.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet))
}
def fleet; end
sig {
params(_fleet: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet))
}
def fleet=(_fleet); end
# Information about fuel that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fuel)).returns(T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fuel))
}
def fuel=(_fuel); end
sig {
params(expand: T.nilable(T::Array[String]), final_amount: Integer, fleet: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fleet), fuel: T.nilable(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams::Fuel)).void
}
def initialize(expand: nil, final_amount: nil, fleet: nil, fuel: nil); end
end
class RespondParams < Stripe::RequestParams
# Whether to simulate the user confirming that the transaction was legitimate (true) or telling Stripe that it was fraudulent (false).
sig { returns(T::Boolean) }
def confirmed; end
sig { params(_confirmed: T::Boolean).returns(T::Boolean) }
def confirmed=(_confirmed); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(confirmed: T::Boolean, expand: T.nilable(T::Array[String])).void }
def initialize(confirmed: nil, expand: nil); end
end
class IncrementParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def increment_amount; end
sig { params(_increment_amount: Integer).returns(Integer) }
def increment_amount=(_increment_amount); end
# If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.
sig { returns(T.nilable(T::Boolean)) }
def is_amount_controllable; end
sig {
params(_is_amount_controllable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def is_amount_controllable=(_is_amount_controllable); end
sig {
params(expand: T.nilable(T::Array[String]), increment_amount: Integer, is_amount_controllable: T.nilable(T::Boolean)).void
}
def initialize(expand: nil, increment_amount: nil, is_amount_controllable: nil); end
end
class ReverseParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(Integer)) }
def reverse_amount; end
sig { params(_reverse_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def reverse_amount=(_reverse_amount); end
sig {
params(expand: T.nilable(T::Array[String]), reverse_amount: T.nilable(Integer)).void
}
def initialize(expand: nil, reverse_amount: nil); end
end
# Capture a test-mode authorization.
sig {
params(authorization: String, params: T.any(::Stripe::TestHelpers::Issuing::AuthorizationService::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
}
def capture(authorization, params = {}, opts = {}); end
# Create a test-mode authorization.
sig {
params(params: T.any(::Stripe::TestHelpers::Issuing::AuthorizationService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
}
def create(params = {}, opts = {}); end
# Expire a test-mode Authorization.
sig {
params(authorization: String, params: T.any(::Stripe::TestHelpers::Issuing::AuthorizationService::ExpireParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
}
def expire(authorization, params = {}, opts = {}); end
# Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.
sig {
params(authorization: String, params: T.any(::Stripe::TestHelpers::Issuing::AuthorizationService::FinalizeAmountParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
}
def finalize_amount(authorization, params = {}, opts = {}); end
# Increment a test-mode Authorization.
sig {
params(authorization: String, params: T.any(::Stripe::TestHelpers::Issuing::AuthorizationService::IncrementParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
}
def increment(authorization, params = {}, opts = {}); end
# Respond to a fraud challenge on a testmode Issuing authorization, simulating either a confirmation of fraud or a correction of legitimacy.
sig {
params(authorization: String, params: T.any(::Stripe::TestHelpers::Issuing::AuthorizationService::RespondParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
}
def respond(authorization, params = {}, opts = {}); end
# Reverse a test-mode Authorization.
sig {
params(authorization: String, params: T.any(::Stripe::TestHelpers::Issuing::AuthorizationService::ReverseParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
}
def reverse(authorization, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module TestHelpers
module Issuing
class CardService < StripeService
class DeliverCardParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class FailCardParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ReturnCardParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ShipCardParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class SubmitCardParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Updates the shipping status of the specified Issuing Card object to delivered.
sig {
params(card: String, params: T.any(::Stripe::TestHelpers::Issuing::CardService::DeliverCardParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Card)
}
def deliver_card(card, params = {}, opts = {}); end
# Updates the shipping status of the specified Issuing Card object to failure.
sig {
params(card: String, params: T.any(::Stripe::TestHelpers::Issuing::CardService::FailCardParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Card)
}
def fail_card(card, params = {}, opts = {}); end
# Updates the shipping status of the specified Issuing Card object to returned.
sig {
params(card: String, params: T.any(::Stripe::TestHelpers::Issuing::CardService::ReturnCardParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Card)
}
def return_card(card, params = {}, opts = {}); end
# Updates the shipping status of the specified Issuing Card object to shipped.
sig {
params(card: String, params: T.any(::Stripe::TestHelpers::Issuing::CardService::ShipCardParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Card)
}
def ship_card(card, params = {}, opts = {}); end
# Updates the shipping status of the specified Issuing Card object to submitted. This method requires Stripe Version ‘2024-09-30.acacia' or later.
sig {
params(card: String, params: T.any(::Stripe::TestHelpers::Issuing::CardService::SubmitCardParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Card)
}
def submit_card(card, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module TestHelpers
module Issuing
class PersonalizationDesignService < StripeService
class ActivateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class DeactivateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class RejectParams < Stripe::RequestParams
class RejectionReasons < Stripe::RequestParams
# The reason(s) the card logo was rejected.
sig { returns(T.nilable(T::Array[String])) }
def card_logo; end
sig {
params(_card_logo: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def card_logo=(_card_logo); end
# The reason(s) the carrier text was rejected.
sig { returns(T.nilable(T::Array[String])) }
def carrier_text; end
sig {
params(_carrier_text: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def carrier_text=(_carrier_text); end
sig {
params(card_logo: T.nilable(T::Array[String]), carrier_text: T.nilable(T::Array[String])).void
}
def initialize(card_logo: nil, carrier_text: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The reason(s) the personalization design was rejected.
sig {
returns(::Stripe::TestHelpers::Issuing::PersonalizationDesignService::RejectParams::RejectionReasons)
}
def rejection_reasons; end
sig {
params(_rejection_reasons: ::Stripe::TestHelpers::Issuing::PersonalizationDesignService::RejectParams::RejectionReasons).returns(::Stripe::TestHelpers::Issuing::PersonalizationDesignService::RejectParams::RejectionReasons)
}
def rejection_reasons=(_rejection_reasons); end
sig {
params(expand: T.nilable(T::Array[String]), rejection_reasons: ::Stripe::TestHelpers::Issuing::PersonalizationDesignService::RejectParams::RejectionReasons).void
}
def initialize(expand: nil, rejection_reasons: nil); end
end
# Updates the status of the specified testmode personalization design object to active.
sig {
params(personalization_design: String, params: T.any(::Stripe::TestHelpers::Issuing::PersonalizationDesignService::ActivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::PersonalizationDesign)
}
def activate(personalization_design, params = {}, opts = {}); end
# Updates the status of the specified testmode personalization design object to inactive.
sig {
params(personalization_design: String, params: T.any(::Stripe::TestHelpers::Issuing::PersonalizationDesignService::DeactivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::PersonalizationDesign)
}
def deactivate(personalization_design, params = {}, opts = {}); end
# Updates the status of the specified testmode personalization design object to rejected.
sig {
params(personalization_design: String, params: T.any(::Stripe::TestHelpers::Issuing::PersonalizationDesignService::RejectParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::PersonalizationDesign)
}
def reject(personalization_design, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module TestHelpers
module Issuing
class TransactionService < StripeService
class RefundParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(T.nilable(Integer)) }
def refund_amount; end
sig { params(_refund_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def refund_amount=(_refund_amount); end
sig {
params(expand: T.nilable(T::Array[String]), refund_amount: T.nilable(Integer)).void
}
def initialize(expand: nil, refund_amount: nil); end
end
class CreateForceCaptureParams < Stripe::RequestParams
class MerchantData < Stripe::RequestParams
# A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# City where the seller is located
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Country where the seller is located
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Name of the seller
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
sig { returns(T.nilable(String)) }
def network_id; end
sig { params(_network_id: T.nilable(String)).returns(T.nilable(String)) }
def network_id=(_network_id); end
# Postal code where the seller is located
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State where the seller is located
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# An ID assigned by the seller to the location of the sale.
sig { returns(T.nilable(String)) }
def terminal_id; end
sig { params(_terminal_id: T.nilable(String)).returns(T.nilable(String)) }
def terminal_id=(_terminal_id); end
# URL provided by the merchant on a 3DS request
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(category: T.nilable(String), city: T.nilable(String), country: T.nilable(String), name: T.nilable(String), network_id: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), terminal_id: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
category: nil,
city: nil,
country: nil,
name: nil,
network_id: nil,
postal_code: nil,
state: nil,
terminal_id: nil,
url: nil
); end
end
class PurchaseDetails < Stripe::RequestParams
class Fleet < Stripe::RequestParams
class CardholderPromptData < Stripe::RequestParams
# Driver ID.
sig { returns(T.nilable(String)) }
def driver_id; end
sig { params(_driver_id: T.nilable(String)).returns(T.nilable(String)) }
def driver_id=(_driver_id); end
# Odometer reading.
sig { returns(T.nilable(Integer)) }
def odometer; end
sig { params(_odometer: T.nilable(Integer)).returns(T.nilable(Integer)) }
def odometer=(_odometer); end
# An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
sig { returns(T.nilable(String)) }
def unspecified_id; end
sig { params(_unspecified_id: T.nilable(String)).returns(T.nilable(String)) }
def unspecified_id=(_unspecified_id); end
# User ID.
sig { returns(T.nilable(String)) }
def user_id; end
sig { params(_user_id: T.nilable(String)).returns(T.nilable(String)) }
def user_id=(_user_id); end
# Vehicle number.
sig { returns(T.nilable(String)) }
def vehicle_number; end
sig { params(_vehicle_number: T.nilable(String)).returns(T.nilable(String)) }
def vehicle_number=(_vehicle_number); end
sig {
params(driver_id: T.nilable(String), odometer: T.nilable(Integer), unspecified_id: T.nilable(String), user_id: T.nilable(String), vehicle_number: T.nilable(String)).void
}
def initialize(
driver_id: nil,
odometer: nil,
unspecified_id: nil,
user_id: nil,
vehicle_number: nil
); end
end
class ReportedBreakdown < Stripe::RequestParams
class Fuel < Stripe::RequestParams
# Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig {
params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class NonFuel < Stripe::RequestParams
# Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig {
params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class Tax < Stripe::RequestParams
# Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def local_amount_decimal; end
sig {
params(_local_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def local_amount_decimal=(_local_amount_decimal); end
# Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def national_amount_decimal; end
sig {
params(_national_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def national_amount_decimal=(_national_amount_decimal); end
sig {
params(local_amount_decimal: T.nilable(String), national_amount_decimal: T.nilable(String)).void
}
def initialize(local_amount_decimal: nil, national_amount_decimal: nil); end
end
# Breakdown of fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel))
}
def fuel=(_fuel); end
# Breakdown of non-fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel; end
sig {
params(_non_fuel: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel=(_non_fuel); end
# Information about tax included in this transaction.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax))
}
def tax=(_tax); end
sig {
params(fuel: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel), non_fuel: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel), tax: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax)).void
}
def initialize(fuel: nil, non_fuel: nil, tax: nil); end
end
# Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::CardholderPromptData))
}
def cardholder_prompt_data; end
sig {
params(_cardholder_prompt_data: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::CardholderPromptData)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::CardholderPromptData))
}
def cardholder_prompt_data=(_cardholder_prompt_data); end
# The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
sig { returns(T.nilable(String)) }
def purchase_type; end
sig { params(_purchase_type: T.nilable(String)).returns(T.nilable(String)) }
def purchase_type=(_purchase_type); end
# More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown))
}
def reported_breakdown; end
sig {
params(_reported_breakdown: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown))
}
def reported_breakdown=(_reported_breakdown); end
# The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
sig { returns(T.nilable(String)) }
def service_type; end
sig { params(_service_type: T.nilable(String)).returns(T.nilable(String)) }
def service_type=(_service_type); end
sig {
params(cardholder_prompt_data: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::CardholderPromptData), purchase_type: T.nilable(String), reported_breakdown: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet::ReportedBreakdown), service_type: T.nilable(String)).void
}
def initialize(
cardholder_prompt_data: nil,
purchase_type: nil,
reported_breakdown: nil,
service_type: nil
); end
end
class Flight < Stripe::RequestParams
class Segment < Stripe::RequestParams
# The three-letter IATA airport code of the flight's destination.
sig { returns(T.nilable(String)) }
def arrival_airport_code; end
sig { params(_arrival_airport_code: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport_code=(_arrival_airport_code); end
# The airline carrier code.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The three-letter IATA airport code that the flight departed from.
sig { returns(T.nilable(String)) }
def departure_airport_code; end
sig {
params(_departure_airport_code: T.nilable(String)).returns(T.nilable(String))
}
def departure_airport_code=(_departure_airport_code); end
# The flight number.
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The flight's service class.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
# Whether a stopover is allowed on this flight.
sig { returns(T.nilable(T::Boolean)) }
def stopover_allowed; end
sig {
params(_stopover_allowed: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def stopover_allowed=(_stopover_allowed); end
sig {
params(arrival_airport_code: T.nilable(String), carrier: T.nilable(String), departure_airport_code: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String), stopover_allowed: T.nilable(T::Boolean)).void
}
def initialize(
arrival_airport_code: nil,
carrier: nil,
departure_airport_code: nil,
flight_number: nil,
service_class: nil,
stopover_allowed: nil
); end
end
# The time that the flight departed.
sig { returns(T.nilable(Integer)) }
def departure_at; end
sig { params(_departure_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def departure_at=(_departure_at); end
# The name of the passenger.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# Whether the ticket is refundable.
sig { returns(T.nilable(T::Boolean)) }
def refundable; end
sig { params(_refundable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refundable=(_refundable); end
# The legs of the trip.
sig {
returns(T.nilable(T::Array[::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Flight::Segment]))
}
def segments; end
sig {
params(_segments: T.nilable(T::Array[::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Flight::Segment])).returns(T.nilable(T::Array[::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Flight::Segment]))
}
def segments=(_segments); end
# The travel agency that issued the ticket.
sig { returns(T.nilable(String)) }
def travel_agency; end
sig { params(_travel_agency: T.nilable(String)).returns(T.nilable(String)) }
def travel_agency=(_travel_agency); end
sig {
params(departure_at: T.nilable(Integer), passenger_name: T.nilable(String), refundable: T.nilable(T::Boolean), segments: T.nilable(T::Array[::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Flight::Segment]), travel_agency: T.nilable(String)).void
}
def initialize(
departure_at: nil,
passenger_name: nil,
refundable: nil,
segments: nil,
travel_agency: nil
); end
end
class Fuel < Stripe::RequestParams
# [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
sig { returns(T.nilable(String)) }
def industry_product_code; end
sig { params(_industry_product_code: T.nilable(String)).returns(T.nilable(String)) }
def industry_product_code=(_industry_product_code); end
# The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def quantity_decimal; end
sig { params(_quantity_decimal: T.nilable(String)).returns(T.nilable(String)) }
def quantity_decimal=(_quantity_decimal); end
# The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
# The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_cost_decimal; end
sig { params(_unit_cost_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_cost_decimal=(_unit_cost_decimal); end
sig {
params(industry_product_code: T.nilable(String), quantity_decimal: T.nilable(String), type: T.nilable(String), unit: T.nilable(String), unit_cost_decimal: T.nilable(String)).void
}
def initialize(
industry_product_code: nil,
quantity_decimal: nil,
type: nil,
unit: nil,
unit_cost_decimal: nil
); end
end
class Lodging < Stripe::RequestParams
# The time of checking into the lodging.
sig { returns(T.nilable(Integer)) }
def check_in_at; end
sig { params(_check_in_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def check_in_at=(_check_in_at); end
# The number of nights stayed at the lodging.
sig { returns(T.nilable(Integer)) }
def nights; end
sig { params(_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def nights=(_nights); end
sig { params(check_in_at: T.nilable(Integer), nights: T.nilable(Integer)).void }
def initialize(check_in_at: nil, nights: nil); end
end
class Receipt < Stripe::RequestParams
# Attribute for param field description
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Attribute for param field quantity
sig { returns(T.nilable(String)) }
def quantity; end
sig { params(_quantity: T.nilable(String)).returns(T.nilable(String)) }
def quantity=(_quantity); end
# Attribute for param field total
sig { returns(T.nilable(Integer)) }
def total; end
sig { params(_total: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total=(_total); end
# Attribute for param field unit_cost
sig { returns(T.nilable(Integer)) }
def unit_cost; end
sig { params(_unit_cost: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_cost=(_unit_cost); end
sig {
params(description: T.nilable(String), quantity: T.nilable(String), total: T.nilable(Integer), unit_cost: T.nilable(Integer)).void
}
def initialize(description: nil, quantity: nil, total: nil, unit_cost: nil); end
end
# Fleet-specific information for transactions using Fleet cards.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet))
}
def fleet; end
sig {
params(_fleet: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet))
}
def fleet=(_fleet); end
# Information about the flight that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Flight))
}
def flight; end
sig {
params(_flight: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Flight)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Flight))
}
def flight=(_flight); end
# Information about fuel that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fuel)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fuel))
}
def fuel=(_fuel); end
# Information about lodging that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Lodging))
}
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Lodging)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Lodging))
}
def lodging=(_lodging); end
# The line items in the purchase.
sig {
returns(T.nilable(T::Array[::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Receipt]))
}
def receipt; end
sig {
params(_receipt: T.nilable(T::Array[::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Receipt])).returns(T.nilable(T::Array[::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Receipt]))
}
def receipt=(_receipt); end
# A merchant-specific order number.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
sig {
params(fleet: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fleet), flight: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Flight), fuel: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Fuel), lodging: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Lodging), receipt: T.nilable(T::Array[::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails::Receipt]), reference: T.nilable(String)).void
}
def initialize(
fleet: nil,
flight: nil,
fuel: nil,
lodging: nil,
receipt: nil,
reference: nil
); end
end
# The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Card associated with this transaction.
sig { returns(String) }
def card; end
sig { params(_card: String).returns(String) }
def card=(_card); end
# The currency of the capture. If not provided, defaults to the currency of the card. 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::MerchantData))
}
def merchant_data; end
sig {
params(_merchant_data: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::MerchantData)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::MerchantData))
}
def merchant_data=(_merchant_data); end
# Additional purchase information that is optionally provided by the merchant.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails))
}
def purchase_details; end
sig {
params(_purchase_details: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails))
}
def purchase_details=(_purchase_details); end
sig {
params(amount: Integer, card: String, currency: T.nilable(String), expand: T.nilable(T::Array[String]), merchant_data: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::MerchantData), purchase_details: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams::PurchaseDetails)).void
}
def initialize(
amount: nil,
card: nil,
currency: nil,
expand: nil,
merchant_data: nil,
purchase_details: nil
); end
end
class CreateUnlinkedRefundParams < Stripe::RequestParams
class MerchantData < Stripe::RequestParams
# A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.
sig { returns(T.nilable(String)) }
def category; end
sig { params(_category: T.nilable(String)).returns(T.nilable(String)) }
def category=(_category); end
# City where the seller is located
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Country where the seller is located
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Name of the seller
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
sig { returns(T.nilable(String)) }
def network_id; end
sig { params(_network_id: T.nilable(String)).returns(T.nilable(String)) }
def network_id=(_network_id); end
# Postal code where the seller is located
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State where the seller is located
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# An ID assigned by the seller to the location of the sale.
sig { returns(T.nilable(String)) }
def terminal_id; end
sig { params(_terminal_id: T.nilable(String)).returns(T.nilable(String)) }
def terminal_id=(_terminal_id); end
# URL provided by the merchant on a 3DS request
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(category: T.nilable(String), city: T.nilable(String), country: T.nilable(String), name: T.nilable(String), network_id: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), terminal_id: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
category: nil,
city: nil,
country: nil,
name: nil,
network_id: nil,
postal_code: nil,
state: nil,
terminal_id: nil,
url: nil
); end
end
class PurchaseDetails < Stripe::RequestParams
class Fleet < Stripe::RequestParams
class CardholderPromptData < Stripe::RequestParams
# Driver ID.
sig { returns(T.nilable(String)) }
def driver_id; end
sig { params(_driver_id: T.nilable(String)).returns(T.nilable(String)) }
def driver_id=(_driver_id); end
# Odometer reading.
sig { returns(T.nilable(Integer)) }
def odometer; end
sig { params(_odometer: T.nilable(Integer)).returns(T.nilable(Integer)) }
def odometer=(_odometer); end
# An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
sig { returns(T.nilable(String)) }
def unspecified_id; end
sig { params(_unspecified_id: T.nilable(String)).returns(T.nilable(String)) }
def unspecified_id=(_unspecified_id); end
# User ID.
sig { returns(T.nilable(String)) }
def user_id; end
sig { params(_user_id: T.nilable(String)).returns(T.nilable(String)) }
def user_id=(_user_id); end
# Vehicle number.
sig { returns(T.nilable(String)) }
def vehicle_number; end
sig { params(_vehicle_number: T.nilable(String)).returns(T.nilable(String)) }
def vehicle_number=(_vehicle_number); end
sig {
params(driver_id: T.nilable(String), odometer: T.nilable(Integer), unspecified_id: T.nilable(String), user_id: T.nilable(String), vehicle_number: T.nilable(String)).void
}
def initialize(
driver_id: nil,
odometer: nil,
unspecified_id: nil,
user_id: nil,
vehicle_number: nil
); end
end
class ReportedBreakdown < Stripe::RequestParams
class Fuel < Stripe::RequestParams
# Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig {
params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class NonFuel < Stripe::RequestParams
# Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
sig { returns(T.nilable(String)) }
def gross_amount_decimal; end
sig {
params(_gross_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def gross_amount_decimal=(_gross_amount_decimal); end
sig { params(gross_amount_decimal: T.nilable(String)).void }
def initialize(gross_amount_decimal: nil); end
end
class Tax < Stripe::RequestParams
# Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def local_amount_decimal; end
sig {
params(_local_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def local_amount_decimal=(_local_amount_decimal); end
# Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
sig { returns(T.nilable(String)) }
def national_amount_decimal; end
sig {
params(_national_amount_decimal: T.nilable(String)).returns(T.nilable(String))
}
def national_amount_decimal=(_national_amount_decimal); end
sig {
params(local_amount_decimal: T.nilable(String), national_amount_decimal: T.nilable(String)).void
}
def initialize(local_amount_decimal: nil, national_amount_decimal: nil); end
end
# Breakdown of fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel))
}
def fuel=(_fuel); end
# Breakdown of non-fuel portion of the purchase.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel; end
sig {
params(_non_fuel: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel))
}
def non_fuel=(_non_fuel); end
# Information about tax included in this transaction.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax))
}
def tax; end
sig {
params(_tax: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax))
}
def tax=(_tax); end
sig {
params(fuel: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::Fuel), non_fuel: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::NonFuel), tax: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown::Tax)).void
}
def initialize(fuel: nil, non_fuel: nil, tax: nil); end
end
# Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::CardholderPromptData))
}
def cardholder_prompt_data; end
sig {
params(_cardholder_prompt_data: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::CardholderPromptData)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::CardholderPromptData))
}
def cardholder_prompt_data=(_cardholder_prompt_data); end
# The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
sig { returns(T.nilable(String)) }
def purchase_type; end
sig { params(_purchase_type: T.nilable(String)).returns(T.nilable(String)) }
def purchase_type=(_purchase_type); end
# More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown))
}
def reported_breakdown; end
sig {
params(_reported_breakdown: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown))
}
def reported_breakdown=(_reported_breakdown); end
# The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
sig { returns(T.nilable(String)) }
def service_type; end
sig { params(_service_type: T.nilable(String)).returns(T.nilable(String)) }
def service_type=(_service_type); end
sig {
params(cardholder_prompt_data: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::CardholderPromptData), purchase_type: T.nilable(String), reported_breakdown: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet::ReportedBreakdown), service_type: T.nilable(String)).void
}
def initialize(
cardholder_prompt_data: nil,
purchase_type: nil,
reported_breakdown: nil,
service_type: nil
); end
end
class Flight < Stripe::RequestParams
class Segment < Stripe::RequestParams
# The three-letter IATA airport code of the flight's destination.
sig { returns(T.nilable(String)) }
def arrival_airport_code; end
sig { params(_arrival_airport_code: T.nilable(String)).returns(T.nilable(String)) }
def arrival_airport_code=(_arrival_airport_code); end
# The airline carrier code.
sig { returns(T.nilable(String)) }
def carrier; end
sig { params(_carrier: T.nilable(String)).returns(T.nilable(String)) }
def carrier=(_carrier); end
# The three-letter IATA airport code that the flight departed from.
sig { returns(T.nilable(String)) }
def departure_airport_code; end
sig {
params(_departure_airport_code: T.nilable(String)).returns(T.nilable(String))
}
def departure_airport_code=(_departure_airport_code); end
# The flight number.
sig { returns(T.nilable(String)) }
def flight_number; end
sig { params(_flight_number: T.nilable(String)).returns(T.nilable(String)) }
def flight_number=(_flight_number); end
# The flight's service class.
sig { returns(T.nilable(String)) }
def service_class; end
sig { params(_service_class: T.nilable(String)).returns(T.nilable(String)) }
def service_class=(_service_class); end
# Whether a stopover is allowed on this flight.
sig { returns(T.nilable(T::Boolean)) }
def stopover_allowed; end
sig {
params(_stopover_allowed: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def stopover_allowed=(_stopover_allowed); end
sig {
params(arrival_airport_code: T.nilable(String), carrier: T.nilable(String), departure_airport_code: T.nilable(String), flight_number: T.nilable(String), service_class: T.nilable(String), stopover_allowed: T.nilable(T::Boolean)).void
}
def initialize(
arrival_airport_code: nil,
carrier: nil,
departure_airport_code: nil,
flight_number: nil,
service_class: nil,
stopover_allowed: nil
); end
end
# The time that the flight departed.
sig { returns(T.nilable(Integer)) }
def departure_at; end
sig { params(_departure_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def departure_at=(_departure_at); end
# The name of the passenger.
sig { returns(T.nilable(String)) }
def passenger_name; end
sig { params(_passenger_name: T.nilable(String)).returns(T.nilable(String)) }
def passenger_name=(_passenger_name); end
# Whether the ticket is refundable.
sig { returns(T.nilable(T::Boolean)) }
def refundable; end
sig { params(_refundable: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refundable=(_refundable); end
# The legs of the trip.
sig {
returns(T.nilable(T::Array[::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Flight::Segment]))
}
def segments; end
sig {
params(_segments: T.nilable(T::Array[::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Flight::Segment])).returns(T.nilable(T::Array[::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Flight::Segment]))
}
def segments=(_segments); end
# The travel agency that issued the ticket.
sig { returns(T.nilable(String)) }
def travel_agency; end
sig { params(_travel_agency: T.nilable(String)).returns(T.nilable(String)) }
def travel_agency=(_travel_agency); end
sig {
params(departure_at: T.nilable(Integer), passenger_name: T.nilable(String), refundable: T.nilable(T::Boolean), segments: T.nilable(T::Array[::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Flight::Segment]), travel_agency: T.nilable(String)).void
}
def initialize(
departure_at: nil,
passenger_name: nil,
refundable: nil,
segments: nil,
travel_agency: nil
); end
end
class Fuel < Stripe::RequestParams
# [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
sig { returns(T.nilable(String)) }
def industry_product_code; end
sig { params(_industry_product_code: T.nilable(String)).returns(T.nilable(String)) }
def industry_product_code=(_industry_product_code); end
# The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def quantity_decimal; end
sig { params(_quantity_decimal: T.nilable(String)).returns(T.nilable(String)) }
def quantity_decimal=(_quantity_decimal); end
# The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
# The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
sig { returns(T.nilable(String)) }
def unit; end
sig { params(_unit: T.nilable(String)).returns(T.nilable(String)) }
def unit=(_unit); end
# The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
sig { returns(T.nilable(String)) }
def unit_cost_decimal; end
sig { params(_unit_cost_decimal: T.nilable(String)).returns(T.nilable(String)) }
def unit_cost_decimal=(_unit_cost_decimal); end
sig {
params(industry_product_code: T.nilable(String), quantity_decimal: T.nilable(String), type: T.nilable(String), unit: T.nilable(String), unit_cost_decimal: T.nilable(String)).void
}
def initialize(
industry_product_code: nil,
quantity_decimal: nil,
type: nil,
unit: nil,
unit_cost_decimal: nil
); end
end
class Lodging < Stripe::RequestParams
# The time of checking into the lodging.
sig { returns(T.nilable(Integer)) }
def check_in_at; end
sig { params(_check_in_at: T.nilable(Integer)).returns(T.nilable(Integer)) }
def check_in_at=(_check_in_at); end
# The number of nights stayed at the lodging.
sig { returns(T.nilable(Integer)) }
def nights; end
sig { params(_nights: T.nilable(Integer)).returns(T.nilable(Integer)) }
def nights=(_nights); end
sig { params(check_in_at: T.nilable(Integer), nights: T.nilable(Integer)).void }
def initialize(check_in_at: nil, nights: nil); end
end
class Receipt < Stripe::RequestParams
# Attribute for param field description
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Attribute for param field quantity
sig { returns(T.nilable(String)) }
def quantity; end
sig { params(_quantity: T.nilable(String)).returns(T.nilable(String)) }
def quantity=(_quantity); end
# Attribute for param field total
sig { returns(T.nilable(Integer)) }
def total; end
sig { params(_total: T.nilable(Integer)).returns(T.nilable(Integer)) }
def total=(_total); end
# Attribute for param field unit_cost
sig { returns(T.nilable(Integer)) }
def unit_cost; end
sig { params(_unit_cost: T.nilable(Integer)).returns(T.nilable(Integer)) }
def unit_cost=(_unit_cost); end
sig {
params(description: T.nilable(String), quantity: T.nilable(String), total: T.nilable(Integer), unit_cost: T.nilable(Integer)).void
}
def initialize(description: nil, quantity: nil, total: nil, unit_cost: nil); end
end
# Fleet-specific information for transactions using Fleet cards.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet))
}
def fleet; end
sig {
params(_fleet: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet))
}
def fleet=(_fleet); end
# Information about the flight that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Flight))
}
def flight; end
sig {
params(_flight: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Flight)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Flight))
}
def flight=(_flight); end
# Information about fuel that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fuel))
}
def fuel; end
sig {
params(_fuel: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fuel)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fuel))
}
def fuel=(_fuel); end
# Information about lodging that was purchased with this transaction.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Lodging))
}
def lodging; end
sig {
params(_lodging: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Lodging)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Lodging))
}
def lodging=(_lodging); end
# The line items in the purchase.
sig {
returns(T.nilable(T::Array[::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Receipt]))
}
def receipt; end
sig {
params(_receipt: T.nilable(T::Array[::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Receipt])).returns(T.nilable(T::Array[::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Receipt]))
}
def receipt=(_receipt); end
# A merchant-specific order number.
sig { returns(T.nilable(String)) }
def reference; end
sig { params(_reference: T.nilable(String)).returns(T.nilable(String)) }
def reference=(_reference); end
sig {
params(fleet: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fleet), flight: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Flight), fuel: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Fuel), lodging: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Lodging), receipt: T.nilable(T::Array[::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails::Receipt]), reference: T.nilable(String)).void
}
def initialize(
fleet: nil,
flight: nil,
fuel: nil,
lodging: nil,
receipt: nil,
reference: nil
); end
end
# The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# Card associated with this unlinked refund transaction.
sig { returns(String) }
def card; end
sig { params(_card: String).returns(String) }
def card=(_card); end
# The currency of the unlinked refund. If not provided, defaults to the currency of the card. 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::MerchantData))
}
def merchant_data; end
sig {
params(_merchant_data: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::MerchantData)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::MerchantData))
}
def merchant_data=(_merchant_data); end
# Additional purchase information that is optionally provided by the merchant.
sig {
returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails))
}
def purchase_details; end
sig {
params(_purchase_details: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails)).returns(T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails))
}
def purchase_details=(_purchase_details); end
sig {
params(amount: Integer, card: String, currency: T.nilable(String), expand: T.nilable(T::Array[String]), merchant_data: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::MerchantData), purchase_details: T.nilable(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams::PurchaseDetails)).void
}
def initialize(
amount: nil,
card: nil,
currency: nil,
expand: nil,
merchant_data: nil,
purchase_details: nil
); end
end
# Allows the user to capture an arbitrary amount, also known as a forced capture.
sig {
params(params: T.any(::Stripe::TestHelpers::Issuing::TransactionService::CreateForceCaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Transaction)
}
def create_force_capture(params = {}, opts = {}); end
# Allows the user to refund an arbitrary amount, also known as a unlinked refund.
sig {
params(params: T.any(::Stripe::TestHelpers::Issuing::TransactionService::CreateUnlinkedRefundParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Transaction)
}
def create_unlinked_refund(params = {}, opts = {}); end
# Refund a test-mode Transaction.
sig {
params(transaction: String, params: T.any(::Stripe::TestHelpers::Issuing::TransactionService::RefundParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Transaction)
}
def refund(transaction, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module TestHelpers
class RefundService < StripeService
class ExpireParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Expire a refund with a status of requires_action.
sig {
params(refund: String, params: T.any(::Stripe::TestHelpers::RefundService::ExpireParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Refund)
}
def expire(refund, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module TestHelpers
class TerminalService < StripeService
attr_reader :readers
end
end
end
# typed: true
module Stripe
module TestHelpers
module Terminal
class ReaderService < StripeService
class PresentPaymentMethodParams < Stripe::RequestParams
class Card < Stripe::RequestParams
# Card security code.
sig { returns(T.nilable(String)) }
def cvc; end
sig { params(_cvc: T.nilable(String)).returns(T.nilable(String)) }
def cvc=(_cvc); end
# Two-digit number representing the card's expiration month.
sig { returns(Integer) }
def exp_month; end
sig { params(_exp_month: Integer).returns(Integer) }
def exp_month=(_exp_month); end
# Two- or four-digit number representing the card's expiration year.
sig { returns(Integer) }
def exp_year; end
sig { params(_exp_year: Integer).returns(Integer) }
def exp_year=(_exp_year); end
# The card number, as a string without any separators.
sig { returns(String) }
def number; end
sig { params(_number: String).returns(String) }
def number=(_number); end
sig {
params(cvc: T.nilable(String), exp_month: Integer, exp_year: Integer, number: String).void
}
def initialize(cvc: nil, exp_month: nil, exp_year: nil, number: nil); end
end
class CardPresent < Stripe::RequestParams
# The card number, as a string without any separators.
sig { returns(T.nilable(String)) }
def number; end
sig { params(_number: T.nilable(String)).returns(T.nilable(String)) }
def number=(_number); end
sig { params(number: T.nilable(String)).void }
def initialize(number: nil); end
end
class InteracPresent < Stripe::RequestParams
# Card Number
sig { returns(T.nilable(String)) }
def number; end
sig { params(_number: T.nilable(String)).returns(T.nilable(String)) }
def number=(_number); end
sig { params(number: T.nilable(String)).void }
def initialize(number: nil); end
end
# Simulated on-reader tip amount.
sig { returns(T.nilable(Integer)) }
def amount_tip; end
sig { params(_amount_tip: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount_tip=(_amount_tip); end
# Simulated data for the card payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::Terminal::ReaderService::PresentPaymentMethodParams::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::TestHelpers::Terminal::ReaderService::PresentPaymentMethodParams::Card)).returns(T.nilable(::Stripe::TestHelpers::Terminal::ReaderService::PresentPaymentMethodParams::Card))
}
def card=(_card); end
# Simulated data for the card_present payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::Terminal::ReaderService::PresentPaymentMethodParams::CardPresent))
}
def card_present; end
sig {
params(_card_present: T.nilable(::Stripe::TestHelpers::Terminal::ReaderService::PresentPaymentMethodParams::CardPresent)).returns(T.nilable(::Stripe::TestHelpers::Terminal::ReaderService::PresentPaymentMethodParams::CardPresent))
}
def card_present=(_card_present); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Simulated data for the interac_present payment method.
sig {
returns(T.nilable(::Stripe::TestHelpers::Terminal::ReaderService::PresentPaymentMethodParams::InteracPresent))
}
def interac_present; end
sig {
params(_interac_present: T.nilable(::Stripe::TestHelpers::Terminal::ReaderService::PresentPaymentMethodParams::InteracPresent)).returns(T.nilable(::Stripe::TestHelpers::Terminal::ReaderService::PresentPaymentMethodParams::InteracPresent))
}
def interac_present=(_interac_present); end
# Simulated payment type.
sig { returns(T.nilable(String)) }
def type; end
sig { params(_type: T.nilable(String)).returns(T.nilable(String)) }
def type=(_type); end
sig {
params(amount_tip: T.nilable(Integer), card: T.nilable(::Stripe::TestHelpers::Terminal::ReaderService::PresentPaymentMethodParams::Card), card_present: T.nilable(::Stripe::TestHelpers::Terminal::ReaderService::PresentPaymentMethodParams::CardPresent), expand: T.nilable(T::Array[String]), interac_present: T.nilable(::Stripe::TestHelpers::Terminal::ReaderService::PresentPaymentMethodParams::InteracPresent), type: T.nilable(String)).void
}
def initialize(
amount_tip: nil,
card: nil,
card_present: nil,
expand: nil,
interac_present: nil,
type: nil
); end
end
class SucceedInputCollectionParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# This parameter defines the skip behavior for input collection.
sig { returns(T.nilable(String)) }
def skip_non_required_inputs; end
sig { params(_skip_non_required_inputs: T.nilable(String)).returns(T.nilable(String)) }
def skip_non_required_inputs=(_skip_non_required_inputs); end
sig {
params(expand: T.nilable(T::Array[String]), skip_non_required_inputs: T.nilable(String)).void
}
def initialize(expand: nil, skip_non_required_inputs: nil); end
end
class TimeoutInputCollectionParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.
sig {
params(reader: String, params: T.any(::Stripe::TestHelpers::Terminal::ReaderService::PresentPaymentMethodParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def present_payment_method(reader, params = {}, opts = {}); end
# Use this endpoint to trigger a successful input collection on a simulated reader.
sig {
params(reader: String, params: T.any(::Stripe::TestHelpers::Terminal::ReaderService::SucceedInputCollectionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def succeed_input_collection(reader, params = {}, opts = {}); end
# Use this endpoint to complete an input collection with a timeout error on a simulated reader.
sig {
params(reader: String, params: T.any(::Stripe::TestHelpers::Terminal::ReaderService::TimeoutInputCollectionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
}
def timeout_input_collection(reader, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module TestHelpers
class TestClockService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The initial frozen time for this test clock.
sig { returns(Integer) }
def frozen_time; end
sig { params(_frozen_time: Integer).returns(Integer) }
def frozen_time=(_frozen_time); end
# The name for this test clock.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(expand: T.nilable(T::Array[String]), frozen_time: Integer, name: T.nilable(String)).void
}
def initialize(expand: nil, frozen_time: nil, name: nil); end
end
class AdvanceParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future.
sig { returns(Integer) }
def frozen_time; end
sig { params(_frozen_time: Integer).returns(Integer) }
def frozen_time=(_frozen_time); end
sig { params(expand: T.nilable(T::Array[String]), frozen_time: Integer).void }
def initialize(expand: nil, frozen_time: nil); end
end
# Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.
sig {
params(test_clock: String, params: T.any(::Stripe::TestHelpers::TestClockService::AdvanceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TestHelpers::TestClock)
}
def advance(test_clock, params = {}, opts = {}); end
# Creates a new test clock that can be attached to new customers and quotes.
sig {
params(params: T.any(::Stripe::TestHelpers::TestClockService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TestHelpers::TestClock)
}
def create(params = {}, opts = {}); end
# Deletes a test clock.
sig {
params(test_clock: String, params: T.any(::Stripe::TestHelpers::TestClockService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TestHelpers::TestClock)
}
def delete(test_clock, params = {}, opts = {}); end
# Returns a list of your test clocks.
sig {
params(params: T.any(::Stripe::TestHelpers::TestClockService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a test clock.
sig {
params(test_clock: String, params: T.any(::Stripe::TestHelpers::TestClockService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::TestHelpers::TestClock)
}
def retrieve(test_clock, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module TestHelpers
class TreasuryService < StripeService
attr_reader :inbound_transfers
attr_reader :outbound_payments
attr_reader :outbound_transfers
attr_reader :received_credits
attr_reader :received_debits
end
end
end
# typed: true
module Stripe
module TestHelpers
module Treasury
class InboundTransferService < StripeService
class FailParams < Stripe::RequestParams
class FailureDetails < Stripe::RequestParams
# Reason for the failure.
sig { returns(T.nilable(String)) }
def code; end
sig { params(_code: T.nilable(String)).returns(T.nilable(String)) }
def code=(_code); end
sig { params(code: T.nilable(String)).void }
def initialize(code: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Details about a failed InboundTransfer.
sig {
returns(T.nilable(::Stripe::TestHelpers::Treasury::InboundTransferService::FailParams::FailureDetails))
}
def failure_details; end
sig {
params(_failure_details: T.nilable(::Stripe::TestHelpers::Treasury::InboundTransferService::FailParams::FailureDetails)).returns(T.nilable(::Stripe::TestHelpers::Treasury::InboundTransferService::FailParams::FailureDetails))
}
def failure_details=(_failure_details); end
sig {
params(expand: T.nilable(T::Array[String]), failure_details: T.nilable(::Stripe::TestHelpers::Treasury::InboundTransferService::FailParams::FailureDetails)).void
}
def initialize(expand: nil, failure_details: nil); end
end
class ReturnInboundTransferParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class SucceedParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.
sig {
params(id: String, params: T.any(::Stripe::TestHelpers::Treasury::InboundTransferService::FailParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::InboundTransfer)
}
def fail(id, params = {}, opts = {}); end
# Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.
sig {
params(id: String, params: T.any(::Stripe::TestHelpers::Treasury::InboundTransferService::ReturnInboundTransferParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::InboundTransfer)
}
def return_inbound_transfer(id, params = {}, opts = {}); end
# Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
sig {
params(id: String, params: T.any(::Stripe::TestHelpers::Treasury::InboundTransferService::SucceedParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::InboundTransfer)
}
def succeed(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module TestHelpers
module Treasury
class OutboundPaymentService < StripeService
class UpdateParams < Stripe::RequestParams
class TrackingDetails < Stripe::RequestParams
class Ach < Stripe::RequestParams
# ACH trace ID for funds sent over the `ach` network.
sig { returns(String) }
def trace_id; end
sig { params(_trace_id: String).returns(String) }
def trace_id=(_trace_id); end
sig { params(trace_id: String).void }
def initialize(trace_id: nil); end
end
class UsDomesticWire < Stripe::RequestParams
# CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def chips; end
sig { params(_chips: T.nilable(String)).returns(T.nilable(String)) }
def chips=(_chips); end
# IMAD for funds sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def imad; end
sig { params(_imad: T.nilable(String)).returns(T.nilable(String)) }
def imad=(_imad); end
# OMAD for funds sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def omad; end
sig { params(_omad: T.nilable(String)).returns(T.nilable(String)) }
def omad=(_omad); end
sig {
params(chips: T.nilable(String), imad: T.nilable(String), omad: T.nilable(String)).void
}
def initialize(chips: nil, imad: nil, omad: nil); end
end
# ACH network tracking details.
sig {
returns(T.nilable(::Stripe::TestHelpers::Treasury::OutboundPaymentService::UpdateParams::TrackingDetails::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::TestHelpers::Treasury::OutboundPaymentService::UpdateParams::TrackingDetails::Ach)).returns(T.nilable(::Stripe::TestHelpers::Treasury::OutboundPaymentService::UpdateParams::TrackingDetails::Ach))
}
def ach=(_ach); end
# The US bank account network used to send funds.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# US domestic wire network tracking details.
sig {
returns(T.nilable(::Stripe::TestHelpers::Treasury::OutboundPaymentService::UpdateParams::TrackingDetails::UsDomesticWire))
}
def us_domestic_wire; end
sig {
params(_us_domestic_wire: T.nilable(::Stripe::TestHelpers::Treasury::OutboundPaymentService::UpdateParams::TrackingDetails::UsDomesticWire)).returns(T.nilable(::Stripe::TestHelpers::Treasury::OutboundPaymentService::UpdateParams::TrackingDetails::UsDomesticWire))
}
def us_domestic_wire=(_us_domestic_wire); end
sig {
params(ach: T.nilable(::Stripe::TestHelpers::Treasury::OutboundPaymentService::UpdateParams::TrackingDetails::Ach), type: String, us_domestic_wire: T.nilable(::Stripe::TestHelpers::Treasury::OutboundPaymentService::UpdateParams::TrackingDetails::UsDomesticWire)).void
}
def initialize(ach: nil, type: nil, us_domestic_wire: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Details about network-specific tracking information.
sig {
returns(::Stripe::TestHelpers::Treasury::OutboundPaymentService::UpdateParams::TrackingDetails)
}
def tracking_details; end
sig {
params(_tracking_details: ::Stripe::TestHelpers::Treasury::OutboundPaymentService::UpdateParams::TrackingDetails).returns(::Stripe::TestHelpers::Treasury::OutboundPaymentService::UpdateParams::TrackingDetails)
}
def tracking_details=(_tracking_details); end
sig {
params(expand: T.nilable(T::Array[String]), tracking_details: ::Stripe::TestHelpers::Treasury::OutboundPaymentService::UpdateParams::TrackingDetails).void
}
def initialize(expand: nil, tracking_details: nil); end
end
class FailParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class PostParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ReturnOutboundPaymentParams < Stripe::RequestParams
class ReturnedDetails < Stripe::RequestParams
# The return code to be set on the OutboundPayment object.
sig { returns(T.nilable(String)) }
def code; end
sig { params(_code: T.nilable(String)).returns(T.nilable(String)) }
def code=(_code); end
sig { params(code: T.nilable(String)).void }
def initialize(code: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Optional hash to set the return code.
sig {
returns(T.nilable(::Stripe::TestHelpers::Treasury::OutboundPaymentService::ReturnOutboundPaymentParams::ReturnedDetails))
}
def returned_details; end
sig {
params(_returned_details: T.nilable(::Stripe::TestHelpers::Treasury::OutboundPaymentService::ReturnOutboundPaymentParams::ReturnedDetails)).returns(T.nilable(::Stripe::TestHelpers::Treasury::OutboundPaymentService::ReturnOutboundPaymentParams::ReturnedDetails))
}
def returned_details=(_returned_details); end
sig {
params(expand: T.nilable(T::Array[String]), returned_details: T.nilable(::Stripe::TestHelpers::Treasury::OutboundPaymentService::ReturnOutboundPaymentParams::ReturnedDetails)).void
}
def initialize(expand: nil, returned_details: nil); end
end
# Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.
sig {
params(id: String, params: T.any(::Stripe::TestHelpers::Treasury::OutboundPaymentService::FailParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundPayment)
}
def fail(id, params = {}, opts = {}); end
# Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.
sig {
params(id: String, params: T.any(::Stripe::TestHelpers::Treasury::OutboundPaymentService::PostParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundPayment)
}
def post(id, params = {}, opts = {}); end
# Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.
sig {
params(id: String, params: T.any(::Stripe::TestHelpers::Treasury::OutboundPaymentService::ReturnOutboundPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundPayment)
}
def return_outbound_payment(id, params = {}, opts = {}); end
# Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.
sig {
params(id: String, params: T.any(::Stripe::TestHelpers::Treasury::OutboundPaymentService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundPayment)
}
def update(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module TestHelpers
module Treasury
class OutboundTransferService < StripeService
class UpdateParams < Stripe::RequestParams
class TrackingDetails < Stripe::RequestParams
class Ach < Stripe::RequestParams
# ACH trace ID for funds sent over the `ach` network.
sig { returns(String) }
def trace_id; end
sig { params(_trace_id: String).returns(String) }
def trace_id=(_trace_id); end
sig { params(trace_id: String).void }
def initialize(trace_id: nil); end
end
class UsDomesticWire < Stripe::RequestParams
# CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def chips; end
sig { params(_chips: T.nilable(String)).returns(T.nilable(String)) }
def chips=(_chips); end
# IMAD for funds sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def imad; end
sig { params(_imad: T.nilable(String)).returns(T.nilable(String)) }
def imad=(_imad); end
# OMAD for funds sent over the `us_domestic_wire` network.
sig { returns(T.nilable(String)) }
def omad; end
sig { params(_omad: T.nilable(String)).returns(T.nilable(String)) }
def omad=(_omad); end
sig {
params(chips: T.nilable(String), imad: T.nilable(String), omad: T.nilable(String)).void
}
def initialize(chips: nil, imad: nil, omad: nil); end
end
# ACH network tracking details.
sig {
returns(T.nilable(::Stripe::TestHelpers::Treasury::OutboundTransferService::UpdateParams::TrackingDetails::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::TestHelpers::Treasury::OutboundTransferService::UpdateParams::TrackingDetails::Ach)).returns(T.nilable(::Stripe::TestHelpers::Treasury::OutboundTransferService::UpdateParams::TrackingDetails::Ach))
}
def ach=(_ach); end
# The US bank account network used to send funds.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# US domestic wire network tracking details.
sig {
returns(T.nilable(::Stripe::TestHelpers::Treasury::OutboundTransferService::UpdateParams::TrackingDetails::UsDomesticWire))
}
def us_domestic_wire; end
sig {
params(_us_domestic_wire: T.nilable(::Stripe::TestHelpers::Treasury::OutboundTransferService::UpdateParams::TrackingDetails::UsDomesticWire)).returns(T.nilable(::Stripe::TestHelpers::Treasury::OutboundTransferService::UpdateParams::TrackingDetails::UsDomesticWire))
}
def us_domestic_wire=(_us_domestic_wire); end
sig {
params(ach: T.nilable(::Stripe::TestHelpers::Treasury::OutboundTransferService::UpdateParams::TrackingDetails::Ach), type: String, us_domestic_wire: T.nilable(::Stripe::TestHelpers::Treasury::OutboundTransferService::UpdateParams::TrackingDetails::UsDomesticWire)).void
}
def initialize(ach: nil, type: nil, us_domestic_wire: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Details about network-specific tracking information.
sig {
returns(::Stripe::TestHelpers::Treasury::OutboundTransferService::UpdateParams::TrackingDetails)
}
def tracking_details; end
sig {
params(_tracking_details: ::Stripe::TestHelpers::Treasury::OutboundTransferService::UpdateParams::TrackingDetails).returns(::Stripe::TestHelpers::Treasury::OutboundTransferService::UpdateParams::TrackingDetails)
}
def tracking_details=(_tracking_details); end
sig {
params(expand: T.nilable(T::Array[String]), tracking_details: ::Stripe::TestHelpers::Treasury::OutboundTransferService::UpdateParams::TrackingDetails).void
}
def initialize(expand: nil, tracking_details: nil); end
end
class FailParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class PostParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class ReturnOutboundTransferParams < Stripe::RequestParams
class ReturnedDetails < Stripe::RequestParams
# Reason for the return.
sig { returns(T.nilable(String)) }
def code; end
sig { params(_code: T.nilable(String)).returns(T.nilable(String)) }
def code=(_code); end
sig { params(code: T.nilable(String)).void }
def initialize(code: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Details about a returned OutboundTransfer.
sig {
returns(T.nilable(::Stripe::TestHelpers::Treasury::OutboundTransferService::ReturnOutboundTransferParams::ReturnedDetails))
}
def returned_details; end
sig {
params(_returned_details: T.nilable(::Stripe::TestHelpers::Treasury::OutboundTransferService::ReturnOutboundTransferParams::ReturnedDetails)).returns(T.nilable(::Stripe::TestHelpers::Treasury::OutboundTransferService::ReturnOutboundTransferParams::ReturnedDetails))
}
def returned_details=(_returned_details); end
sig {
params(expand: T.nilable(T::Array[String]), returned_details: T.nilable(::Stripe::TestHelpers::Treasury::OutboundTransferService::ReturnOutboundTransferParams::ReturnedDetails)).void
}
def initialize(expand: nil, returned_details: nil); end
end
# Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.
sig {
params(outbound_transfer: String, params: T.any(::Stripe::TestHelpers::Treasury::OutboundTransferService::FailParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundTransfer)
}
def fail(outbound_transfer, params = {}, opts = {}); end
# Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.
sig {
params(outbound_transfer: String, params: T.any(::Stripe::TestHelpers::Treasury::OutboundTransferService::PostParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundTransfer)
}
def post(outbound_transfer, params = {}, opts = {}); end
# Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.
sig {
params(outbound_transfer: String, params: T.any(::Stripe::TestHelpers::Treasury::OutboundTransferService::ReturnOutboundTransferParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundTransfer)
}
def return_outbound_transfer(outbound_transfer, params = {}, opts = {}); end
# Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.
sig {
params(outbound_transfer: String, params: T.any(::Stripe::TestHelpers::Treasury::OutboundTransferService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundTransfer)
}
def update(outbound_transfer, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module TestHelpers
module Treasury
class ReceivedCreditService < StripeService
class CreateParams < Stripe::RequestParams
class InitiatingPaymentMethodDetails < Stripe::RequestParams
class UsBankAccount < Stripe::RequestParams
# The bank account holder's name.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The bank account number.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# The bank account's routing number.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_name: T.nilable(String), account_number: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
routing_number: nil
); end
end
# The source type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Optional fields for `us_bank_account`.
sig {
returns(T.nilable(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams::InitiatingPaymentMethodDetails::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams::InitiatingPaymentMethodDetails::UsBankAccount)).returns(T.nilable(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams::InitiatingPaymentMethodDetails::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
sig {
params(type: String, us_bank_account: T.nilable(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams::InitiatingPaymentMethodDetails::UsBankAccount)).void
}
def initialize(type: nil, us_bank_account: nil); end
end
class NetworkDetails < Stripe::RequestParams
class Ach < Stripe::RequestParams
# ACH Addenda record
sig { returns(T.nilable(String)) }
def addenda; end
sig { params(_addenda: T.nilable(String)).returns(T.nilable(String)) }
def addenda=(_addenda); end
sig { params(addenda: T.nilable(String)).void }
def initialize(addenda: nil); end
end
# Optional fields for `ach`.
sig {
returns(T.nilable(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams::NetworkDetails::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams::NetworkDetails::Ach)).returns(T.nilable(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams::NetworkDetails::Ach))
}
def ach=(_ach); end
# The type of flow that originated the ReceivedCredit.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(ach: T.nilable(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams::NetworkDetails::Ach), type: String).void
}
def initialize(ach: nil, type: nil); end
end
# Amount (in cents) to be transferred.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FinancialAccount to send funds to.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# Initiating payment method details for the object.
sig {
returns(T.nilable(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams::InitiatingPaymentMethodDetails))
}
def initiating_payment_method_details; end
sig {
params(_initiating_payment_method_details: T.nilable(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams::InitiatingPaymentMethodDetails)).returns(T.nilable(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams::InitiatingPaymentMethodDetails))
}
def initiating_payment_method_details=(_initiating_payment_method_details); end
# Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
sig { returns(String) }
def network; end
sig { params(_network: String).returns(String) }
def network=(_network); end
# Details about the network used for the ReceivedCredit.
sig {
returns(T.nilable(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams::NetworkDetails))
}
def network_details; end
sig {
params(_network_details: T.nilable(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams::NetworkDetails)).returns(T.nilable(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams::NetworkDetails))
}
def network_details=(_network_details); end
sig {
params(amount: Integer, currency: String, description: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, initiating_payment_method_details: T.nilable(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams::InitiatingPaymentMethodDetails), network: String, network_details: T.nilable(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams::NetworkDetails)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
expand: nil,
financial_account: nil,
initiating_payment_method_details: nil,
network: nil,
network_details: nil
); end
end
# Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can't directly create ReceivedCredits initiated by third parties.
sig {
params(params: T.any(::Stripe::TestHelpers::Treasury::ReceivedCreditService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::ReceivedCredit)
}
def create(params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module TestHelpers
module Treasury
class ReceivedDebitService < StripeService
class CreateParams < Stripe::RequestParams
class InitiatingPaymentMethodDetails < Stripe::RequestParams
class UsBankAccount < Stripe::RequestParams
# The bank account holder's name.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The bank account number.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# The bank account's routing number.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_name: T.nilable(String), account_number: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_name: nil,
account_number: nil,
routing_number: nil
); end
end
# The source type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Optional fields for `us_bank_account`.
sig {
returns(T.nilable(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams::InitiatingPaymentMethodDetails::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams::InitiatingPaymentMethodDetails::UsBankAccount)).returns(T.nilable(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams::InitiatingPaymentMethodDetails::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
sig {
params(type: String, us_bank_account: T.nilable(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams::InitiatingPaymentMethodDetails::UsBankAccount)).void
}
def initialize(type: nil, us_bank_account: nil); end
end
class NetworkDetails < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Addenda record data associated with this ReceivedDebit.
sig { returns(T.nilable(String)) }
def addenda; end
sig { params(_addenda: T.nilable(String)).returns(T.nilable(String)) }
def addenda=(_addenda); end
sig { params(addenda: T.nilable(String)).void }
def initialize(addenda: nil); end
end
# Optional fields for `ach`.
sig {
returns(T.nilable(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams::NetworkDetails::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams::NetworkDetails::Ach)).returns(T.nilable(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams::NetworkDetails::Ach))
}
def ach=(_ach); end
# The type of flow that originated the ReceivedDebit.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(ach: T.nilable(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams::NetworkDetails::Ach), type: String).void
}
def initialize(ach: nil, type: nil); end
end
# Amount (in cents) to be transferred.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FinancialAccount to pull funds from.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# Initiating payment method details for the object.
sig {
returns(T.nilable(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams::InitiatingPaymentMethodDetails))
}
def initiating_payment_method_details; end
sig {
params(_initiating_payment_method_details: T.nilable(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams::InitiatingPaymentMethodDetails)).returns(T.nilable(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams::InitiatingPaymentMethodDetails))
}
def initiating_payment_method_details=(_initiating_payment_method_details); end
# Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
sig { returns(String) }
def network; end
sig { params(_network: String).returns(String) }
def network=(_network); end
# Details about the network used for the ReceivedDebit.
sig {
returns(T.nilable(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams::NetworkDetails))
}
def network_details; end
sig {
params(_network_details: T.nilable(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams::NetworkDetails)).returns(T.nilable(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams::NetworkDetails))
}
def network_details=(_network_details); end
sig {
params(amount: Integer, currency: String, description: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, initiating_payment_method_details: T.nilable(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams::InitiatingPaymentMethodDetails), network: String, network_details: T.nilable(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams::NetworkDetails)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
expand: nil,
financial_account: nil,
initiating_payment_method_details: nil,
network: nil,
network_details: nil
); end
end
# Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can't directly create ReceivedDebits initiated by third parties.
sig {
params(params: T.any(::Stripe::TestHelpers::Treasury::ReceivedDebitService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::ReceivedDebit)
}
def create(params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
class TokenService < StripeService
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class CreateParams < Stripe::RequestParams
class Account < Stripe::RequestParams
class Company < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class DirectorshipDeclaration < Stripe::RequestParams
# The Unix timestamp marking when the directorship declaration attestation was made.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the directorship declaration attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the directorship declaration attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class OwnershipDeclaration < Stripe::RequestParams
# The Unix timestamp marking when the beneficial owner attestation was made.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class RegistrationDate < Stripe::RequestParams
# The day of registration, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of registration, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of registration.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Verification < Stripe::RequestParams
class Document < Stripe::RequestParams
# The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# A document verifying the business.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Company::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::TokenService::CreateParams::Account::Company::Verification::Document)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Company::Verification::Document))
}
def document=(_document); end
sig {
params(document: T.nilable(::Stripe::TokenService::CreateParams::Account::Company::Verification::Document)).void
}
def initialize(document: nil); end
end
# The company's primary address.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Company::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::TokenService::CreateParams::Account::Company::Address)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Company::Address))
}
def address=(_address); end
# The Kana variation of the company's primary address (Japan only).
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Company::AddressKana))
}
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::TokenService::CreateParams::Account::Company::AddressKana)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Company::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the company's primary address (Japan only).
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Company::AddressKanji))
}
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::TokenService::CreateParams::Account::Company::AddressKanji)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Company::AddressKanji))
}
def address_kanji=(_address_kanji); end
# Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.
sig { returns(T.nilable(T::Boolean)) }
def directors_provided; end
sig { params(_directors_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def directors_provided=(_directors_provided); end
# This hash is used to attest that the directors information provided to Stripe is both current and correct.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Company::DirectorshipDeclaration))
}
def directorship_declaration; end
sig {
params(_directorship_declaration: T.nilable(::Stripe::TokenService::CreateParams::Account::Company::DirectorshipDeclaration)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Company::DirectorshipDeclaration))
}
def directorship_declaration=(_directorship_declaration); end
# Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](/api/persons) for accounts with a `relationship.executive` requirement.
sig { returns(T.nilable(T::Boolean)) }
def executives_provided; end
sig { params(_executives_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executives_provided=(_executives_provided); end
# The export license ID number of the company, also referred as Import Export Code (India only).
sig { returns(T.nilable(String)) }
def export_license_id; end
sig { params(_export_license_id: T.nilable(String)).returns(T.nilable(String)) }
def export_license_id=(_export_license_id); end
# The purpose code to use for export transactions (India only).
sig { returns(T.nilable(String)) }
def export_purpose_code; end
sig { params(_export_purpose_code: T.nilable(String)).returns(T.nilable(String)) }
def export_purpose_code=(_export_purpose_code); end
# The company's legal name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# The Kana variation of the company's legal name (Japan only).
sig { returns(T.nilable(String)) }
def name_kana; end
sig { params(_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def name_kana=(_name_kana); end
# The Kanji variation of the company's legal name (Japan only).
sig { returns(T.nilable(String)) }
def name_kanji; end
sig { params(_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def name_kanji=(_name_kanji); end
# Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](/api/persons) for accounts with a `relationship.owner` requirement.
sig { returns(T.nilable(T::Boolean)) }
def owners_provided; end
sig { params(_owners_provided: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owners_provided=(_owners_provided); end
# This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Company::OwnershipDeclaration))
}
def ownership_declaration; end
sig {
params(_ownership_declaration: T.nilable(::Stripe::TokenService::CreateParams::Account::Company::OwnershipDeclaration)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Company::OwnershipDeclaration))
}
def ownership_declaration=(_ownership_declaration); end
# Whether the user described by the data in the token has been shown the Ownership Declaration and indicated that it is correct.
sig { returns(T.nilable(T::Boolean)) }
def ownership_declaration_shown_and_signed; end
sig {
params(_ownership_declaration_shown_and_signed: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def ownership_declaration_shown_and_signed=(_ownership_declaration_shown_and_signed); end
# This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.
sig { returns(T.nilable(T.any(String, String))) }
def ownership_exemption_reason; end
sig {
params(_ownership_exemption_reason: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def ownership_exemption_reason=(_ownership_exemption_reason); end
# The company's phone number (used for verification).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# When the business was incorporated or registered.
sig {
returns(T.nilable(T.any(String, ::Stripe::TokenService::CreateParams::Account::Company::RegistrationDate)))
}
def registration_date; end
sig {
params(_registration_date: T.nilable(T.any(String, ::Stripe::TokenService::CreateParams::Account::Company::RegistrationDate))).returns(T.nilable(T.any(String, ::Stripe::TokenService::CreateParams::Account::Company::RegistrationDate)))
}
def registration_date=(_registration_date); end
# The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).
sig { returns(T.nilable(String)) }
def registration_number; end
sig { params(_registration_number: T.nilable(String)).returns(T.nilable(String)) }
def registration_number=(_registration_number); end
# The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
sig { returns(T.nilable(T.any(String, String))) }
def structure; end
sig {
params(_structure: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String)))
}
def structure=(_structure); end
# The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)
sig { returns(T.nilable(String)) }
def tax_id; end
sig { params(_tax_id: T.nilable(String)).returns(T.nilable(String)) }
def tax_id=(_tax_id); end
# The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
sig { returns(T.nilable(String)) }
def tax_id_registrar; end
sig { params(_tax_id_registrar: T.nilable(String)).returns(T.nilable(String)) }
def tax_id_registrar=(_tax_id_registrar); end
# The VAT number of the company.
sig { returns(T.nilable(String)) }
def vat_id; end
sig { params(_vat_id: T.nilable(String)).returns(T.nilable(String)) }
def vat_id=(_vat_id); end
# Information on the verification state of the company.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Company::Verification))
}
def verification; end
sig {
params(_verification: T.nilable(::Stripe::TokenService::CreateParams::Account::Company::Verification)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Company::Verification))
}
def verification=(_verification); end
sig {
params(address: T.nilable(::Stripe::TokenService::CreateParams::Account::Company::Address), address_kana: T.nilable(::Stripe::TokenService::CreateParams::Account::Company::AddressKana), address_kanji: T.nilable(::Stripe::TokenService::CreateParams::Account::Company::AddressKanji), directors_provided: T.nilable(T::Boolean), directorship_declaration: T.nilable(::Stripe::TokenService::CreateParams::Account::Company::DirectorshipDeclaration), executives_provided: T.nilable(T::Boolean), export_license_id: T.nilable(String), export_purpose_code: T.nilable(String), name: T.nilable(String), name_kana: T.nilable(String), name_kanji: T.nilable(String), owners_provided: T.nilable(T::Boolean), ownership_declaration: T.nilable(::Stripe::TokenService::CreateParams::Account::Company::OwnershipDeclaration), ownership_declaration_shown_and_signed: T.nilable(T::Boolean), ownership_exemption_reason: T.nilable(T.any(String, String)), phone: T.nilable(String), registration_date: T.nilable(T.any(String, ::Stripe::TokenService::CreateParams::Account::Company::RegistrationDate)), registration_number: T.nilable(String), structure: T.nilable(T.any(String, String)), tax_id: T.nilable(String), tax_id_registrar: T.nilable(String), vat_id: T.nilable(String), verification: T.nilable(::Stripe::TokenService::CreateParams::Account::Company::Verification)).void
}
def initialize(
address: nil,
address_kana: nil,
address_kanji: nil,
directors_provided: nil,
directorship_declaration: nil,
executives_provided: nil,
export_license_id: nil,
export_purpose_code: nil,
name: nil,
name_kana: nil,
name_kanji: nil,
owners_provided: nil,
ownership_declaration: nil,
ownership_declaration_shown_and_signed: nil,
ownership_exemption_reason: nil,
phone: nil,
registration_date: nil,
registration_number: nil,
structure: nil,
tax_id: nil,
tax_id_registrar: nil,
vat_id: nil,
verification: nil
); end
end
class Individual < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class RegisteredAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Relationship < Stripe::RequestParams
# Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
sig { returns(T.nilable(T::Boolean)) }
def director; end
sig { params(_director: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def director=(_director); end
# Whether the person has significant responsibility to control, manage, or direct the organization.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
sig { params(_executive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executive=(_executive); end
# Whether the person is an owner of the account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
sig { params(_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owner=(_owner); end
# The percent owned by the person of the account's legal entity.
sig { returns(T.nilable(T.any(String, Float))) }
def percent_ownership; end
sig {
params(_percent_ownership: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def percent_ownership=(_percent_ownership); end
# The person's title (e.g., CEO, Support Engineer).
sig { returns(T.nilable(String)) }
def title; end
sig { params(_title: T.nilable(String)).returns(T.nilable(String)) }
def title=(_title); end
sig {
params(director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), percent_ownership: T.nilable(T.any(String, Float)), title: T.nilable(String)).void
}
def initialize(
director: nil,
executive: nil,
owner: nil,
percent_ownership: nil,
title: nil
); end
end
class Verification < Stripe::RequestParams
class AdditionalDocument < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
class Document < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Verification::AdditionalDocument))
}
def additional_document; end
sig {
params(_additional_document: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Verification::AdditionalDocument)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Verification::AdditionalDocument))
}
def additional_document=(_additional_document); end
# An identifying document, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Verification::Document)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Verification::Document))
}
def document=(_document); end
sig {
params(additional_document: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Verification::AdditionalDocument), document: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Verification::Document)).void
}
def initialize(additional_document: nil, document: nil); end
end
# The individual's primary address.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Address)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Address))
}
def address=(_address); end
# The Kana variation of the individual's primary address (Japan only).
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::AddressKana))
}
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::AddressKana)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the individual's primary address (Japan only).
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::AddressKanji))
}
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::AddressKanji)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::AddressKanji))
}
def address_kanji=(_address_kanji); end
# The individual's date of birth.
sig {
returns(T.nilable(T.any(String, ::Stripe::TokenService::CreateParams::Account::Individual::Dob)))
}
def dob; end
sig {
params(_dob: T.nilable(T.any(String, ::Stripe::TokenService::CreateParams::Account::Individual::Dob))).returns(T.nilable(T.any(String, ::Stripe::TokenService::CreateParams::Account::Individual::Dob)))
}
def dob=(_dob); end
# The individual's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The individual's first name.
sig { returns(T.nilable(String)) }
def first_name; end
sig { params(_first_name: T.nilable(String)).returns(T.nilable(String)) }
def first_name=(_first_name); end
# The Kana variation of the individual's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kana; end
sig { params(_first_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kana=(_first_name_kana); end
# The Kanji variation of the individual's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kanji; end
sig { params(_first_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kanji=(_first_name_kanji); end
# A list of alternate names or aliases that the individual is known by.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def full_name_aliases; end
sig {
params(_full_name_aliases: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def full_name_aliases=(_full_name_aliases); end
# The individual's gender
sig { returns(T.nilable(String)) }
def gender; end
sig { params(_gender: T.nilable(String)).returns(T.nilable(String)) }
def gender=(_gender); end
# The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number; end
sig { params(_id_number: T.nilable(String)).returns(T.nilable(String)) }
def id_number=(_id_number); end
# The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number_secondary; end
sig { params(_id_number_secondary: T.nilable(String)).returns(T.nilable(String)) }
def id_number_secondary=(_id_number_secondary); end
# The individual's last name.
sig { returns(T.nilable(String)) }
def last_name; end
sig { params(_last_name: T.nilable(String)).returns(T.nilable(String)) }
def last_name=(_last_name); end
# The Kana variation of the individual's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kana; end
sig { params(_last_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kana=(_last_name_kana); end
# The Kanji variation of the individual's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kanji; end
sig { params(_last_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kanji=(_last_name_kanji); end
# The individual's maiden name.
sig { returns(T.nilable(String)) }
def maiden_name; end
sig { params(_maiden_name: T.nilable(String)).returns(T.nilable(String)) }
def maiden_name=(_maiden_name); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The individual's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
sig { returns(T.nilable(String)) }
def political_exposure; end
sig { params(_political_exposure: T.nilable(String)).returns(T.nilable(String)) }
def political_exposure=(_political_exposure); end
# The individual's registered address.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::RegisteredAddress))
}
def registered_address; end
sig {
params(_registered_address: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::RegisteredAddress)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::RegisteredAddress))
}
def registered_address=(_registered_address); end
# Describes the person’s relationship to the account.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Relationship))
}
def relationship; end
sig {
params(_relationship: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Relationship)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Relationship))
}
def relationship=(_relationship); end
# The last four digits of the individual's Social Security Number (U.S. only).
sig { returns(T.nilable(String)) }
def ssn_last_4; end
sig { params(_ssn_last_4: T.nilable(String)).returns(T.nilable(String)) }
def ssn_last_4=(_ssn_last_4); end
# The individual's verification document information.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Verification))
}
def verification; end
sig {
params(_verification: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Verification)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Verification))
}
def verification=(_verification); end
sig {
params(address: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Address), address_kana: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::AddressKana), address_kanji: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::AddressKanji), dob: T.nilable(T.any(String, ::Stripe::TokenService::CreateParams::Account::Individual::Dob)), email: T.nilable(String), first_name: T.nilable(String), first_name_kana: T.nilable(String), first_name_kanji: T.nilable(String), full_name_aliases: T.nilable(T.any(String, T::Array[String])), gender: T.nilable(String), id_number: T.nilable(String), id_number_secondary: T.nilable(String), last_name: T.nilable(String), last_name_kana: T.nilable(String), last_name_kanji: T.nilable(String), maiden_name: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), phone: T.nilable(String), political_exposure: T.nilable(String), registered_address: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::RegisteredAddress), relationship: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Relationship), ssn_last_4: T.nilable(String), verification: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual::Verification)).void
}
def initialize(
address: nil,
address_kana: nil,
address_kanji: nil,
dob: nil,
email: nil,
first_name: nil,
first_name_kana: nil,
first_name_kanji: nil,
full_name_aliases: nil,
gender: nil,
id_number: nil,
id_number_secondary: nil,
last_name: nil,
last_name_kana: nil,
last_name_kanji: nil,
maiden_name: nil,
metadata: nil,
phone: nil,
political_exposure: nil,
registered_address: nil,
relationship: nil,
ssn_last_4: nil,
verification: nil
); end
end
# The business type.
sig { returns(T.nilable(String)) }
def business_type; end
sig { params(_business_type: T.nilable(String)).returns(T.nilable(String)) }
def business_type=(_business_type); end
# Information about the company or business.
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Company)) }
def company; end
sig {
params(_company: T.nilable(::Stripe::TokenService::CreateParams::Account::Company)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Company))
}
def company=(_company); end
# Information about the person represented by the account.
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual)) }
def individual; end
sig {
params(_individual: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account::Individual))
}
def individual=(_individual); end
# Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.
sig { returns(T.nilable(T::Boolean)) }
def tos_shown_and_accepted; end
sig {
params(_tos_shown_and_accepted: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean))
}
def tos_shown_and_accepted=(_tos_shown_and_accepted); end
sig {
params(business_type: T.nilable(String), company: T.nilable(::Stripe::TokenService::CreateParams::Account::Company), individual: T.nilable(::Stripe::TokenService::CreateParams::Account::Individual), tos_shown_and_accepted: T.nilable(T::Boolean)).void
}
def initialize(
business_type: nil,
company: nil,
individual: nil,
tos_shown_and_accepted: nil
); end
end
class BankAccount < Stripe::RequestParams
# The name of the person or business that owns the bank account. This field is required when attaching the bank account to a `Customer` object.
sig { returns(T.nilable(String)) }
def account_holder_name; end
sig { params(_account_holder_name: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_name=(_account_holder_name); end
# The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# The account number for the bank account, in string form. Must be a checking account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The country in which the bank account is located.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](https://stripe.com/docs/payouts)
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The ID of a Payment Method with a `type` of `us_bank_account`. The Payment Method's bank account information will be copied and returned as a Bank Account Token. This parameter is exclusive with respect to all other parameters in the `bank_account` hash. You must include the top-level `customer` parameter if the Payment Method is attached to a `Customer` object. If the Payment Method is not attached to a `Customer` object, it will be consumed and cannot be used again. You may not use Payment Methods which were created by a Setup Intent with `attach_to_self=true`.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_name: T.nilable(String), account_holder_type: T.nilable(String), account_number: String, account_type: T.nilable(String), country: String, currency: T.nilable(String), payment_method: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_name: nil,
account_holder_type: nil,
account_number: nil,
account_type: nil,
country: nil,
currency: nil,
payment_method: nil,
routing_number: nil
); end
end
class Card < Stripe::RequestParams
class Networks < Stripe::RequestParams
# The customer's preferred card network for co-branded cards. Supports `cartes_bancaires`, `mastercard`, or `visa`. Selection of a network that does not apply to the card will be stored as `invalid_preference` on the card.
sig { returns(T.nilable(String)) }
def preferred; end
sig { params(_preferred: T.nilable(String)).returns(T.nilable(String)) }
def preferred=(_preferred); end
sig { params(preferred: T.nilable(String)).void }
def initialize(preferred: nil); end
end
# City / District / Suburb / Town / Village.
sig { returns(T.nilable(String)) }
def address_city; end
sig { params(_address_city: T.nilable(String)).returns(T.nilable(String)) }
def address_city=(_address_city); end
# Billing address country, if provided.
sig { returns(T.nilable(String)) }
def address_country; end
sig { params(_address_country: T.nilable(String)).returns(T.nilable(String)) }
def address_country=(_address_country); end
# Address line 1 (Street address / PO Box / Company name).
sig { returns(T.nilable(String)) }
def address_line1; end
sig { params(_address_line1: T.nilable(String)).returns(T.nilable(String)) }
def address_line1=(_address_line1); end
# Address line 2 (Apartment / Suite / Unit / Building).
sig { returns(T.nilable(String)) }
def address_line2; end
sig { params(_address_line2: T.nilable(String)).returns(T.nilable(String)) }
def address_line2=(_address_line2); end
# State / County / Province / Region.
sig { returns(T.nilable(String)) }
def address_state; end
sig { params(_address_state: T.nilable(String)).returns(T.nilable(String)) }
def address_state=(_address_state); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def address_zip; end
sig { params(_address_zip: T.nilable(String)).returns(T.nilable(String)) }
def address_zip=(_address_zip); end
# Required in order to add the card to an account; in all other cases, this parameter is not used. When added to an account, the card (which must be a debit card) can be used as a transfer destination for funds in this currency.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# Card security code. Highly recommended to always include this value.
sig { returns(T.nilable(String)) }
def cvc; end
sig { params(_cvc: T.nilable(String)).returns(T.nilable(String)) }
def cvc=(_cvc); end
# Two-digit number representing the card's expiration month.
sig { returns(String) }
def exp_month; end
sig { params(_exp_month: String).returns(String) }
def exp_month=(_exp_month); end
# Two- or four-digit number representing the card's expiration year.
sig { returns(String) }
def exp_year; end
sig { params(_exp_year: String).returns(String) }
def exp_year=(_exp_year); end
# Cardholder's full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Contains information about card networks used to process the payment.
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::Card::Networks)) }
def networks; end
sig {
params(_networks: T.nilable(::Stripe::TokenService::CreateParams::Card::Networks)).returns(T.nilable(::Stripe::TokenService::CreateParams::Card::Networks))
}
def networks=(_networks); end
# The card number, as a string without any separators.
sig { returns(String) }
def number; end
sig { params(_number: String).returns(String) }
def number=(_number); end
sig {
params(address_city: T.nilable(String), address_country: T.nilable(String), address_line1: T.nilable(String), address_line2: T.nilable(String), address_state: T.nilable(String), address_zip: T.nilable(String), currency: T.nilable(String), cvc: T.nilable(String), exp_month: String, exp_year: String, name: T.nilable(String), networks: T.nilable(::Stripe::TokenService::CreateParams::Card::Networks), number: String).void
}
def initialize(
address_city: nil,
address_country: nil,
address_line1: nil,
address_line2: nil,
address_state: nil,
address_zip: nil,
currency: nil,
cvc: nil,
exp_month: nil,
exp_year: nil,
name: nil,
networks: nil,
number: nil
); end
end
class CvcUpdate < Stripe::RequestParams
# The CVC value, in string form.
sig { returns(String) }
def cvc; end
sig { params(_cvc: String).returns(String) }
def cvc=(_cvc); end
sig { params(cvc: String).void }
def initialize(cvc: nil); end
end
class Person < Stripe::RequestParams
class AdditionalTosAcceptances < Stripe::RequestParams
class Account < Stripe::RequestParams
# The Unix timestamp marking when the account representative accepted the service agreement.
sig { returns(T.nilable(Integer)) }
def date; end
sig { params(_date: T.nilable(Integer)).returns(T.nilable(Integer)) }
def date=(_date); end
# The IP address from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the account representative accepted the service agreement.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Details on the legal guardian's acceptance of the main Stripe service agreement.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Person::AdditionalTosAcceptances::Account))
}
def account; end
sig {
params(_account: T.nilable(::Stripe::TokenService::CreateParams::Person::AdditionalTosAcceptances::Account)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::AdditionalTosAcceptances::Account))
}
def account=(_account); end
sig {
params(account: T.nilable(::Stripe::TokenService::CreateParams::Person::AdditionalTosAcceptances::Account)).void
}
def initialize(account: nil); end
end
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class AddressKana < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AddressKanji < Stripe::RequestParams
# City or ward.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Block or building number.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Building details.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# Postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Prefecture.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth, between 1 and 12.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The four-digit year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Documents < Stripe::RequestParams
class CompanyAuthorization < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class Passport < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
class Visa < Stripe::RequestParams
# One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
sig { returns(T.nilable(T::Array[String])) }
def files; end
sig { params(_files: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def files=(_files); end
sig { params(files: T.nilable(T::Array[String])).void }
def initialize(files: nil); end
end
# One or more documents that demonstrate proof that this person is authorized to represent the company.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Documents::CompanyAuthorization))
}
def company_authorization; end
sig {
params(_company_authorization: T.nilable(::Stripe::TokenService::CreateParams::Person::Documents::CompanyAuthorization)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Documents::CompanyAuthorization))
}
def company_authorization=(_company_authorization); end
# One or more documents showing the person's passport page with photo and personal data.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Documents::Passport))
}
def passport; end
sig {
params(_passport: T.nilable(::Stripe::TokenService::CreateParams::Person::Documents::Passport)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Documents::Passport))
}
def passport=(_passport); end
# One or more documents showing the person's visa required for living in the country where they are residing.
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Documents::Visa)) }
def visa; end
sig {
params(_visa: T.nilable(::Stripe::TokenService::CreateParams::Person::Documents::Visa)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Documents::Visa))
}
def visa=(_visa); end
sig {
params(company_authorization: T.nilable(::Stripe::TokenService::CreateParams::Person::Documents::CompanyAuthorization), passport: T.nilable(::Stripe::TokenService::CreateParams::Person::Documents::Passport), visa: T.nilable(::Stripe::TokenService::CreateParams::Person::Documents::Visa)).void
}
def initialize(company_authorization: nil, passport: nil, visa: nil); end
end
class RegisteredAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
class Relationship < Stripe::RequestParams
# Whether the person is the authorizer of the account's representative.
sig { returns(T.nilable(T::Boolean)) }
def authorizer; end
sig { params(_authorizer: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def authorizer=(_authorizer); end
# Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
sig { returns(T.nilable(T::Boolean)) }
def director; end
sig { params(_director: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def director=(_director); end
# Whether the person has significant responsibility to control, manage, or direct the organization.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
sig { params(_executive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executive=(_executive); end
# Whether the person is the legal guardian of the account's representative.
sig { returns(T.nilable(T::Boolean)) }
def legal_guardian; end
sig { params(_legal_guardian: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def legal_guardian=(_legal_guardian); end
# Whether the person is an owner of the account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
sig { params(_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owner=(_owner); end
# The percent owned by the person of the account's legal entity.
sig { returns(T.nilable(T.any(String, Float))) }
def percent_ownership; end
sig {
params(_percent_ownership: T.nilable(T.any(String, Float))).returns(T.nilable(T.any(String, Float)))
}
def percent_ownership=(_percent_ownership); end
# Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
sig { returns(T.nilable(T::Boolean)) }
def representative; end
sig { params(_representative: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def representative=(_representative); end
# The person's title (e.g., CEO, Support Engineer).
sig { returns(T.nilable(String)) }
def title; end
sig { params(_title: T.nilable(String)).returns(T.nilable(String)) }
def title=(_title); end
sig {
params(authorizer: T.nilable(T::Boolean), director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), legal_guardian: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), percent_ownership: T.nilable(T.any(String, Float)), representative: T.nilable(T::Boolean), title: T.nilable(String)).void
}
def initialize(
authorizer: nil,
director: nil,
executive: nil,
legal_guardian: nil,
owner: nil,
percent_ownership: nil,
representative: nil,
title: nil
); end
end
class UsCfpbData < Stripe::RequestParams
class EthnicityDetails < Stripe::RequestParams
# The persons ethnicity
sig { returns(T.nilable(T::Array[String])) }
def ethnicity; end
sig {
params(_ethnicity: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def ethnicity=(_ethnicity); end
# Please specify your origin, when other is selected.
sig { returns(T.nilable(String)) }
def ethnicity_other; end
sig { params(_ethnicity_other: T.nilable(String)).returns(T.nilable(String)) }
def ethnicity_other=(_ethnicity_other); end
sig {
params(ethnicity: T.nilable(T::Array[String]), ethnicity_other: T.nilable(String)).void
}
def initialize(ethnicity: nil, ethnicity_other: nil); end
end
class RaceDetails < Stripe::RequestParams
# The persons race.
sig { returns(T.nilable(T::Array[String])) }
def race; end
sig { params(_race: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def race=(_race); end
# Please specify your race, when other is selected.
sig { returns(T.nilable(String)) }
def race_other; end
sig { params(_race_other: T.nilable(String)).returns(T.nilable(String)) }
def race_other=(_race_other); end
sig { params(race: T.nilable(T::Array[String]), race_other: T.nilable(String)).void }
def initialize(race: nil, race_other: nil); end
end
# The persons ethnicity details
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Person::UsCfpbData::EthnicityDetails))
}
def ethnicity_details; end
sig {
params(_ethnicity_details: T.nilable(::Stripe::TokenService::CreateParams::Person::UsCfpbData::EthnicityDetails)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::UsCfpbData::EthnicityDetails))
}
def ethnicity_details=(_ethnicity_details); end
# The persons race details
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Person::UsCfpbData::RaceDetails))
}
def race_details; end
sig {
params(_race_details: T.nilable(::Stripe::TokenService::CreateParams::Person::UsCfpbData::RaceDetails)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::UsCfpbData::RaceDetails))
}
def race_details=(_race_details); end
# The persons self-identified gender
sig { returns(T.nilable(String)) }
def self_identified_gender; end
sig { params(_self_identified_gender: T.nilable(String)).returns(T.nilable(String)) }
def self_identified_gender=(_self_identified_gender); end
sig {
params(ethnicity_details: T.nilable(::Stripe::TokenService::CreateParams::Person::UsCfpbData::EthnicityDetails), race_details: T.nilable(::Stripe::TokenService::CreateParams::Person::UsCfpbData::RaceDetails), self_identified_gender: T.nilable(String)).void
}
def initialize(
ethnicity_details: nil,
race_details: nil,
self_identified_gender: nil
); end
end
class Verification < Stripe::RequestParams
class AdditionalDocument < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
class Document < Stripe::RequestParams
# The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Verification::AdditionalDocument))
}
def additional_document; end
sig {
params(_additional_document: T.nilable(::Stripe::TokenService::CreateParams::Person::Verification::AdditionalDocument)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Verification::AdditionalDocument))
}
def additional_document=(_additional_document); end
# An identifying document, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Verification::Document))
}
def document; end
sig {
params(_document: T.nilable(::Stripe::TokenService::CreateParams::Person::Verification::Document)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Verification::Document))
}
def document=(_document); end
sig {
params(additional_document: T.nilable(::Stripe::TokenService::CreateParams::Person::Verification::AdditionalDocument), document: T.nilable(::Stripe::TokenService::CreateParams::Person::Verification::Document)).void
}
def initialize(additional_document: nil, document: nil); end
end
# Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.
sig {
returns(T.nilable(::Stripe::TokenService::CreateParams::Person::AdditionalTosAcceptances))
}
def additional_tos_acceptances; end
sig {
params(_additional_tos_acceptances: T.nilable(::Stripe::TokenService::CreateParams::Person::AdditionalTosAcceptances)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::AdditionalTosAcceptances))
}
def additional_tos_acceptances=(_additional_tos_acceptances); end
# The person's address.
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Address)) }
def address; end
sig {
params(_address: T.nilable(::Stripe::TokenService::CreateParams::Person::Address)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Address))
}
def address=(_address); end
# The Kana variation of the person's address (Japan only).
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::Person::AddressKana)) }
def address_kana; end
sig {
params(_address_kana: T.nilable(::Stripe::TokenService::CreateParams::Person::AddressKana)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::AddressKana))
}
def address_kana=(_address_kana); end
# The Kanji variation of the person's address (Japan only).
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::Person::AddressKanji)) }
def address_kanji; end
sig {
params(_address_kanji: T.nilable(::Stripe::TokenService::CreateParams::Person::AddressKanji)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::AddressKanji))
}
def address_kanji=(_address_kanji); end
# The person's date of birth.
sig { returns(T.nilable(T.any(String, ::Stripe::TokenService::CreateParams::Person::Dob))) }
def dob; end
sig {
params(_dob: T.nilable(T.any(String, ::Stripe::TokenService::CreateParams::Person::Dob))).returns(T.nilable(T.any(String, ::Stripe::TokenService::CreateParams::Person::Dob)))
}
def dob=(_dob); end
# Documents that may be submitted to satisfy various informational requests.
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Documents)) }
def documents; end
sig {
params(_documents: T.nilable(::Stripe::TokenService::CreateParams::Person::Documents)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Documents))
}
def documents=(_documents); end
# The person's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The person's first name.
sig { returns(T.nilable(String)) }
def first_name; end
sig { params(_first_name: T.nilable(String)).returns(T.nilable(String)) }
def first_name=(_first_name); end
# The Kana variation of the person's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kana; end
sig { params(_first_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kana=(_first_name_kana); end
# The Kanji variation of the person's first name (Japan only).
sig { returns(T.nilable(String)) }
def first_name_kanji; end
sig { params(_first_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def first_name_kanji=(_first_name_kanji); end
# A list of alternate names or aliases that the person is known by.
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
def full_name_aliases; end
sig {
params(_full_name_aliases: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String])))
}
def full_name_aliases=(_full_name_aliases); end
# The person's gender (International regulations require either "male" or "female").
sig { returns(T.nilable(String)) }
def gender; end
sig { params(_gender: T.nilable(String)).returns(T.nilable(String)) }
def gender=(_gender); end
# The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number; end
sig { params(_id_number: T.nilable(String)).returns(T.nilable(String)) }
def id_number=(_id_number); end
# The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
sig { returns(T.nilable(String)) }
def id_number_secondary; end
sig { params(_id_number_secondary: T.nilable(String)).returns(T.nilable(String)) }
def id_number_secondary=(_id_number_secondary); end
# The person's last name.
sig { returns(T.nilable(String)) }
def last_name; end
sig { params(_last_name: T.nilable(String)).returns(T.nilable(String)) }
def last_name=(_last_name); end
# The Kana variation of the person's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kana; end
sig { params(_last_name_kana: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kana=(_last_name_kana); end
# The Kanji variation of the person's last name (Japan only).
sig { returns(T.nilable(String)) }
def last_name_kanji; end
sig { params(_last_name_kanji: T.nilable(String)).returns(T.nilable(String)) }
def last_name_kanji=(_last_name_kanji); end
# The person's maiden name.
sig { returns(T.nilable(String)) }
def maiden_name; end
sig { params(_maiden_name: T.nilable(String)).returns(T.nilable(String)) }
def maiden_name=(_maiden_name); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable.
sig { returns(T.nilable(String)) }
def nationality; end
sig { params(_nationality: T.nilable(String)).returns(T.nilable(String)) }
def nationality=(_nationality); end
# The person's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
sig { returns(T.nilable(String)) }
def political_exposure; end
sig { params(_political_exposure: T.nilable(String)).returns(T.nilable(String)) }
def political_exposure=(_political_exposure); end
# The person's registered address.
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::Person::RegisteredAddress)) }
def registered_address; end
sig {
params(_registered_address: T.nilable(::Stripe::TokenService::CreateParams::Person::RegisteredAddress)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::RegisteredAddress))
}
def registered_address=(_registered_address); end
# The relationship that this person has with the account's legal entity.
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Relationship)) }
def relationship; end
sig {
params(_relationship: T.nilable(::Stripe::TokenService::CreateParams::Person::Relationship)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Relationship))
}
def relationship=(_relationship); end
# The last four digits of the person's Social Security number (U.S. only).
sig { returns(T.nilable(String)) }
def ssn_last_4; end
sig { params(_ssn_last_4: T.nilable(String)).returns(T.nilable(String)) }
def ssn_last_4=(_ssn_last_4); end
# Demographic data related to the person.
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::Person::UsCfpbData)) }
def us_cfpb_data; end
sig {
params(_us_cfpb_data: T.nilable(::Stripe::TokenService::CreateParams::Person::UsCfpbData)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::UsCfpbData))
}
def us_cfpb_data=(_us_cfpb_data); end
# The person's verification status.
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Verification)) }
def verification; end
sig {
params(_verification: T.nilable(::Stripe::TokenService::CreateParams::Person::Verification)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person::Verification))
}
def verification=(_verification); end
sig {
params(additional_tos_acceptances: T.nilable(::Stripe::TokenService::CreateParams::Person::AdditionalTosAcceptances), address: T.nilable(::Stripe::TokenService::CreateParams::Person::Address), address_kana: T.nilable(::Stripe::TokenService::CreateParams::Person::AddressKana), address_kanji: T.nilable(::Stripe::TokenService::CreateParams::Person::AddressKanji), dob: T.nilable(T.any(String, ::Stripe::TokenService::CreateParams::Person::Dob)), documents: T.nilable(::Stripe::TokenService::CreateParams::Person::Documents), email: T.nilable(String), first_name: T.nilable(String), first_name_kana: T.nilable(String), first_name_kanji: T.nilable(String), full_name_aliases: T.nilable(T.any(String, T::Array[String])), gender: T.nilable(String), id_number: T.nilable(String), id_number_secondary: T.nilable(String), last_name: T.nilable(String), last_name_kana: T.nilable(String), last_name_kanji: T.nilable(String), maiden_name: T.nilable(String), metadata: T.nilable(T.any(String, T::Hash[String, String])), nationality: T.nilable(String), phone: T.nilable(String), political_exposure: T.nilable(String), registered_address: T.nilable(::Stripe::TokenService::CreateParams::Person::RegisteredAddress), relationship: T.nilable(::Stripe::TokenService::CreateParams::Person::Relationship), ssn_last_4: T.nilable(String), us_cfpb_data: T.nilable(::Stripe::TokenService::CreateParams::Person::UsCfpbData), verification: T.nilable(::Stripe::TokenService::CreateParams::Person::Verification)).void
}
def initialize(
additional_tos_acceptances: nil,
address: nil,
address_kana: nil,
address_kanji: nil,
dob: nil,
documents: nil,
email: nil,
first_name: nil,
first_name_kana: nil,
first_name_kanji: nil,
full_name_aliases: nil,
gender: nil,
id_number: nil,
id_number_secondary: nil,
last_name: nil,
last_name_kana: nil,
last_name_kanji: nil,
maiden_name: nil,
metadata: nil,
nationality: nil,
phone: nil,
political_exposure: nil,
registered_address: nil,
relationship: nil,
ssn_last_4: nil,
us_cfpb_data: nil,
verification: nil
); end
end
class Pii < Stripe::RequestParams
# The `id_number` for the PII, in string form.
sig { returns(T.nilable(String)) }
def id_number; end
sig { params(_id_number: T.nilable(String)).returns(T.nilable(String)) }
def id_number=(_id_number); end
sig { params(id_number: T.nilable(String)).void }
def initialize(id_number: nil); end
end
# Information for the account this token represents.
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::Account)) }
def account; end
sig {
params(_account: T.nilable(::Stripe::TokenService::CreateParams::Account)).returns(T.nilable(::Stripe::TokenService::CreateParams::Account))
}
def account=(_account); end
# The bank account this token will represent.
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::BankAccount)) }
def bank_account; end
sig {
params(_bank_account: T.nilable(::Stripe::TokenService::CreateParams::BankAccount)).returns(T.nilable(::Stripe::TokenService::CreateParams::BankAccount))
}
def bank_account=(_bank_account); end
# The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user's credit card details, with the options described below.
sig { returns(T.nilable(T.any(::Stripe::TokenService::CreateParams::Card, String))) }
def card; end
sig {
params(_card: T.nilable(T.any(::Stripe::TokenService::CreateParams::Card, String))).returns(T.nilable(T.any(::Stripe::TokenService::CreateParams::Card, String)))
}
def card=(_card); end
# Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). Learn more about [cloning saved payment methods](https://stripe.com/docs/connect/cloning-saved-payment-methods).
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# The updated CVC value this token represents.
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::CvcUpdate)) }
def cvc_update; end
sig {
params(_cvc_update: T.nilable(::Stripe::TokenService::CreateParams::CvcUpdate)).returns(T.nilable(::Stripe::TokenService::CreateParams::CvcUpdate))
}
def cvc_update=(_cvc_update); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Information for the person this token represents.
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::Person)) }
def person; end
sig {
params(_person: T.nilable(::Stripe::TokenService::CreateParams::Person)).returns(T.nilable(::Stripe::TokenService::CreateParams::Person))
}
def person=(_person); end
# The PII this token represents.
sig { returns(T.nilable(::Stripe::TokenService::CreateParams::Pii)) }
def pii; end
sig {
params(_pii: T.nilable(::Stripe::TokenService::CreateParams::Pii)).returns(T.nilable(::Stripe::TokenService::CreateParams::Pii))
}
def pii=(_pii); end
sig {
params(account: T.nilable(::Stripe::TokenService::CreateParams::Account), bank_account: T.nilable(::Stripe::TokenService::CreateParams::BankAccount), card: T.nilable(T.any(::Stripe::TokenService::CreateParams::Card, String)), customer: T.nilable(String), cvc_update: T.nilable(::Stripe::TokenService::CreateParams::CvcUpdate), expand: T.nilable(T::Array[String]), person: T.nilable(::Stripe::TokenService::CreateParams::Person), pii: T.nilable(::Stripe::TokenService::CreateParams::Pii)).void
}
def initialize(
account: nil,
bank_account: nil,
card: nil,
customer: nil,
cvc_update: nil,
expand: nil,
person: nil,
pii: nil
); end
end
# Creates a single-use token that represents a bank account's details.
# You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://docs.stripe.com/api#accounts) where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts.
sig {
params(params: T.any(::Stripe::TokenService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Token)
}
def create(params = {}, opts = {}); end
# Retrieves the token with the given ID.
sig {
params(token: String, params: T.any(::Stripe::TokenService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Token)
}
def retrieve(token, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class TopupService < StripeService
class ListParams < Stripe::RequestParams
class Amount < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# A positive integer representing how much to transfer.
sig { returns(T.nilable(T.any(::Stripe::TopupService::ListParams::Amount, Integer))) }
def amount; end
sig {
params(_amount: T.nilable(T.any(::Stripe::TopupService::ListParams::Amount, Integer))).returns(T.nilable(T.any(::Stripe::TopupService::ListParams::Amount, Integer)))
}
def amount=(_amount); end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
sig { returns(T.nilable(T.any(::Stripe::TopupService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::TopupService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::TopupService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(amount: T.nilable(T.any(::Stripe::TopupService::ListParams::Amount, Integer)), created: T.nilable(T.any(::Stripe::TopupService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
amount: nil,
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
# A positive integer representing how much to transfer.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)).
sig { returns(T.nilable(String)) }
def source; end
sig { params(_source: T.nilable(String)).returns(T.nilable(String)) }
def source=(_source); end
# Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# A string that identifies this top-up as part of a group.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(amount: Integer, currency: String, description: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), source: T.nilable(String), statement_descriptor: T.nilable(String), transfer_group: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
expand: nil,
metadata: nil,
source: nil,
statement_descriptor: nil,
transfer_group: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(description: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(description: nil, expand: nil, metadata: nil); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Cancels a top-up. Only pending top-ups can be canceled.
sig {
params(topup: String, params: T.any(::Stripe::TopupService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Topup)
}
def cancel(topup, params = {}, opts = {}); end
# Top up the balance of an account
sig {
params(params: T.any(::Stripe::TopupService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Topup)
}
def create(params = {}, opts = {}); end
# Returns a list of top-ups.
sig {
params(params: T.any(::Stripe::TopupService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.
sig {
params(topup: String, params: T.any(::Stripe::TopupService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Topup)
}
def retrieve(topup, params = {}, opts = {}); end
# Updates the metadata of a top-up. Other top-up details are not editable by design.
sig {
params(topup: String, params: T.any(::Stripe::TopupService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Topup)
}
def update(topup, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class TransferService < StripeService
attr_reader :reversals
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return transfers that were created during the given date interval.
sig { returns(T.nilable(T.any(::Stripe::TransferService::ListParams::Created, Integer))) }
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::TransferService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::TransferService::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return transfers for the destination specified by this account ID.
sig { returns(T.nilable(String)) }
def destination; end
sig { params(_destination: T.nilable(String)).returns(T.nilable(String)) }
def destination=(_destination); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return transfers with the specified transfer group.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(created: T.nilable(T.any(::Stripe::TransferService::ListParams::Created, Integer)), destination: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), transfer_group: T.nilable(String)).void
}
def initialize(
created: nil,
destination: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
transfer_group: nil
); end
end
class CreateParams < Stripe::RequestParams
# A positive integer in cents (or local equivalent) representing how much to transfer.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies).
sig { returns(String) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The ID of a connected Stripe account. See the Connect documentation for details.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FX rate in the quote is validated and used to convert the transfer amount to the destination currency.
sig { returns(T.nilable(String)) }
def fx_quote; end
sig { params(_fx_quote: T.nilable(String)).returns(T.nilable(String)) }
def fx_quote=(_fx_quote); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details.
sig { returns(T.nilable(String)) }
def source_transaction; end
sig { params(_source_transaction: T.nilable(String)).returns(T.nilable(String)) }
def source_transaction=(_source_transaction); end
# The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`.
sig { returns(T.nilable(String)) }
def source_type; end
sig { params(_source_type: T.nilable(String)).returns(T.nilable(String)) }
def source_type=(_source_type); end
# A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
sig { returns(T.nilable(String)) }
def transfer_group; end
sig { params(_transfer_group: T.nilable(String)).returns(T.nilable(String)) }
def transfer_group=(_transfer_group); end
sig {
params(amount: T.nilable(Integer), currency: String, description: T.nilable(String), destination: String, expand: T.nilable(T::Array[String]), fx_quote: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), source_transaction: T.nilable(String), source_type: T.nilable(String), transfer_group: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
destination: nil,
expand: nil,
fx_quote: nil,
metadata: nil,
source_transaction: nil,
source_type: nil,
transfer_group: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(description: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(description: nil, expand: nil, metadata: nil); end
end
# To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://docs.stripe.com/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.
sig {
params(params: T.any(::Stripe::TransferService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Transfer)
}
def create(params = {}, opts = {}); end
# Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.
sig {
params(params: T.any(::Stripe::TransferService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.
sig {
params(transfer: String, params: T.any(::Stripe::TransferService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Transfer)
}
def retrieve(transfer, params = {}, opts = {}); end
# Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
#
# This request accepts only metadata as an argument.
sig {
params(transfer: String, params: T.any(::Stripe::TransferService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Transfer)
}
def update(transfer, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class TransferReversalService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateParams < Stripe::RequestParams
# A positive integer in cents (or local equivalent) representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount.
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# An arbitrary string which you can attach to a reversal object. This will be unset if you POST an empty value.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed.
sig { returns(T.nilable(T::Boolean)) }
def refund_application_fee; end
sig { params(_refund_application_fee: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def refund_application_fee=(_refund_application_fee); end
sig {
params(amount: T.nilable(Integer), description: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), refund_application_fee: T.nilable(T::Boolean)).void
}
def initialize(
amount: nil,
description: nil,
expand: nil,
metadata: nil,
refund_application_fee: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String]))).void
}
def initialize(expand: nil, metadata: nil); end
end
# When you create a new reversal, you must specify a transfer to create it on.
#
# When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.
#
# Once entirely reversed, a transfer can't be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.
sig {
params(id: String, params: T.any(::Stripe::TransferReversalService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Reversal)
}
def create(id, params = {}, opts = {}); end
# You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.
sig {
params(id: String, params: T.any(::Stripe::TransferReversalService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(id, params = {}, opts = {}); end
# By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.
sig {
params(transfer: String, id: String, params: T.any(::Stripe::TransferReversalService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Reversal)
}
def retrieve(transfer, id, params = {}, opts = {}); end
# Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
#
# This request only accepts metadata and description as arguments.
sig {
params(transfer: String, id: String, params: T.any(::Stripe::TransferReversalService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Reversal)
}
def update(transfer, id, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class TreasuryService < StripeService
attr_reader :credit_reversals
attr_reader :debit_reversals
attr_reader :financial_accounts
attr_reader :inbound_transfers
attr_reader :outbound_payments
attr_reader :outbound_transfers
attr_reader :received_credits
attr_reader :received_debits
attr_reader :transactions
attr_reader :transaction_entries
end
end
# typed: true
module Stripe
module Treasury
class CreditReversalService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Returns objects associated with this FinancialAccount.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return CreditReversals for the ReceivedCredit ID.
sig { returns(T.nilable(String)) }
def received_credit; end
sig { params(_received_credit: T.nilable(String)).returns(T.nilable(String)) }
def received_credit=(_received_credit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return CreditReversals for a given status.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), received_credit: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
received_credit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ReceivedCredit to reverse.
sig { returns(String) }
def received_credit; end
sig { params(_received_credit: String).returns(String) }
def received_credit=(_received_credit); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), received_credit: String).void
}
def initialize(expand: nil, metadata: nil, received_credit: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Reverses a ReceivedCredit and creates a CreditReversal object.
sig {
params(params: T.any(::Stripe::Treasury::CreditReversalService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::CreditReversal)
}
def create(params = {}, opts = {}); end
# Returns a list of CreditReversals.
sig {
params(params: T.any(::Stripe::Treasury::CreditReversalService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list
sig {
params(credit_reversal: String, params: T.any(::Stripe::Treasury::CreditReversalService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::CreditReversal)
}
def retrieve(credit_reversal, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
class DebitReversalService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Returns objects associated with this FinancialAccount.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return DebitReversals for the ReceivedDebit ID.
sig { returns(T.nilable(String)) }
def received_debit; end
sig { params(_received_debit: T.nilable(String)).returns(T.nilable(String)) }
def received_debit=(_received_debit); end
# Only return DebitReversals for a given resolution.
sig { returns(T.nilable(String)) }
def resolution; end
sig { params(_resolution: T.nilable(String)).returns(T.nilable(String)) }
def resolution=(_resolution); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return DebitReversals for a given status.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), received_debit: T.nilable(String), resolution: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
received_debit: nil,
resolution: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The ReceivedDebit to reverse.
sig { returns(String) }
def received_debit; end
sig { params(_received_debit: String).returns(String) }
def received_debit=(_received_debit); end
sig {
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), received_debit: String).void
}
def initialize(expand: nil, metadata: nil, received_debit: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Reverses a ReceivedDebit and creates a DebitReversal object.
sig {
params(params: T.any(::Stripe::Treasury::DebitReversalService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::DebitReversal)
}
def create(params = {}, opts = {}); end
# Returns a list of DebitReversals.
sig {
params(params: T.any(::Stripe::Treasury::DebitReversalService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a DebitReversal object.
sig {
params(debit_reversal: String, params: T.any(::Stripe::Treasury::DebitReversalService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::DebitReversal)
}
def retrieve(debit_reversal, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
class FinancialAccountService < StripeService
attr_reader :features
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return FinancialAccounts that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Treasury::FinancialAccountService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Treasury::FinancialAccountService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Treasury::FinancialAccountService::ListParams::Created, Integer)))
}
def created=(_created); end
# An object ID cursor for use in pagination.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit ranging from 1 to 100 (defaults to 10).
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# An object ID cursor for use in pagination.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return FinancialAccounts that have the given status: `open` or `closed`
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(created: T.nilable(T.any(::Stripe::Treasury::FinancialAccountService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class Features < Stripe::RequestParams
class CardIssuing < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class DepositInsurance < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class FinancialAddresses < Stripe::RequestParams
class Aba < Stripe::RequestParams
# Requested bank partner
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(bank: T.nilable(String), requested: T::Boolean).void }
def initialize(bank: nil, requested: nil); end
end
# Adds an ABA FinancialAddress to the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::FinancialAddresses::Aba))
}
def aba; end
sig {
params(_aba: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::FinancialAddresses::Aba)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::FinancialAddresses::Aba))
}
def aba=(_aba); end
sig {
params(aba: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::FinancialAddresses::Aba)).void
}
def initialize(aba: nil); end
end
class InboundTransfers < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH Debits via the InboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::InboundTransfers::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::InboundTransfers::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::InboundTransfers::Ach))
}
def ach=(_ach); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::InboundTransfers::Ach)).void
}
def initialize(ach: nil); end
end
class IntraStripeFlows < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class OutboundPayments < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class UsDomesticWire < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH transfers via the OutboundPayments API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundPayments::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundPayments::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundPayments::Ach))
}
def ach=(_ach); end
# Enables US domestic wire transfers via the OutboundPayments API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundPayments::UsDomesticWire))
}
def us_domestic_wire; end
sig {
params(_us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundPayments::UsDomesticWire)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundPayments::UsDomesticWire))
}
def us_domestic_wire=(_us_domestic_wire); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundPayments::Ach), us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundPayments::UsDomesticWire)).void
}
def initialize(ach: nil, us_domestic_wire: nil); end
end
class OutboundTransfers < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class UsDomesticWire < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH transfers via the OutboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundTransfers::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundTransfers::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundTransfers::Ach))
}
def ach=(_ach); end
# Enables US domestic wire transfers via the OutboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundTransfers::UsDomesticWire))
}
def us_domestic_wire; end
sig {
params(_us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundTransfers::UsDomesticWire)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundTransfers::UsDomesticWire))
}
def us_domestic_wire=(_us_domestic_wire); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundTransfers::Ach), us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundTransfers::UsDomesticWire)).void
}
def initialize(ach: nil, us_domestic_wire: nil); end
end
# Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::CardIssuing))
}
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::CardIssuing)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::CardIssuing))
}
def card_issuing=(_card_issuing); end
# Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::DepositInsurance))
}
def deposit_insurance; end
sig {
params(_deposit_insurance: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::DepositInsurance)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::DepositInsurance))
}
def deposit_insurance=(_deposit_insurance); end
# Contains Features that add FinancialAddresses to the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::FinancialAddresses))
}
def financial_addresses; end
sig {
params(_financial_addresses: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::FinancialAddresses)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::FinancialAddresses))
}
def financial_addresses=(_financial_addresses); end
# Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::InboundTransfers))
}
def inbound_transfers; end
sig {
params(_inbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::InboundTransfers)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::InboundTransfers))
}
def inbound_transfers=(_inbound_transfers); end
# Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::IntraStripeFlows))
}
def intra_stripe_flows; end
sig {
params(_intra_stripe_flows: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::IntraStripeFlows)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::IntraStripeFlows))
}
def intra_stripe_flows=(_intra_stripe_flows); end
# Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundPayments))
}
def outbound_payments; end
sig {
params(_outbound_payments: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundPayments)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundPayments))
}
def outbound_payments=(_outbound_payments); end
# Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundTransfers))
}
def outbound_transfers; end
sig {
params(_outbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundTransfers)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundTransfers))
}
def outbound_transfers=(_outbound_transfers); end
sig {
params(card_issuing: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::CardIssuing), deposit_insurance: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::DepositInsurance), financial_addresses: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::FinancialAddresses), inbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::InboundTransfers), intra_stripe_flows: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::IntraStripeFlows), outbound_payments: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundPayments), outbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features::OutboundTransfers)).void
}
def initialize(
card_issuing: nil,
deposit_insurance: nil,
financial_addresses: nil,
inbound_transfers: nil,
intra_stripe_flows: nil,
outbound_payments: nil,
outbound_transfers: nil
); end
end
class PlatformRestrictions < Stripe::RequestParams
# Restricts all inbound money movement.
sig { returns(T.nilable(String)) }
def inbound_flows; end
sig { params(_inbound_flows: T.nilable(String)).returns(T.nilable(String)) }
def inbound_flows=(_inbound_flows); end
# Restricts all outbound money movement.
sig { returns(T.nilable(String)) }
def outbound_flows; end
sig { params(_outbound_flows: T.nilable(String)).returns(T.nilable(String)) }
def outbound_flows=(_outbound_flows); end
sig { params(inbound_flows: T.nilable(String), outbound_flows: T.nilable(String)).void }
def initialize(inbound_flows: nil, outbound_flows: nil); end
end
# The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features))
}
def features=(_features); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The nickname for the FinancialAccount.
sig { returns(T.nilable(String)) }
def nickname; end
sig { params(_nickname: T.nilable(String)).returns(T.nilable(String)) }
def nickname=(_nickname); end
# The set of functionalities that the platform can restrict on the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::PlatformRestrictions))
}
def platform_restrictions; end
sig {
params(_platform_restrictions: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::PlatformRestrictions)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::PlatformRestrictions))
}
def platform_restrictions=(_platform_restrictions); end
# The currencies the FinancialAccount can hold a balance in.
sig { returns(T::Array[String]) }
def supported_currencies; end
sig { params(_supported_currencies: T::Array[String]).returns(T::Array[String]) }
def supported_currencies=(_supported_currencies); end
sig {
params(display_name: T.nilable(String), expand: T.nilable(T::Array[String]), features: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::Features), metadata: T.nilable(T::Hash[String, String]), nickname: T.nilable(String), platform_restrictions: T.nilable(::Stripe::Treasury::FinancialAccountService::CreateParams::PlatformRestrictions), supported_currencies: T::Array[String]).void
}
def initialize(
display_name: nil,
expand: nil,
features: nil,
metadata: nil,
nickname: nil,
platform_restrictions: nil,
supported_currencies: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
class Features < Stripe::RequestParams
class CardIssuing < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class DepositInsurance < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class FinancialAddresses < Stripe::RequestParams
class Aba < Stripe::RequestParams
# Requested bank partner
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(bank: T.nilable(String), requested: T::Boolean).void }
def initialize(bank: nil, requested: nil); end
end
# Adds an ABA FinancialAddress to the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::FinancialAddresses::Aba))
}
def aba; end
sig {
params(_aba: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::FinancialAddresses::Aba)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::FinancialAddresses::Aba))
}
def aba=(_aba); end
sig {
params(aba: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::FinancialAddresses::Aba)).void
}
def initialize(aba: nil); end
end
class InboundTransfers < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH Debits via the InboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::InboundTransfers::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::InboundTransfers::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::InboundTransfers::Ach))
}
def ach=(_ach); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::InboundTransfers::Ach)).void
}
def initialize(ach: nil); end
end
class IntraStripeFlows < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class OutboundPayments < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class UsDomesticWire < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH transfers via the OutboundPayments API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundPayments::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundPayments::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundPayments::Ach))
}
def ach=(_ach); end
# Enables US domestic wire transfers via the OutboundPayments API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundPayments::UsDomesticWire))
}
def us_domestic_wire; end
sig {
params(_us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundPayments::UsDomesticWire)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundPayments::UsDomesticWire))
}
def us_domestic_wire=(_us_domestic_wire); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundPayments::Ach), us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundPayments::UsDomesticWire)).void
}
def initialize(ach: nil, us_domestic_wire: nil); end
end
class OutboundTransfers < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class UsDomesticWire < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH transfers via the OutboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundTransfers::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundTransfers::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundTransfers::Ach))
}
def ach=(_ach); end
# Enables US domestic wire transfers via the OutboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundTransfers::UsDomesticWire))
}
def us_domestic_wire; end
sig {
params(_us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundTransfers::UsDomesticWire)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundTransfers::UsDomesticWire))
}
def us_domestic_wire=(_us_domestic_wire); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundTransfers::Ach), us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundTransfers::UsDomesticWire)).void
}
def initialize(ach: nil, us_domestic_wire: nil); end
end
# Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::CardIssuing))
}
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::CardIssuing)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::CardIssuing))
}
def card_issuing=(_card_issuing); end
# Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::DepositInsurance))
}
def deposit_insurance; end
sig {
params(_deposit_insurance: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::DepositInsurance)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::DepositInsurance))
}
def deposit_insurance=(_deposit_insurance); end
# Contains Features that add FinancialAddresses to the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::FinancialAddresses))
}
def financial_addresses; end
sig {
params(_financial_addresses: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::FinancialAddresses)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::FinancialAddresses))
}
def financial_addresses=(_financial_addresses); end
# Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::InboundTransfers))
}
def inbound_transfers; end
sig {
params(_inbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::InboundTransfers)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::InboundTransfers))
}
def inbound_transfers=(_inbound_transfers); end
# Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::IntraStripeFlows))
}
def intra_stripe_flows; end
sig {
params(_intra_stripe_flows: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::IntraStripeFlows)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::IntraStripeFlows))
}
def intra_stripe_flows=(_intra_stripe_flows); end
# Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundPayments))
}
def outbound_payments; end
sig {
params(_outbound_payments: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundPayments)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundPayments))
}
def outbound_payments=(_outbound_payments); end
# Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundTransfers))
}
def outbound_transfers; end
sig {
params(_outbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundTransfers)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundTransfers))
}
def outbound_transfers=(_outbound_transfers); end
sig {
params(card_issuing: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::CardIssuing), deposit_insurance: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::DepositInsurance), financial_addresses: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::FinancialAddresses), inbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::InboundTransfers), intra_stripe_flows: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::IntraStripeFlows), outbound_payments: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundPayments), outbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features::OutboundTransfers)).void
}
def initialize(
card_issuing: nil,
deposit_insurance: nil,
financial_addresses: nil,
inbound_transfers: nil,
intra_stripe_flows: nil,
outbound_payments: nil,
outbound_transfers: nil
); end
end
class ForwardingSettings < Stripe::RequestParams
# The financial_account id
sig { returns(T.nilable(String)) }
def financial_account; end
sig { params(_financial_account: T.nilable(String)).returns(T.nilable(String)) }
def financial_account=(_financial_account); end
# The payment_method or bank account id. This needs to be a verified bank account.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The type of the bank account provided. This can be either "financial_account" or "payment_method"
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(financial_account: T.nilable(String), payment_method: T.nilable(String), type: String).void
}
def initialize(financial_account: nil, payment_method: nil, type: nil); end
end
class PlatformRestrictions < Stripe::RequestParams
# Restricts all inbound money movement.
sig { returns(T.nilable(String)) }
def inbound_flows; end
sig { params(_inbound_flows: T.nilable(String)).returns(T.nilable(String)) }
def inbound_flows=(_inbound_flows); end
# Restricts all outbound money movement.
sig { returns(T.nilable(String)) }
def outbound_flows; end
sig { params(_outbound_flows: T.nilable(String)).returns(T.nilable(String)) }
def outbound_flows=(_outbound_flows); end
sig { params(inbound_flows: T.nilable(String), outbound_flows: T.nilable(String)).void }
def initialize(inbound_flows: nil, outbound_flows: nil); end
end
# The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated `status_details`. Stripe or the platform may control features via the requested field.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features))
}
def features; end
sig {
params(_features: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features))
}
def features=(_features); end
# A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::ForwardingSettings))
}
def forwarding_settings; end
sig {
params(_forwarding_settings: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::ForwardingSettings)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::ForwardingSettings))
}
def forwarding_settings=(_forwarding_settings); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The nickname for the FinancialAccount.
sig { returns(T.nilable(String)) }
def nickname; end
sig { params(_nickname: T.nilable(String)).returns(T.nilable(String)) }
def nickname=(_nickname); end
# The set of functionalities that the platform can restrict on the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::PlatformRestrictions))
}
def platform_restrictions; end
sig {
params(_platform_restrictions: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::PlatformRestrictions)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::PlatformRestrictions))
}
def platform_restrictions=(_platform_restrictions); end
sig {
params(display_name: T.nilable(String), expand: T.nilable(T::Array[String]), features: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::Features), forwarding_settings: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::ForwardingSettings), metadata: T.nilable(T::Hash[String, String]), nickname: T.nilable(String), platform_restrictions: T.nilable(::Stripe::Treasury::FinancialAccountService::UpdateParams::PlatformRestrictions)).void
}
def initialize(
display_name: nil,
expand: nil,
features: nil,
forwarding_settings: nil,
metadata: nil,
nickname: nil,
platform_restrictions: nil
); end
end
class CloseParams < Stripe::RequestParams
class ForwardingSettings < Stripe::RequestParams
# The financial_account id
sig { returns(T.nilable(String)) }
def financial_account; end
sig { params(_financial_account: T.nilable(String)).returns(T.nilable(String)) }
def financial_account=(_financial_account); end
# The payment_method or bank account id. This needs to be a verified bank account.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The type of the bank account provided. This can be either "financial_account" or "payment_method"
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(financial_account: T.nilable(String), payment_method: T.nilable(String), type: String).void
}
def initialize(financial_account: nil, payment_method: nil, type: nil); end
end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CloseParams::ForwardingSettings))
}
def forwarding_settings; end
sig {
params(_forwarding_settings: T.nilable(::Stripe::Treasury::FinancialAccountService::CloseParams::ForwardingSettings)).returns(T.nilable(::Stripe::Treasury::FinancialAccountService::CloseParams::ForwardingSettings))
}
def forwarding_settings=(_forwarding_settings); end
sig {
params(expand: T.nilable(T::Array[String]), forwarding_settings: T.nilable(::Stripe::Treasury::FinancialAccountService::CloseParams::ForwardingSettings)).void
}
def initialize(expand: nil, forwarding_settings: nil); end
end
# Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.
sig {
params(financial_account: String, params: T.any(::Stripe::Treasury::FinancialAccountService::CloseParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::FinancialAccount)
}
def close(financial_account, params = {}, opts = {}); end
# Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.
sig {
params(params: T.any(::Stripe::Treasury::FinancialAccountService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::FinancialAccount)
}
def create(params = {}, opts = {}); end
# Returns a list of FinancialAccounts.
sig {
params(params: T.any(::Stripe::Treasury::FinancialAccountService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of a FinancialAccount.
sig {
params(financial_account: String, params: T.any(::Stripe::Treasury::FinancialAccountService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::FinancialAccount)
}
def retrieve(financial_account, params = {}, opts = {}); end
# Updates the details of a FinancialAccount.
sig {
params(financial_account: String, params: T.any(::Stripe::Treasury::FinancialAccountService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::FinancialAccount)
}
def update(financial_account, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
class FinancialAccountFeaturesService < StripeService
class UpdateParams < Stripe::RequestParams
class CardIssuing < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class DepositInsurance < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class FinancialAddresses < Stripe::RequestParams
class Aba < Stripe::RequestParams
# Requested bank partner
sig { returns(T.nilable(String)) }
def bank; end
sig { params(_bank: T.nilable(String)).returns(T.nilable(String)) }
def bank=(_bank); end
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(bank: T.nilable(String), requested: T::Boolean).void }
def initialize(bank: nil, requested: nil); end
end
# Adds an ABA FinancialAddress to the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::FinancialAddresses::Aba))
}
def aba; end
sig {
params(_aba: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::FinancialAddresses::Aba)).returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::FinancialAddresses::Aba))
}
def aba=(_aba); end
sig {
params(aba: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::FinancialAddresses::Aba)).void
}
def initialize(aba: nil); end
end
class InboundTransfers < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH Debits via the InboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::InboundTransfers::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::InboundTransfers::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::InboundTransfers::Ach))
}
def ach=(_ach); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::InboundTransfers::Ach)).void
}
def initialize(ach: nil); end
end
class IntraStripeFlows < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class OutboundPayments < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class UsDomesticWire < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH transfers via the OutboundPayments API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundPayments::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundPayments::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundPayments::Ach))
}
def ach=(_ach); end
# Enables US domestic wire transfers via the OutboundPayments API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundPayments::UsDomesticWire))
}
def us_domestic_wire; end
sig {
params(_us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundPayments::UsDomesticWire)).returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundPayments::UsDomesticWire))
}
def us_domestic_wire=(_us_domestic_wire); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundPayments::Ach), us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundPayments::UsDomesticWire)).void
}
def initialize(ach: nil, us_domestic_wire: nil); end
end
class OutboundTransfers < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class UsDomesticWire < Stripe::RequestParams
# Whether the FinancialAccount should have the Feature.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables ACH transfers via the OutboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundTransfers::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundTransfers::Ach)).returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundTransfers::Ach))
}
def ach=(_ach); end
# Enables US domestic wire transfers via the OutboundTransfers API.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundTransfers::UsDomesticWire))
}
def us_domestic_wire; end
sig {
params(_us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundTransfers::UsDomesticWire)).returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundTransfers::UsDomesticWire))
}
def us_domestic_wire=(_us_domestic_wire); end
sig {
params(ach: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundTransfers::Ach), us_domestic_wire: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundTransfers::UsDomesticWire)).void
}
def initialize(ach: nil, us_domestic_wire: nil); end
end
# Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::CardIssuing))
}
def card_issuing; end
sig {
params(_card_issuing: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::CardIssuing)).returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::CardIssuing))
}
def card_issuing=(_card_issuing); end
# Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::DepositInsurance))
}
def deposit_insurance; end
sig {
params(_deposit_insurance: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::DepositInsurance)).returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::DepositInsurance))
}
def deposit_insurance=(_deposit_insurance); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Contains Features that add FinancialAddresses to the FinancialAccount.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::FinancialAddresses))
}
def financial_addresses; end
sig {
params(_financial_addresses: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::FinancialAddresses)).returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::FinancialAddresses))
}
def financial_addresses=(_financial_addresses); end
# Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::InboundTransfers))
}
def inbound_transfers; end
sig {
params(_inbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::InboundTransfers)).returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::InboundTransfers))
}
def inbound_transfers=(_inbound_transfers); end
# Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::IntraStripeFlows))
}
def intra_stripe_flows; end
sig {
params(_intra_stripe_flows: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::IntraStripeFlows)).returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::IntraStripeFlows))
}
def intra_stripe_flows=(_intra_stripe_flows); end
# Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundPayments))
}
def outbound_payments; end
sig {
params(_outbound_payments: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundPayments)).returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundPayments))
}
def outbound_payments=(_outbound_payments); end
# Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.
sig {
returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundTransfers))
}
def outbound_transfers; end
sig {
params(_outbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundTransfers)).returns(T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundTransfers))
}
def outbound_transfers=(_outbound_transfers); end
sig {
params(card_issuing: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::CardIssuing), deposit_insurance: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::DepositInsurance), expand: T.nilable(T::Array[String]), financial_addresses: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::FinancialAddresses), inbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::InboundTransfers), intra_stripe_flows: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::IntraStripeFlows), outbound_payments: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundPayments), outbound_transfers: T.nilable(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams::OutboundTransfers)).void
}
def initialize(
card_issuing: nil,
deposit_insurance: nil,
expand: nil,
financial_addresses: nil,
inbound_transfers: nil,
intra_stripe_flows: nil,
outbound_payments: nil,
outbound_transfers: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Retrieves Features information associated with the FinancialAccount.
sig {
params(financial_account: String, params: T.any(::Stripe::Treasury::FinancialAccountFeaturesService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::FinancialAccountFeatures)
}
def retrieve(financial_account, params = {}, opts = {}); end
# Updates the Features associated with a FinancialAccount.
sig {
params(financial_account: String, params: T.any(::Stripe::Treasury::FinancialAccountFeaturesService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::FinancialAccountFeatures)
}
def update(financial_account, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
class InboundTransferService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Returns objects associated with this FinancialAccount.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
# Amount (in cents) to be transferred.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FinancialAccount to send funds to.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The origin payment method to be debited for the InboundTransfer.
sig { returns(String) }
def origin_payment_method; end
sig { params(_origin_payment_method: String).returns(String) }
def origin_payment_method=(_origin_payment_method); end
# The complete description that appears on your customers' statements. Maximum 10 characters.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
sig {
params(amount: Integer, currency: String, description: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, metadata: T.nilable(T::Hash[String, String]), origin_payment_method: String, statement_descriptor: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
expand: nil,
financial_account: nil,
metadata: nil,
origin_payment_method: nil,
statement_descriptor: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Cancels an InboundTransfer.
sig {
params(inbound_transfer: String, params: T.any(::Stripe::Treasury::InboundTransferService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::InboundTransfer)
}
def cancel(inbound_transfer, params = {}, opts = {}); end
# Creates an InboundTransfer.
sig {
params(params: T.any(::Stripe::Treasury::InboundTransferService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::InboundTransfer)
}
def create(params = {}, opts = {}); end
# Returns a list of InboundTransfers sent from the specified FinancialAccount.
sig {
params(params: T.any(::Stripe::Treasury::InboundTransferService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing InboundTransfer.
sig {
params(id: String, params: T.any(::Stripe::Treasury::InboundTransferService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::InboundTransfer)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
class OutboundPaymentService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return OutboundPayments that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Treasury::OutboundPaymentService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Treasury::OutboundPaymentService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Treasury::OutboundPaymentService::ListParams::Created, Integer)))
}
def created=(_created); end
# Only return OutboundPayments sent to this customer.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Returns objects associated with this FinancialAccount.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return OutboundPayments that have the given status: `processing`, `failed`, `posted`, `returned`, or `canceled`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(created: T.nilable(T.any(::Stripe::Treasury::OutboundPaymentService::ListParams::Created, Integer)), customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
created: nil,
customer: nil,
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class DestinationPaymentMethodData < Stripe::RequestParams
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1, such as the street, PO Box, or company name.
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2, such as the apartment, suite, unit, or building.
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Billing address.
sig {
returns(T.nilable(T.any(String, ::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodData::BillingDetails::Address)))
}
def address; end
sig {
params(_address: T.nilable(T.any(String, ::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodData::BillingDetails::Address))).returns(T.nilable(T.any(String, ::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodData::BillingDetails::Address)))
}
def address=(_address); end
# Email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# Full name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Billing phone number (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(T.any(String, ::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodData::BillingDetails::Address)), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, email: nil, name: nil, phone: nil); end
end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
sig { returns(T.nilable(String)) }
def account_holder_type; end
sig { params(_account_holder_type: T.nilable(String)).returns(T.nilable(String)) }
def account_holder_type=(_account_holder_type); end
# Account number of the bank account.
sig { returns(T.nilable(String)) }
def account_number; end
sig { params(_account_number: T.nilable(String)).returns(T.nilable(String)) }
def account_number=(_account_number); end
# Account type: checkings or savings. Defaults to checking if omitted.
sig { returns(T.nilable(String)) }
def account_type; end
sig { params(_account_type: T.nilable(String)).returns(T.nilable(String)) }
def account_type=(_account_type); end
# The ID of a Financial Connections Account to use as a payment method.
sig { returns(T.nilable(String)) }
def financial_connections_account; end
sig {
params(_financial_connections_account: T.nilable(String)).returns(T.nilable(String))
}
def financial_connections_account=(_financial_connections_account); end
# Routing number of the bank account.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
); end
end
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodData::BillingDetails))
}
def billing_details; end
sig {
params(_billing_details: T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodData::BillingDetails)).returns(T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodData::BillingDetails))
}
def billing_details=(_billing_details); end
# Required if type is set to `financial_account`. The FinancialAccount ID to send funds to.
sig { returns(T.nilable(String)) }
def financial_account; end
sig { params(_financial_account: T.nilable(String)).returns(T.nilable(String)) }
def financial_account=(_financial_account); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Required hash if type is set to `us_bank_account`.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodData::UsBankAccount))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodData::UsBankAccount)).returns(T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodData::UsBankAccount))
}
def us_bank_account=(_us_bank_account); end
sig {
params(billing_details: T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodData::BillingDetails), financial_account: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), type: String, us_bank_account: T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodData::UsBankAccount)).void
}
def initialize(
billing_details: nil,
financial_account: nil,
metadata: nil,
type: nil,
us_bank_account: nil
); end
end
class DestinationPaymentMethodOptions < Stripe::RequestParams
class UsBankAccount < Stripe::RequestParams
# Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
sig { params(network: T.nilable(String)).void }
def initialize(network: nil); end
end
# Optional fields for `us_bank_account`.
sig {
returns(T.nilable(T.any(String, ::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
sig {
params(us_bank_account: T.nilable(T.any(String, ::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodOptions::UsBankAccount))).void
}
def initialize(us_bank_account: nil); end
end
class EndUserDetails < Stripe::RequestParams
# IP address of the user initiating the OutboundPayment. Must be supplied if `present` is set to `true`.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# `True` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.
sig { returns(T::Boolean) }
def present; end
sig { params(_present: T::Boolean).returns(T::Boolean) }
def present=(_present); end
sig { params(ip_address: T.nilable(String), present: T::Boolean).void }
def initialize(ip_address: nil, present: nil); end
end
# Amount (in cents) to be transferred.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the `destination_payment_method` passed in.
sig { returns(T.nilable(String)) }
def customer; end
sig { params(_customer: T.nilable(String)).returns(T.nilable(String)) }
def customer=(_customer); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with `destination_payment_method_data`.
sig { returns(T.nilable(String)) }
def destination_payment_method; end
sig { params(_destination_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def destination_payment_method=(_destination_payment_method); end
# Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with `destination_payment_method`.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodData))
}
def destination_payment_method_data; end
sig {
params(_destination_payment_method_data: T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodData)).returns(T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodData))
}
def destination_payment_method_data=(_destination_payment_method_data); end
# Payment method-specific configuration for this OutboundPayment.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodOptions))
}
def destination_payment_method_options; end
sig {
params(_destination_payment_method_options: T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodOptions)).returns(T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodOptions))
}
def destination_payment_method_options=(_destination_payment_method_options); end
# End user details.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::EndUserDetails))
}
def end_user_details; end
sig {
params(_end_user_details: T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::EndUserDetails)).returns(T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::EndUserDetails))
}
def end_user_details=(_end_user_details); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FinancialAccount to pull funds from.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. The default value is "payment".
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
sig {
params(amount: Integer, currency: String, customer: T.nilable(String), description: T.nilable(String), destination_payment_method: T.nilable(String), destination_payment_method_data: T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodData), destination_payment_method_options: T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::DestinationPaymentMethodOptions), end_user_details: T.nilable(::Stripe::Treasury::OutboundPaymentService::CreateParams::EndUserDetails), expand: T.nilable(T::Array[String]), financial_account: String, metadata: T.nilable(T::Hash[String, String]), statement_descriptor: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
customer: nil,
description: nil,
destination_payment_method: nil,
destination_payment_method_data: nil,
destination_payment_method_options: nil,
end_user_details: nil,
expand: nil,
financial_account: nil,
metadata: nil,
statement_descriptor: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Cancel an OutboundPayment.
sig {
params(id: String, params: T.any(::Stripe::Treasury::OutboundPaymentService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundPayment)
}
def cancel(id, params = {}, opts = {}); end
# Creates an OutboundPayment.
sig {
params(params: T.any(::Stripe::Treasury::OutboundPaymentService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundPayment)
}
def create(params = {}, opts = {}); end
# Returns a list of OutboundPayments sent from the specified FinancialAccount.
sig {
params(params: T.any(::Stripe::Treasury::OutboundPaymentService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.
sig {
params(id: String, params: T.any(::Stripe::Treasury::OutboundPaymentService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundPayment)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
class OutboundTransferService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Returns objects associated with this FinancialAccount.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class DestinationPaymentMethodData < Stripe::RequestParams
# Required if type is set to `financial_account`. The FinancialAccount ID to send funds to.
sig { returns(T.nilable(String)) }
def financial_account; end
sig { params(_financial_account: T.nilable(String)).returns(T.nilable(String)) }
def financial_account=(_financial_account); end
# The type of the destination.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(financial_account: T.nilable(String), type: String).void }
def initialize(financial_account: nil, type: nil); end
end
class DestinationPaymentMethodOptions < Stripe::RequestParams
class UsBankAccount < Stripe::RequestParams
# Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
sig { returns(T.nilable(String)) }
def network; end
sig { params(_network: T.nilable(String)).returns(T.nilable(String)) }
def network=(_network); end
sig { params(network: T.nilable(String)).void }
def initialize(network: nil); end
end
# Optional fields for `us_bank_account`.
sig {
returns(T.nilable(T.any(String, ::Stripe::Treasury::OutboundTransferService::CreateParams::DestinationPaymentMethodOptions::UsBankAccount)))
}
def us_bank_account; end
sig {
params(_us_bank_account: T.nilable(T.any(String, ::Stripe::Treasury::OutboundTransferService::CreateParams::DestinationPaymentMethodOptions::UsBankAccount))).returns(T.nilable(T.any(String, ::Stripe::Treasury::OutboundTransferService::CreateParams::DestinationPaymentMethodOptions::UsBankAccount)))
}
def us_bank_account=(_us_bank_account); end
sig {
params(us_bank_account: T.nilable(T.any(String, ::Stripe::Treasury::OutboundTransferService::CreateParams::DestinationPaymentMethodOptions::UsBankAccount))).void
}
def initialize(us_bank_account: nil); end
end
class NetworkDetails < Stripe::RequestParams
class Ach < Stripe::RequestParams
# Addenda record data associated with this OutboundTransfer.
sig { returns(T.nilable(String)) }
def addenda; end
sig { params(_addenda: T.nilable(String)).returns(T.nilable(String)) }
def addenda=(_addenda); end
sig { params(addenda: T.nilable(String)).void }
def initialize(addenda: nil); end
end
# Optional fields for `ach`.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundTransferService::CreateParams::NetworkDetails::Ach))
}
def ach; end
sig {
params(_ach: T.nilable(::Stripe::Treasury::OutboundTransferService::CreateParams::NetworkDetails::Ach)).returns(T.nilable(::Stripe::Treasury::OutboundTransferService::CreateParams::NetworkDetails::Ach))
}
def ach=(_ach); end
# The type of flow that originated the OutboundTransfer.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(ach: T.nilable(::Stripe::Treasury::OutboundTransferService::CreateParams::NetworkDetails::Ach), type: String).void
}
def initialize(ach: nil, type: nil); end
end
# Amount (in cents) to be transferred.
sig { returns(Integer) }
def amount; end
sig { params(_amount: Integer).returns(Integer) }
def amount=(_amount); end
# 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) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# An arbitrary string attached to the object. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The PaymentMethod to use as the payment instrument for the OutboundTransfer.
sig { returns(T.nilable(String)) }
def destination_payment_method; end
sig { params(_destination_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def destination_payment_method=(_destination_payment_method); end
# Hash used to generate the PaymentMethod to be used for this OutboundTransfer. Exclusive with `destination_payment_method`.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundTransferService::CreateParams::DestinationPaymentMethodData))
}
def destination_payment_method_data; end
sig {
params(_destination_payment_method_data: T.nilable(::Stripe::Treasury::OutboundTransferService::CreateParams::DestinationPaymentMethodData)).returns(T.nilable(::Stripe::Treasury::OutboundTransferService::CreateParams::DestinationPaymentMethodData))
}
def destination_payment_method_data=(_destination_payment_method_data); end
# Hash describing payment method configuration details.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundTransferService::CreateParams::DestinationPaymentMethodOptions))
}
def destination_payment_method_options; end
sig {
params(_destination_payment_method_options: T.nilable(::Stripe::Treasury::OutboundTransferService::CreateParams::DestinationPaymentMethodOptions)).returns(T.nilable(::Stripe::Treasury::OutboundTransferService::CreateParams::DestinationPaymentMethodOptions))
}
def destination_payment_method_options=(_destination_payment_method_options); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FinancialAccount to pull funds from.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# 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`.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Details about the network used for the OutboundTransfer.
sig {
returns(T.nilable(::Stripe::Treasury::OutboundTransferService::CreateParams::NetworkDetails))
}
def network_details; end
sig {
params(_network_details: T.nilable(::Stripe::Treasury::OutboundTransferService::CreateParams::NetworkDetails)).returns(T.nilable(::Stripe::Treasury::OutboundTransferService::CreateParams::NetworkDetails))
}
def network_details=(_network_details); end
# Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer".
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
sig {
params(amount: Integer, currency: String, description: T.nilable(String), destination_payment_method: T.nilable(String), destination_payment_method_data: T.nilable(::Stripe::Treasury::OutboundTransferService::CreateParams::DestinationPaymentMethodData), destination_payment_method_options: T.nilable(::Stripe::Treasury::OutboundTransferService::CreateParams::DestinationPaymentMethodOptions), expand: T.nilable(T::Array[String]), financial_account: String, metadata: T.nilable(T::Hash[String, String]), network_details: T.nilable(::Stripe::Treasury::OutboundTransferService::CreateParams::NetworkDetails), statement_descriptor: T.nilable(String)).void
}
def initialize(
amount: nil,
currency: nil,
description: nil,
destination_payment_method: nil,
destination_payment_method_data: nil,
destination_payment_method_options: nil,
expand: nil,
financial_account: nil,
metadata: nil,
network_details: nil,
statement_descriptor: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# An OutboundTransfer can be canceled if the funds have not yet been paid out.
sig {
params(outbound_transfer: String, params: T.any(::Stripe::Treasury::OutboundTransferService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundTransfer)
}
def cancel(outbound_transfer, params = {}, opts = {}); end
# Creates an OutboundTransfer.
sig {
params(params: T.any(::Stripe::Treasury::OutboundTransferService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundTransfer)
}
def create(params = {}, opts = {}); end
# Returns a list of OutboundTransfers sent from the specified FinancialAccount.
sig {
params(params: T.any(::Stripe::Treasury::OutboundTransferService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.
sig {
params(outbound_transfer: String, params: T.any(::Stripe::Treasury::OutboundTransferService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::OutboundTransfer)
}
def retrieve(outbound_transfer, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
class ReceivedCreditService < StripeService
class ListParams < Stripe::RequestParams
class LinkedFlows < Stripe::RequestParams
# The source flow type.
sig { returns(String) }
def source_flow_type; end
sig { params(_source_flow_type: String).returns(String) }
def source_flow_type=(_source_flow_type); end
sig { params(source_flow_type: String).void }
def initialize(source_flow_type: nil); end
end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FinancialAccount that received the funds.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return ReceivedCredits described by the flow.
sig {
returns(T.nilable(::Stripe::Treasury::ReceivedCreditService::ListParams::LinkedFlows))
}
def linked_flows; end
sig {
params(_linked_flows: T.nilable(::Stripe::Treasury::ReceivedCreditService::ListParams::LinkedFlows)).returns(T.nilable(::Stripe::Treasury::ReceivedCreditService::ListParams::LinkedFlows))
}
def linked_flows=(_linked_flows); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return ReceivedCredits that have the given status: `succeeded` or `failed`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), linked_flows: T.nilable(::Stripe::Treasury::ReceivedCreditService::ListParams::LinkedFlows), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
linked_flows: nil,
starting_after: nil,
status: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of ReceivedCredits.
sig {
params(params: T.any(::Stripe::Treasury::ReceivedCreditService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.
sig {
params(id: String, params: T.any(::Stripe::Treasury::ReceivedCreditService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::ReceivedCredit)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
class ReceivedDebitService < StripeService
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# The FinancialAccount that funds were pulled from.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return ReceivedDebits that have the given status: `succeeded` or `failed`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
}
def initialize(
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
starting_after: nil,
status: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Returns a list of ReceivedDebits.
sig {
params(params: T.any(::Stripe::Treasury::ReceivedDebitService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list
sig {
params(id: String, params: T.any(::Stripe::Treasury::ReceivedDebitService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::ReceivedDebit)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
class TransactionService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class StatusTransitions < Stripe::RequestParams
class PostedAt < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Returns Transactions with `posted_at` within the specified range.
sig {
returns(T.nilable(T.any(::Stripe::Treasury::TransactionService::ListParams::StatusTransitions::PostedAt, Integer)))
}
def posted_at; end
sig {
params(_posted_at: T.nilable(T.any(::Stripe::Treasury::TransactionService::ListParams::StatusTransitions::PostedAt, Integer))).returns(T.nilable(T.any(::Stripe::Treasury::TransactionService::ListParams::StatusTransitions::PostedAt, Integer)))
}
def posted_at=(_posted_at); end
sig {
params(posted_at: T.nilable(T.any(::Stripe::Treasury::TransactionService::ListParams::StatusTransitions::PostedAt, Integer))).void
}
def initialize(posted_at: nil); end
end
# Only return Transactions that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Treasury::TransactionService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Treasury::TransactionService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Treasury::TransactionService::ListParams::Created, Integer)))
}
def created=(_created); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Returns objects associated with this FinancialAccount.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The results are in reverse chronological order by `created` or `posted_at`. The default is `created`.
sig { returns(T.nilable(String)) }
def order_by; end
sig { params(_order_by: T.nilable(String)).returns(T.nilable(String)) }
def order_by=(_order_by); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return Transactions that have the given status: `open`, `posted`, or `void`.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
# A filter for the `status_transitions.posted_at` timestamp. When using this filter, `status=posted` and `order_by=posted_at` must also be specified.
sig {
returns(T.nilable(::Stripe::Treasury::TransactionService::ListParams::StatusTransitions))
}
def status_transitions; end
sig {
params(_status_transitions: T.nilable(::Stripe::Treasury::TransactionService::ListParams::StatusTransitions)).returns(T.nilable(::Stripe::Treasury::TransactionService::ListParams::StatusTransitions))
}
def status_transitions=(_status_transitions); end
sig {
params(created: T.nilable(T.any(::Stripe::Treasury::TransactionService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), order_by: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String), status_transitions: T.nilable(::Stripe::Treasury::TransactionService::ListParams::StatusTransitions)).void
}
def initialize(
created: nil,
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
order_by: nil,
starting_after: nil,
status: nil,
status_transitions: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Retrieves a list of Transaction objects.
sig {
params(params: T.any(::Stripe::Treasury::TransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing Transaction.
sig {
params(id: String, params: T.any(::Stripe::Treasury::TransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::Transaction)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
module Treasury
class TransactionEntryService < StripeService
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
class EffectiveAt < Stripe::RequestParams
# Minimum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def gt; end
sig { params(_gt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gt=(_gt); end
# Minimum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def gte; end
sig { params(_gte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def gte=(_gte); end
# Maximum value to filter by (exclusive)
sig { returns(T.nilable(Integer)) }
def lt; end
sig { params(_lt: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lt=(_lt); end
# Maximum value to filter by (inclusive)
sig { returns(T.nilable(Integer)) }
def lte; end
sig { params(_lte: T.nilable(Integer)).returns(T.nilable(Integer)) }
def lte=(_lte); end
sig {
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
}
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
end
# Only return TransactionEntries that were created during the given date interval.
sig {
returns(T.nilable(T.any(::Stripe::Treasury::TransactionEntryService::ListParams::Created, Integer)))
}
def created; end
sig {
params(_created: T.nilable(T.any(::Stripe::Treasury::TransactionEntryService::ListParams::Created, Integer))).returns(T.nilable(T.any(::Stripe::Treasury::TransactionEntryService::ListParams::Created, Integer)))
}
def created=(_created); end
# Attribute for param field effective_at
sig {
returns(T.nilable(T.any(::Stripe::Treasury::TransactionEntryService::ListParams::EffectiveAt, Integer)))
}
def effective_at; end
sig {
params(_effective_at: T.nilable(T.any(::Stripe::Treasury::TransactionEntryService::ListParams::EffectiveAt, Integer))).returns(T.nilable(T.any(::Stripe::Treasury::TransactionEntryService::ListParams::EffectiveAt, Integer)))
}
def effective_at=(_effective_at); end
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# Returns objects associated with this FinancialAccount.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The results are in reverse chronological order by `created` or `effective_at`. The default is `created`.
sig { returns(T.nilable(String)) }
def order_by; end
sig { params(_order_by: T.nilable(String)).returns(T.nilable(String)) }
def order_by=(_order_by); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
# Only return TransactionEntries associated with this Transaction.
sig { returns(T.nilable(String)) }
def transaction; end
sig { params(_transaction: T.nilable(String)).returns(T.nilable(String)) }
def transaction=(_transaction); end
sig {
params(created: T.nilable(T.any(::Stripe::Treasury::TransactionEntryService::ListParams::Created, Integer)), effective_at: T.nilable(T.any(::Stripe::Treasury::TransactionEntryService::ListParams::EffectiveAt, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), order_by: T.nilable(String), starting_after: T.nilable(String), transaction: T.nilable(String)).void
}
def initialize(
created: nil,
effective_at: nil,
ending_before: nil,
expand: nil,
financial_account: nil,
limit: nil,
order_by: nil,
starting_after: nil,
transaction: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
# Retrieves a list of TransactionEntry objects.
sig {
params(params: T.any(::Stripe::Treasury::TransactionEntryService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a TransactionEntry object.
sig {
params(id: String, params: T.any(::Stripe::Treasury::TransactionEntryService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::TransactionEntry)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
# typed: true
module Stripe
class WebhookEndpointService < StripeService
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
sig { params(expand: T.nilable(T::Array[String])).void }
def initialize(expand: nil); end
end
class UpdateParams < Stripe::RequestParams
# An optional description of what the webhook is used for.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Disable the webhook endpoint if set to true.
sig { returns(T.nilable(T::Boolean)) }
def disabled; end
sig { params(_disabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def disabled=(_disabled); end
# The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection.
sig { returns(T.nilable(T::Array[String])) }
def enabled_events; end
sig {
params(_enabled_events: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def enabled_events=(_enabled_events); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The URL of the webhook endpoint.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(description: T.nilable(String), disabled: T.nilable(T::Boolean), enabled_events: T.nilable(T::Array[String]), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), url: T.nilable(String)).void
}
def initialize(
description: nil,
disabled: nil,
enabled_events: nil,
expand: nil,
metadata: nil,
url: nil
); end
end
class ListParams < Stripe::RequestParams
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
sig { returns(T.nilable(String)) }
def ending_before; end
sig { params(_ending_before: T.nilable(String)).returns(T.nilable(String)) }
def ending_before=(_ending_before); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
sig { returns(T.nilable(String)) }
def starting_after; end
sig { params(_starting_after: T.nilable(String)).returns(T.nilable(String)) }
def starting_after=(_starting_after); end
sig {
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
}
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
end
class CreateParams < Stripe::RequestParams
# Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version.
sig { returns(T.nilable(String)) }
def api_version; end
sig { params(_api_version: T.nilable(String)).returns(T.nilable(String)) }
def api_version=(_api_version); end
# Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`.
sig { returns(T.nilable(T::Boolean)) }
def connect; end
sig { params(_connect: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def connect=(_connect); end
# An optional description of what the webhook is used for.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection.
sig { returns(T::Array[String]) }
def enabled_events; end
sig { params(_enabled_events: T::Array[String]).returns(T::Array[String]) }
def enabled_events=(_enabled_events); end
# Specifies which fields in the response should be expanded.
sig { returns(T.nilable(T::Array[String])) }
def expand; end
sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def expand=(_expand); end
# 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`.
sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
def metadata; end
sig {
params(_metadata: T.nilable(T.any(String, T::Hash[String, String]))).returns(T.nilable(T.any(String, T::Hash[String, String])))
}
def metadata=(_metadata); end
# The URL of the webhook endpoint.
sig { returns(String) }
def url; end
sig { params(_url: String).returns(String) }
def url=(_url); end
sig {
params(api_version: T.nilable(String), connect: T.nilable(T::Boolean), description: T.nilable(String), enabled_events: T::Array[String], expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), url: String).void
}
def initialize(
api_version: nil,
connect: nil,
description: nil,
enabled_events: nil,
expand: nil,
metadata: nil,
url: nil
); end
end
# A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the [webhooks settings](https://dashboard.stripe.com/account/webhooks) section of the Dashboard.
sig {
params(params: T.any(::Stripe::WebhookEndpointService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::WebhookEndpoint)
}
def create(params = {}, opts = {}); end
# You can also delete webhook endpoints via the [webhook endpoint management](https://dashboard.stripe.com/account/webhooks) page of the Stripe dashboard.
sig {
params(webhook_endpoint: String, params: T.any(::Stripe::WebhookEndpointService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::WebhookEndpoint)
}
def delete(webhook_endpoint, params = {}, opts = {}); end
# Returns a list of your webhook endpoints.
sig {
params(params: T.any(::Stripe::WebhookEndpointService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the webhook endpoint with the given ID.
sig {
params(webhook_endpoint: String, params: T.any(::Stripe::WebhookEndpointService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::WebhookEndpoint)
}
def retrieve(webhook_endpoint, params = {}, opts = {}); end
# Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.
sig {
params(webhook_endpoint: String, params: T.any(::Stripe::WebhookEndpointService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::WebhookEndpoint)
}
def update(webhook_endpoint, params = {}, opts = {}); end
end
end
# typed: true
module Stripe
class V2Services < StripeService
attr_reader :billing
attr_reader :core
attr_reader :money_management
attr_reader :payments
attr_reader :test_helpers
end
end
# typed: true
module Stripe
module V2
class BillingService < StripeService
attr_reader :meter_events
attr_reader :meter_event_adjustments
attr_reader :meter_event_session
attr_reader :meter_event_stream
end
end
end
# typed: true
module Stripe
module V2
module Billing
class MeterEventService < StripeService
class CreateParams < Stripe::RequestParams
# The name of the meter event. Corresponds with the `event_name` field on a meter.
sig { returns(String) }
def event_name; end
sig { params(_event_name: String).returns(String) }
def event_name=(_event_name); end
# A unique identifier for the event. If not provided, one will be generated.
# We recommend using a globally unique identifier for this. We’ll enforce
# uniqueness within a rolling 24 hour period.
sig { returns(T.nilable(String)) }
def identifier; end
sig { params(_identifier: T.nilable(String)).returns(T.nilable(String)) }
def identifier=(_identifier); end
# The payload of the event. This must contain the fields corresponding to a meter’s
# `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and
# `value_settings.event_payload_key` (default is `value`). Read more about
# the
# [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
sig { returns(T::Hash[String, String]) }
def payload; end
sig { params(_payload: T::Hash[String, String]).returns(T::Hash[String, String]) }
def payload=(_payload); end
# The time of the event. Must be within the past 35 calendar days or up to
# 5 minutes in the future. Defaults to current timestamp if not specified.
sig { returns(T.nilable(String)) }
def timestamp; end
sig { params(_timestamp: T.nilable(String)).returns(T.nilable(String)) }
def timestamp=(_timestamp); end
sig {
params(event_name: String, identifier: T.nilable(String), payload: T::Hash[String, String], timestamp: T.nilable(String)).void
}
def initialize(event_name: nil, identifier: nil, payload: nil, timestamp: nil); end
end
# Creates a meter event. Events are validated synchronously, but are processed asynchronously. Supports up to 1,000 events per second in livemode. For higher rate-limits, please use meter event streams instead.
sig {
params(params: T.any(::Stripe::V2::Billing::MeterEventService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Billing::MeterEvent)
}
def create(params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module Billing
class MeterEventAdjustmentService < StripeService
class CreateParams < Stripe::RequestParams
class Cancel < Stripe::RequestParams
# Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.
sig { returns(String) }
def identifier; end
sig { params(_identifier: String).returns(String) }
def identifier=(_identifier); end
sig { params(identifier: String).void }
def initialize(identifier: nil); end
end
# Specifies which event to cancel.
sig { returns(::Stripe::V2::Billing::MeterEventAdjustmentService::CreateParams::Cancel) }
def cancel; end
sig {
params(_cancel: ::Stripe::V2::Billing::MeterEventAdjustmentService::CreateParams::Cancel).returns(::Stripe::V2::Billing::MeterEventAdjustmentService::CreateParams::Cancel)
}
def cancel=(_cancel); end
# The name of the meter event. Corresponds with the `event_name` field on a meter.
sig { returns(String) }
def event_name; end
sig { params(_event_name: String).returns(String) }
def event_name=(_event_name); end
# Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(cancel: ::Stripe::V2::Billing::MeterEventAdjustmentService::CreateParams::Cancel, event_name: String, type: String).void
}
def initialize(cancel: nil, event_name: nil, type: nil); end
end
# Creates a meter event adjustment to cancel a previously sent meter event.
sig {
params(params: T.any(::Stripe::V2::Billing::MeterEventAdjustmentService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Billing::MeterEventAdjustment)
}
def create(params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module Billing
class MeterEventSessionService < StripeService
class CreateParams < Stripe::RequestParams; end
# Creates a meter event session to send usage on the high-throughput meter event stream. Authentication tokens are only valid for 15 minutes, so you will need to create a new meter event session when your token expires.
sig {
params(params: T.any(::Stripe::V2::Billing::MeterEventSessionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Billing::MeterEventSession)
}
def create(params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module Billing
class MeterEventStreamService < StripeService
class CreateParams < Stripe::RequestParams
class Event < Stripe::RequestParams
# The name of the meter event. Corresponds with the `event_name` field on a meter.
sig { returns(String) }
def event_name; end
sig { params(_event_name: String).returns(String) }
def event_name=(_event_name); end
# A unique identifier for the event. If not provided, one will be generated.
# We recommend using a globally unique identifier for this. We’ll enforce
# uniqueness within a rolling 24 hour period.
sig { returns(T.nilable(String)) }
def identifier; end
sig { params(_identifier: T.nilable(String)).returns(T.nilable(String)) }
def identifier=(_identifier); end
# The payload of the event. This must contain the fields corresponding to a meter’s
# `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and
# `value_settings.event_payload_key` (default is `value`). Read more about
# the
# [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
sig { returns(T::Hash[String, String]) }
def payload; end
sig { params(_payload: T::Hash[String, String]).returns(T::Hash[String, String]) }
def payload=(_payload); end
# The time of the event. Must be within the past 35 calendar days or up to
# 5 minutes in the future. Defaults to current timestamp if not specified.
sig { returns(T.nilable(String)) }
def timestamp; end
sig { params(_timestamp: T.nilable(String)).returns(T.nilable(String)) }
def timestamp=(_timestamp); end
sig {
params(event_name: String, identifier: T.nilable(String), payload: T::Hash[String, String], timestamp: T.nilable(String)).void
}
def initialize(event_name: nil, identifier: nil, payload: nil, timestamp: nil); end
end
# List of meter events to include in the request.
sig {
returns(T::Array[::Stripe::V2::Billing::MeterEventStreamService::CreateParams::Event])
}
def events; end
sig {
params(_events: T::Array[::Stripe::V2::Billing::MeterEventStreamService::CreateParams::Event]).returns(T::Array[::Stripe::V2::Billing::MeterEventStreamService::CreateParams::Event])
}
def events=(_events); end
sig {
params(events: T::Array[::Stripe::V2::Billing::MeterEventStreamService::CreateParams::Event]).void
}
def initialize(events: nil); end
end
# Creates meter events. Events are processed asynchronously, including validation. Requires a meter event session for authentication. Supports up to 10,000 requests per second in livemode. For even higher rate-limits, contact sales.
#
# ** raises TemporarySessionExpiredError
sig {
params(params: T.any(::Stripe::V2::Billing::MeterEventStreamService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).void
}
def create(params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
class CoreService < StripeService
attr_reader :accounts
attr_reader :account_links
attr_reader :events
attr_reader :event_destinations
attr_reader :vault
end
end
end
# typed: true
module Stripe
module V2
module Core
class AccountService < StripeService
attr_reader :persons
class ListParams < Stripe::RequestParams
# Filter only accounts that have all of the configurations specified. If omitted, returns all accounts regardless of which configurations they have.
sig { returns(T.nilable(T::Array[String])) }
def applied_configurations; end
sig {
params(_applied_configurations: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def applied_configurations=(_applied_configurations); end
# The upper limit on the number of accounts returned by the List Account request.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
sig {
params(applied_configurations: T.nilable(T::Array[String]), limit: T.nilable(Integer)).void
}
def initialize(applied_configurations: nil, limit: nil); end
end
class CreateParams < Stripe::RequestParams
class Configuration < Stripe::RequestParams
class Customer < Stripe::RequestParams
class AutomaticIndirectTax < Stripe::RequestParams
# Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to reverse, invoice and receipt PDFs include the following text: “Reverse charge”.
sig { returns(T.nilable(String)) }
def exempt; end
sig { params(_exempt: T.nilable(String)).returns(T.nilable(String)) }
def exempt=(_exempt); end
# A recent IP address of the customer used for tax reporting and tax location inference.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# The data source used to identify the customer's tax location - defaults to 'identity_address'. Will only be used for automatic tax calculation on the customer's Invoices and Subscriptions.
sig { returns(T.nilable(String)) }
def location_source; end
sig { params(_location_source: T.nilable(String)).returns(T.nilable(String)) }
def location_source=(_location_source); end
sig {
params(exempt: T.nilable(String), ip_address: T.nilable(String), location_source: T.nilable(String)).void
}
def initialize(exempt: nil, ip_address: nil, location_source: nil); end
end
class Billing < Stripe::RequestParams
class Invoice < Stripe::RequestParams
class CustomField < Stripe::RequestParams
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The value of the custom field. This may be up to 140 characters. When updating, pass an empty string to remove previously-defined values.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
class Rendering < Stripe::RequestParams
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of exclude_tax or include_inclusive_tax. include_inclusive_tax will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. exclude_tax will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(String)) }
def amount_tax_display; end
sig {
params(_amount_tax_display: T.nilable(String)).returns(T.nilable(String))
}
def amount_tax_display=(_amount_tax_display); end
# ID of the invoice rendering template to use for future invoices.
sig { returns(T.nilable(String)) }
def template; end
sig { params(_template: T.nilable(String)).returns(T.nilable(String)) }
def template=(_template); end
sig {
params(amount_tax_display: T.nilable(String), template: T.nilable(String)).void
}
def initialize(amount_tax_display: nil, template: nil); end
end
# The list of up to 4 default custom fields to be displayed on invoices for this customer.
sig {
returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Billing::Invoice::CustomField]))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Billing::Invoice::CustomField])).returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Billing::Invoice::CustomField]))
}
def custom_fields=(_custom_fields); end
# Default footer to be displayed on invoices for this customer.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# The sequence to be used on the customer's next invoice. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def next_sequence; end
sig { params(_next_sequence: T.nilable(Integer)).returns(T.nilable(Integer)) }
def next_sequence=(_next_sequence); end
# The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
sig { returns(T.nilable(String)) }
def prefix; end
sig { params(_prefix: T.nilable(String)).returns(T.nilable(String)) }
def prefix=(_prefix); end
# Default options for invoice PDF rendering for this customer.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Billing::Invoice::Rendering))
}
def rendering; end
sig {
params(_rendering: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Billing::Invoice::Rendering)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Billing::Invoice::Rendering))
}
def rendering=(_rendering); end
sig {
params(custom_fields: T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Billing::Invoice::CustomField]), footer: T.nilable(String), next_sequence: T.nilable(Integer), prefix: T.nilable(String), rendering: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Billing::Invoice::Rendering)).void
}
def initialize(
custom_fields: nil,
footer: nil,
next_sequence: nil,
prefix: nil,
rendering: nil
); end
end
# Default settings used on invoices for this customer.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Billing::Invoice))
}
def invoice; end
sig {
params(_invoice: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Billing::Invoice)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Billing::Invoice))
}
def invoice=(_invoice); end
sig {
params(invoice: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Billing::Invoice)).void
}
def initialize(invoice: nil); end
end
class Capabilities < Stripe::RequestParams
class AutomaticIndirectTax < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Generates requirements for enabling automatic indirect tax calculation on this customer's invoices or subscriptions. Recommended to request this capability if planning to enable automatic tax calculation on this customer's invoices or subscriptions. Uses the `location_source` field.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Capabilities::AutomaticIndirectTax))
}
def automatic_indirect_tax; end
sig {
params(_automatic_indirect_tax: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Capabilities::AutomaticIndirectTax)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Capabilities::AutomaticIndirectTax))
}
def automatic_indirect_tax=(_automatic_indirect_tax); end
sig {
params(automatic_indirect_tax: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Capabilities::AutomaticIndirectTax)).void
}
def initialize(automatic_indirect_tax: nil); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Customer shipping address.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Shipping::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Shipping::Address)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Shipping::Address))
}
def address=(_address); end
# Customer name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Customer phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Shipping::Address), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
# Automatic indirect tax settings to be used when automatic tax calculation is enabled on the customer's invoices, subscriptions, checkout sessions, or payment links. Surfaces if automatic tax calculation is possible given the current customer location information.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::AutomaticIndirectTax))
}
def automatic_indirect_tax; end
sig {
params(_automatic_indirect_tax: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::AutomaticIndirectTax)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::AutomaticIndirectTax))
}
def automatic_indirect_tax=(_automatic_indirect_tax); end
# Billing settings - default settings used for this customer in Billing flows such as Invoices and Subscriptions.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Billing))
}
def billing; end
sig {
params(_billing: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Billing)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Billing))
}
def billing=(_billing); end
# Capabilities that have been requested on the Customer Configuration.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Capabilities))
}
def capabilities; end
sig {
params(_capabilities: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Capabilities)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Capabilities))
}
def capabilities=(_capabilities); end
# The customer's shipping information. Appears on invoices emailed to this customer.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Shipping))
}
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Shipping)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Shipping))
}
def shipping=(_shipping); end
# ID of the test clock to attach to the customer. Can only be set on testmode Accounts, and when the Customer Configuration is first set on an Account.
sig { returns(T.nilable(String)) }
def test_clock; end
sig { params(_test_clock: T.nilable(String)).returns(T.nilable(String)) }
def test_clock=(_test_clock); end
sig {
params(automatic_indirect_tax: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::AutomaticIndirectTax), billing: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Billing), capabilities: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Capabilities), shipping: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer::Shipping), test_clock: T.nilable(String)).void
}
def initialize(
automatic_indirect_tax: nil,
billing: nil,
capabilities: nil,
shipping: nil,
test_clock: nil
); end
end
class Merchant < Stripe::RequestParams
class BacsDebitPayments < Stripe::RequestParams
# Display name for Bacs debit payments.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
sig { params(display_name: T.nilable(String)).void }
def initialize(display_name: nil); end
end
class Branding < Stripe::RequestParams
# ID of a [file upload](https://docs.stripe.com/api/persons/update#create_file): An icon for the merchant. Must be square and at least 128px x 128px.
sig { returns(T.nilable(String)) }
def icon; end
sig { params(_icon: T.nilable(String)).returns(T.nilable(String)) }
def icon=(_icon); end
# ID of a [file upload](https://docs.stripe.com/api/persons/update#create_file): A logo for the merchant that will be used in Checkout instead of the icon and without the merchant's name next to it if provided. Must be at least 128px x 128px.
sig { returns(T.nilable(String)) }
def logo; end
sig { params(_logo: T.nilable(String)).returns(T.nilable(String)) }
def logo=(_logo); end
# A CSS hex color value representing the primary branding color for the merchant.
sig { returns(T.nilable(String)) }
def primary_color; end
sig { params(_primary_color: T.nilable(String)).returns(T.nilable(String)) }
def primary_color=(_primary_color); end
# A CSS hex color value representing the secondary branding color for the merchant.
sig { returns(T.nilable(String)) }
def secondary_color; end
sig { params(_secondary_color: T.nilable(String)).returns(T.nilable(String)) }
def secondary_color=(_secondary_color); end
sig {
params(icon: T.nilable(String), logo: T.nilable(String), primary_color: T.nilable(String), secondary_color: T.nilable(String)).void
}
def initialize(icon: nil, logo: nil, primary_color: nil, secondary_color: nil); end
end
class Capabilities < Stripe::RequestParams
class AchDebitPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class AcssDebitPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class AffirmPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class AfterpayClearpayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class AlmaPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class AmazonPayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class AuBecsDebitPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class BacsDebitPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class BancontactPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class BlikPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class BoletoPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class CardPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class CartesBancairesPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class CashappPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class EpsPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class FpxPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class GbBankTransferPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class GrabpayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class IdealPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class JcbPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class JpBankTransferPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class KakaoPayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class KlarnaPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class KonbiniPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class KrCardPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class LinkPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class MobilepayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class MultibancoPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class MxBankTransferPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class NaverPayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class OxxoPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class P24Payments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class PayByBankPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class PaycoPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class PaynowPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class PromptpayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class RevolutPayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class SamsungPayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class SepaBankTransferPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class SepaDebitPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class SwishPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class TwintPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class UsBankTransferPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class ZipPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Allow the merchant to process ACH debit payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AchDebitPayments))
}
def ach_debit_payments; end
sig {
params(_ach_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AchDebitPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AchDebitPayments))
}
def ach_debit_payments=(_ach_debit_payments); end
# Allow the merchant to process ACSS debit payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AcssDebitPayments))
}
def acss_debit_payments; end
sig {
params(_acss_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AcssDebitPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AcssDebitPayments))
}
def acss_debit_payments=(_acss_debit_payments); end
# Allow the merchant to process Affirm payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AffirmPayments))
}
def affirm_payments; end
sig {
params(_affirm_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AffirmPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AffirmPayments))
}
def affirm_payments=(_affirm_payments); end
# Allow the merchant to process Afterpay/Clearpay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AfterpayClearpayPayments))
}
def afterpay_clearpay_payments; end
sig {
params(_afterpay_clearpay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AfterpayClearpayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AfterpayClearpayPayments))
}
def afterpay_clearpay_payments=(_afterpay_clearpay_payments); end
# Allow the merchant to process Alma payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AlmaPayments))
}
def alma_payments; end
sig {
params(_alma_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AlmaPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AlmaPayments))
}
def alma_payments=(_alma_payments); end
# Allow the merchant to process Amazon Pay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AmazonPayPayments))
}
def amazon_pay_payments; end
sig {
params(_amazon_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AmazonPayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AmazonPayPayments))
}
def amazon_pay_payments=(_amazon_pay_payments); end
# Allow the merchant to process Australian BECS Direct Debit payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AuBecsDebitPayments))
}
def au_becs_debit_payments; end
sig {
params(_au_becs_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AuBecsDebitPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AuBecsDebitPayments))
}
def au_becs_debit_payments=(_au_becs_debit_payments); end
# Allow the merchant to process BACS Direct Debit payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::BacsDebitPayments))
}
def bacs_debit_payments; end
sig {
params(_bacs_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::BacsDebitPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::BacsDebitPayments))
}
def bacs_debit_payments=(_bacs_debit_payments); end
# Allow the merchant to process Bancontact payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::BancontactPayments))
}
def bancontact_payments; end
sig {
params(_bancontact_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::BancontactPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::BancontactPayments))
}
def bancontact_payments=(_bancontact_payments); end
# Allow the merchant to process BLIK payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::BlikPayments))
}
def blik_payments; end
sig {
params(_blik_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::BlikPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::BlikPayments))
}
def blik_payments=(_blik_payments); end
# Allow the merchant to process Boleto payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::BoletoPayments))
}
def boleto_payments; end
sig {
params(_boleto_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::BoletoPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::BoletoPayments))
}
def boleto_payments=(_boleto_payments); end
# Allow the merchant to collect card payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::CardPayments))
}
def card_payments; end
sig {
params(_card_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::CardPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::CardPayments))
}
def card_payments=(_card_payments); end
# Allow the merchant to process Cartes Bancaires payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::CartesBancairesPayments))
}
def cartes_bancaires_payments; end
sig {
params(_cartes_bancaires_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::CartesBancairesPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::CartesBancairesPayments))
}
def cartes_bancaires_payments=(_cartes_bancaires_payments); end
# Allow the merchant to process Cash App payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::CashappPayments))
}
def cashapp_payments; end
sig {
params(_cashapp_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::CashappPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::CashappPayments))
}
def cashapp_payments=(_cashapp_payments); end
# Allow the merchant to process EPS payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::EpsPayments))
}
def eps_payments; end
sig {
params(_eps_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::EpsPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::EpsPayments))
}
def eps_payments=(_eps_payments); end
# Allow the merchant to process FPX payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::FpxPayments))
}
def fpx_payments; end
sig {
params(_fpx_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::FpxPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::FpxPayments))
}
def fpx_payments=(_fpx_payments); end
# Allow the merchant to process UK bank transfer payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::GbBankTransferPayments))
}
def gb_bank_transfer_payments; end
sig {
params(_gb_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::GbBankTransferPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::GbBankTransferPayments))
}
def gb_bank_transfer_payments=(_gb_bank_transfer_payments); end
# Allow the merchant to process GrabPay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::GrabpayPayments))
}
def grabpay_payments; end
sig {
params(_grabpay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::GrabpayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::GrabpayPayments))
}
def grabpay_payments=(_grabpay_payments); end
# Allow the merchant to process iDEAL payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::IdealPayments))
}
def ideal_payments; end
sig {
params(_ideal_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::IdealPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::IdealPayments))
}
def ideal_payments=(_ideal_payments); end
# Allow the merchant to process JCB card payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::JcbPayments))
}
def jcb_payments; end
sig {
params(_jcb_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::JcbPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::JcbPayments))
}
def jcb_payments=(_jcb_payments); end
# Allow the merchant to process Japanese bank transfer payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::JpBankTransferPayments))
}
def jp_bank_transfer_payments; end
sig {
params(_jp_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::JpBankTransferPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::JpBankTransferPayments))
}
def jp_bank_transfer_payments=(_jp_bank_transfer_payments); end
# Allow the merchant to process Kakao Pay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::KakaoPayPayments))
}
def kakao_pay_payments; end
sig {
params(_kakao_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::KakaoPayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::KakaoPayPayments))
}
def kakao_pay_payments=(_kakao_pay_payments); end
# Allow the merchant to process Klarna payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::KlarnaPayments))
}
def klarna_payments; end
sig {
params(_klarna_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::KlarnaPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::KlarnaPayments))
}
def klarna_payments=(_klarna_payments); end
# Allow the merchant to process Konbini convenience store payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::KonbiniPayments))
}
def konbini_payments; end
sig {
params(_konbini_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::KonbiniPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::KonbiniPayments))
}
def konbini_payments=(_konbini_payments); end
# Allow the merchant to process Korean card payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::KrCardPayments))
}
def kr_card_payments; end
sig {
params(_kr_card_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::KrCardPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::KrCardPayments))
}
def kr_card_payments=(_kr_card_payments); end
# Allow the merchant to process Link payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::LinkPayments))
}
def link_payments; end
sig {
params(_link_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::LinkPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::LinkPayments))
}
def link_payments=(_link_payments); end
# Allow the merchant to process MobilePay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::MobilepayPayments))
}
def mobilepay_payments; end
sig {
params(_mobilepay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::MobilepayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::MobilepayPayments))
}
def mobilepay_payments=(_mobilepay_payments); end
# Allow the merchant to process Multibanco payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::MultibancoPayments))
}
def multibanco_payments; end
sig {
params(_multibanco_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::MultibancoPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::MultibancoPayments))
}
def multibanco_payments=(_multibanco_payments); end
# Allow the merchant to process Mexican bank transfer payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::MxBankTransferPayments))
}
def mx_bank_transfer_payments; end
sig {
params(_mx_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::MxBankTransferPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::MxBankTransferPayments))
}
def mx_bank_transfer_payments=(_mx_bank_transfer_payments); end
# Allow the merchant to process Naver Pay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::NaverPayPayments))
}
def naver_pay_payments; end
sig {
params(_naver_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::NaverPayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::NaverPayPayments))
}
def naver_pay_payments=(_naver_pay_payments); end
# Allow the merchant to process OXXO payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::OxxoPayments))
}
def oxxo_payments; end
sig {
params(_oxxo_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::OxxoPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::OxxoPayments))
}
def oxxo_payments=(_oxxo_payments); end
# Allow the merchant to process Przelewy24 (P24) payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::P24Payments))
}
def p24_payments; end
sig {
params(_p24_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::P24Payments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::P24Payments))
}
def p24_payments=(_p24_payments); end
# Allow the merchant to process Pay by Bank payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::PayByBankPayments))
}
def pay_by_bank_payments; end
sig {
params(_pay_by_bank_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::PayByBankPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::PayByBankPayments))
}
def pay_by_bank_payments=(_pay_by_bank_payments); end
# Allow the merchant to process PAYCO payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::PaycoPayments))
}
def payco_payments; end
sig {
params(_payco_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::PaycoPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::PaycoPayments))
}
def payco_payments=(_payco_payments); end
# Allow the merchant to process PayNow payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::PaynowPayments))
}
def paynow_payments; end
sig {
params(_paynow_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::PaynowPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::PaynowPayments))
}
def paynow_payments=(_paynow_payments); end
# Allow the merchant to process PromptPay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::PromptpayPayments))
}
def promptpay_payments; end
sig {
params(_promptpay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::PromptpayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::PromptpayPayments))
}
def promptpay_payments=(_promptpay_payments); end
# Allow the merchant to process Revolut Pay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::RevolutPayPayments))
}
def revolut_pay_payments; end
sig {
params(_revolut_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::RevolutPayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::RevolutPayPayments))
}
def revolut_pay_payments=(_revolut_pay_payments); end
# Allow the merchant to process Samsung Pay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::SamsungPayPayments))
}
def samsung_pay_payments; end
sig {
params(_samsung_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::SamsungPayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::SamsungPayPayments))
}
def samsung_pay_payments=(_samsung_pay_payments); end
# Allow the merchant to process SEPA bank transfer payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::SepaBankTransferPayments))
}
def sepa_bank_transfer_payments; end
sig {
params(_sepa_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::SepaBankTransferPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::SepaBankTransferPayments))
}
def sepa_bank_transfer_payments=(_sepa_bank_transfer_payments); end
# Allow the merchant to process SEPA Direct Debit payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::SepaDebitPayments))
}
def sepa_debit_payments; end
sig {
params(_sepa_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::SepaDebitPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::SepaDebitPayments))
}
def sepa_debit_payments=(_sepa_debit_payments); end
# Allow the merchant to process Swish payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::SwishPayments))
}
def swish_payments; end
sig {
params(_swish_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::SwishPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::SwishPayments))
}
def swish_payments=(_swish_payments); end
# Allow the merchant to process TWINT payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::TwintPayments))
}
def twint_payments; end
sig {
params(_twint_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::TwintPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::TwintPayments))
}
def twint_payments=(_twint_payments); end
# Allow the merchant to process US bank transfer payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::UsBankTransferPayments))
}
def us_bank_transfer_payments; end
sig {
params(_us_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::UsBankTransferPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::UsBankTransferPayments))
}
def us_bank_transfer_payments=(_us_bank_transfer_payments); end
# Allow the merchant to process Zip payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::ZipPayments))
}
def zip_payments; end
sig {
params(_zip_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::ZipPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::ZipPayments))
}
def zip_payments=(_zip_payments); end
sig {
params(ach_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AchDebitPayments), acss_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AcssDebitPayments), affirm_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AffirmPayments), afterpay_clearpay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AfterpayClearpayPayments), alma_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AlmaPayments), amazon_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AmazonPayPayments), au_becs_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::AuBecsDebitPayments), bacs_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::BacsDebitPayments), bancontact_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::BancontactPayments), blik_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::BlikPayments), boleto_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::BoletoPayments), card_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::CardPayments), cartes_bancaires_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::CartesBancairesPayments), cashapp_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::CashappPayments), eps_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::EpsPayments), fpx_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::FpxPayments), gb_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::GbBankTransferPayments), grabpay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::GrabpayPayments), ideal_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::IdealPayments), jcb_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::JcbPayments), jp_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::JpBankTransferPayments), kakao_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::KakaoPayPayments), klarna_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::KlarnaPayments), konbini_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::KonbiniPayments), kr_card_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::KrCardPayments), link_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::LinkPayments), mobilepay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::MobilepayPayments), multibanco_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::MultibancoPayments), mx_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::MxBankTransferPayments), naver_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::NaverPayPayments), oxxo_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::OxxoPayments), p24_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::P24Payments), pay_by_bank_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::PayByBankPayments), payco_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::PaycoPayments), paynow_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::PaynowPayments), promptpay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::PromptpayPayments), revolut_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::RevolutPayPayments), samsung_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::SamsungPayPayments), sepa_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::SepaBankTransferPayments), sepa_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::SepaDebitPayments), swish_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::SwishPayments), twint_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::TwintPayments), us_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::UsBankTransferPayments), zip_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities::ZipPayments)).void
}
def initialize(
ach_debit_payments: nil,
acss_debit_payments: nil,
affirm_payments: nil,
afterpay_clearpay_payments: nil,
alma_payments: nil,
amazon_pay_payments: nil,
au_becs_debit_payments: nil,
bacs_debit_payments: nil,
bancontact_payments: nil,
blik_payments: nil,
boleto_payments: nil,
card_payments: nil,
cartes_bancaires_payments: nil,
cashapp_payments: nil,
eps_payments: nil,
fpx_payments: nil,
gb_bank_transfer_payments: nil,
grabpay_payments: nil,
ideal_payments: nil,
jcb_payments: nil,
jp_bank_transfer_payments: nil,
kakao_pay_payments: nil,
klarna_payments: nil,
konbini_payments: nil,
kr_card_payments: nil,
link_payments: nil,
mobilepay_payments: nil,
multibanco_payments: nil,
mx_bank_transfer_payments: nil,
naver_pay_payments: nil,
oxxo_payments: nil,
p24_payments: nil,
pay_by_bank_payments: nil,
payco_payments: nil,
paynow_payments: nil,
promptpay_payments: nil,
revolut_pay_payments: nil,
samsung_pay_payments: nil,
sepa_bank_transfer_payments: nil,
sepa_debit_payments: nil,
swish_payments: nil,
twint_payments: nil,
us_bank_transfer_payments: nil,
zip_payments: nil
); end
end
class CardPayments < Stripe::RequestParams
class DeclineOn < Stripe::RequestParams
# Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.
sig { returns(T.nilable(T::Boolean)) }
def avs_failure; end
sig { params(_avs_failure: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def avs_failure=(_avs_failure); end
# Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.
sig { returns(T.nilable(T::Boolean)) }
def cvc_failure; end
sig { params(_cvc_failure: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def cvc_failure=(_cvc_failure); end
sig {
params(avs_failure: T.nilable(T::Boolean), cvc_failure: T.nilable(T::Boolean)).void
}
def initialize(avs_failure: nil, cvc_failure: nil); end
end
# Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::CardPayments::DeclineOn))
}
def decline_on; end
sig {
params(_decline_on: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::CardPayments::DeclineOn)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::CardPayments::DeclineOn))
}
def decline_on=(_decline_on); end
sig {
params(decline_on: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::CardPayments::DeclineOn)).void
}
def initialize(decline_on: nil); end
end
class StatementDescriptor < Stripe::RequestParams
# The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don’t set a statement_descriptor_prefix, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the statement_descriptor text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation.
sig { returns(T.nilable(String)) }
def descriptor; end
sig { params(_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def descriptor=(_descriptor); end
# Default text that appears on statements for card charges outside of Japan, prefixing any dynamic statement_descriptor_suffix specified on the charge. To maximize space for the dynamic part of the descriptor, keep this text short. If you don’t specify this value, statement_descriptor is used as the prefix. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation.
sig { returns(T.nilable(String)) }
def prefix; end
sig { params(_prefix: T.nilable(String)).returns(T.nilable(String)) }
def prefix=(_prefix); end
sig { params(descriptor: T.nilable(String), prefix: T.nilable(String)).void }
def initialize(descriptor: nil, prefix: nil); end
end
class Support < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
# A publicly available mailing address for sending support issues to.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Support::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Support::Address)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Support::Address))
}
def address=(_address); end
# A publicly available email address for sending support issues to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# A publicly available phone number to call with support issues.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# A publicly available website for handling support issues.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(address: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Support::Address), email: T.nilable(String), phone: T.nilable(String), url: T.nilable(String)).void
}
def initialize(address: nil, email: nil, phone: nil, url: nil); end
end
# Settings used for Bacs debit payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::BacsDebitPayments))
}
def bacs_debit_payments; end
sig {
params(_bacs_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::BacsDebitPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::BacsDebitPayments))
}
def bacs_debit_payments=(_bacs_debit_payments); end
# Settings used to apply the merchant's branding to email receipts, invoices, Checkout, and other products.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Branding))
}
def branding; end
sig {
params(_branding: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Branding)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Branding))
}
def branding=(_branding); end
# Capabilities to request on the Merchant Configuration.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities))
}
def capabilities; end
sig {
params(_capabilities: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities))
}
def capabilities=(_capabilities); end
# Card payments settings.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::CardPayments))
}
def card_payments; end
sig {
params(_card_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::CardPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::CardPayments))
}
def card_payments=(_card_payments); end
# The merchant category code for the Merchant Configuration. MCCs are used to classify businesses based on the goods or services they provide.
sig { returns(T.nilable(String)) }
def mcc; end
sig { params(_mcc: T.nilable(String)).returns(T.nilable(String)) }
def mcc=(_mcc); end
# Statement descriptor.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::StatementDescriptor))
}
def statement_descriptor; end
sig {
params(_statement_descriptor: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::StatementDescriptor)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::StatementDescriptor))
}
def statement_descriptor=(_statement_descriptor); end
# Publicly available contact information for sending support issues to.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Support))
}
def support; end
sig {
params(_support: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Support)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Support))
}
def support=(_support); end
sig {
params(bacs_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::BacsDebitPayments), branding: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Branding), capabilities: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Capabilities), card_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::CardPayments), mcc: T.nilable(String), statement_descriptor: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::StatementDescriptor), support: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant::Support)).void
}
def initialize(
bacs_debit_payments: nil,
branding: nil,
capabilities: nil,
card_payments: nil,
mcc: nil,
statement_descriptor: nil,
support: nil
); end
end
class Recipient < Stripe::RequestParams
class Capabilities < Stripe::RequestParams
class BankAccounts < Stripe::RequestParams
class Local < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class Wire < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Enables this Account to receive OutboundPayments to linked bank accounts over local networks.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::BankAccounts::Local))
}
def local; end
sig {
params(_local: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::BankAccounts::Local)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::BankAccounts::Local))
}
def local=(_local); end
# Enables this Account to receive OutboundPayments to linked bank accounts over wire.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::BankAccounts::Wire))
}
def wire; end
sig {
params(_wire: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::BankAccounts::Wire)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::BankAccounts::Wire))
}
def wire=(_wire); end
sig {
params(local: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::BankAccounts::Local), wire: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::BankAccounts::Wire)).void
}
def initialize(local: nil, wire: nil); end
end
class Cards < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class StripeBalance < Stripe::RequestParams
class StripeTransfers < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Allows the account to receive /v1/transfers into their Stripe Balance (/v1/balance).
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::StripeBalance::StripeTransfers))
}
def stripe_transfers; end
sig {
params(_stripe_transfers: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::StripeBalance::StripeTransfers)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::StripeBalance::StripeTransfers))
}
def stripe_transfers=(_stripe_transfers); end
sig {
params(stripe_transfers: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::StripeBalance::StripeTransfers)).void
}
def initialize(stripe_transfers: nil); end
end
# Capabilities that enable OutboundPayments to a bank account linked to this Account.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::BankAccounts))
}
def bank_accounts; end
sig {
params(_bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::BankAccounts)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::BankAccounts))
}
def bank_accounts=(_bank_accounts); end
# Capabilities that enable OutboundPayments to a card linked to this Account.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::Cards))
}
def cards; end
sig {
params(_cards: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::Cards)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::Cards))
}
def cards=(_cards); end
# Capabilities that enable the recipient to manage their Stripe Balance (/v1/balance).
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::StripeBalance))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::StripeBalance)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
sig {
params(bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::BankAccounts), cards: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::Cards), stripe_balance: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities::StripeBalance)).void
}
def initialize(bank_accounts: nil, cards: nil, stripe_balance: nil); end
end
# Capabilities to be requested on the Recipient Configuration.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities))
}
def capabilities; end
sig {
params(_capabilities: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities))
}
def capabilities=(_capabilities); end
sig {
params(capabilities: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient::Capabilities)).void
}
def initialize(capabilities: nil); end
end
class Storer < Stripe::RequestParams
class Capabilities < Stripe::RequestParams
class FinancialAddresses < Stripe::RequestParams
class BankAccounts < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Can provision a bank-account-like financial address (VBAN) to credit/debit a FinancialAccount.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::FinancialAddresses::BankAccounts))
}
def bank_accounts; end
sig {
params(_bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::FinancialAddresses::BankAccounts)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::FinancialAddresses::BankAccounts))
}
def bank_accounts=(_bank_accounts); end
sig {
params(bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::FinancialAddresses::BankAccounts)).void
}
def initialize(bank_accounts: nil); end
end
class HoldsCurrencies < Stripe::RequestParams
class Gbp < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Can hold storage-type funds on Stripe in GBP.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::HoldsCurrencies::Gbp))
}
def gbp; end
sig {
params(_gbp: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::HoldsCurrencies::Gbp)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::HoldsCurrencies::Gbp))
}
def gbp=(_gbp); end
sig {
params(gbp: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::HoldsCurrencies::Gbp)).void
}
def initialize(gbp: nil); end
end
class InboundTransfers < Stripe::RequestParams
class BankAccounts < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Can pull funds from an external bank account owned by yourself to a FinancialAccount.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::InboundTransfers::BankAccounts))
}
def bank_accounts; end
sig {
params(_bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::InboundTransfers::BankAccounts)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::InboundTransfers::BankAccounts))
}
def bank_accounts=(_bank_accounts); end
sig {
params(bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::InboundTransfers::BankAccounts)).void
}
def initialize(bank_accounts: nil); end
end
class OutboundPayments < Stripe::RequestParams
class BankAccounts < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class Cards < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class FinancialAccounts < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Can send funds from a FinancialAccount to a bank account owned by someone else.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundPayments::BankAccounts))
}
def bank_accounts; end
sig {
params(_bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundPayments::BankAccounts)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundPayments::BankAccounts))
}
def bank_accounts=(_bank_accounts); end
# Can send funds from a FinancialAccount to a debit card owned by someone else.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundPayments::Cards))
}
def cards; end
sig {
params(_cards: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundPayments::Cards)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundPayments::Cards))
}
def cards=(_cards); end
# Can send funds from a FinancialAccount to another FinancialAccount owned by someone else.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundPayments::FinancialAccounts))
}
def financial_accounts; end
sig {
params(_financial_accounts: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundPayments::FinancialAccounts)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundPayments::FinancialAccounts))
}
def financial_accounts=(_financial_accounts); end
sig {
params(bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundPayments::BankAccounts), cards: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundPayments::Cards), financial_accounts: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundPayments::FinancialAccounts)).void
}
def initialize(bank_accounts: nil, cards: nil, financial_accounts: nil); end
end
class OutboundTransfers < Stripe::RequestParams
class BankAccounts < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
class FinancialAccounts < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T::Boolean) }
def requested; end
sig { params(_requested: T::Boolean).returns(T::Boolean) }
def requested=(_requested); end
sig { params(requested: T::Boolean).void }
def initialize(requested: nil); end
end
# Can send funds from a FinancialAccount to a bank account owned by yourself.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundTransfers::BankAccounts))
}
def bank_accounts; end
sig {
params(_bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundTransfers::BankAccounts)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundTransfers::BankAccounts))
}
def bank_accounts=(_bank_accounts); end
# Can send funds from a FinancialAccount to another FinancialAccount owned by yourself.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundTransfers::FinancialAccounts))
}
def financial_accounts; end
sig {
params(_financial_accounts: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundTransfers::FinancialAccounts)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundTransfers::FinancialAccounts))
}
def financial_accounts=(_financial_accounts); end
sig {
params(bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundTransfers::BankAccounts), financial_accounts: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundTransfers::FinancialAccounts)).void
}
def initialize(bank_accounts: nil, financial_accounts: nil); end
end
# Can provision a financial address to credit/debit a FinancialAccount.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::FinancialAddresses))
}
def financial_addresses; end
sig {
params(_financial_addresses: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::FinancialAddresses)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::FinancialAddresses))
}
def financial_addresses=(_financial_addresses); end
# Can hold storage-type funds on Stripe.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::HoldsCurrencies))
}
def holds_currencies; end
sig {
params(_holds_currencies: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::HoldsCurrencies)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::HoldsCurrencies))
}
def holds_currencies=(_holds_currencies); end
# Can pull funds from an external source, owned by yourself, to a FinancialAccount.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::InboundTransfers))
}
def inbound_transfers; end
sig {
params(_inbound_transfers: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::InboundTransfers)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::InboundTransfers))
}
def inbound_transfers=(_inbound_transfers); end
# Can send funds from a FinancialAccount to a destination owned by someone else.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundPayments))
}
def outbound_payments; end
sig {
params(_outbound_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundPayments))
}
def outbound_payments=(_outbound_payments); end
# Can send funds from a FinancialAccount to a destination owned by yourself.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundTransfers))
}
def outbound_transfers; end
sig {
params(_outbound_transfers: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundTransfers)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundTransfers))
}
def outbound_transfers=(_outbound_transfers); end
sig {
params(financial_addresses: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::FinancialAddresses), holds_currencies: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::HoldsCurrencies), inbound_transfers: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::InboundTransfers), outbound_payments: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundPayments), outbound_transfers: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities::OutboundTransfers)).void
}
def initialize(
financial_addresses: nil,
holds_currencies: nil,
inbound_transfers: nil,
outbound_payments: nil,
outbound_transfers: nil
); end
end
# Capabilities to request on the Storer Configuration.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities))
}
def capabilities; end
sig {
params(_capabilities: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities))
}
def capabilities=(_capabilities); end
sig {
params(capabilities: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer::Capabilities)).void
}
def initialize(capabilities: nil); end
end
# The Customer Configuration allows the Account to be used in inbound payment flows.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer))
}
def customer; end
sig {
params(_customer: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer))
}
def customer=(_customer); end
# The Merchant configuration allows the Account to act as a connected account and collect payments facilitated by a Connect platform. You can add this configuration to your connected accounts only if you’ve completed onboarding as a Connect platform.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant))
}
def merchant; end
sig {
params(_merchant: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant))
}
def merchant=(_merchant); end
# The Recipient Configuration allows the Account to receive funds.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient))
}
def recipient=(_recipient); end
# The Storer Configuration allows the Account to store and move funds using stored-value FinancialAccounts.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer))
}
def storer; end
sig {
params(_storer: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer))
}
def storer=(_storer); end
sig {
params(customer: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Customer), merchant: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Merchant), recipient: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Recipient), storer: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration::Storer)).void
}
def initialize(customer: nil, merchant: nil, recipient: nil, storer: nil); end
end
class Defaults < Stripe::RequestParams
class Responsibilities < Stripe::RequestParams
# A value indicating the party responsible for collecting fees from this account.
sig { returns(String) }
def fees_collector; end
sig { params(_fees_collector: String).returns(String) }
def fees_collector=(_fees_collector); end
# A value indicating who is responsible for losses when this Account can’t pay back negative balances from payments.
sig { returns(String) }
def losses_collector; end
sig { params(_losses_collector: String).returns(String) }
def losses_collector=(_losses_collector); end
sig { params(fees_collector: String, losses_collector: String).void }
def initialize(fees_collector: nil, losses_collector: nil); end
end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The Account's preferred locales (languages), ordered by preference.
sig { returns(T.nilable(T::Array[String])) }
def locales; end
sig {
params(_locales: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def locales=(_locales); end
# Default responsibilities held by either Stripe or the platform.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Defaults::Responsibilities))
}
def responsibilities; end
sig {
params(_responsibilities: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Defaults::Responsibilities)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Defaults::Responsibilities))
}
def responsibilities=(_responsibilities); end
sig {
params(currency: T.nilable(String), locales: T.nilable(T::Array[String]), responsibilities: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Defaults::Responsibilities)).void
}
def initialize(currency: nil, locales: nil, responsibilities: nil); end
end
class Identity < Stripe::RequestParams
class Attestations < Stripe::RequestParams
class DirectorshipDeclaration < Stripe::RequestParams
# The time marking when the director attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def date; end
sig { params(_date: T.nilable(String)).returns(T.nilable(String)) }
def date=(_date); end
# The IP address from which the director attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the director attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(String), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class OwnershipDeclaration < Stripe::RequestParams
# The time marking when the beneficial owner attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def date; end
sig { params(_date: T.nilable(String)).returns(T.nilable(String)) }
def date=(_date); end
# The IP address from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(String), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class PersonsProvided < Stripe::RequestParams
# Whether the company’s directors have been provided. Set this Boolean to true after creating all the company’s directors with the [Persons API](https://docs.stripe.com/api/v2/core/accounts/createperson).
sig { returns(T.nilable(T::Boolean)) }
def directors; end
sig { params(_directors: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def directors=(_directors); end
# Whether the company’s executives have been provided. Set this Boolean to true after creating all the company’s executives with the [Persons API](https://docs.stripe.com/api/v2/core/accounts/createperson).
sig { returns(T.nilable(T::Boolean)) }
def executives; end
sig { params(_executives: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executives=(_executives); end
# Whether the company’s owners have been provided. Set this Boolean to true after creating all the company’s owners with the [Persons API](https://docs.stripe.com/api/v2/core/accounts/createperson).
sig { returns(T.nilable(T::Boolean)) }
def owners; end
sig { params(_owners: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owners=(_owners); end
# Reason for why the company is exempt from providing ownership information.
sig { returns(T.nilable(String)) }
def ownership_exemption_reason; end
sig {
params(_ownership_exemption_reason: T.nilable(String)).returns(T.nilable(String))
}
def ownership_exemption_reason=(_ownership_exemption_reason); end
sig {
params(directors: T.nilable(T::Boolean), executives: T.nilable(T::Boolean), owners: T.nilable(T::Boolean), ownership_exemption_reason: T.nilable(String)).void
}
def initialize(
directors: nil,
executives: nil,
owners: nil,
ownership_exemption_reason: nil
); end
end
class TermsOfService < Stripe::RequestParams
class Account < Stripe::RequestParams
# The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
# The IP address from which the Account's representative accepted the terms of service.
sig { returns(String) }
def ip; end
sig { params(_ip: String).returns(String) }
def ip=(_ip); end
# The user agent of the browser from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig { params(date: String, ip: String, user_agent: T.nilable(String)).void }
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class Storer < Stripe::RequestParams
# The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
# The IP address from which the Account's representative accepted the terms of service.
sig { returns(String) }
def ip; end
sig { params(_ip: String).returns(String) }
def ip=(_ip); end
# The user agent of the browser from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig { params(date: String, ip: String, user_agent: T.nilable(String)).void }
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Details on the Account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance).
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::TermsOfService::Account))
}
def account; end
sig {
params(_account: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::TermsOfService::Account)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::TermsOfService::Account))
}
def account=(_account); end
# Details on the Account's acceptance of Treasury-specific terms of service.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::TermsOfService::Storer))
}
def storer; end
sig {
params(_storer: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::TermsOfService::Storer)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::TermsOfService::Storer))
}
def storer=(_storer); end
sig {
params(account: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::TermsOfService::Account), storer: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::TermsOfService::Storer)).void
}
def initialize(account: nil, storer: nil); end
end
# This hash is used to attest that the directors information provided to Stripe is both current and correct.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::DirectorshipDeclaration))
}
def directorship_declaration; end
sig {
params(_directorship_declaration: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::DirectorshipDeclaration)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::DirectorshipDeclaration))
}
def directorship_declaration=(_directorship_declaration); end
# This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::OwnershipDeclaration))
}
def ownership_declaration; end
sig {
params(_ownership_declaration: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::OwnershipDeclaration)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::OwnershipDeclaration))
}
def ownership_declaration=(_ownership_declaration); end
# Attestation that all Persons with a specific Relationship value have been provided.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::PersonsProvided))
}
def persons_provided; end
sig {
params(_persons_provided: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::PersonsProvided)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::PersonsProvided))
}
def persons_provided=(_persons_provided); end
# Attestations of accepted terms of service agreements.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::TermsOfService))
}
def terms_of_service; end
sig {
params(_terms_of_service: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::TermsOfService)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::TermsOfService))
}
def terms_of_service=(_terms_of_service); end
sig {
params(directorship_declaration: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::DirectorshipDeclaration), ownership_declaration: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::OwnershipDeclaration), persons_provided: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::PersonsProvided), terms_of_service: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations::TermsOfService)).void
}
def initialize(
directorship_declaration: nil,
ownership_declaration: nil,
persons_provided: nil,
terms_of_service: nil
); end
end
class BusinessDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AnnualRevenue < Stripe::RequestParams
# A non-negative integer representing the amount in the smallest currency unit.
sig { returns(T.nilable(Stripe::V2::Amount)) }
def amount; end
sig {
params(_amount: T.nilable(Stripe::V2::Amount)).returns(T.nilable(Stripe::V2::Amount))
}
def amount=(_amount); end
# The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
sig { returns(T.nilable(String)) }
def fiscal_year_end; end
sig { params(_fiscal_year_end: T.nilable(String)).returns(T.nilable(String)) }
def fiscal_year_end=(_fiscal_year_end); end
sig {
params(amount: T.nilable(Stripe::V2::Amount), fiscal_year_end: T.nilable(String)).void
}
def initialize(amount: nil, fiscal_year_end: nil); end
end
class Documents < Stripe::RequestParams
class BankAccountOwnershipVerification < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class CompanyLicense < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class CompanyMemorandumOfAssociation < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class CompanyMinisterialDecree < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class CompanyRegistrationVerification < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class CompanyTaxIdVerification < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class PrimaryVerification < Stripe::RequestParams
class FrontBack < Stripe::RequestParams
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(String) }
def front; end
sig { params(_front: String).returns(String) }
def front=(_front); end
sig { params(back: T.nilable(String), front: String).void }
def initialize(back: nil, front: nil); end
end
# The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
sig {
returns(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::PrimaryVerification::FrontBack)
}
def front_back; end
sig {
params(_front_back: ::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::PrimaryVerification::FrontBack).returns(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::PrimaryVerification::FrontBack)
}
def front_back=(_front_back); end
# The format of the verification document. Currently supports `front_back` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(front_back: ::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::PrimaryVerification::FrontBack, type: String).void
}
def initialize(front_back: nil, type: nil); end
end
class ProofOfAddress < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class ProofOfRegistration < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class ProofOfUltimateBeneficialOwnership < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
# One or more documents that support the bank account ownership verification requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::BankAccountOwnershipVerification))
}
def bank_account_ownership_verification; end
sig {
params(_bank_account_ownership_verification: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::BankAccountOwnershipVerification)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::BankAccountOwnershipVerification))
}
def bank_account_ownership_verification=(_bank_account_ownership_verification); end
# One or more documents that demonstrate proof of a company’s license to operate.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyLicense))
}
def company_license; end
sig {
params(_company_license: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyLicense)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyLicense))
}
def company_license=(_company_license); end
# One or more documents showing the company’s Memorandum of Association.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyMemorandumOfAssociation))
}
def company_memorandum_of_association; end
sig {
params(_company_memorandum_of_association: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyMemorandumOfAssociation)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyMemorandumOfAssociation))
}
def company_memorandum_of_association=(_company_memorandum_of_association); end
# Certain countries only: One or more documents showing the ministerial decree legalizing the company’s establishment.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyMinisterialDecree))
}
def company_ministerial_decree; end
sig {
params(_company_ministerial_decree: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyMinisterialDecree)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyMinisterialDecree))
}
def company_ministerial_decree=(_company_ministerial_decree); end
# One or more documents that demonstrate proof of a company’s registration with the appropriate local authorities.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyRegistrationVerification))
}
def company_registration_verification; end
sig {
params(_company_registration_verification: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyRegistrationVerification)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyRegistrationVerification))
}
def company_registration_verification=(_company_registration_verification); end
# One or more documents that demonstrate proof of a company’s tax ID.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyTaxIdVerification))
}
def company_tax_id_verification; end
sig {
params(_company_tax_id_verification: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyTaxIdVerification)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyTaxIdVerification))
}
def company_tax_id_verification=(_company_tax_id_verification); end
# A document verifying the business.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::PrimaryVerification))
}
def primary_verification; end
sig {
params(_primary_verification: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::PrimaryVerification)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::PrimaryVerification))
}
def primary_verification=(_primary_verification); end
# One or more documents that demonstrate proof of address.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::ProofOfAddress))
}
def proof_of_address; end
sig {
params(_proof_of_address: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::ProofOfAddress)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::ProofOfAddress))
}
def proof_of_address=(_proof_of_address); end
# One or more documents showing the company’s proof of registration with the national business registry.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::ProofOfRegistration))
}
def proof_of_registration; end
sig {
params(_proof_of_registration: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::ProofOfRegistration)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::ProofOfRegistration))
}
def proof_of_registration=(_proof_of_registration); end
# One or more documents that demonstrate proof of ultimate beneficial ownership.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::ProofOfUltimateBeneficialOwnership))
}
def proof_of_ultimate_beneficial_ownership; end
sig {
params(_proof_of_ultimate_beneficial_ownership: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::ProofOfUltimateBeneficialOwnership)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::ProofOfUltimateBeneficialOwnership))
}
def proof_of_ultimate_beneficial_ownership=(
_proof_of_ultimate_beneficial_ownership
); end
sig {
params(bank_account_ownership_verification: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::BankAccountOwnershipVerification), company_license: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyLicense), company_memorandum_of_association: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyMemorandumOfAssociation), company_ministerial_decree: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyMinisterialDecree), company_registration_verification: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyRegistrationVerification), company_tax_id_verification: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::CompanyTaxIdVerification), primary_verification: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::PrimaryVerification), proof_of_address: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::ProofOfAddress), proof_of_registration: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::ProofOfRegistration), proof_of_ultimate_beneficial_ownership: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents::ProofOfUltimateBeneficialOwnership)).void
}
def initialize(
bank_account_ownership_verification: nil,
company_license: nil,
company_memorandum_of_association: nil,
company_ministerial_decree: nil,
company_registration_verification: nil,
company_tax_id_verification: nil,
primary_verification: nil,
proof_of_address: nil,
proof_of_registration: nil,
proof_of_ultimate_beneficial_ownership: nil
); end
end
class IdNumber < Stripe::RequestParams
# The registrar of the ID number (Only valid for DE ID number types).
sig { returns(T.nilable(String)) }
def registrar; end
sig { params(_registrar: T.nilable(String)).returns(T.nilable(String)) }
def registrar=(_registrar); end
# Open Enum. The ID number type of a business entity.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The value of the ID number.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(registrar: T.nilable(String), type: String, value: String).void }
def initialize(registrar: nil, type: nil, value: nil); end
end
class MonthlyEstimatedRevenue < Stripe::RequestParams
# A non-negative integer representing the amount in the smallest currency unit.
sig { returns(T.nilable(Stripe::V2::Amount)) }
def amount; end
sig {
params(_amount: T.nilable(Stripe::V2::Amount)).returns(T.nilable(Stripe::V2::Amount))
}
def amount=(_amount); end
sig { params(amount: T.nilable(Stripe::V2::Amount)).void }
def initialize(amount: nil); end
end
class ScriptAddresses < Stripe::RequestParams
class Kana < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class Kanji < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
# Kana Address.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptAddresses::Kana))
}
def kana; end
sig {
params(_kana: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptAddresses::Kana)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptAddresses::Kana))
}
def kana=(_kana); end
# Kanji Address.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptAddresses::Kanji))
}
def kanji; end
sig {
params(_kanji: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptAddresses::Kanji)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptAddresses::Kanji))
}
def kanji=(_kanji); end
sig {
params(kana: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptAddresses::Kana), kanji: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptAddresses::Kanji)).void
}
def initialize(kana: nil, kanji: nil); end
end
class ScriptNames < Stripe::RequestParams
class Kana < Stripe::RequestParams
# Registered name of the business.
sig { returns(T.nilable(String)) }
def registered_name; end
sig { params(_registered_name: T.nilable(String)).returns(T.nilable(String)) }
def registered_name=(_registered_name); end
sig { params(registered_name: T.nilable(String)).void }
def initialize(registered_name: nil); end
end
class Kanji < Stripe::RequestParams
# Registered name of the business.
sig { returns(T.nilable(String)) }
def registered_name; end
sig { params(_registered_name: T.nilable(String)).returns(T.nilable(String)) }
def registered_name=(_registered_name); end
sig { params(registered_name: T.nilable(String)).void }
def initialize(registered_name: nil); end
end
# Kana name.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptNames::Kana))
}
def kana; end
sig {
params(_kana: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptNames::Kana)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptNames::Kana))
}
def kana=(_kana); end
# Kanji name.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptNames::Kanji))
}
def kanji; end
sig {
params(_kanji: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptNames::Kanji)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptNames::Kanji))
}
def kanji=(_kanji); end
sig {
params(kana: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptNames::Kana), kanji: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptNames::Kanji)).void
}
def initialize(kana: nil, kanji: nil); end
end
# The business registration address of the business entity.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Address)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Address))
}
def address=(_address); end
# The business gross annual revenue for its preceding fiscal year.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::AnnualRevenue))
}
def annual_revenue; end
sig {
params(_annual_revenue: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::AnnualRevenue)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::AnnualRevenue))
}
def annual_revenue=(_annual_revenue); end
# A document verifying the business.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents))
}
def documents; end
sig {
params(_documents: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents))
}
def documents=(_documents); end
# The name which is used by the business.
sig { returns(T.nilable(String)) }
def doing_business_as; end
sig { params(_doing_business_as: T.nilable(String)).returns(T.nilable(String)) }
def doing_business_as=(_doing_business_as); end
# An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
sig { returns(T.nilable(Integer)) }
def estimated_worker_count; end
sig {
params(_estimated_worker_count: T.nilable(Integer)).returns(T.nilable(Integer))
}
def estimated_worker_count=(_estimated_worker_count); end
# The ID numbers of a business entity.
sig {
returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::IdNumber]))
}
def id_numbers; end
sig {
params(_id_numbers: T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::IdNumber])).returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::IdNumber]))
}
def id_numbers=(_id_numbers); end
# An estimate of the monthly revenue of the business.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::MonthlyEstimatedRevenue))
}
def monthly_estimated_revenue; end
sig {
params(_monthly_estimated_revenue: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::MonthlyEstimatedRevenue)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::MonthlyEstimatedRevenue))
}
def monthly_estimated_revenue=(_monthly_estimated_revenue); end
# The phone number of the Business Entity.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# The business legal name.
sig { returns(T.nilable(String)) }
def registered_name; end
sig { params(_registered_name: T.nilable(String)).returns(T.nilable(String)) }
def registered_name=(_registered_name); end
# The business registration address of the business entity in non latin script.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptAddresses))
}
def script_addresses; end
sig {
params(_script_addresses: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptAddresses)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptAddresses))
}
def script_addresses=(_script_addresses); end
# The business legal name in non latin script.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptNames))
}
def script_names; end
sig {
params(_script_names: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptNames)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptNames))
}
def script_names=(_script_names); end
# The category identifying the legal structure of the business.
sig { returns(T.nilable(String)) }
def structure; end
sig { params(_structure: T.nilable(String)).returns(T.nilable(String)) }
def structure=(_structure); end
# The business's publicly available website.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(address: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Address), annual_revenue: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::AnnualRevenue), documents: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::Documents), doing_business_as: T.nilable(String), estimated_worker_count: T.nilable(Integer), id_numbers: T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::IdNumber]), monthly_estimated_revenue: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::MonthlyEstimatedRevenue), phone: T.nilable(String), product_description: T.nilable(String), registered_name: T.nilable(String), script_addresses: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptAddresses), script_names: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails::ScriptNames), structure: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
address: nil,
annual_revenue: nil,
documents: nil,
doing_business_as: nil,
estimated_worker_count: nil,
id_numbers: nil,
monthly_estimated_revenue: nil,
phone: nil,
product_description: nil,
registered_name: nil,
script_addresses: nil,
script_names: nil,
structure: nil,
url: nil
); end
end
class Individual < Stripe::RequestParams
class AdditionalAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Purpose of additional address.
sig { returns(String) }
def purpose; end
sig { params(_purpose: String).returns(String) }
def purpose=(_purpose); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), purpose: String, state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
purpose: nil,
state: nil,
town: nil
); end
end
class AdditionalName < Stripe::RequestParams
# The person's full name.
sig { returns(T.nilable(String)) }
def full_name; end
sig { params(_full_name: T.nilable(String)).returns(T.nilable(String)) }
def full_name=(_full_name); end
# The person's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
sig { params(_given_name: T.nilable(String)).returns(T.nilable(String)) }
def given_name=(_given_name); end
# The purpose or type of the additional name.
sig { returns(String) }
def purpose; end
sig { params(_purpose: String).returns(String) }
def purpose=(_purpose); end
# The person's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
sig { params(_surname: T.nilable(String)).returns(T.nilable(String)) }
def surname=(_surname); end
sig {
params(full_name: T.nilable(String), given_name: T.nilable(String), purpose: String, surname: T.nilable(String)).void
}
def initialize(full_name: nil, given_name: nil, purpose: nil, surname: nil); end
end
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class DateOfBirth < Stripe::RequestParams
# The day of birth.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Documents < Stripe::RequestParams
class CompanyAuthorization < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class Passport < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class PrimaryVerification < Stripe::RequestParams
class FrontBack < Stripe::RequestParams
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(String) }
def front; end
sig { params(_front: String).returns(String) }
def front=(_front); end
sig { params(back: T.nilable(String), front: String).void }
def initialize(back: nil, front: nil); end
end
# The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
sig {
returns(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::PrimaryVerification::FrontBack)
}
def front_back; end
sig {
params(_front_back: ::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::PrimaryVerification::FrontBack).returns(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::PrimaryVerification::FrontBack)
}
def front_back=(_front_back); end
# The format of the verification document. Currently supports `front_back` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(front_back: ::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::PrimaryVerification::FrontBack, type: String).void
}
def initialize(front_back: nil, type: nil); end
end
class SecondaryVerification < Stripe::RequestParams
class FrontBack < Stripe::RequestParams
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(String) }
def front; end
sig { params(_front: String).returns(String) }
def front=(_front); end
sig { params(back: T.nilable(String), front: String).void }
def initialize(back: nil, front: nil); end
end
# The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
sig {
returns(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::SecondaryVerification::FrontBack)
}
def front_back; end
sig {
params(_front_back: ::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::SecondaryVerification::FrontBack).returns(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::SecondaryVerification::FrontBack)
}
def front_back=(_front_back); end
# The format of the verification document. Currently supports `front_back` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(front_back: ::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::SecondaryVerification::FrontBack, type: String).void
}
def initialize(front_back: nil, type: nil); end
end
class Visa < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
# One or more documents that demonstrate proof that this person is authorized to represent the company.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::CompanyAuthorization))
}
def company_authorization; end
sig {
params(_company_authorization: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::CompanyAuthorization)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::CompanyAuthorization))
}
def company_authorization=(_company_authorization); end
# One or more documents showing the person’s passport page with photo and personal data.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::Passport))
}
def passport; end
sig {
params(_passport: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::Passport)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::Passport))
}
def passport=(_passport); end
# An identifying document showing the person's name, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::PrimaryVerification))
}
def primary_verification; end
sig {
params(_primary_verification: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::PrimaryVerification)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::PrimaryVerification))
}
def primary_verification=(_primary_verification); end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::SecondaryVerification))
}
def secondary_verification; end
sig {
params(_secondary_verification: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::SecondaryVerification)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::SecondaryVerification))
}
def secondary_verification=(_secondary_verification); end
# One or more documents showing the person’s visa required for living in the country where they are residing.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::Visa))
}
def visa; end
sig {
params(_visa: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::Visa)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::Visa))
}
def visa=(_visa); end
sig {
params(company_authorization: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::CompanyAuthorization), passport: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::Passport), primary_verification: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::PrimaryVerification), secondary_verification: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::SecondaryVerification), visa: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents::Visa)).void
}
def initialize(
company_authorization: nil,
passport: nil,
primary_verification: nil,
secondary_verification: nil,
visa: nil
); end
end
class IdNumber < Stripe::RequestParams
# The ID number type of an individual.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The value of the ID number.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(type: String, value: String).void }
def initialize(type: nil, value: nil); end
end
class Relationship < Stripe::RequestParams
# Whether the person is a director of the account's identity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
sig { returns(T.nilable(T::Boolean)) }
def director; end
sig { params(_director: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def director=(_director); end
# Whether the person has significant responsibility to control, manage, or direct the organization.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
sig { params(_executive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executive=(_executive); end
# Whether the person is an owner of the account’s identity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
sig { params(_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owner=(_owner); end
# The percent owned by the person of the account's legal entity.
sig { returns(T.nilable(String)) }
def percent_ownership; end
sig { params(_percent_ownership: T.nilable(String)).returns(T.nilable(String)) }
def percent_ownership=(_percent_ownership); end
# The person's title (e.g., CEO, Support Engineer).
sig { returns(T.nilable(String)) }
def title; end
sig { params(_title: T.nilable(String)).returns(T.nilable(String)) }
def title=(_title); end
sig {
params(director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), percent_ownership: T.nilable(String), title: T.nilable(String)).void
}
def initialize(
director: nil,
executive: nil,
owner: nil,
percent_ownership: nil,
title: nil
); end
end
class ScriptAddresses < Stripe::RequestParams
class Kana < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class Kanji < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
# Kana Address.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptAddresses::Kana))
}
def kana; end
sig {
params(_kana: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptAddresses::Kana)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptAddresses::Kana))
}
def kana=(_kana); end
# Kanji Address.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptAddresses::Kanji))
}
def kanji; end
sig {
params(_kanji: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptAddresses::Kanji)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptAddresses::Kanji))
}
def kanji=(_kanji); end
sig {
params(kana: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptAddresses::Kana), kanji: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptAddresses::Kanji)).void
}
def initialize(kana: nil, kanji: nil); end
end
class ScriptNames < Stripe::RequestParams
class Kana < Stripe::RequestParams
# The person's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
sig { params(_given_name: T.nilable(String)).returns(T.nilable(String)) }
def given_name=(_given_name); end
# The person's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
sig { params(_surname: T.nilable(String)).returns(T.nilable(String)) }
def surname=(_surname); end
sig { params(given_name: T.nilable(String), surname: T.nilable(String)).void }
def initialize(given_name: nil, surname: nil); end
end
class Kanji < Stripe::RequestParams
# The person's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
sig { params(_given_name: T.nilable(String)).returns(T.nilable(String)) }
def given_name=(_given_name); end
# The person's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
sig { params(_surname: T.nilable(String)).returns(T.nilable(String)) }
def surname=(_surname); end
sig { params(given_name: T.nilable(String), surname: T.nilable(String)).void }
def initialize(given_name: nil, surname: nil); end
end
# Persons name in kana script.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptNames::Kana))
}
def kana; end
sig {
params(_kana: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptNames::Kana)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptNames::Kana))
}
def kana=(_kana); end
# Persons name in kanji script.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptNames::Kanji))
}
def kanji; end
sig {
params(_kanji: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptNames::Kanji)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptNames::Kanji))
}
def kanji=(_kanji); end
sig {
params(kana: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptNames::Kana), kanji: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptNames::Kanji)).void
}
def initialize(kana: nil, kanji: nil); end
end
# Additional addresses associated with the individual.
sig {
returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::AdditionalAddress]))
}
def additional_addresses; end
sig {
params(_additional_addresses: T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::AdditionalAddress])).returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::AdditionalAddress]))
}
def additional_addresses=(_additional_addresses); end
# Additional names (e.g. aliases) associated with the individual.
sig {
returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::AdditionalName]))
}
def additional_names; end
sig {
params(_additional_names: T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::AdditionalName])).returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::AdditionalName]))
}
def additional_names=(_additional_names); end
# The individual's residential address.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Address)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Address))
}
def address=(_address); end
# The individual's date of birth.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::DateOfBirth))
}
def date_of_birth; end
sig {
params(_date_of_birth: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::DateOfBirth)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::DateOfBirth))
}
def date_of_birth=(_date_of_birth); end
# Documents that may be submitted to satisfy various informational requests.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents))
}
def documents; end
sig {
params(_documents: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents))
}
def documents=(_documents); end
# The individual's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The individual's first name.
sig { returns(T.nilable(String)) }
def given_name; end
sig { params(_given_name: T.nilable(String)).returns(T.nilable(String)) }
def given_name=(_given_name); end
# The identification numbers (e.g., SSN) associated with the individual.
sig {
returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::IdNumber]))
}
def id_numbers; end
sig {
params(_id_numbers: T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::IdNumber])).returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::IdNumber]))
}
def id_numbers=(_id_numbers); end
# The individual's gender (International regulations require either "male" or "female").
sig { returns(T.nilable(String)) }
def legal_gender; end
sig { params(_legal_gender: T.nilable(String)).returns(T.nilable(String)) }
def legal_gender=(_legal_gender); end
# Set of key-value pairs 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The countries where the individual is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(T::Array[String])) }
def nationalities; end
sig {
params(_nationalities: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def nationalities=(_nationalities); end
# The individual's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The individual's political exposure.
sig { returns(T.nilable(String)) }
def political_exposure; end
sig { params(_political_exposure: T.nilable(String)).returns(T.nilable(String)) }
def political_exposure=(_political_exposure); end
# The relationship that this individual has with the account's identity.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Relationship))
}
def relationship; end
sig {
params(_relationship: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Relationship)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Relationship))
}
def relationship=(_relationship); end
# The script addresses (e.g., non-Latin characters) associated with the individual.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptAddresses))
}
def script_addresses; end
sig {
params(_script_addresses: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptAddresses)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptAddresses))
}
def script_addresses=(_script_addresses); end
# The individuals primary name in non latin script.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptNames))
}
def script_names; end
sig {
params(_script_names: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptNames)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptNames))
}
def script_names=(_script_names); end
# The individual's last name.
sig { returns(T.nilable(String)) }
def surname; end
sig { params(_surname: T.nilable(String)).returns(T.nilable(String)) }
def surname=(_surname); end
sig {
params(additional_addresses: T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::AdditionalAddress]), additional_names: T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::AdditionalName]), address: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Address), date_of_birth: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::DateOfBirth), documents: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Documents), email: T.nilable(String), given_name: T.nilable(String), id_numbers: T.nilable(T::Array[::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::IdNumber]), legal_gender: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), nationalities: T.nilable(T::Array[String]), phone: T.nilable(String), political_exposure: T.nilable(String), relationship: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::Relationship), script_addresses: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptAddresses), script_names: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual::ScriptNames), surname: T.nilable(String)).void
}
def initialize(
additional_addresses: nil,
additional_names: nil,
address: nil,
date_of_birth: nil,
documents: nil,
email: nil,
given_name: nil,
id_numbers: nil,
legal_gender: nil,
metadata: nil,
nationalities: nil,
phone: nil,
political_exposure: nil,
relationship: nil,
script_addresses: nil,
script_names: nil,
surname: nil
); end
end
# Attestations from the identity's key people, e.g. owners, executives, directors.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations))
}
def attestations; end
sig {
params(_attestations: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations))
}
def attestations=(_attestations); end
# Information about the company or business.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails))
}
def business_details; end
sig {
params(_business_details: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails))
}
def business_details=(_business_details); end
# The country in which the account holder resides, or in which the business is legally established. This should be an [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# The entity type.
sig { returns(T.nilable(String)) }
def entity_type; end
sig { params(_entity_type: T.nilable(String)).returns(T.nilable(String)) }
def entity_type=(_entity_type); end
# Information about the person represented by the account.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual))
}
def individual; end
sig {
params(_individual: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual))
}
def individual=(_individual); end
sig {
params(attestations: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Attestations), business_details: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::BusinessDetails), country: T.nilable(String), entity_type: T.nilable(String), individual: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity::Individual)).void
}
def initialize(
attestations: nil,
business_details: nil,
country: nil,
entity_type: nil,
individual: nil
); end
end
# An Account Configuration which allows the Account to take on a key persona across Stripe products.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration))
}
def configuration; end
sig {
params(_configuration: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration))
}
def configuration=(_configuration); end
# The default contact email address for the Account. Required when configuring the account as a merchant or recipient.
sig { returns(T.nilable(String)) }
def contact_email; end
sig { params(_contact_email: T.nilable(String)).returns(T.nilable(String)) }
def contact_email=(_contact_email); end
# A value indicating the Stripe dashboard this Account has access to. This will depend on which configurations are enabled for this account.
sig { returns(T.nilable(String)) }
def dashboard; end
sig { params(_dashboard: T.nilable(String)).returns(T.nilable(String)) }
def dashboard=(_dashboard); end
# Default values to be used on Account Configurations.
sig { returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Defaults)) }
def defaults; end
sig {
params(_defaults: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Defaults)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Defaults))
}
def defaults=(_defaults); end
# A descriptive name for the Account. This name will be surfaced in the Stripe Dashboard and on any invoices sent to the Account.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# Information about the company, individual, and business represented by the Account.
sig { returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity)) }
def identity; end
sig {
params(_identity: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity)).returns(T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity))
}
def identity=(_identity); end
# Additional fields to include in the response.
sig { returns(T.nilable(T::Array[String])) }
def include; end
sig { params(_include: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def include=(_include); end
# Set of key-value pairs 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
sig {
params(configuration: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Configuration), contact_email: T.nilable(String), dashboard: T.nilable(String), defaults: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Defaults), display_name: T.nilable(String), identity: T.nilable(::Stripe::V2::Core::AccountService::CreateParams::Identity), include: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String])).void
}
def initialize(
configuration: nil,
contact_email: nil,
dashboard: nil,
defaults: nil,
display_name: nil,
identity: nil,
include: nil,
metadata: nil
); end
end
class RetrieveParams < Stripe::RequestParams
# Additional fields to include in the response.
sig { returns(T.nilable(T::Array[String])) }
def include; end
sig { params(_include: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def include=(_include); end
sig { params(include: T.nilable(T::Array[String])).void }
def initialize(include: nil); end
end
class UpdateParams < Stripe::RequestParams
class Configuration < Stripe::RequestParams
class Customer < Stripe::RequestParams
class AutomaticIndirectTax < Stripe::RequestParams
# Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to reverse, invoice and receipt PDFs include the following text: “Reverse charge”.
sig { returns(T.nilable(String)) }
def exempt; end
sig { params(_exempt: T.nilable(String)).returns(T.nilable(String)) }
def exempt=(_exempt); end
# A recent IP address of the customer used for tax reporting and tax location inference.
sig { returns(T.nilable(String)) }
def ip_address; end
sig { params(_ip_address: T.nilable(String)).returns(T.nilable(String)) }
def ip_address=(_ip_address); end
# The data source used to identify the customer's tax location - defaults to 'identity_address'. Will only be used for automatic tax calculation on the customer's Invoices and Subscriptions.
sig { returns(T.nilable(String)) }
def location_source; end
sig { params(_location_source: T.nilable(String)).returns(T.nilable(String)) }
def location_source=(_location_source); end
# A per-request flag that indicates when Stripe should validate the customer tax location - defaults to 'auto'.
sig { returns(T.nilable(String)) }
def validate_location; end
sig { params(_validate_location: T.nilable(String)).returns(T.nilable(String)) }
def validate_location=(_validate_location); end
sig {
params(exempt: T.nilable(String), ip_address: T.nilable(String), location_source: T.nilable(String), validate_location: T.nilable(String)).void
}
def initialize(
exempt: nil,
ip_address: nil,
location_source: nil,
validate_location: nil
); end
end
class Billing < Stripe::RequestParams
class Invoice < Stripe::RequestParams
class CustomField < Stripe::RequestParams
# The name of the custom field. This may be up to 40 characters.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# The value of the custom field. This may be up to 140 characters. When updating, pass an empty string to remove previously-defined values.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(name: String, value: String).void }
def initialize(name: nil, value: nil); end
end
class Rendering < Stripe::RequestParams
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of exclude_tax or include_inclusive_tax. include_inclusive_tax will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. exclude_tax will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
sig { returns(T.nilable(String)) }
def amount_tax_display; end
sig {
params(_amount_tax_display: T.nilable(String)).returns(T.nilable(String))
}
def amount_tax_display=(_amount_tax_display); end
# ID of the invoice rendering template to use for future invoices.
sig { returns(T.nilable(String)) }
def template; end
sig { params(_template: T.nilable(String)).returns(T.nilable(String)) }
def template=(_template); end
sig {
params(amount_tax_display: T.nilable(String), template: T.nilable(String)).void
}
def initialize(amount_tax_display: nil, template: nil); end
end
# The list of up to 4 default custom fields to be displayed on invoices for this customer.
sig {
returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Billing::Invoice::CustomField]))
}
def custom_fields; end
sig {
params(_custom_fields: T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Billing::Invoice::CustomField])).returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Billing::Invoice::CustomField]))
}
def custom_fields=(_custom_fields); end
# Default footer to be displayed on invoices for this customer.
sig { returns(T.nilable(String)) }
def footer; end
sig { params(_footer: T.nilable(String)).returns(T.nilable(String)) }
def footer=(_footer); end
# The sequence to be used on the customer's next invoice. Defaults to 1.
sig { returns(T.nilable(Integer)) }
def next_sequence; end
sig { params(_next_sequence: T.nilable(Integer)).returns(T.nilable(Integer)) }
def next_sequence=(_next_sequence); end
# The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
sig { returns(T.nilable(String)) }
def prefix; end
sig { params(_prefix: T.nilable(String)).returns(T.nilable(String)) }
def prefix=(_prefix); end
# Default options for invoice PDF rendering for this customer.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Billing::Invoice::Rendering))
}
def rendering; end
sig {
params(_rendering: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Billing::Invoice::Rendering)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Billing::Invoice::Rendering))
}
def rendering=(_rendering); end
sig {
params(custom_fields: T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Billing::Invoice::CustomField]), footer: T.nilable(String), next_sequence: T.nilable(Integer), prefix: T.nilable(String), rendering: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Billing::Invoice::Rendering)).void
}
def initialize(
custom_fields: nil,
footer: nil,
next_sequence: nil,
prefix: nil,
rendering: nil
); end
end
# ID of a payment method that’s attached to the customer, to be used as the customer’s default payment method for invoices and subscriptions.
sig { returns(T.nilable(String)) }
def default_payment_method; end
sig {
params(_default_payment_method: T.nilable(String)).returns(T.nilable(String))
}
def default_payment_method=(_default_payment_method); end
# Default settings used on invoices for this customer.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Billing::Invoice))
}
def invoice; end
sig {
params(_invoice: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Billing::Invoice)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Billing::Invoice))
}
def invoice=(_invoice); end
sig {
params(default_payment_method: T.nilable(String), invoice: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Billing::Invoice)).void
}
def initialize(default_payment_method: nil, invoice: nil); end
end
class Capabilities < Stripe::RequestParams
class AutomaticIndirectTax < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
# Generates requirements for enabling automatic indirect tax calculation on this customer's invoices or subscriptions. Recommended to request this capability if planning to enable automatic tax calculation on this customer's invoices or subscriptions. Uses the `location_source` field.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Capabilities::AutomaticIndirectTax))
}
def automatic_indirect_tax; end
sig {
params(_automatic_indirect_tax: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Capabilities::AutomaticIndirectTax)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Capabilities::AutomaticIndirectTax))
}
def automatic_indirect_tax=(_automatic_indirect_tax); end
sig {
params(automatic_indirect_tax: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Capabilities::AutomaticIndirectTax)).void
}
def initialize(automatic_indirect_tax: nil); end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
); end
end
# Customer shipping address.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Shipping::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Shipping::Address)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Shipping::Address))
}
def address=(_address); end
# Customer name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Customer phone (including extension).
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
sig {
params(address: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Shipping::Address), name: T.nilable(String), phone: T.nilable(String)).void
}
def initialize(address: nil, name: nil, phone: nil); end
end
# Represents the state of the configuration, and can be updated to deactivate or re-apply a configuration.
sig { returns(T.nilable(T::Boolean)) }
def applied; end
sig { params(_applied: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def applied=(_applied); end
# Automatic indirect tax settings to be used when automatic tax calculation is enabled on the customer's invoices, subscriptions, checkout sessions, or payment links. Surfaces if automatic tax calculation is possible given the current customer location information.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::AutomaticIndirectTax))
}
def automatic_indirect_tax; end
sig {
params(_automatic_indirect_tax: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::AutomaticIndirectTax)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::AutomaticIndirectTax))
}
def automatic_indirect_tax=(_automatic_indirect_tax); end
# Billing settings - default settings used for this customer in Billing flows such as Invoices and Subscriptions.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Billing))
}
def billing; end
sig {
params(_billing: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Billing)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Billing))
}
def billing=(_billing); end
# Capabilities that have been requested on the Customer Configuration.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Capabilities))
}
def capabilities; end
sig {
params(_capabilities: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Capabilities)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Capabilities))
}
def capabilities=(_capabilities); end
# The customer's shipping information. Appears on invoices emailed to this customer.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Shipping))
}
def shipping; end
sig {
params(_shipping: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Shipping)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Shipping))
}
def shipping=(_shipping); end
# ID of the test clock to attach to the customer. Can only be set on testmode Accounts, and when the Customer Configuration is first set on an Account.
sig { returns(T.nilable(String)) }
def test_clock; end
sig { params(_test_clock: T.nilable(String)).returns(T.nilable(String)) }
def test_clock=(_test_clock); end
sig {
params(applied: T.nilable(T::Boolean), automatic_indirect_tax: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::AutomaticIndirectTax), billing: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Billing), capabilities: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Capabilities), shipping: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer::Shipping), test_clock: T.nilable(String)).void
}
def initialize(
applied: nil,
automatic_indirect_tax: nil,
billing: nil,
capabilities: nil,
shipping: nil,
test_clock: nil
); end
end
class Merchant < Stripe::RequestParams
class BacsDebitPayments < Stripe::RequestParams
# Display name for Bacs debit payments.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
sig { params(display_name: T.nilable(String)).void }
def initialize(display_name: nil); end
end
class Branding < Stripe::RequestParams
# ID of a [file upload](https://docs.stripe.com/api/persons/update#create_file): An icon for the merchant. Must be square and at least 128px x 128px.
sig { returns(T.nilable(String)) }
def icon; end
sig { params(_icon: T.nilable(String)).returns(T.nilable(String)) }
def icon=(_icon); end
# ID of a [file upload](https://docs.stripe.com/api/persons/update#create_file): A logo for the merchant that will be used in Checkout instead of the icon and without the merchant's name next to it if provided. Must be at least 128px x 128px.
sig { returns(T.nilable(String)) }
def logo; end
sig { params(_logo: T.nilable(String)).returns(T.nilable(String)) }
def logo=(_logo); end
# A CSS hex color value representing the primary branding color for the merchant.
sig { returns(T.nilable(String)) }
def primary_color; end
sig { params(_primary_color: T.nilable(String)).returns(T.nilable(String)) }
def primary_color=(_primary_color); end
# A CSS hex color value representing the secondary branding color for the merchant.
sig { returns(T.nilable(String)) }
def secondary_color; end
sig { params(_secondary_color: T.nilable(String)).returns(T.nilable(String)) }
def secondary_color=(_secondary_color); end
sig {
params(icon: T.nilable(String), logo: T.nilable(String), primary_color: T.nilable(String), secondary_color: T.nilable(String)).void
}
def initialize(icon: nil, logo: nil, primary_color: nil, secondary_color: nil); end
end
class Capabilities < Stripe::RequestParams
class AchDebitPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AcssDebitPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AffirmPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AfterpayClearpayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AlmaPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AmazonPayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class AuBecsDebitPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BacsDebitPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BancontactPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BlikPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class BoletoPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CardPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CartesBancairesPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class CashappPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class EpsPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class FpxPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GbBankTransferPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class GrabpayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class IdealPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class JcbPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class JpBankTransferPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KakaoPayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KlarnaPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KonbiniPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class KrCardPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class LinkPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MobilepayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MultibancoPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class MxBankTransferPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class NaverPayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class OxxoPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class P24Payments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PayByBankPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaycoPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PaynowPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class PromptpayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class RevolutPayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SamsungPayPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SepaBankTransferPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SepaDebitPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class SwishPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class TwintPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class UsBankTransferPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class ZipPayments < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
# Allow the merchant to process ACH debit payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AchDebitPayments))
}
def ach_debit_payments; end
sig {
params(_ach_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AchDebitPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AchDebitPayments))
}
def ach_debit_payments=(_ach_debit_payments); end
# Allow the merchant to process ACSS debit payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AcssDebitPayments))
}
def acss_debit_payments; end
sig {
params(_acss_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AcssDebitPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AcssDebitPayments))
}
def acss_debit_payments=(_acss_debit_payments); end
# Allow the merchant to process Affirm payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AffirmPayments))
}
def affirm_payments; end
sig {
params(_affirm_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AffirmPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AffirmPayments))
}
def affirm_payments=(_affirm_payments); end
# Allow the merchant to process Afterpay/Clearpay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AfterpayClearpayPayments))
}
def afterpay_clearpay_payments; end
sig {
params(_afterpay_clearpay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AfterpayClearpayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AfterpayClearpayPayments))
}
def afterpay_clearpay_payments=(_afterpay_clearpay_payments); end
# Allow the merchant to process Alma payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AlmaPayments))
}
def alma_payments; end
sig {
params(_alma_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AlmaPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AlmaPayments))
}
def alma_payments=(_alma_payments); end
# Allow the merchant to process Amazon Pay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AmazonPayPayments))
}
def amazon_pay_payments; end
sig {
params(_amazon_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AmazonPayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AmazonPayPayments))
}
def amazon_pay_payments=(_amazon_pay_payments); end
# Allow the merchant to process Australian BECS Direct Debit payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AuBecsDebitPayments))
}
def au_becs_debit_payments; end
sig {
params(_au_becs_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AuBecsDebitPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AuBecsDebitPayments))
}
def au_becs_debit_payments=(_au_becs_debit_payments); end
# Allow the merchant to process BACS Direct Debit payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::BacsDebitPayments))
}
def bacs_debit_payments; end
sig {
params(_bacs_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::BacsDebitPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::BacsDebitPayments))
}
def bacs_debit_payments=(_bacs_debit_payments); end
# Allow the merchant to process Bancontact payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::BancontactPayments))
}
def bancontact_payments; end
sig {
params(_bancontact_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::BancontactPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::BancontactPayments))
}
def bancontact_payments=(_bancontact_payments); end
# Allow the merchant to process BLIK payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::BlikPayments))
}
def blik_payments; end
sig {
params(_blik_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::BlikPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::BlikPayments))
}
def blik_payments=(_blik_payments); end
# Allow the merchant to process Boleto payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::BoletoPayments))
}
def boleto_payments; end
sig {
params(_boleto_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::BoletoPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::BoletoPayments))
}
def boleto_payments=(_boleto_payments); end
# Allow the merchant to collect card payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::CardPayments))
}
def card_payments; end
sig {
params(_card_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::CardPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::CardPayments))
}
def card_payments=(_card_payments); end
# Allow the merchant to process Cartes Bancaires payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::CartesBancairesPayments))
}
def cartes_bancaires_payments; end
sig {
params(_cartes_bancaires_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::CartesBancairesPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::CartesBancairesPayments))
}
def cartes_bancaires_payments=(_cartes_bancaires_payments); end
# Allow the merchant to process Cash App payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::CashappPayments))
}
def cashapp_payments; end
sig {
params(_cashapp_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::CashappPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::CashappPayments))
}
def cashapp_payments=(_cashapp_payments); end
# Allow the merchant to process EPS payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::EpsPayments))
}
def eps_payments; end
sig {
params(_eps_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::EpsPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::EpsPayments))
}
def eps_payments=(_eps_payments); end
# Allow the merchant to process FPX payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::FpxPayments))
}
def fpx_payments; end
sig {
params(_fpx_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::FpxPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::FpxPayments))
}
def fpx_payments=(_fpx_payments); end
# Allow the merchant to process UK bank transfer payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::GbBankTransferPayments))
}
def gb_bank_transfer_payments; end
sig {
params(_gb_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::GbBankTransferPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::GbBankTransferPayments))
}
def gb_bank_transfer_payments=(_gb_bank_transfer_payments); end
# Allow the merchant to process GrabPay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::GrabpayPayments))
}
def grabpay_payments; end
sig {
params(_grabpay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::GrabpayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::GrabpayPayments))
}
def grabpay_payments=(_grabpay_payments); end
# Allow the merchant to process iDEAL payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::IdealPayments))
}
def ideal_payments; end
sig {
params(_ideal_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::IdealPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::IdealPayments))
}
def ideal_payments=(_ideal_payments); end
# Allow the merchant to process JCB card payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::JcbPayments))
}
def jcb_payments; end
sig {
params(_jcb_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::JcbPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::JcbPayments))
}
def jcb_payments=(_jcb_payments); end
# Allow the merchant to process Japanese bank transfer payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::JpBankTransferPayments))
}
def jp_bank_transfer_payments; end
sig {
params(_jp_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::JpBankTransferPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::JpBankTransferPayments))
}
def jp_bank_transfer_payments=(_jp_bank_transfer_payments); end
# Allow the merchant to process Kakao Pay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::KakaoPayPayments))
}
def kakao_pay_payments; end
sig {
params(_kakao_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::KakaoPayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::KakaoPayPayments))
}
def kakao_pay_payments=(_kakao_pay_payments); end
# Allow the merchant to process Klarna payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::KlarnaPayments))
}
def klarna_payments; end
sig {
params(_klarna_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::KlarnaPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::KlarnaPayments))
}
def klarna_payments=(_klarna_payments); end
# Allow the merchant to process Konbini convenience store payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::KonbiniPayments))
}
def konbini_payments; end
sig {
params(_konbini_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::KonbiniPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::KonbiniPayments))
}
def konbini_payments=(_konbini_payments); end
# Allow the merchant to process Korean card payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::KrCardPayments))
}
def kr_card_payments; end
sig {
params(_kr_card_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::KrCardPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::KrCardPayments))
}
def kr_card_payments=(_kr_card_payments); end
# Allow the merchant to process Link payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::LinkPayments))
}
def link_payments; end
sig {
params(_link_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::LinkPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::LinkPayments))
}
def link_payments=(_link_payments); end
# Allow the merchant to process MobilePay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::MobilepayPayments))
}
def mobilepay_payments; end
sig {
params(_mobilepay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::MobilepayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::MobilepayPayments))
}
def mobilepay_payments=(_mobilepay_payments); end
# Allow the merchant to process Multibanco payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::MultibancoPayments))
}
def multibanco_payments; end
sig {
params(_multibanco_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::MultibancoPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::MultibancoPayments))
}
def multibanco_payments=(_multibanco_payments); end
# Allow the merchant to process Mexican bank transfer payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::MxBankTransferPayments))
}
def mx_bank_transfer_payments; end
sig {
params(_mx_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::MxBankTransferPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::MxBankTransferPayments))
}
def mx_bank_transfer_payments=(_mx_bank_transfer_payments); end
# Allow the merchant to process Naver Pay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::NaverPayPayments))
}
def naver_pay_payments; end
sig {
params(_naver_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::NaverPayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::NaverPayPayments))
}
def naver_pay_payments=(_naver_pay_payments); end
# Allow the merchant to process OXXO payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::OxxoPayments))
}
def oxxo_payments; end
sig {
params(_oxxo_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::OxxoPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::OxxoPayments))
}
def oxxo_payments=(_oxxo_payments); end
# Allow the merchant to process Przelewy24 (P24) payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::P24Payments))
}
def p24_payments; end
sig {
params(_p24_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::P24Payments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::P24Payments))
}
def p24_payments=(_p24_payments); end
# Allow the merchant to process Pay by Bank payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::PayByBankPayments))
}
def pay_by_bank_payments; end
sig {
params(_pay_by_bank_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::PayByBankPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::PayByBankPayments))
}
def pay_by_bank_payments=(_pay_by_bank_payments); end
# Allow the merchant to process PAYCO payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::PaycoPayments))
}
def payco_payments; end
sig {
params(_payco_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::PaycoPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::PaycoPayments))
}
def payco_payments=(_payco_payments); end
# Allow the merchant to process PayNow payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::PaynowPayments))
}
def paynow_payments; end
sig {
params(_paynow_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::PaynowPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::PaynowPayments))
}
def paynow_payments=(_paynow_payments); end
# Allow the merchant to process PromptPay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::PromptpayPayments))
}
def promptpay_payments; end
sig {
params(_promptpay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::PromptpayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::PromptpayPayments))
}
def promptpay_payments=(_promptpay_payments); end
# Allow the merchant to process Revolut Pay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::RevolutPayPayments))
}
def revolut_pay_payments; end
sig {
params(_revolut_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::RevolutPayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::RevolutPayPayments))
}
def revolut_pay_payments=(_revolut_pay_payments); end
# Allow the merchant to process Samsung Pay payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::SamsungPayPayments))
}
def samsung_pay_payments; end
sig {
params(_samsung_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::SamsungPayPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::SamsungPayPayments))
}
def samsung_pay_payments=(_samsung_pay_payments); end
# Allow the merchant to process SEPA bank transfer payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::SepaBankTransferPayments))
}
def sepa_bank_transfer_payments; end
sig {
params(_sepa_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::SepaBankTransferPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::SepaBankTransferPayments))
}
def sepa_bank_transfer_payments=(_sepa_bank_transfer_payments); end
# Allow the merchant to process SEPA Direct Debit payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::SepaDebitPayments))
}
def sepa_debit_payments; end
sig {
params(_sepa_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::SepaDebitPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::SepaDebitPayments))
}
def sepa_debit_payments=(_sepa_debit_payments); end
# Allow the merchant to process Swish payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::SwishPayments))
}
def swish_payments; end
sig {
params(_swish_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::SwishPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::SwishPayments))
}
def swish_payments=(_swish_payments); end
# Allow the merchant to process TWINT payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::TwintPayments))
}
def twint_payments; end
sig {
params(_twint_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::TwintPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::TwintPayments))
}
def twint_payments=(_twint_payments); end
# Allow the merchant to process US bank transfer payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::UsBankTransferPayments))
}
def us_bank_transfer_payments; end
sig {
params(_us_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::UsBankTransferPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::UsBankTransferPayments))
}
def us_bank_transfer_payments=(_us_bank_transfer_payments); end
# Allow the merchant to process Zip payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::ZipPayments))
}
def zip_payments; end
sig {
params(_zip_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::ZipPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::ZipPayments))
}
def zip_payments=(_zip_payments); end
sig {
params(ach_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AchDebitPayments), acss_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AcssDebitPayments), affirm_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AffirmPayments), afterpay_clearpay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AfterpayClearpayPayments), alma_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AlmaPayments), amazon_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AmazonPayPayments), au_becs_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::AuBecsDebitPayments), bacs_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::BacsDebitPayments), bancontact_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::BancontactPayments), blik_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::BlikPayments), boleto_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::BoletoPayments), card_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::CardPayments), cartes_bancaires_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::CartesBancairesPayments), cashapp_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::CashappPayments), eps_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::EpsPayments), fpx_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::FpxPayments), gb_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::GbBankTransferPayments), grabpay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::GrabpayPayments), ideal_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::IdealPayments), jcb_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::JcbPayments), jp_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::JpBankTransferPayments), kakao_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::KakaoPayPayments), klarna_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::KlarnaPayments), konbini_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::KonbiniPayments), kr_card_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::KrCardPayments), link_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::LinkPayments), mobilepay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::MobilepayPayments), multibanco_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::MultibancoPayments), mx_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::MxBankTransferPayments), naver_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::NaverPayPayments), oxxo_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::OxxoPayments), p24_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::P24Payments), pay_by_bank_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::PayByBankPayments), payco_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::PaycoPayments), paynow_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::PaynowPayments), promptpay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::PromptpayPayments), revolut_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::RevolutPayPayments), samsung_pay_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::SamsungPayPayments), sepa_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::SepaBankTransferPayments), sepa_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::SepaDebitPayments), swish_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::SwishPayments), twint_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::TwintPayments), us_bank_transfer_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::UsBankTransferPayments), zip_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities::ZipPayments)).void
}
def initialize(
ach_debit_payments: nil,
acss_debit_payments: nil,
affirm_payments: nil,
afterpay_clearpay_payments: nil,
alma_payments: nil,
amazon_pay_payments: nil,
au_becs_debit_payments: nil,
bacs_debit_payments: nil,
bancontact_payments: nil,
blik_payments: nil,
boleto_payments: nil,
card_payments: nil,
cartes_bancaires_payments: nil,
cashapp_payments: nil,
eps_payments: nil,
fpx_payments: nil,
gb_bank_transfer_payments: nil,
grabpay_payments: nil,
ideal_payments: nil,
jcb_payments: nil,
jp_bank_transfer_payments: nil,
kakao_pay_payments: nil,
klarna_payments: nil,
konbini_payments: nil,
kr_card_payments: nil,
link_payments: nil,
mobilepay_payments: nil,
multibanco_payments: nil,
mx_bank_transfer_payments: nil,
naver_pay_payments: nil,
oxxo_payments: nil,
p24_payments: nil,
pay_by_bank_payments: nil,
payco_payments: nil,
paynow_payments: nil,
promptpay_payments: nil,
revolut_pay_payments: nil,
samsung_pay_payments: nil,
sepa_bank_transfer_payments: nil,
sepa_debit_payments: nil,
swish_payments: nil,
twint_payments: nil,
us_bank_transfer_payments: nil,
zip_payments: nil
); end
end
class CardPayments < Stripe::RequestParams
class DeclineOn < Stripe::RequestParams
# Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.
sig { returns(T.nilable(T::Boolean)) }
def avs_failure; end
sig { params(_avs_failure: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def avs_failure=(_avs_failure); end
# Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.
sig { returns(T.nilable(T::Boolean)) }
def cvc_failure; end
sig { params(_cvc_failure: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def cvc_failure=(_cvc_failure); end
sig {
params(avs_failure: T.nilable(T::Boolean), cvc_failure: T.nilable(T::Boolean)).void
}
def initialize(avs_failure: nil, cvc_failure: nil); end
end
# Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::CardPayments::DeclineOn))
}
def decline_on; end
sig {
params(_decline_on: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::CardPayments::DeclineOn)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::CardPayments::DeclineOn))
}
def decline_on=(_decline_on); end
sig {
params(decline_on: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::CardPayments::DeclineOn)).void
}
def initialize(decline_on: nil); end
end
class StatementDescriptor < Stripe::RequestParams
# The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don’t set a statement_descriptor_prefix, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the statement_descriptor text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation.
sig { returns(T.nilable(String)) }
def descriptor; end
sig { params(_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def descriptor=(_descriptor); end
# Default text that appears on statements for card charges outside of Japan, prefixing any dynamic statement_descriptor_suffix specified on the charge. To maximize space for the dynamic part of the descriptor, keep this text short. If you don’t specify this value, statement_descriptor is used as the prefix. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation.
sig { returns(T.nilable(String)) }
def prefix; end
sig { params(_prefix: T.nilable(String)).returns(T.nilable(String)) }
def prefix=(_prefix); end
sig { params(descriptor: T.nilable(String), prefix: T.nilable(String)).void }
def initialize(descriptor: nil, prefix: nil); end
end
class Support < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
# A publicly available mailing address for sending support issues to.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Support::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Support::Address)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Support::Address))
}
def address=(_address); end
# A publicly available email address for sending support issues to.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# A publicly available phone number to call with support issues.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# A publicly available website for handling support issues.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(address: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Support::Address), email: T.nilable(String), phone: T.nilable(String), url: T.nilable(String)).void
}
def initialize(address: nil, email: nil, phone: nil, url: nil); end
end
# Represents the state of the configuration, and can be updated to deactivate or re-apply a configuration.
sig { returns(T.nilable(T::Boolean)) }
def applied; end
sig { params(_applied: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def applied=(_applied); end
# Settings used for Bacs debit payments.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::BacsDebitPayments))
}
def bacs_debit_payments; end
sig {
params(_bacs_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::BacsDebitPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::BacsDebitPayments))
}
def bacs_debit_payments=(_bacs_debit_payments); end
# Settings used to apply the merchant's branding to email receipts, invoices, Checkout, and other products.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Branding))
}
def branding; end
sig {
params(_branding: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Branding)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Branding))
}
def branding=(_branding); end
# Capabilities to request on the Merchant Configuration.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities))
}
def capabilities; end
sig {
params(_capabilities: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities))
}
def capabilities=(_capabilities); end
# Card payments settings.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::CardPayments))
}
def card_payments; end
sig {
params(_card_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::CardPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::CardPayments))
}
def card_payments=(_card_payments); end
# The merchant category code for the merchant. MCCs are used to classify businesses based on the goods or services they provide.
sig { returns(T.nilable(String)) }
def mcc; end
sig { params(_mcc: T.nilable(String)).returns(T.nilable(String)) }
def mcc=(_mcc); end
# Statement descriptor.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::StatementDescriptor))
}
def statement_descriptor; end
sig {
params(_statement_descriptor: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::StatementDescriptor)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::StatementDescriptor))
}
def statement_descriptor=(_statement_descriptor); end
# Publicly available contact information for sending support issues to.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Support))
}
def support; end
sig {
params(_support: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Support)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Support))
}
def support=(_support); end
sig {
params(applied: T.nilable(T::Boolean), bacs_debit_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::BacsDebitPayments), branding: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Branding), capabilities: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Capabilities), card_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::CardPayments), mcc: T.nilable(String), statement_descriptor: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::StatementDescriptor), support: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant::Support)).void
}
def initialize(
applied: nil,
bacs_debit_payments: nil,
branding: nil,
capabilities: nil,
card_payments: nil,
mcc: nil,
statement_descriptor: nil,
support: nil
); end
end
class Recipient < Stripe::RequestParams
class Capabilities < Stripe::RequestParams
class BankAccounts < Stripe::RequestParams
class Local < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class Wire < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
# Enables this Account to receive OutboundPayments to linked bank accounts over local networks.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::BankAccounts::Local))
}
def local; end
sig {
params(_local: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::BankAccounts::Local)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::BankAccounts::Local))
}
def local=(_local); end
# Enables this Account to receive OutboundPayments to linked bank accounts over wire.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::BankAccounts::Wire))
}
def wire; end
sig {
params(_wire: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::BankAccounts::Wire)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::BankAccounts::Wire))
}
def wire=(_wire); end
sig {
params(local: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::BankAccounts::Local), wire: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::BankAccounts::Wire)).void
}
def initialize(local: nil, wire: nil); end
end
class Cards < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class StripeBalance < Stripe::RequestParams
class StripeTransfers < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
# Allows the account to receive /v1/transfers into their Stripe Balance (/v1/balance).
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::StripeBalance::StripeTransfers))
}
def stripe_transfers; end
sig {
params(_stripe_transfers: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::StripeBalance::StripeTransfers)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::StripeBalance::StripeTransfers))
}
def stripe_transfers=(_stripe_transfers); end
sig {
params(stripe_transfers: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::StripeBalance::StripeTransfers)).void
}
def initialize(stripe_transfers: nil); end
end
# Capabilities that enable OutboundPayments to a bank account linked to this Account.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::BankAccounts))
}
def bank_accounts; end
sig {
params(_bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::BankAccounts)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::BankAccounts))
}
def bank_accounts=(_bank_accounts); end
# Capability that enable OutboundPayments to a debit card linked to this Account.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::Cards))
}
def cards; end
sig {
params(_cards: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::Cards)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::Cards))
}
def cards=(_cards); end
# Capabilities that enable the recipient to manage their Stripe Balance (/v1/balance).
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::StripeBalance))
}
def stripe_balance; end
sig {
params(_stripe_balance: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::StripeBalance)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::StripeBalance))
}
def stripe_balance=(_stripe_balance); end
sig {
params(bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::BankAccounts), cards: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::Cards), stripe_balance: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities::StripeBalance)).void
}
def initialize(bank_accounts: nil, cards: nil, stripe_balance: nil); end
end
# Represents the state of the configuration, and can be updated to deactivate or re-apply a configuration.
sig { returns(T.nilable(T::Boolean)) }
def applied; end
sig { params(_applied: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def applied=(_applied); end
# Capabilities to request on the Recipient Configuration.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities))
}
def capabilities; end
sig {
params(_capabilities: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities))
}
def capabilities=(_capabilities); end
# The payout method id to be used as a default outbound destination. This will allow the PayoutMethod to be omitted on OutboundPayments made through API or sending payouts via dashboard. Can also be explicitly set to `null` to clear the existing default outbound destination.
sig { returns(T.nilable(String)) }
def default_outbound_destination; end
sig {
params(_default_outbound_destination: T.nilable(String)).returns(T.nilable(String))
}
def default_outbound_destination=(_default_outbound_destination); end
sig {
params(applied: T.nilable(T::Boolean), capabilities: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient::Capabilities), default_outbound_destination: T.nilable(String)).void
}
def initialize(
applied: nil,
capabilities: nil,
default_outbound_destination: nil
); end
end
class Storer < Stripe::RequestParams
class Capabilities < Stripe::RequestParams
class FinancialAddresses < Stripe::RequestParams
class BankAccounts < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
# Can provision a bank-account-like financial address (VBAN) to credit/debit a FinancialAccount.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::FinancialAddresses::BankAccounts))
}
def bank_accounts; end
sig {
params(_bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::FinancialAddresses::BankAccounts)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::FinancialAddresses::BankAccounts))
}
def bank_accounts=(_bank_accounts); end
sig {
params(bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::FinancialAddresses::BankAccounts)).void
}
def initialize(bank_accounts: nil); end
end
class HoldsCurrencies < Stripe::RequestParams
class Gbp < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
# Can hold storage-type funds on Stripe in GBP.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::HoldsCurrencies::Gbp))
}
def gbp; end
sig {
params(_gbp: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::HoldsCurrencies::Gbp)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::HoldsCurrencies::Gbp))
}
def gbp=(_gbp); end
sig {
params(gbp: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::HoldsCurrencies::Gbp)).void
}
def initialize(gbp: nil); end
end
class InboundTransfers < Stripe::RequestParams
class BankAccounts < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
# Can pull funds from an external bank account owned by yourself to a FinancialAccount.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::InboundTransfers::BankAccounts))
}
def bank_accounts; end
sig {
params(_bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::InboundTransfers::BankAccounts)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::InboundTransfers::BankAccounts))
}
def bank_accounts=(_bank_accounts); end
sig {
params(bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::InboundTransfers::BankAccounts)).void
}
def initialize(bank_accounts: nil); end
end
class OutboundPayments < Stripe::RequestParams
class BankAccounts < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class Cards < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class FinancialAccounts < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
# Can send funds from a FinancialAccount to a bank account owned by someone else.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundPayments::BankAccounts))
}
def bank_accounts; end
sig {
params(_bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundPayments::BankAccounts)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundPayments::BankAccounts))
}
def bank_accounts=(_bank_accounts); end
# Can send funds from a FinancialAccount to a debit card owned by someone else.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundPayments::Cards))
}
def cards; end
sig {
params(_cards: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundPayments::Cards)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundPayments::Cards))
}
def cards=(_cards); end
# Can send funds from a FinancialAccount to another FinancialAccount owned by someone else.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundPayments::FinancialAccounts))
}
def financial_accounts; end
sig {
params(_financial_accounts: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundPayments::FinancialAccounts)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundPayments::FinancialAccounts))
}
def financial_accounts=(_financial_accounts); end
sig {
params(bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundPayments::BankAccounts), cards: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundPayments::Cards), financial_accounts: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundPayments::FinancialAccounts)).void
}
def initialize(bank_accounts: nil, cards: nil, financial_accounts: nil); end
end
class OutboundTransfers < Stripe::RequestParams
class BankAccounts < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
class FinancialAccounts < Stripe::RequestParams
# To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
sig { returns(T.nilable(T::Boolean)) }
def requested; end
sig { params(_requested: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def requested=(_requested); end
sig { params(requested: T.nilable(T::Boolean)).void }
def initialize(requested: nil); end
end
# Can send funds from a FinancialAccount to a bank account owned by yourself.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundTransfers::BankAccounts))
}
def bank_accounts; end
sig {
params(_bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundTransfers::BankAccounts)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundTransfers::BankAccounts))
}
def bank_accounts=(_bank_accounts); end
# Can send funds from a FinancialAccount to another FinancialAccount owned by yourself.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundTransfers::FinancialAccounts))
}
def financial_accounts; end
sig {
params(_financial_accounts: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundTransfers::FinancialAccounts)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundTransfers::FinancialAccounts))
}
def financial_accounts=(_financial_accounts); end
sig {
params(bank_accounts: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundTransfers::BankAccounts), financial_accounts: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundTransfers::FinancialAccounts)).void
}
def initialize(bank_accounts: nil, financial_accounts: nil); end
end
# Can provision a financial address to credit/debit a FinancialAccount.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::FinancialAddresses))
}
def financial_addresses; end
sig {
params(_financial_addresses: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::FinancialAddresses)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::FinancialAddresses))
}
def financial_addresses=(_financial_addresses); end
# Can hold storage-type funds on Stripe.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::HoldsCurrencies))
}
def holds_currencies; end
sig {
params(_holds_currencies: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::HoldsCurrencies)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::HoldsCurrencies))
}
def holds_currencies=(_holds_currencies); end
# Can pull funds from an external source, owned by yourself, to a FinancialAccount.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::InboundTransfers))
}
def inbound_transfers; end
sig {
params(_inbound_transfers: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::InboundTransfers)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::InboundTransfers))
}
def inbound_transfers=(_inbound_transfers); end
# Can send funds from a FinancialAccount to a destination owned by someone else.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundPayments))
}
def outbound_payments; end
sig {
params(_outbound_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundPayments)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundPayments))
}
def outbound_payments=(_outbound_payments); end
# Can send funds from a FinancialAccount to a destination owned by yourself.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundTransfers))
}
def outbound_transfers; end
sig {
params(_outbound_transfers: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundTransfers)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundTransfers))
}
def outbound_transfers=(_outbound_transfers); end
sig {
params(financial_addresses: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::FinancialAddresses), holds_currencies: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::HoldsCurrencies), inbound_transfers: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::InboundTransfers), outbound_payments: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundPayments), outbound_transfers: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities::OutboundTransfers)).void
}
def initialize(
financial_addresses: nil,
holds_currencies: nil,
inbound_transfers: nil,
outbound_payments: nil,
outbound_transfers: nil
); end
end
# Represents the state of the configuration, and can be updated to deactivate or re-apply a configuration.
sig { returns(T.nilable(T::Boolean)) }
def applied; end
sig { params(_applied: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def applied=(_applied); end
# Capabilities to request on the Storer Configuration.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities))
}
def capabilities; end
sig {
params(_capabilities: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities))
}
def capabilities=(_capabilities); end
sig {
params(applied: T.nilable(T::Boolean), capabilities: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer::Capabilities)).void
}
def initialize(applied: nil, capabilities: nil); end
end
# The Customer Configuration allows the Account to be charged.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer))
}
def customer; end
sig {
params(_customer: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer))
}
def customer=(_customer); end
# The Merchant configuration allows the Account to act as a connected account and collect payments facilitated by a Connect platform. You can add this configuration to your connected accounts only if you’ve completed onboarding as a Connect platform.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant))
}
def merchant; end
sig {
params(_merchant: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant))
}
def merchant=(_merchant); end
# The Recipient Configuration allows the Account to receive funds.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient))
}
def recipient; end
sig {
params(_recipient: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient))
}
def recipient=(_recipient); end
# The Storer Configuration allows the Account to store and move funds using stored-value FinancialAccounts.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer))
}
def storer; end
sig {
params(_storer: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer))
}
def storer=(_storer); end
sig {
params(customer: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Customer), merchant: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Merchant), recipient: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Recipient), storer: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration::Storer)).void
}
def initialize(customer: nil, merchant: nil, recipient: nil, storer: nil); end
end
class Defaults < Stripe::RequestParams
class Responsibilities < Stripe::RequestParams
# A value indicating the party responsible for collecting fees from this account.
sig { returns(String) }
def fees_collector; end
sig { params(_fees_collector: String).returns(String) }
def fees_collector=(_fees_collector); end
# A value indicating who is responsible for losses when this Account can’t pay back negative balances from payments.
sig { returns(String) }
def losses_collector; end
sig { params(_losses_collector: String).returns(String) }
def losses_collector=(_losses_collector); end
sig { params(fees_collector: String, losses_collector: String).void }
def initialize(fees_collector: nil, losses_collector: nil); end
end
# 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(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The Account's preferred locales (languages), ordered by preference.
sig { returns(T.nilable(T::Array[String])) }
def locales; end
sig {
params(_locales: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def locales=(_locales); end
# Default responsibilities held by either Stripe or the platform.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Defaults::Responsibilities))
}
def responsibilities; end
sig {
params(_responsibilities: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Defaults::Responsibilities)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Defaults::Responsibilities))
}
def responsibilities=(_responsibilities); end
sig {
params(currency: T.nilable(String), locales: T.nilable(T::Array[String]), responsibilities: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Defaults::Responsibilities)).void
}
def initialize(currency: nil, locales: nil, responsibilities: nil); end
end
class Identity < Stripe::RequestParams
class Attestations < Stripe::RequestParams
class DirectorshipDeclaration < Stripe::RequestParams
# The time marking when the director attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def date; end
sig { params(_date: T.nilable(String)).returns(T.nilable(String)) }
def date=(_date); end
# The IP address from which the director attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the director attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(String), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class OwnershipDeclaration < Stripe::RequestParams
# The time marking when the beneficial owner attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def date; end
sig { params(_date: T.nilable(String)).returns(T.nilable(String)) }
def date=(_date); end
# The IP address from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the beneficial owner attestation was made.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(String), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class PersonsProvided < Stripe::RequestParams
# Whether the company’s directors have been provided. Set this Boolean to true after creating all the company’s directors with the [Persons API](https://docs.stripe.com/api/v2/core/accounts/createperson).
sig { returns(T.nilable(T::Boolean)) }
def directors; end
sig { params(_directors: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def directors=(_directors); end
# Whether the company’s executives have been provided. Set this Boolean to true after creating all the company’s executives with the [Persons API](https://docs.stripe.com/api/v2/core/accounts/createperson).
sig { returns(T.nilable(T::Boolean)) }
def executives; end
sig { params(_executives: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executives=(_executives); end
# Whether the company’s owners have been provided. Set this Boolean to true after creating all the company’s owners with the [Persons API](https://docs.stripe.com/api/v2/core/accounts/createperson).
sig { returns(T.nilable(T::Boolean)) }
def owners; end
sig { params(_owners: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owners=(_owners); end
# Reason for why the company is exempt from providing ownership information.
sig { returns(T.nilable(String)) }
def ownership_exemption_reason; end
sig {
params(_ownership_exemption_reason: T.nilable(String)).returns(T.nilable(String))
}
def ownership_exemption_reason=(_ownership_exemption_reason); end
sig {
params(directors: T.nilable(T::Boolean), executives: T.nilable(T::Boolean), owners: T.nilable(T::Boolean), ownership_exemption_reason: T.nilable(String)).void
}
def initialize(
directors: nil,
executives: nil,
owners: nil,
ownership_exemption_reason: nil
); end
end
class TermsOfService < Stripe::RequestParams
class Account < Stripe::RequestParams
# The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def date; end
sig { params(_date: T.nilable(String)).returns(T.nilable(String)) }
def date=(_date); end
# The IP address from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(String), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
class Storer < Stripe::RequestParams
# The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def date; end
sig { params(_date: T.nilable(String)).returns(T.nilable(String)) }
def date=(_date); end
# The IP address from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(String), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Details on the Account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance).
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::TermsOfService::Account))
}
def account; end
sig {
params(_account: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::TermsOfService::Account)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::TermsOfService::Account))
}
def account=(_account); end
# Details on the Account's acceptance of Treasury-specific terms of service.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::TermsOfService::Storer))
}
def storer; end
sig {
params(_storer: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::TermsOfService::Storer)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::TermsOfService::Storer))
}
def storer=(_storer); end
sig {
params(account: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::TermsOfService::Account), storer: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::TermsOfService::Storer)).void
}
def initialize(account: nil, storer: nil); end
end
# This hash is used to attest that the directors information provided to Stripe is both current and correct.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::DirectorshipDeclaration))
}
def directorship_declaration; end
sig {
params(_directorship_declaration: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::DirectorshipDeclaration)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::DirectorshipDeclaration))
}
def directorship_declaration=(_directorship_declaration); end
# This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::OwnershipDeclaration))
}
def ownership_declaration; end
sig {
params(_ownership_declaration: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::OwnershipDeclaration)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::OwnershipDeclaration))
}
def ownership_declaration=(_ownership_declaration); end
# Attestation that all Persons with a specific Relationship value have been provided.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::PersonsProvided))
}
def persons_provided; end
sig {
params(_persons_provided: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::PersonsProvided)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::PersonsProvided))
}
def persons_provided=(_persons_provided); end
# Attestations of accepted terms of service agreements.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::TermsOfService))
}
def terms_of_service; end
sig {
params(_terms_of_service: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::TermsOfService)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::TermsOfService))
}
def terms_of_service=(_terms_of_service); end
sig {
params(directorship_declaration: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::DirectorshipDeclaration), ownership_declaration: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::OwnershipDeclaration), persons_provided: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::PersonsProvided), terms_of_service: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations::TermsOfService)).void
}
def initialize(
directorship_declaration: nil,
ownership_declaration: nil,
persons_provided: nil,
terms_of_service: nil
); end
end
class BusinessDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class AnnualRevenue < Stripe::RequestParams
# A non-negative integer representing the amount in the smallest currency unit.
sig { returns(T.nilable(Stripe::V2::Amount)) }
def amount; end
sig {
params(_amount: T.nilable(Stripe::V2::Amount)).returns(T.nilable(Stripe::V2::Amount))
}
def amount=(_amount); end
# The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
sig { returns(T.nilable(String)) }
def fiscal_year_end; end
sig { params(_fiscal_year_end: T.nilable(String)).returns(T.nilable(String)) }
def fiscal_year_end=(_fiscal_year_end); end
sig {
params(amount: T.nilable(Stripe::V2::Amount), fiscal_year_end: T.nilable(String)).void
}
def initialize(amount: nil, fiscal_year_end: nil); end
end
class Documents < Stripe::RequestParams
class BankAccountOwnershipVerification < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class CompanyLicense < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class CompanyMemorandumOfAssociation < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class CompanyMinisterialDecree < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class CompanyRegistrationVerification < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class CompanyTaxIdVerification < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class PrimaryVerification < Stripe::RequestParams
class FrontBack < Stripe::RequestParams
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
sig {
returns(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::PrimaryVerification::FrontBack)
}
def front_back; end
sig {
params(_front_back: ::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::PrimaryVerification::FrontBack).returns(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::PrimaryVerification::FrontBack)
}
def front_back=(_front_back); end
# The format of the verification document. Currently supports `front_back` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(front_back: ::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::PrimaryVerification::FrontBack, type: String).void
}
def initialize(front_back: nil, type: nil); end
end
class ProofOfAddress < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class ProofOfRegistration < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class ProofOfUltimateBeneficialOwnership < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
# One or more documents that support the bank account ownership verification requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::BankAccountOwnershipVerification))
}
def bank_account_ownership_verification; end
sig {
params(_bank_account_ownership_verification: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::BankAccountOwnershipVerification)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::BankAccountOwnershipVerification))
}
def bank_account_ownership_verification=(_bank_account_ownership_verification); end
# One or more documents that demonstrate proof of a company’s license to operate.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyLicense))
}
def company_license; end
sig {
params(_company_license: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyLicense)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyLicense))
}
def company_license=(_company_license); end
# One or more documents showing the company’s Memorandum of Association.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyMemorandumOfAssociation))
}
def company_memorandum_of_association; end
sig {
params(_company_memorandum_of_association: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyMemorandumOfAssociation)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyMemorandumOfAssociation))
}
def company_memorandum_of_association=(_company_memorandum_of_association); end
# Certain countries only: One or more documents showing the ministerial decree legalizing the company’s establishment.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyMinisterialDecree))
}
def company_ministerial_decree; end
sig {
params(_company_ministerial_decree: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyMinisterialDecree)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyMinisterialDecree))
}
def company_ministerial_decree=(_company_ministerial_decree); end
# One or more documents that demonstrate proof of a company’s registration with the appropriate local authorities.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyRegistrationVerification))
}
def company_registration_verification; end
sig {
params(_company_registration_verification: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyRegistrationVerification)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyRegistrationVerification))
}
def company_registration_verification=(_company_registration_verification); end
# One or more documents that demonstrate proof of a company’s tax ID.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyTaxIdVerification))
}
def company_tax_id_verification; end
sig {
params(_company_tax_id_verification: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyTaxIdVerification)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyTaxIdVerification))
}
def company_tax_id_verification=(_company_tax_id_verification); end
# A document verifying the business.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::PrimaryVerification))
}
def primary_verification; end
sig {
params(_primary_verification: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::PrimaryVerification)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::PrimaryVerification))
}
def primary_verification=(_primary_verification); end
# One or more documents that demonstrate proof of address.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::ProofOfAddress))
}
def proof_of_address; end
sig {
params(_proof_of_address: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::ProofOfAddress)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::ProofOfAddress))
}
def proof_of_address=(_proof_of_address); end
# One or more documents showing the company’s proof of registration with the national business registry.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::ProofOfRegistration))
}
def proof_of_registration; end
sig {
params(_proof_of_registration: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::ProofOfRegistration)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::ProofOfRegistration))
}
def proof_of_registration=(_proof_of_registration); end
# One or more documents that demonstrate proof of ultimate beneficial ownership.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::ProofOfUltimateBeneficialOwnership))
}
def proof_of_ultimate_beneficial_ownership; end
sig {
params(_proof_of_ultimate_beneficial_ownership: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::ProofOfUltimateBeneficialOwnership)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::ProofOfUltimateBeneficialOwnership))
}
def proof_of_ultimate_beneficial_ownership=(
_proof_of_ultimate_beneficial_ownership
); end
sig {
params(bank_account_ownership_verification: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::BankAccountOwnershipVerification), company_license: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyLicense), company_memorandum_of_association: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyMemorandumOfAssociation), company_ministerial_decree: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyMinisterialDecree), company_registration_verification: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyRegistrationVerification), company_tax_id_verification: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::CompanyTaxIdVerification), primary_verification: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::PrimaryVerification), proof_of_address: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::ProofOfAddress), proof_of_registration: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::ProofOfRegistration), proof_of_ultimate_beneficial_ownership: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents::ProofOfUltimateBeneficialOwnership)).void
}
def initialize(
bank_account_ownership_verification: nil,
company_license: nil,
company_memorandum_of_association: nil,
company_ministerial_decree: nil,
company_registration_verification: nil,
company_tax_id_verification: nil,
primary_verification: nil,
proof_of_address: nil,
proof_of_registration: nil,
proof_of_ultimate_beneficial_ownership: nil
); end
end
class IdNumber < Stripe::RequestParams
# The registrar of the ID number (Only valid for DE ID number types).
sig { returns(T.nilable(String)) }
def registrar; end
sig { params(_registrar: T.nilable(String)).returns(T.nilable(String)) }
def registrar=(_registrar); end
# Open Enum. The ID number type of a business entity.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The value of the ID number.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(registrar: T.nilable(String), type: String, value: String).void }
def initialize(registrar: nil, type: nil, value: nil); end
end
class MonthlyEstimatedRevenue < Stripe::RequestParams
# A non-negative integer representing the amount in the smallest currency unit.
sig { returns(T.nilable(Stripe::V2::Amount)) }
def amount; end
sig {
params(_amount: T.nilable(Stripe::V2::Amount)).returns(T.nilable(Stripe::V2::Amount))
}
def amount=(_amount); end
sig { params(amount: T.nilable(Stripe::V2::Amount)).void }
def initialize(amount: nil); end
end
class ScriptAddresses < Stripe::RequestParams
class Kana < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class Kanji < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
# Kana Address.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptAddresses::Kana))
}
def kana; end
sig {
params(_kana: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptAddresses::Kana)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptAddresses::Kana))
}
def kana=(_kana); end
# Kanji Address.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptAddresses::Kanji))
}
def kanji; end
sig {
params(_kanji: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptAddresses::Kanji)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptAddresses::Kanji))
}
def kanji=(_kanji); end
sig {
params(kana: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptAddresses::Kana), kanji: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptAddresses::Kanji)).void
}
def initialize(kana: nil, kanji: nil); end
end
class ScriptNames < Stripe::RequestParams
class Kana < Stripe::RequestParams
# Registered name of the business.
sig { returns(T.nilable(String)) }
def registered_name; end
sig { params(_registered_name: T.nilable(String)).returns(T.nilable(String)) }
def registered_name=(_registered_name); end
sig { params(registered_name: T.nilable(String)).void }
def initialize(registered_name: nil); end
end
class Kanji < Stripe::RequestParams
# Registered name of the business.
sig { returns(T.nilable(String)) }
def registered_name; end
sig { params(_registered_name: T.nilable(String)).returns(T.nilable(String)) }
def registered_name=(_registered_name); end
sig { params(registered_name: T.nilable(String)).void }
def initialize(registered_name: nil); end
end
# Kana name.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptNames::Kana))
}
def kana; end
sig {
params(_kana: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptNames::Kana)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptNames::Kana))
}
def kana=(_kana); end
# Kanji name.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptNames::Kanji))
}
def kanji; end
sig {
params(_kanji: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptNames::Kanji)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptNames::Kanji))
}
def kanji=(_kanji); end
sig {
params(kana: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptNames::Kana), kanji: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptNames::Kanji)).void
}
def initialize(kana: nil, kanji: nil); end
end
# The business registration address of the business entity.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Address)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Address))
}
def address=(_address); end
# The business gross annual revenue for its preceding fiscal year.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::AnnualRevenue))
}
def annual_revenue; end
sig {
params(_annual_revenue: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::AnnualRevenue)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::AnnualRevenue))
}
def annual_revenue=(_annual_revenue); end
# A document verifying the business.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents))
}
def documents; end
sig {
params(_documents: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents))
}
def documents=(_documents); end
# The name which is used by the business.
sig { returns(T.nilable(String)) }
def doing_business_as; end
sig { params(_doing_business_as: T.nilable(String)).returns(T.nilable(String)) }
def doing_business_as=(_doing_business_as); end
# An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
sig { returns(T.nilable(Integer)) }
def estimated_worker_count; end
sig {
params(_estimated_worker_count: T.nilable(Integer)).returns(T.nilable(Integer))
}
def estimated_worker_count=(_estimated_worker_count); end
# The ID numbers of a business entity.
sig {
returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::IdNumber]))
}
def id_numbers; end
sig {
params(_id_numbers: T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::IdNumber])).returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::IdNumber]))
}
def id_numbers=(_id_numbers); end
# An estimate of the monthly revenue of the business.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::MonthlyEstimatedRevenue))
}
def monthly_estimated_revenue; end
sig {
params(_monthly_estimated_revenue: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::MonthlyEstimatedRevenue)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::MonthlyEstimatedRevenue))
}
def monthly_estimated_revenue=(_monthly_estimated_revenue); end
# The phone number of the Business Entity.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# Internal-only description of the product sold or service provided by the business. It’s used by Stripe for risk and underwriting purposes.
sig { returns(T.nilable(String)) }
def product_description; end
sig { params(_product_description: T.nilable(String)).returns(T.nilable(String)) }
def product_description=(_product_description); end
# The business legal name.
sig { returns(T.nilable(String)) }
def registered_name; end
sig { params(_registered_name: T.nilable(String)).returns(T.nilable(String)) }
def registered_name=(_registered_name); end
# The business registration address of the business entity in non latin script.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptAddresses))
}
def script_addresses; end
sig {
params(_script_addresses: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptAddresses)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptAddresses))
}
def script_addresses=(_script_addresses); end
# The business legal name in non latin script.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptNames))
}
def script_names; end
sig {
params(_script_names: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptNames)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptNames))
}
def script_names=(_script_names); end
# The category identifying the legal structure of the business.
sig { returns(T.nilable(String)) }
def structure; end
sig { params(_structure: T.nilable(String)).returns(T.nilable(String)) }
def structure=(_structure); end
# The business's publicly available website.
sig { returns(T.nilable(String)) }
def url; end
sig { params(_url: T.nilable(String)).returns(T.nilable(String)) }
def url=(_url); end
sig {
params(address: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Address), annual_revenue: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::AnnualRevenue), documents: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::Documents), doing_business_as: T.nilable(String), estimated_worker_count: T.nilable(Integer), id_numbers: T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::IdNumber]), monthly_estimated_revenue: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::MonthlyEstimatedRevenue), phone: T.nilable(String), product_description: T.nilable(String), registered_name: T.nilable(String), script_addresses: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptAddresses), script_names: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails::ScriptNames), structure: T.nilable(String), url: T.nilable(String)).void
}
def initialize(
address: nil,
annual_revenue: nil,
documents: nil,
doing_business_as: nil,
estimated_worker_count: nil,
id_numbers: nil,
monthly_estimated_revenue: nil,
phone: nil,
product_description: nil,
registered_name: nil,
script_addresses: nil,
script_names: nil,
structure: nil,
url: nil
); end
end
class Individual < Stripe::RequestParams
class AdditionalAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Purpose of additional address.
sig { returns(String) }
def purpose; end
sig { params(_purpose: String).returns(String) }
def purpose=(_purpose); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), purpose: String, state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
purpose: nil,
state: nil,
town: nil
); end
end
class AdditionalName < Stripe::RequestParams
# The person's full name.
sig { returns(T.nilable(String)) }
def full_name; end
sig { params(_full_name: T.nilable(String)).returns(T.nilable(String)) }
def full_name=(_full_name); end
# The person's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
sig { params(_given_name: T.nilable(String)).returns(T.nilable(String)) }
def given_name=(_given_name); end
# The purpose or type of the additional name.
sig { returns(String) }
def purpose; end
sig { params(_purpose: String).returns(String) }
def purpose=(_purpose); end
# The person's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
sig { params(_surname: T.nilable(String)).returns(T.nilable(String)) }
def surname=(_surname); end
sig {
params(full_name: T.nilable(String), given_name: T.nilable(String), purpose: String, surname: T.nilable(String)).void
}
def initialize(full_name: nil, given_name: nil, purpose: nil, surname: nil); end
end
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class DateOfBirth < Stripe::RequestParams
# The day of the birth.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Documents < Stripe::RequestParams
class CompanyAuthorization < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class Passport < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class PrimaryVerification < Stripe::RequestParams
class FrontBack < Stripe::RequestParams
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
sig {
returns(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::PrimaryVerification::FrontBack)
}
def front_back; end
sig {
params(_front_back: ::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::PrimaryVerification::FrontBack).returns(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::PrimaryVerification::FrontBack)
}
def front_back=(_front_back); end
# The format of the verification document. Currently supports `front_back` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(front_back: ::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::PrimaryVerification::FrontBack, type: String).void
}
def initialize(front_back: nil, type: nil); end
end
class SecondaryVerification < Stripe::RequestParams
class FrontBack < Stripe::RequestParams
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
sig {
returns(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::SecondaryVerification::FrontBack)
}
def front_back; end
sig {
params(_front_back: ::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::SecondaryVerification::FrontBack).returns(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::SecondaryVerification::FrontBack)
}
def front_back=(_front_back); end
# The format of the verification document. Currently supports `front_back` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(front_back: ::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::SecondaryVerification::FrontBack, type: String).void
}
def initialize(front_back: nil, type: nil); end
end
class Visa < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
# One or more documents that demonstrate proof that this person is authorized to represent the company.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::CompanyAuthorization))
}
def company_authorization; end
sig {
params(_company_authorization: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::CompanyAuthorization)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::CompanyAuthorization))
}
def company_authorization=(_company_authorization); end
# One or more documents showing the person’s passport page with photo and personal data.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::Passport))
}
def passport; end
sig {
params(_passport: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::Passport)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::Passport))
}
def passport=(_passport); end
# An identifying document showing the person's name, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::PrimaryVerification))
}
def primary_verification; end
sig {
params(_primary_verification: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::PrimaryVerification)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::PrimaryVerification))
}
def primary_verification=(_primary_verification); end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::SecondaryVerification))
}
def secondary_verification; end
sig {
params(_secondary_verification: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::SecondaryVerification)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::SecondaryVerification))
}
def secondary_verification=(_secondary_verification); end
# One or more documents showing the person’s visa required for living in the country where they are residing.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::Visa))
}
def visa; end
sig {
params(_visa: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::Visa)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::Visa))
}
def visa=(_visa); end
sig {
params(company_authorization: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::CompanyAuthorization), passport: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::Passport), primary_verification: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::PrimaryVerification), secondary_verification: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::SecondaryVerification), visa: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents::Visa)).void
}
def initialize(
company_authorization: nil,
passport: nil,
primary_verification: nil,
secondary_verification: nil,
visa: nil
); end
end
class IdNumber < Stripe::RequestParams
# The ID number type of an individual.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The value of the ID number.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(type: String, value: String).void }
def initialize(type: nil, value: nil); end
end
class Relationship < Stripe::RequestParams
# Whether the person is a director of the account's identity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
sig { returns(T.nilable(T::Boolean)) }
def director; end
sig { params(_director: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def director=(_director); end
# Whether the person has significant responsibility to control, manage, or direct the organization.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
sig { params(_executive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executive=(_executive); end
# Whether the person is an owner of the account’s identity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
sig { params(_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owner=(_owner); end
# The percent owned by the person of the account's legal entity.
sig { returns(T.nilable(String)) }
def percent_ownership; end
sig { params(_percent_ownership: T.nilable(String)).returns(T.nilable(String)) }
def percent_ownership=(_percent_ownership); end
# The person's title (e.g., CEO, Support Engineer).
sig { returns(T.nilable(String)) }
def title; end
sig { params(_title: T.nilable(String)).returns(T.nilable(String)) }
def title=(_title); end
sig {
params(director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), percent_ownership: T.nilable(String), title: T.nilable(String)).void
}
def initialize(
director: nil,
executive: nil,
owner: nil,
percent_ownership: nil,
title: nil
); end
end
class ScriptAddresses < Stripe::RequestParams
class Kana < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class Kanji < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
# Kana Address.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptAddresses::Kana))
}
def kana; end
sig {
params(_kana: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptAddresses::Kana)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptAddresses::Kana))
}
def kana=(_kana); end
# Kanji Address.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptAddresses::Kanji))
}
def kanji; end
sig {
params(_kanji: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptAddresses::Kanji)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptAddresses::Kanji))
}
def kanji=(_kanji); end
sig {
params(kana: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptAddresses::Kana), kanji: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptAddresses::Kanji)).void
}
def initialize(kana: nil, kanji: nil); end
end
class ScriptNames < Stripe::RequestParams
class Kana < Stripe::RequestParams
# The person's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
sig { params(_given_name: T.nilable(String)).returns(T.nilable(String)) }
def given_name=(_given_name); end
# The person's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
sig { params(_surname: T.nilable(String)).returns(T.nilable(String)) }
def surname=(_surname); end
sig { params(given_name: T.nilable(String), surname: T.nilable(String)).void }
def initialize(given_name: nil, surname: nil); end
end
class Kanji < Stripe::RequestParams
# The person's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
sig { params(_given_name: T.nilable(String)).returns(T.nilable(String)) }
def given_name=(_given_name); end
# The person's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
sig { params(_surname: T.nilable(String)).returns(T.nilable(String)) }
def surname=(_surname); end
sig { params(given_name: T.nilable(String), surname: T.nilable(String)).void }
def initialize(given_name: nil, surname: nil); end
end
# Persons name in kana script.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptNames::Kana))
}
def kana; end
sig {
params(_kana: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptNames::Kana)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptNames::Kana))
}
def kana=(_kana); end
# Persons name in kanji script.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptNames::Kanji))
}
def kanji; end
sig {
params(_kanji: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptNames::Kanji)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptNames::Kanji))
}
def kanji=(_kanji); end
sig {
params(kana: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptNames::Kana), kanji: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptNames::Kanji)).void
}
def initialize(kana: nil, kanji: nil); end
end
# Additional addresses associated with the individual.
sig {
returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::AdditionalAddress]))
}
def additional_addresses; end
sig {
params(_additional_addresses: T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::AdditionalAddress])).returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::AdditionalAddress]))
}
def additional_addresses=(_additional_addresses); end
# Additional names (e.g. aliases) associated with the individual.
sig {
returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::AdditionalName]))
}
def additional_names; end
sig {
params(_additional_names: T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::AdditionalName])).returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::AdditionalName]))
}
def additional_names=(_additional_names); end
# The individual's residential address.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Address)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Address))
}
def address=(_address); end
# The individual's date of birth.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::DateOfBirth))
}
def date_of_birth; end
sig {
params(_date_of_birth: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::DateOfBirth)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::DateOfBirth))
}
def date_of_birth=(_date_of_birth); end
# Documents that may be submitted to satisfy various informational requests.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents))
}
def documents; end
sig {
params(_documents: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents))
}
def documents=(_documents); end
# The individual's email address.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The individual's first name.
sig { returns(T.nilable(String)) }
def given_name; end
sig { params(_given_name: T.nilable(String)).returns(T.nilable(String)) }
def given_name=(_given_name); end
# The identification numbers (e.g., SSN) associated with the individual.
sig {
returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::IdNumber]))
}
def id_numbers; end
sig {
params(_id_numbers: T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::IdNumber])).returns(T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::IdNumber]))
}
def id_numbers=(_id_numbers); end
# The individual's gender (International regulations require either "male" or "female").
sig { returns(T.nilable(String)) }
def legal_gender; end
sig { params(_legal_gender: T.nilable(String)).returns(T.nilable(String)) }
def legal_gender=(_legal_gender); end
# Set of key-value pairs 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, T.nilable(String)])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, T.nilable(String)])).returns(T.nilable(T::Hash[String, T.nilable(String)]))
}
def metadata=(_metadata); end
# The countries where the individual is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(T::Array[String])) }
def nationalities; end
sig {
params(_nationalities: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def nationalities=(_nationalities); end
# The individual's phone number.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The individual's political exposure.
sig { returns(T.nilable(String)) }
def political_exposure; end
sig { params(_political_exposure: T.nilable(String)).returns(T.nilable(String)) }
def political_exposure=(_political_exposure); end
# The relationship that this individual has with the account's identity.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Relationship))
}
def relationship; end
sig {
params(_relationship: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Relationship)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Relationship))
}
def relationship=(_relationship); end
# The script addresses (e.g., non-Latin characters) associated with the individual.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptAddresses))
}
def script_addresses; end
sig {
params(_script_addresses: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptAddresses)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptAddresses))
}
def script_addresses=(_script_addresses); end
# The individuals primary name in non latin script.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptNames))
}
def script_names; end
sig {
params(_script_names: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptNames)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptNames))
}
def script_names=(_script_names); end
# The individual's last name.
sig { returns(T.nilable(String)) }
def surname; end
sig { params(_surname: T.nilable(String)).returns(T.nilable(String)) }
def surname=(_surname); end
sig {
params(additional_addresses: T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::AdditionalAddress]), additional_names: T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::AdditionalName]), address: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Address), date_of_birth: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::DateOfBirth), documents: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Documents), email: T.nilable(String), given_name: T.nilable(String), id_numbers: T.nilable(T::Array[::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::IdNumber]), legal_gender: T.nilable(String), metadata: T.nilable(T::Hash[String, T.nilable(String)]), nationalities: T.nilable(T::Array[String]), phone: T.nilable(String), political_exposure: T.nilable(String), relationship: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::Relationship), script_addresses: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptAddresses), script_names: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual::ScriptNames), surname: T.nilable(String)).void
}
def initialize(
additional_addresses: nil,
additional_names: nil,
address: nil,
date_of_birth: nil,
documents: nil,
email: nil,
given_name: nil,
id_numbers: nil,
legal_gender: nil,
metadata: nil,
nationalities: nil,
phone: nil,
political_exposure: nil,
relationship: nil,
script_addresses: nil,
script_names: nil,
surname: nil
); end
end
# Attestations from the identity's key people, e.g. owners, executives, directors.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations))
}
def attestations; end
sig {
params(_attestations: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations))
}
def attestations=(_attestations); end
# Information about the company or business.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails))
}
def business_details; end
sig {
params(_business_details: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails))
}
def business_details=(_business_details); end
# The country in which the account holder resides, or in which the business is legally established. This should be an [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# The entity type.
sig { returns(T.nilable(String)) }
def entity_type; end
sig { params(_entity_type: T.nilable(String)).returns(T.nilable(String)) }
def entity_type=(_entity_type); end
# Information about the individual represented by the Account. This property is `null` unless `entity_type` is set to `individual`.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual))
}
def individual; end
sig {
params(_individual: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual))
}
def individual=(_individual); end
sig {
params(attestations: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Attestations), business_details: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::BusinessDetails), country: T.nilable(String), entity_type: T.nilable(String), individual: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity::Individual)).void
}
def initialize(
attestations: nil,
business_details: nil,
country: nil,
entity_type: nil,
individual: nil
); end
end
# An Account Configuration which allows the Account to take on a key persona across Stripe products.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration))
}
def configuration; end
sig {
params(_configuration: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration))
}
def configuration=(_configuration); end
# The default contact email address for the Account. Required when configuring the account as a merchant or recipient.
sig { returns(T.nilable(String)) }
def contact_email; end
sig { params(_contact_email: T.nilable(String)).returns(T.nilable(String)) }
def contact_email=(_contact_email); end
# A value indicating the Stripe dashboard this Account has access to. This will depend on which configurations are enabled for this account.
sig { returns(T.nilable(String)) }
def dashboard; end
sig { params(_dashboard: T.nilable(String)).returns(T.nilable(String)) }
def dashboard=(_dashboard); end
# Default values to be used on Account Configurations.
sig { returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Defaults)) }
def defaults; end
sig {
params(_defaults: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Defaults)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Defaults))
}
def defaults=(_defaults); end
# A descriptive name for the Account. This name will be surfaced in the Stripe Dashboard and on any invoices sent to the Account.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# Information about the company, individual, and business represented by the Account.
sig { returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity)) }
def identity; end
sig {
params(_identity: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity)).returns(T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity))
}
def identity=(_identity); end
# Additional fields to include in the response.
sig { returns(T.nilable(T::Array[String])) }
def include; end
sig { params(_include: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def include=(_include); end
# Set of key-value pairs 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, T.nilable(String)])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, T.nilable(String)])).returns(T.nilable(T::Hash[String, T.nilable(String)]))
}
def metadata=(_metadata); end
sig {
params(configuration: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Configuration), contact_email: T.nilable(String), dashboard: T.nilable(String), defaults: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Defaults), display_name: T.nilable(String), identity: T.nilable(::Stripe::V2::Core::AccountService::UpdateParams::Identity), include: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, T.nilable(String)])).void
}
def initialize(
configuration: nil,
contact_email: nil,
dashboard: nil,
defaults: nil,
display_name: nil,
identity: nil,
include: nil,
metadata: nil
); end
end
class CloseParams < Stripe::RequestParams
# Configurations on the Account to be closed. All configurations on the Account must be passed in for this request to succeed.
sig { returns(T.nilable(T::Array[String])) }
def applied_configurations; end
sig {
params(_applied_configurations: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def applied_configurations=(_applied_configurations); end
sig { params(applied_configurations: T.nilable(T::Array[String])).void }
def initialize(applied_configurations: nil); end
end
# Removes access to the Account and its associated resources.
sig {
params(id: String, params: T.any(::Stripe::V2::Core::AccountService::CloseParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::Account)
}
def close(id, params = {}, opts = {}); end
# An Account is a representation of a company, individual or other entity that a user interacts with. Accounts contain identifying information about the entity, and configurations that store the features an account has access to. An account can be configured as any or all of the following configurations: Customer, Merchant and/or Recipient.
sig {
params(params: T.any(::Stripe::V2::Core::AccountService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::Account)
}
def create(params = {}, opts = {}); end
# Returns a list of Accounts.
sig {
params(params: T.any(::Stripe::V2::Core::AccountService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an Account.
sig {
params(id: String, params: T.any(::Stripe::V2::Core::AccountService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::Account)
}
def retrieve(id, params = {}, opts = {}); end
# Updates the details of an Account.
sig {
params(id: String, params: T.any(::Stripe::V2::Core::AccountService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::Account)
}
def update(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module Core
module Accounts
class PersonService < StripeService
class ListParams < Stripe::RequestParams
# The upper limit on the number of accounts returned by the List Account request.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
sig { params(limit: T.nilable(Integer)).void }
def initialize(limit: nil); end
end
class CreateParams < Stripe::RequestParams
class AdditionalAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Purpose of additional address.
sig { returns(String) }
def purpose; end
sig { params(_purpose: String).returns(String) }
def purpose=(_purpose); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), purpose: String, state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
purpose: nil,
state: nil,
town: nil
); end
end
class AdditionalName < Stripe::RequestParams
# The person's full name.
sig { returns(T.nilable(String)) }
def full_name; end
sig { params(_full_name: T.nilable(String)).returns(T.nilable(String)) }
def full_name=(_full_name); end
# The person's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
sig { params(_given_name: T.nilable(String)).returns(T.nilable(String)) }
def given_name=(_given_name); end
# The purpose or type of the additional name.
sig { returns(String) }
def purpose; end
sig { params(_purpose: String).returns(String) }
def purpose=(_purpose); end
# The person's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
sig { params(_surname: T.nilable(String)).returns(T.nilable(String)) }
def surname=(_surname); end
sig {
params(full_name: T.nilable(String), given_name: T.nilable(String), purpose: String, surname: T.nilable(String)).void
}
def initialize(full_name: nil, given_name: nil, purpose: nil, surname: nil); end
end
class AdditionalTermsOfService < Stripe::RequestParams
class Account < Stripe::RequestParams
# The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(String) }
def date; end
sig { params(_date: String).returns(String) }
def date=(_date); end
# The IP address from which the Account's representative accepted the terms of service.
sig { returns(String) }
def ip; end
sig { params(_ip: String).returns(String) }
def ip=(_ip); end
# The user agent of the browser from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig { params(date: String, ip: String, user_agent: T.nilable(String)).void }
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Stripe terms of service agreement.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::AdditionalTermsOfService::Account))
}
def account; end
sig {
params(_account: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::AdditionalTermsOfService::Account)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::AdditionalTermsOfService::Account))
}
def account=(_account); end
sig {
params(account: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::AdditionalTermsOfService::Account)).void
}
def initialize(account: nil); end
end
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class DateOfBirth < Stripe::RequestParams
# The day of birth.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Documents < Stripe::RequestParams
class CompanyAuthorization < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class Passport < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class PrimaryVerification < Stripe::RequestParams
class FrontBack < Stripe::RequestParams
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(String) }
def front; end
sig { params(_front: String).returns(String) }
def front=(_front); end
sig { params(back: T.nilable(String), front: String).void }
def initialize(back: nil, front: nil); end
end
# The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
sig {
returns(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::PrimaryVerification::FrontBack)
}
def front_back; end
sig {
params(_front_back: ::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::PrimaryVerification::FrontBack).returns(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::PrimaryVerification::FrontBack)
}
def front_back=(_front_back); end
# The format of the verification document. Currently supports `front_back` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(front_back: ::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::PrimaryVerification::FrontBack, type: String).void
}
def initialize(front_back: nil, type: nil); end
end
class SecondaryVerification < Stripe::RequestParams
class FrontBack < Stripe::RequestParams
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(String) }
def front; end
sig { params(_front: String).returns(String) }
def front=(_front); end
sig { params(back: T.nilable(String), front: String).void }
def initialize(back: nil, front: nil); end
end
# The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
sig {
returns(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::SecondaryVerification::FrontBack)
}
def front_back; end
sig {
params(_front_back: ::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::SecondaryVerification::FrontBack).returns(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::SecondaryVerification::FrontBack)
}
def front_back=(_front_back); end
# The format of the verification document. Currently supports `front_back` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(front_back: ::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::SecondaryVerification::FrontBack, type: String).void
}
def initialize(front_back: nil, type: nil); end
end
class Visa < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
# One or more documents that demonstrate proof that this person is authorized to represent the company.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::CompanyAuthorization))
}
def company_authorization; end
sig {
params(_company_authorization: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::CompanyAuthorization)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::CompanyAuthorization))
}
def company_authorization=(_company_authorization); end
# One or more documents showing the person’s passport page with photo and personal data.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::Passport))
}
def passport; end
sig {
params(_passport: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::Passport)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::Passport))
}
def passport=(_passport); end
# An identifying document showing the person's name, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::PrimaryVerification))
}
def primary_verification; end
sig {
params(_primary_verification: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::PrimaryVerification)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::PrimaryVerification))
}
def primary_verification=(_primary_verification); end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::SecondaryVerification))
}
def secondary_verification; end
sig {
params(_secondary_verification: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::SecondaryVerification)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::SecondaryVerification))
}
def secondary_verification=(_secondary_verification); end
# One or more documents showing the person’s visa required for living in the country where they are residing.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::Visa))
}
def visa; end
sig {
params(_visa: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::Visa)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::Visa))
}
def visa=(_visa); end
sig {
params(company_authorization: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::CompanyAuthorization), passport: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::Passport), primary_verification: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::PrimaryVerification), secondary_verification: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::SecondaryVerification), visa: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents::Visa)).void
}
def initialize(
company_authorization: nil,
passport: nil,
primary_verification: nil,
secondary_verification: nil,
visa: nil
); end
end
class IdNumber < Stripe::RequestParams
# The ID number type of an individual.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The value of the ID number.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(type: String, value: String).void }
def initialize(type: nil, value: nil); end
end
class Relationship < Stripe::RequestParams
# Whether the individual is an authorizer of the Account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def authorizer; end
sig { params(_authorizer: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def authorizer=(_authorizer); end
# Indicates whether the person is a director of the associated legal entity.
sig { returns(T.nilable(T::Boolean)) }
def director; end
sig { params(_director: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def director=(_director); end
# Indicates whether the person is an executive of the associated legal entity.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
sig { params(_executive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executive=(_executive); end
# Indicates whether the person is a legal guardian of the associated legal entity.
sig { returns(T.nilable(T::Boolean)) }
def legal_guardian; end
sig { params(_legal_guardian: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def legal_guardian=(_legal_guardian); end
# Indicates whether the person is an owner of the associated legal entity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
sig { params(_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owner=(_owner); end
# The percentage of ownership the person has in the associated legal entity.
sig { returns(T.nilable(String)) }
def percent_ownership; end
sig { params(_percent_ownership: T.nilable(String)).returns(T.nilable(String)) }
def percent_ownership=(_percent_ownership); end
# Indicates whether the person is a representative of the associated legal entity.
sig { returns(T.nilable(T::Boolean)) }
def representative; end
sig { params(_representative: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def representative=(_representative); end
# The title or position the person holds in the associated legal entity.
sig { returns(T.nilable(String)) }
def title; end
sig { params(_title: T.nilable(String)).returns(T.nilable(String)) }
def title=(_title); end
sig {
params(authorizer: T.nilable(T::Boolean), director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), legal_guardian: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), percent_ownership: T.nilable(String), representative: T.nilable(T::Boolean), title: T.nilable(String)).void
}
def initialize(
authorizer: nil,
director: nil,
executive: nil,
legal_guardian: nil,
owner: nil,
percent_ownership: nil,
representative: nil,
title: nil
); end
end
class ScriptAddresses < Stripe::RequestParams
class Kana < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class Kanji < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
# Kana Address.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptAddresses::Kana))
}
def kana; end
sig {
params(_kana: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptAddresses::Kana)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptAddresses::Kana))
}
def kana=(_kana); end
# Kanji Address.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptAddresses::Kanji))
}
def kanji; end
sig {
params(_kanji: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptAddresses::Kanji)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptAddresses::Kanji))
}
def kanji=(_kanji); end
sig {
params(kana: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptAddresses::Kana), kanji: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptAddresses::Kanji)).void
}
def initialize(kana: nil, kanji: nil); end
end
class ScriptNames < Stripe::RequestParams
class Kana < Stripe::RequestParams
# The person's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
sig { params(_given_name: T.nilable(String)).returns(T.nilable(String)) }
def given_name=(_given_name); end
# The person's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
sig { params(_surname: T.nilable(String)).returns(T.nilable(String)) }
def surname=(_surname); end
sig { params(given_name: T.nilable(String), surname: T.nilable(String)).void }
def initialize(given_name: nil, surname: nil); end
end
class Kanji < Stripe::RequestParams
# The person's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
sig { params(_given_name: T.nilable(String)).returns(T.nilable(String)) }
def given_name=(_given_name); end
# The person's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
sig { params(_surname: T.nilable(String)).returns(T.nilable(String)) }
def surname=(_surname); end
sig { params(given_name: T.nilable(String), surname: T.nilable(String)).void }
def initialize(given_name: nil, surname: nil); end
end
# Persons name in kana script.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptNames::Kana))
}
def kana; end
sig {
params(_kana: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptNames::Kana)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptNames::Kana))
}
def kana=(_kana); end
# Persons name in kanji script.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptNames::Kanji))
}
def kanji; end
sig {
params(_kanji: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptNames::Kanji)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptNames::Kanji))
}
def kanji=(_kanji); end
sig {
params(kana: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptNames::Kana), kanji: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptNames::Kanji)).void
}
def initialize(kana: nil, kanji: nil); end
end
# Additional addresses associated with the person.
sig {
returns(T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::CreateParams::AdditionalAddress]))
}
def additional_addresses; end
sig {
params(_additional_addresses: T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::CreateParams::AdditionalAddress])).returns(T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::CreateParams::AdditionalAddress]))
}
def additional_addresses=(_additional_addresses); end
# Additional names (e.g. aliases) associated with the person.
sig {
returns(T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::CreateParams::AdditionalName]))
}
def additional_names; end
sig {
params(_additional_names: T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::CreateParams::AdditionalName])).returns(T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::CreateParams::AdditionalName]))
}
def additional_names=(_additional_names); end
# Attestations of accepted terms of service agreements.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::AdditionalTermsOfService))
}
def additional_terms_of_service; end
sig {
params(_additional_terms_of_service: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::AdditionalTermsOfService)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::AdditionalTermsOfService))
}
def additional_terms_of_service=(_additional_terms_of_service); end
# The person's residential address.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Address)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Address))
}
def address=(_address); end
# The person's date of birth.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::DateOfBirth))
}
def date_of_birth; end
sig {
params(_date_of_birth: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::DateOfBirth)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::DateOfBirth))
}
def date_of_birth=(_date_of_birth); end
# Documents that may be submitted to satisfy various informational requests.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents))
}
def documents; end
sig {
params(_documents: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents))
}
def documents=(_documents); end
# Email.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The person's first name.
sig { returns(T.nilable(String)) }
def given_name; end
sig { params(_given_name: T.nilable(String)).returns(T.nilable(String)) }
def given_name=(_given_name); end
# The identification numbers (e.g., SSN) associated with the person.
sig {
returns(T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::CreateParams::IdNumber]))
}
def id_numbers; end
sig {
params(_id_numbers: T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::CreateParams::IdNumber])).returns(T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::CreateParams::IdNumber]))
}
def id_numbers=(_id_numbers); end
# The person's gender (International regulations require either "male" or "female").
sig { returns(T.nilable(String)) }
def legal_gender; end
sig { params(_legal_gender: T.nilable(String)).returns(T.nilable(String)) }
def legal_gender=(_legal_gender); end
# Set of key-value pairs 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The nationalities (countries) this person is associated with.
sig { returns(T.nilable(T::Array[String])) }
def nationalities; end
sig {
params(_nationalities: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def nationalities=(_nationalities); end
# The phone number for this person.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The person's political exposure.
sig { returns(T.nilable(String)) }
def political_exposure; end
sig { params(_political_exposure: T.nilable(String)).returns(T.nilable(String)) }
def political_exposure=(_political_exposure); end
# The relationship that this person has with the Account's business or legal entity.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Relationship))
}
def relationship; end
sig {
params(_relationship: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Relationship)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Relationship))
}
def relationship=(_relationship); end
# The script addresses (e.g., non-Latin characters) associated with the person.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptAddresses))
}
def script_addresses; end
sig {
params(_script_addresses: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptAddresses)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptAddresses))
}
def script_addresses=(_script_addresses); end
# The script names (e.g. non-Latin characters) associated with the person.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptNames))
}
def script_names; end
sig {
params(_script_names: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptNames)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptNames))
}
def script_names=(_script_names); end
# The person's last name.
sig { returns(T.nilable(String)) }
def surname; end
sig { params(_surname: T.nilable(String)).returns(T.nilable(String)) }
def surname=(_surname); end
sig {
params(additional_addresses: T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::CreateParams::AdditionalAddress]), additional_names: T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::CreateParams::AdditionalName]), additional_terms_of_service: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::AdditionalTermsOfService), address: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Address), date_of_birth: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::DateOfBirth), documents: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Documents), email: T.nilable(String), given_name: T.nilable(String), id_numbers: T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::CreateParams::IdNumber]), legal_gender: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), nationalities: T.nilable(T::Array[String]), phone: T.nilable(String), political_exposure: T.nilable(String), relationship: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::Relationship), script_addresses: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptAddresses), script_names: T.nilable(::Stripe::V2::Core::Accounts::PersonService::CreateParams::ScriptNames), surname: T.nilable(String)).void
}
def initialize(
additional_addresses: nil,
additional_names: nil,
additional_terms_of_service: nil,
address: nil,
date_of_birth: nil,
documents: nil,
email: nil,
given_name: nil,
id_numbers: nil,
legal_gender: nil,
metadata: nil,
nationalities: nil,
phone: nil,
political_exposure: nil,
relationship: nil,
script_addresses: nil,
script_names: nil,
surname: nil
); end
end
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams; end
class UpdateParams < Stripe::RequestParams
class AdditionalAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# Purpose of additional address.
sig { returns(String) }
def purpose; end
sig { params(_purpose: String).returns(String) }
def purpose=(_purpose); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), purpose: String, state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
purpose: nil,
state: nil,
town: nil
); end
end
class AdditionalName < Stripe::RequestParams
# The person's full name.
sig { returns(T.nilable(String)) }
def full_name; end
sig { params(_full_name: T.nilable(String)).returns(T.nilable(String)) }
def full_name=(_full_name); end
# The person's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
sig { params(_given_name: T.nilable(String)).returns(T.nilable(String)) }
def given_name=(_given_name); end
# The purpose or type of the additional name.
sig { returns(String) }
def purpose; end
sig { params(_purpose: String).returns(String) }
def purpose=(_purpose); end
# The person's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
sig { params(_surname: T.nilable(String)).returns(T.nilable(String)) }
def surname=(_surname); end
sig {
params(full_name: T.nilable(String), given_name: T.nilable(String), purpose: String, surname: T.nilable(String)).void
}
def initialize(full_name: nil, given_name: nil, purpose: nil, surname: nil); end
end
class AdditionalTermsOfService < Stripe::RequestParams
class Account < Stripe::RequestParams
# The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
sig { returns(T.nilable(String)) }
def date; end
sig { params(_date: T.nilable(String)).returns(T.nilable(String)) }
def date=(_date); end
# The IP address from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def ip; end
sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) }
def ip=(_ip); end
# The user agent of the browser from which the Account's representative accepted the terms of service.
sig { returns(T.nilable(String)) }
def user_agent; end
sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) }
def user_agent=(_user_agent); end
sig {
params(date: T.nilable(String), ip: T.nilable(String), user_agent: T.nilable(String)).void
}
def initialize(date: nil, ip: nil, user_agent: nil); end
end
# Stripe terms of service agreement.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::AdditionalTermsOfService::Account))
}
def account; end
sig {
params(_account: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::AdditionalTermsOfService::Account)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::AdditionalTermsOfService::Account))
}
def account=(_account); end
sig {
params(account: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::AdditionalTermsOfService::Account)).void
}
def initialize(account: nil); end
end
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class DateOfBirth < Stripe::RequestParams
# The day of the birth.
sig { returns(Integer) }
def day; end
sig { params(_day: Integer).returns(Integer) }
def day=(_day); end
# The month of birth.
sig { returns(Integer) }
def month; end
sig { params(_month: Integer).returns(Integer) }
def month=(_month); end
# The year of birth.
sig { returns(Integer) }
def year; end
sig { params(_year: Integer).returns(Integer) }
def year=(_year); end
sig { params(day: Integer, month: Integer, year: Integer).void }
def initialize(day: nil, month: nil, year: nil); end
end
class Documents < Stripe::RequestParams
class CompanyAuthorization < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class Passport < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
class PrimaryVerification < Stripe::RequestParams
class FrontBack < Stripe::RequestParams
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
sig {
returns(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::PrimaryVerification::FrontBack)
}
def front_back; end
sig {
params(_front_back: ::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::PrimaryVerification::FrontBack).returns(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::PrimaryVerification::FrontBack)
}
def front_back=(_front_back); end
# The format of the verification document. Currently supports `front_back` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(front_back: ::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::PrimaryVerification::FrontBack, type: String).void
}
def initialize(front_back: nil, type: nil); end
end
class SecondaryVerification < Stripe::RequestParams
class FrontBack < Stripe::RequestParams
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def back; end
sig { params(_back: T.nilable(String)).returns(T.nilable(String)) }
def back=(_back); end
# A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be 'identity_document'. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
sig { returns(T.nilable(String)) }
def front; end
sig { params(_front: T.nilable(String)).returns(T.nilable(String)) }
def front=(_front); end
sig { params(back: T.nilable(String), front: T.nilable(String)).void }
def initialize(back: nil, front: nil); end
end
# The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document.
sig {
returns(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::SecondaryVerification::FrontBack)
}
def front_back; end
sig {
params(_front_back: ::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::SecondaryVerification::FrontBack).returns(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::SecondaryVerification::FrontBack)
}
def front_back=(_front_back); end
# The format of the verification document. Currently supports `front_back` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(front_back: ::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::SecondaryVerification::FrontBack, type: String).void
}
def initialize(front_back: nil, type: nil); end
end
class Visa < Stripe::RequestParams
# One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
sig { returns(T::Array[String]) }
def files; end
sig { params(_files: T::Array[String]).returns(T::Array[String]) }
def files=(_files); end
# The format of the document. Currently supports `files` only.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig { params(files: T::Array[String], type: String).void }
def initialize(files: nil, type: nil); end
end
# One or more documents that demonstrate proof that this person is authorized to represent the company.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::CompanyAuthorization))
}
def company_authorization; end
sig {
params(_company_authorization: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::CompanyAuthorization)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::CompanyAuthorization))
}
def company_authorization=(_company_authorization); end
# One or more documents showing the person’s passport page with photo and personal data.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::Passport))
}
def passport; end
sig {
params(_passport: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::Passport)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::Passport))
}
def passport=(_passport); end
# An identifying document showing the person's name, either a passport or local ID card.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::PrimaryVerification))
}
def primary_verification; end
sig {
params(_primary_verification: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::PrimaryVerification)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::PrimaryVerification))
}
def primary_verification=(_primary_verification); end
# A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::SecondaryVerification))
}
def secondary_verification; end
sig {
params(_secondary_verification: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::SecondaryVerification)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::SecondaryVerification))
}
def secondary_verification=(_secondary_verification); end
# One or more documents showing the person’s visa required for living in the country where they are residing.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::Visa))
}
def visa; end
sig {
params(_visa: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::Visa)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::Visa))
}
def visa=(_visa); end
sig {
params(company_authorization: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::CompanyAuthorization), passport: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::Passport), primary_verification: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::PrimaryVerification), secondary_verification: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::SecondaryVerification), visa: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents::Visa)).void
}
def initialize(
company_authorization: nil,
passport: nil,
primary_verification: nil,
secondary_verification: nil,
visa: nil
); end
end
class IdNumber < Stripe::RequestParams
# The ID number type of an individual.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The value of the ID number.
sig { returns(String) }
def value; end
sig { params(_value: String).returns(String) }
def value=(_value); end
sig { params(type: String, value: String).void }
def initialize(type: nil, value: nil); end
end
class Relationship < Stripe::RequestParams
# Whether the individual is an authorizer of the Account’s legal entity.
sig { returns(T.nilable(T::Boolean)) }
def authorizer; end
sig { params(_authorizer: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def authorizer=(_authorizer); end
# Indicates whether the person is a director of the associated legal entity.
sig { returns(T.nilable(T::Boolean)) }
def director; end
sig { params(_director: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def director=(_director); end
# Indicates whether the person is an executive of the associated legal entity.
sig { returns(T.nilable(T::Boolean)) }
def executive; end
sig { params(_executive: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def executive=(_executive); end
# Indicates whether the person is a legal guardian of the associated legal entity.
sig { returns(T.nilable(T::Boolean)) }
def legal_guardian; end
sig { params(_legal_guardian: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def legal_guardian=(_legal_guardian); end
# Indicates whether the person is an owner of the associated legal entity.
sig { returns(T.nilable(T::Boolean)) }
def owner; end
sig { params(_owner: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def owner=(_owner); end
# The percentage of ownership the person has in the associated legal entity.
sig { returns(T.nilable(String)) }
def percent_ownership; end
sig { params(_percent_ownership: T.nilable(String)).returns(T.nilable(String)) }
def percent_ownership=(_percent_ownership); end
# Indicates whether the person is a representative of the associated legal entity.
sig { returns(T.nilable(T::Boolean)) }
def representative; end
sig { params(_representative: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
def representative=(_representative); end
# The title or position the person holds in the associated legal entity.
sig { returns(T.nilable(String)) }
def title; end
sig { params(_title: T.nilable(String)).returns(T.nilable(String)) }
def title=(_title); end
sig {
params(authorizer: T.nilable(T::Boolean), director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), legal_guardian: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), percent_ownership: T.nilable(String), representative: T.nilable(T::Boolean), title: T.nilable(String)).void
}
def initialize(
authorizer: nil,
director: nil,
executive: nil,
legal_guardian: nil,
owner: nil,
percent_ownership: nil,
representative: nil,
title: nil
); end
end
class ScriptAddresses < Stripe::RequestParams
class Kana < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
class Kanji < Stripe::RequestParams
# City, district, suburb, town, or village.
sig { returns(T.nilable(String)) }
def city; end
sig { params(_city: T.nilable(String)).returns(T.nilable(String)) }
def city=(_city); end
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
sig { returns(T.nilable(String)) }
def country; end
sig { params(_country: T.nilable(String)).returns(T.nilable(String)) }
def country=(_country); end
# Address line 1 (e.g., street, PO Box, or company name).
sig { returns(T.nilable(String)) }
def line1; end
sig { params(_line1: T.nilable(String)).returns(T.nilable(String)) }
def line1=(_line1); end
# Address line 2 (e.g., apartment, suite, unit, or building).
sig { returns(T.nilable(String)) }
def line2; end
sig { params(_line2: T.nilable(String)).returns(T.nilable(String)) }
def line2=(_line2); end
# ZIP or postal code.
sig { returns(T.nilable(String)) }
def postal_code; end
sig { params(_postal_code: T.nilable(String)).returns(T.nilable(String)) }
def postal_code=(_postal_code); end
# State, county, province, or region.
sig { returns(T.nilable(String)) }
def state; end
sig { params(_state: T.nilable(String)).returns(T.nilable(String)) }
def state=(_state); end
# Town or cho-me.
sig { returns(T.nilable(String)) }
def town; end
sig { params(_town: T.nilable(String)).returns(T.nilable(String)) }
def town=(_town); end
sig {
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
}
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil,
town: nil
); end
end
# Kana Address.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptAddresses::Kana))
}
def kana; end
sig {
params(_kana: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptAddresses::Kana)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptAddresses::Kana))
}
def kana=(_kana); end
# Kanji Address.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptAddresses::Kanji))
}
def kanji; end
sig {
params(_kanji: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptAddresses::Kanji)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptAddresses::Kanji))
}
def kanji=(_kanji); end
sig {
params(kana: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptAddresses::Kana), kanji: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptAddresses::Kanji)).void
}
def initialize(kana: nil, kanji: nil); end
end
class ScriptNames < Stripe::RequestParams
class Kana < Stripe::RequestParams
# The person's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
sig { params(_given_name: T.nilable(String)).returns(T.nilable(String)) }
def given_name=(_given_name); end
# The person's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
sig { params(_surname: T.nilable(String)).returns(T.nilable(String)) }
def surname=(_surname); end
sig { params(given_name: T.nilable(String), surname: T.nilable(String)).void }
def initialize(given_name: nil, surname: nil); end
end
class Kanji < Stripe::RequestParams
# The person's first or given name.
sig { returns(T.nilable(String)) }
def given_name; end
sig { params(_given_name: T.nilable(String)).returns(T.nilable(String)) }
def given_name=(_given_name); end
# The person's last or family name.
sig { returns(T.nilable(String)) }
def surname; end
sig { params(_surname: T.nilable(String)).returns(T.nilable(String)) }
def surname=(_surname); end
sig { params(given_name: T.nilable(String), surname: T.nilable(String)).void }
def initialize(given_name: nil, surname: nil); end
end
# Persons name in kana script.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptNames::Kana))
}
def kana; end
sig {
params(_kana: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptNames::Kana)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptNames::Kana))
}
def kana=(_kana); end
# Persons name in kanji script.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptNames::Kanji))
}
def kanji; end
sig {
params(_kanji: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptNames::Kanji)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptNames::Kanji))
}
def kanji=(_kanji); end
sig {
params(kana: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptNames::Kana), kanji: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptNames::Kanji)).void
}
def initialize(kana: nil, kanji: nil); end
end
# Additional addresses associated with the person.
sig {
returns(T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::UpdateParams::AdditionalAddress]))
}
def additional_addresses; end
sig {
params(_additional_addresses: T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::UpdateParams::AdditionalAddress])).returns(T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::UpdateParams::AdditionalAddress]))
}
def additional_addresses=(_additional_addresses); end
# Additional names (e.g. aliases) associated with the person.
sig {
returns(T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::UpdateParams::AdditionalName]))
}
def additional_names; end
sig {
params(_additional_names: T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::UpdateParams::AdditionalName])).returns(T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::UpdateParams::AdditionalName]))
}
def additional_names=(_additional_names); end
# Attestations of accepted terms of service agreements.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::AdditionalTermsOfService))
}
def additional_terms_of_service; end
sig {
params(_additional_terms_of_service: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::AdditionalTermsOfService)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::AdditionalTermsOfService))
}
def additional_terms_of_service=(_additional_terms_of_service); end
# The primary address associated with the person.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Address))
}
def address; end
sig {
params(_address: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Address)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Address))
}
def address=(_address); end
# The person's date of birth.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::DateOfBirth))
}
def date_of_birth; end
sig {
params(_date_of_birth: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::DateOfBirth)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::DateOfBirth))
}
def date_of_birth=(_date_of_birth); end
# Documents that may be submitted to satisfy various informational requests.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents))
}
def documents; end
sig {
params(_documents: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents))
}
def documents=(_documents); end
# Email.
sig { returns(T.nilable(String)) }
def email; end
sig { params(_email: T.nilable(String)).returns(T.nilable(String)) }
def email=(_email); end
# The person's first name.
sig { returns(T.nilable(String)) }
def given_name; end
sig { params(_given_name: T.nilable(String)).returns(T.nilable(String)) }
def given_name=(_given_name); end
# The identification numbers (e.g., SSN) associated with the person.
sig {
returns(T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::UpdateParams::IdNumber]))
}
def id_numbers; end
sig {
params(_id_numbers: T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::UpdateParams::IdNumber])).returns(T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::UpdateParams::IdNumber]))
}
def id_numbers=(_id_numbers); end
# The person's gender (International regulations require either "male" or "female").
sig { returns(T.nilable(String)) }
def legal_gender; end
sig { params(_legal_gender: T.nilable(String)).returns(T.nilable(String)) }
def legal_gender=(_legal_gender); end
# Set of key-value pairs 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, T.nilable(String)])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, T.nilable(String)])).returns(T.nilable(T::Hash[String, T.nilable(String)]))
}
def metadata=(_metadata); end
# The nationalities (countries) this person is associated with.
sig { returns(T.nilable(T::Array[String])) }
def nationalities; end
sig {
params(_nationalities: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def nationalities=(_nationalities); end
# The phone number for this person.
sig { returns(T.nilable(String)) }
def phone; end
sig { params(_phone: T.nilable(String)).returns(T.nilable(String)) }
def phone=(_phone); end
# The person's political exposure.
sig { returns(T.nilable(String)) }
def political_exposure; end
sig { params(_political_exposure: T.nilable(String)).returns(T.nilable(String)) }
def political_exposure=(_political_exposure); end
# The relationship that this person has with the Account's business or legal entity.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Relationship))
}
def relationship; end
sig {
params(_relationship: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Relationship)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Relationship))
}
def relationship=(_relationship); end
# The script addresses (e.g., non-Latin characters) associated with the person.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptAddresses))
}
def script_addresses; end
sig {
params(_script_addresses: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptAddresses)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptAddresses))
}
def script_addresses=(_script_addresses); end
# The script names (e.g. non-Latin characters) associated with the person.
sig {
returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptNames))
}
def script_names; end
sig {
params(_script_names: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptNames)).returns(T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptNames))
}
def script_names=(_script_names); end
# The person's last name.
sig { returns(T.nilable(String)) }
def surname; end
sig { params(_surname: T.nilable(String)).returns(T.nilable(String)) }
def surname=(_surname); end
sig {
params(additional_addresses: T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::UpdateParams::AdditionalAddress]), additional_names: T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::UpdateParams::AdditionalName]), additional_terms_of_service: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::AdditionalTermsOfService), address: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Address), date_of_birth: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::DateOfBirth), documents: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Documents), email: T.nilable(String), given_name: T.nilable(String), id_numbers: T.nilable(T::Array[::Stripe::V2::Core::Accounts::PersonService::UpdateParams::IdNumber]), legal_gender: T.nilable(String), metadata: T.nilable(T::Hash[String, T.nilable(String)]), nationalities: T.nilable(T::Array[String]), phone: T.nilable(String), political_exposure: T.nilable(String), relationship: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::Relationship), script_addresses: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptAddresses), script_names: T.nilable(::Stripe::V2::Core::Accounts::PersonService::UpdateParams::ScriptNames), surname: T.nilable(String)).void
}
def initialize(
additional_addresses: nil,
additional_names: nil,
additional_terms_of_service: nil,
address: nil,
date_of_birth: nil,
documents: nil,
email: nil,
given_name: nil,
id_numbers: nil,
legal_gender: nil,
metadata: nil,
nationalities: nil,
phone: nil,
political_exposure: nil,
relationship: nil,
script_addresses: nil,
script_names: nil,
surname: nil
); end
end
# Create a Person associated with an Account.
sig {
params(account_id: String, params: T.any(::Stripe::V2::Core::Accounts::PersonService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::AccountPerson)
}
def create(account_id, params = {}, opts = {}); end
# Delete a Person associated with an Account.
sig {
params(account_id: String, id: String, params: T.any(::Stripe::V2::Core::Accounts::PersonService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::DeletedObject)
}
def delete(account_id, id, params = {}, opts = {}); end
# Returns a list of Persons associated with an Account.
sig {
params(account_id: String, params: T.any(::Stripe::V2::Core::Accounts::PersonService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(account_id, params = {}, opts = {}); end
# Retrieves a Person associated with an Account.
sig {
params(account_id: String, id: String, params: T.any(::Stripe::V2::Core::Accounts::PersonService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::AccountPerson)
}
def retrieve(account_id, id, params = {}, opts = {}); end
# Updates a Person associated with an Account.
sig {
params(account_id: String, id: String, params: T.any(::Stripe::V2::Core::Accounts::PersonService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::AccountPerson)
}
def update(account_id, id, params = {}, opts = {}); end
end
end
end
end
end
# typed: true
module Stripe
module V2
module Core
class AccountLinkService < StripeService
class CreateParams < Stripe::RequestParams
class UseCase < Stripe::RequestParams
class AccountOnboarding < Stripe::RequestParams
class CollectionOptions < Stripe::RequestParams
# Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don’t specify collection_options, the default value is currently_due.
sig { returns(T.nilable(String)) }
def fields; end
sig { params(_fields: T.nilable(String)).returns(T.nilable(String)) }
def fields=(_fields); end
# Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
sig { returns(T.nilable(String)) }
def future_requirements; end
sig { params(_future_requirements: T.nilable(String)).returns(T.nilable(String)) }
def future_requirements=(_future_requirements); end
sig {
params(fields: T.nilable(String), future_requirements: T.nilable(String)).void
}
def initialize(fields: nil, future_requirements: nil); end
end
# Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase::AccountOnboarding::CollectionOptions))
}
def collection_options; end
sig {
params(_collection_options: T.nilable(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase::AccountOnboarding::CollectionOptions)).returns(T.nilable(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase::AccountOnboarding::CollectionOptions))
}
def collection_options=(_collection_options); end
# Open Enum. A v2/core/account can be configured to enable certain functionality. The configuration param targets the v2/core/account_link to collect information for the specified v2/core/account configuration/s.
sig { returns(T::Array[String]) }
def configurations; end
sig { params(_configurations: T::Array[String]).returns(T::Array[String]) }
def configurations=(_configurations); end
# The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink’s URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
sig { returns(String) }
def refresh_url; end
sig { params(_refresh_url: String).returns(String) }
def refresh_url=(_refresh_url); end
# The URL that the user will be redirected to upon completing the linked flow.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(collection_options: T.nilable(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase::AccountOnboarding::CollectionOptions), configurations: T::Array[String], refresh_url: String, return_url: T.nilable(String)).void
}
def initialize(
collection_options: nil,
configurations: nil,
refresh_url: nil,
return_url: nil
); end
end
class AccountUpdate < Stripe::RequestParams
class CollectionOptions < Stripe::RequestParams
# Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don’t specify collection_options, the default value is currently_due.
sig { returns(T.nilable(String)) }
def fields; end
sig { params(_fields: T.nilable(String)).returns(T.nilable(String)) }
def fields=(_fields); end
# Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
sig { returns(T.nilable(String)) }
def future_requirements; end
sig { params(_future_requirements: T.nilable(String)).returns(T.nilable(String)) }
def future_requirements=(_future_requirements); end
sig {
params(fields: T.nilable(String), future_requirements: T.nilable(String)).void
}
def initialize(fields: nil, future_requirements: nil); end
end
# Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase::AccountUpdate::CollectionOptions))
}
def collection_options; end
sig {
params(_collection_options: T.nilable(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase::AccountUpdate::CollectionOptions)).returns(T.nilable(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase::AccountUpdate::CollectionOptions))
}
def collection_options=(_collection_options); end
# Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
sig { returns(T::Array[String]) }
def configurations; end
sig { params(_configurations: T::Array[String]).returns(T::Array[String]) }
def configurations=(_configurations); end
# The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink’s URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
sig { returns(String) }
def refresh_url; end
sig { params(_refresh_url: String).returns(String) }
def refresh_url=(_refresh_url); end
# The URL that the user will be redirected to upon completing the linked flow.
sig { returns(T.nilable(String)) }
def return_url; end
sig { params(_return_url: T.nilable(String)).returns(T.nilable(String)) }
def return_url=(_return_url); end
sig {
params(collection_options: T.nilable(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase::AccountUpdate::CollectionOptions), configurations: T::Array[String], refresh_url: String, return_url: T.nilable(String)).void
}
def initialize(
collection_options: nil,
configurations: nil,
refresh_url: nil,
return_url: nil
); end
end
# Open Enum. The type of AccountLink the user is requesting.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Indicates that the AccountLink provided should onboard an account.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase::AccountOnboarding))
}
def account_onboarding; end
sig {
params(_account_onboarding: T.nilable(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase::AccountOnboarding)).returns(T.nilable(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase::AccountOnboarding))
}
def account_onboarding=(_account_onboarding); end
# Indicates that the AccountLink provided should update a previously onboarded account.
sig {
returns(T.nilable(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase::AccountUpdate))
}
def account_update; end
sig {
params(_account_update: T.nilable(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase::AccountUpdate)).returns(T.nilable(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase::AccountUpdate))
}
def account_update=(_account_update); end
sig {
params(type: String, account_onboarding: T.nilable(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase::AccountOnboarding), account_update: T.nilable(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase::AccountUpdate)).void
}
def initialize(type: nil, account_onboarding: nil, account_update: nil); end
end
# The ID of the Account to create link for.
sig { returns(String) }
def account; end
sig { params(_account: String).returns(String) }
def account=(_account); end
# The use case of the AccountLink.
sig { returns(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase) }
def use_case; end
sig {
params(_use_case: ::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase).returns(::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase)
}
def use_case=(_use_case); end
sig {
params(account: String, use_case: ::Stripe::V2::Core::AccountLinkService::CreateParams::UseCase).void
}
def initialize(account: nil, use_case: nil); end
end
# Creates an AccountLink object that includes a single-use Stripe URL that the merchant can redirect their user to in order to take them to a Stripe-hosted application such as Recipient Onboarding.
sig {
params(params: T.any(::Stripe::V2::Core::AccountLinkService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::AccountLink)
}
def create(params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module Core
class EventService < StripeService
class ListParams < Stripe::RequestParams
# The page size.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Primary object ID used to retrieve related events.
#
# To avoid conflict with Ruby's ':object_id', this attribute has been renamed. If using a hash parameter map instead, please use the original name ':object_id' with NO trailing underscore as the provided param key.
sig { returns(String) }
def object_id_; end
sig { params(_object_id_: String).returns(String) }
def object_id_=(_object_id_); end
sig { params(limit: T.nilable(Integer), object_id_: String).void }
def initialize(limit: nil, object_id_: nil); end
end
class RetrieveParams < Stripe::RequestParams; end
# List events, going back up to 30 days.
sig {
params(params: T.any(::Stripe::V2::Core::EventService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an event.
sig {
params(id: String, params: T.any(::Stripe::V2::Core::EventService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Event)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module Core
class EventDestinationService < StripeService
class ListParams < Stripe::RequestParams
# Additional fields to include in the response. Currently supports `webhook_endpoint.url`.
sig { returns(T.nilable(T::Array[String])) }
def include; end
sig { params(_include: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def include=(_include); end
# The page size.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
sig { params(include: T.nilable(T::Array[String]), limit: T.nilable(Integer)).void }
def initialize(include: nil, limit: nil); end
end
class CreateParams < Stripe::RequestParams
class AmazonEventbridge < Stripe::RequestParams
# The AWS account ID.
sig { returns(String) }
def aws_account_id; end
sig { params(_aws_account_id: String).returns(String) }
def aws_account_id=(_aws_account_id); end
# The region of the AWS event source.
sig { returns(String) }
def aws_region; end
sig { params(_aws_region: String).returns(String) }
def aws_region=(_aws_region); end
sig { params(aws_account_id: String, aws_region: String).void }
def initialize(aws_account_id: nil, aws_region: nil); end
end
class WebhookEndpoint < Stripe::RequestParams
# The URL of the webhook endpoint.
sig { returns(String) }
def url; end
sig { params(_url: String).returns(String) }
def url=(_url); end
sig { params(url: String).void }
def initialize(url: nil); end
end
# An optional description of what the event destination is used for.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The list of events to enable for this endpoint.
sig { returns(T::Array[String]) }
def enabled_events; end
sig { params(_enabled_events: T::Array[String]).returns(T::Array[String]) }
def enabled_events=(_enabled_events); end
# Payload type of events being subscribed to.
sig { returns(String) }
def event_payload; end
sig { params(_event_payload: String).returns(String) }
def event_payload=(_event_payload); end
# Where events should be routed from.
sig { returns(T.nilable(T::Array[String])) }
def events_from; end
sig {
params(_events_from: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def events_from=(_events_from); end
# Additional fields to include in the response.
sig { returns(T.nilable(T::Array[String])) }
def include; end
sig { params(_include: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def include=(_include); end
# Metadata.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Event destination name.
sig { returns(String) }
def name; end
sig { params(_name: String).returns(String) }
def name=(_name); end
# If using the snapshot event payload, the API version events are rendered as.
sig { returns(T.nilable(String)) }
def snapshot_api_version; end
sig { params(_snapshot_api_version: T.nilable(String)).returns(T.nilable(String)) }
def snapshot_api_version=(_snapshot_api_version); end
# Event destination type.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# Amazon EventBridge configuration.
sig {
returns(T.nilable(::Stripe::V2::Core::EventDestinationService::CreateParams::AmazonEventbridge))
}
def amazon_eventbridge; end
sig {
params(_amazon_eventbridge: T.nilable(::Stripe::V2::Core::EventDestinationService::CreateParams::AmazonEventbridge)).returns(T.nilable(::Stripe::V2::Core::EventDestinationService::CreateParams::AmazonEventbridge))
}
def amazon_eventbridge=(_amazon_eventbridge); end
# Webhook endpoint configuration.
sig {
returns(T.nilable(::Stripe::V2::Core::EventDestinationService::CreateParams::WebhookEndpoint))
}
def webhook_endpoint; end
sig {
params(_webhook_endpoint: T.nilable(::Stripe::V2::Core::EventDestinationService::CreateParams::WebhookEndpoint)).returns(T.nilable(::Stripe::V2::Core::EventDestinationService::CreateParams::WebhookEndpoint))
}
def webhook_endpoint=(_webhook_endpoint); end
sig {
params(description: T.nilable(String), enabled_events: T::Array[String], event_payload: String, events_from: T.nilable(T::Array[String]), include: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: String, snapshot_api_version: T.nilable(String), type: String, amazon_eventbridge: T.nilable(::Stripe::V2::Core::EventDestinationService::CreateParams::AmazonEventbridge), webhook_endpoint: T.nilable(::Stripe::V2::Core::EventDestinationService::CreateParams::WebhookEndpoint)).void
}
def initialize(
description: nil,
enabled_events: nil,
event_payload: nil,
events_from: nil,
include: nil,
metadata: nil,
name: nil,
snapshot_api_version: nil,
type: nil,
amazon_eventbridge: nil,
webhook_endpoint: nil
); end
end
class DeleteParams < Stripe::RequestParams; end
class RetrieveParams < Stripe::RequestParams
# Additional fields to include in the response.
sig { returns(T.nilable(T::Array[String])) }
def include; end
sig { params(_include: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def include=(_include); end
sig { params(include: T.nilable(T::Array[String])).void }
def initialize(include: nil); end
end
class UpdateParams < Stripe::RequestParams
class WebhookEndpoint < Stripe::RequestParams
# The URL of the webhook endpoint.
sig { returns(String) }
def url; end
sig { params(_url: String).returns(String) }
def url=(_url); end
sig { params(url: String).void }
def initialize(url: nil); end
end
# An optional description of what the event destination is used for.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The list of events to enable for this endpoint.
sig { returns(T.nilable(T::Array[String])) }
def enabled_events; end
sig {
params(_enabled_events: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def enabled_events=(_enabled_events); end
# Additional fields to include in the response. Currently supports `webhook_endpoint.url`.
sig { returns(T.nilable(T::Array[String])) }
def include; end
sig { params(_include: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def include=(_include); end
# Metadata.
sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, T.nilable(String)])).returns(T.nilable(T::Hash[String, T.nilable(String)]))
}
def metadata=(_metadata); end
# Event destination name.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
# Webhook endpoint configuration.
sig {
returns(T.nilable(::Stripe::V2::Core::EventDestinationService::UpdateParams::WebhookEndpoint))
}
def webhook_endpoint; end
sig {
params(_webhook_endpoint: T.nilable(::Stripe::V2::Core::EventDestinationService::UpdateParams::WebhookEndpoint)).returns(T.nilable(::Stripe::V2::Core::EventDestinationService::UpdateParams::WebhookEndpoint))
}
def webhook_endpoint=(_webhook_endpoint); end
sig {
params(description: T.nilable(String), enabled_events: T.nilable(T::Array[String]), include: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, T.nilable(String)]), name: T.nilable(String), webhook_endpoint: T.nilable(::Stripe::V2::Core::EventDestinationService::UpdateParams::WebhookEndpoint)).void
}
def initialize(
description: nil,
enabled_events: nil,
include: nil,
metadata: nil,
name: nil,
webhook_endpoint: nil
); end
end
class DisableParams < Stripe::RequestParams; end
class EnableParams < Stripe::RequestParams; end
class PingParams < Stripe::RequestParams; end
# Create a new event destination.
sig {
params(params: T.any(::Stripe::V2::Core::EventDestinationService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::EventDestination)
}
def create(params = {}, opts = {}); end
# Delete an event destination.
sig {
params(id: String, params: T.any(::Stripe::V2::Core::EventDestinationService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::DeletedObject)
}
def delete(id, params = {}, opts = {}); end
# Disable an event destination.
sig {
params(id: String, params: T.any(::Stripe::V2::Core::EventDestinationService::DisableParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::EventDestination)
}
def disable(id, params = {}, opts = {}); end
# Enable an event destination.
sig {
params(id: String, params: T.any(::Stripe::V2::Core::EventDestinationService::EnableParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::EventDestination)
}
def enable(id, params = {}, opts = {}); end
# Lists all event destinations.
sig {
params(params: T.any(::Stripe::V2::Core::EventDestinationService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(params = {}, opts = {}); end
# Send a `ping` event to an event destination.
sig {
params(id: String, params: T.any(::Stripe::V2::Core::EventDestinationService::PingParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Event)
}
def ping(id, params = {}, opts = {}); end
# Retrieves the details of an event destination.
sig {
params(id: String, params: T.any(::Stripe::V2::Core::EventDestinationService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::EventDestination)
}
def retrieve(id, params = {}, opts = {}); end
# Update the details of an event destination.
sig {
params(id: String, params: T.any(::Stripe::V2::Core::EventDestinationService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::EventDestination)
}
def update(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module Core
class VaultService < StripeService
attr_reader :gb_bank_accounts
attr_reader :us_bank_accounts
end
end
end
end
# typed: true
module Stripe
module V2
module Core
module Vault
class GbBankAccountService < StripeService
class CreateParams < Stripe::RequestParams
class ConfirmationOfPayee < Stripe::RequestParams
# The business type to be checked against. Legal entity information will be used if unspecified.
# Closed enum.
sig { returns(T.nilable(String)) }
def business_type; end
sig { params(_business_type: T.nilable(String)).returns(T.nilable(String)) }
def business_type=(_business_type); end
# User specifies whether Confirmation of Payee is automatically initiated when creating the bank account.
sig { returns(T::Boolean) }
def initiate; end
sig { params(_initiate: T::Boolean).returns(T::Boolean) }
def initiate=(_initiate); end
# The name to be checked against. Legal entity information will be used if unspecified.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig {
params(business_type: T.nilable(String), initiate: T::Boolean, name: T.nilable(String)).void
}
def initialize(business_type: nil, initiate: nil, name: nil); end
end
# The Account Number of the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Closed Enum. The type of the bank account (checking or savings).
sig { returns(T.nilable(String)) }
def bank_account_type; end
sig { params(_bank_account_type: T.nilable(String)).returns(T.nilable(String)) }
def bank_account_type=(_bank_account_type); end
# Whether or not to automatically perform Confirmation of Payee to verify the users information
# against what was provided by the bank. Doing so is required for all bank accounts not owned
# by you before making domestic UK OutboundPayments.
sig {
returns(T.nilable(::Stripe::V2::Core::Vault::GbBankAccountService::CreateParams::ConfirmationOfPayee))
}
def confirmation_of_payee; end
sig {
params(_confirmation_of_payee: T.nilable(::Stripe::V2::Core::Vault::GbBankAccountService::CreateParams::ConfirmationOfPayee)).returns(T.nilable(::Stripe::V2::Core::Vault::GbBankAccountService::CreateParams::ConfirmationOfPayee))
}
def confirmation_of_payee=(_confirmation_of_payee); end
# The Sort Code of the bank account.
sig { returns(String) }
def sort_code; end
sig { params(_sort_code: String).returns(String) }
def sort_code=(_sort_code); end
sig {
params(account_number: String, bank_account_type: T.nilable(String), confirmation_of_payee: T.nilable(::Stripe::V2::Core::Vault::GbBankAccountService::CreateParams::ConfirmationOfPayee), sort_code: String).void
}
def initialize(
account_number: nil,
bank_account_type: nil,
confirmation_of_payee: nil,
sort_code: nil
); end
end
class RetrieveParams < Stripe::RequestParams; end
class AcknowledgeConfirmationOfPayeeParams < Stripe::RequestParams; end
class ArchiveParams < Stripe::RequestParams; end
class InitiateConfirmationOfPayeeParams < Stripe::RequestParams
# The business type to be checked against. Legal entity information will be used if unspecified.
sig { returns(T.nilable(String)) }
def business_type; end
sig { params(_business_type: T.nilable(String)).returns(T.nilable(String)) }
def business_type=(_business_type); end
# The name of the user to be checked against. Legal entity information will be used if unspecified.
sig { returns(T.nilable(String)) }
def name; end
sig { params(_name: T.nilable(String)).returns(T.nilable(String)) }
def name=(_name); end
sig { params(business_type: T.nilable(String), name: T.nilable(String)).void }
def initialize(business_type: nil, name: nil); end
end
# Confirm that you have received the result of the Confirmation of Payee request, and that you are okay with
# proceeding to pay out to this bank account despite the account not matching, partially matching, or the service
# being unavailable. Once you confirm this, you will be able to send OutboundPayments, but this may lead to
# funds being sent to the wrong account, which we might not be able to recover.
sig {
params(id: String, params: T.any(::Stripe::V2::Core::Vault::GbBankAccountService::AcknowledgeConfirmationOfPayeeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::Vault::GbBankAccount)
}
def acknowledge_confirmation_of_payee(id, params = {}, opts = {}); end
# Archive a GBBankAccount object. Archived GBBankAccount objects cannot be used as outbound destinations
# and will not appear in the outbound destination list.
sig {
params(id: String, params: T.any(::Stripe::V2::Core::Vault::GbBankAccountService::ArchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::Vault::GbBankAccount)
}
def archive(id, params = {}, opts = {}); end
# Create a GB bank account.
sig {
params(params: T.any(::Stripe::V2::Core::Vault::GbBankAccountService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::Vault::GbBankAccount)
}
def create(params = {}, opts = {}); end
# Initiate Confirmation of Payee (CoP) in order to verify that the owner of a UK bank account matches
# who you expect. This must be done on all UK bank accounts before sending domestic OutboundPayments. If
# the result is a partial match or a non match, explicit acknowledgement using AcknowledgeConfirmationOfPayee
# is required before sending funds.
sig {
params(id: String, params: T.any(::Stripe::V2::Core::Vault::GbBankAccountService::InitiateConfirmationOfPayeeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::Vault::GbBankAccount)
}
def initiate_confirmation_of_payee(id, params = {}, opts = {}); end
# Retrieve a GB bank account.
sig {
params(id: String, params: T.any(::Stripe::V2::Core::Vault::GbBankAccountService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::Vault::GbBankAccount)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
end
end
# typed: true
module Stripe
module V2
module Core
module Vault
class UsBankAccountService < StripeService
class CreateParams < Stripe::RequestParams
# The account number of the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Closed Enum. The type of the bank account (checking or savings).
sig { returns(T.nilable(String)) }
def bank_account_type; end
sig { params(_bank_account_type: T.nilable(String)).returns(T.nilable(String)) }
def bank_account_type=(_bank_account_type); end
# The fedwire routing number of the bank account. Note that certain banks have the same ACH and wire routing number.
sig { returns(T.nilable(String)) }
def fedwire_routing_number; end
sig { params(_fedwire_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def fedwire_routing_number=(_fedwire_routing_number); end
# The ACH routing number of the bank account. Note that certain banks have the same ACH and wire routing number.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(account_number: String, bank_account_type: T.nilable(String), fedwire_routing_number: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(
account_number: nil,
bank_account_type: nil,
fedwire_routing_number: nil,
routing_number: nil
); end
end
class RetrieveParams < Stripe::RequestParams; end
class UpdateParams < Stripe::RequestParams
# The bank account's fedwire routing number can be provided for update it was were empty previously.
sig { returns(T.nilable(String)) }
def fedwire_routing_number; end
sig { params(_fedwire_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def fedwire_routing_number=(_fedwire_routing_number); end
# The bank account's ACH routing number can be provided for update if it was empty previously.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
sig {
params(fedwire_routing_number: T.nilable(String), routing_number: T.nilable(String)).void
}
def initialize(fedwire_routing_number: nil, routing_number: nil); end
end
class ArchiveParams < Stripe::RequestParams; end
# Archive a USBankAccount object. USBankAccount objects will not be automatically archived by Stripe.
# Archived USBankAccount objects cannot be used as outbound destinations
# and will not appear in the outbound destination list.
#
# ** raises ControlledByDashboardError
sig {
params(id: String, params: T.any(::Stripe::V2::Core::Vault::UsBankAccountService::ArchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::Vault::UsBankAccount)
}
def archive(id, params = {}, opts = {}); end
# Create a USBankAccount object.
#
# ** raises BlockedByStripeError
# ** raises InvalidPaymentMethodError
# ** raises QuotaExceededError
sig {
params(params: T.any(::Stripe::V2::Core::Vault::UsBankAccountService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::Vault::UsBankAccount)
}
def create(params = {}, opts = {}); end
# Retrieve a USBankAccount object.
sig {
params(id: String, params: T.any(::Stripe::V2::Core::Vault::UsBankAccountService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::Vault::UsBankAccount)
}
def retrieve(id, params = {}, opts = {}); end
# Update a USBankAccount object. This is limited to supplying a previously empty routing_number field.
#
# ** raises BlockedByStripeError
# ** raises InvalidPaymentMethodError
# ** raises QuotaExceededError
sig {
params(id: String, params: T.any(::Stripe::V2::Core::Vault::UsBankAccountService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Core::Vault::UsBankAccount)
}
def update(id, params = {}, opts = {}); end
end
end
end
end
end
# typed: true
module Stripe
module V2
class MoneyManagementService < StripeService
attr_reader :adjustments
attr_reader :financial_accounts
attr_reader :financial_addresses
attr_reader :inbound_transfers
attr_reader :outbound_payments
attr_reader :outbound_payment_quotes
attr_reader :outbound_setup_intents
attr_reader :outbound_transfers
attr_reader :payout_methods
attr_reader :payout_methods_bank_account_spec
attr_reader :received_credits
attr_reader :received_debits
attr_reader :transactions
attr_reader :transaction_entries
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
class AdjustmentService < StripeService
class ListParams < Stripe::RequestParams
# Filter for Adjustments linked to a Flow.
sig { returns(T.nilable(String)) }
def adjusted_flow; end
sig { params(_adjusted_flow: T.nilable(String)).returns(T.nilable(String)) }
def adjusted_flow=(_adjusted_flow); end
# Filter for objects created at the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created; end
sig { params(_created: T.nilable(String)).returns(T.nilable(String)) }
def created=(_created); end
# Filter for objects created after the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_gt; end
sig { params(_created_gt: T.nilable(String)).returns(T.nilable(String)) }
def created_gt=(_created_gt); end
# Filter for objects created on or after the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_gte; end
sig { params(_created_gte: T.nilable(String)).returns(T.nilable(String)) }
def created_gte=(_created_gte); end
# Filter for objects created before the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_lt; end
sig { params(_created_lt: T.nilable(String)).returns(T.nilable(String)) }
def created_lt=(_created_lt); end
# Filter for objects created on or before the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_lte; end
sig { params(_created_lte: T.nilable(String)).returns(T.nilable(String)) }
def created_lte=(_created_lte); end
# The page limit.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
sig {
params(adjusted_flow: T.nilable(String), created: T.nilable(String), created_gt: T.nilable(String), created_gte: T.nilable(String), created_lt: T.nilable(String), created_lte: T.nilable(String), limit: T.nilable(Integer)).void
}
def initialize(
adjusted_flow: nil,
created: nil,
created_gt: nil,
created_gte: nil,
created_lt: nil,
created_lte: nil,
limit: nil
); end
end
class RetrieveParams < Stripe::RequestParams; end
# Returns a list of Adjustments that match the provided filters.
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::AdjustmentService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an Adjustment by ID.
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::AdjustmentService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::Adjustment)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
class FinancialAccountService < StripeService
class ListParams < Stripe::RequestParams
# The page limit.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# The status of the FinancialAccount to filter by. By default, closed FinancialAccounts are not returned.
sig { returns(T.nilable(String)) }
def status; end
sig { params(_status: T.nilable(String)).returns(T.nilable(String)) }
def status=(_status); end
sig { params(limit: T.nilable(Integer), status: T.nilable(String)).void }
def initialize(limit: nil, status: nil); end
end
class CreateParams < Stripe::RequestParams
class Storage < Stripe::RequestParams
# The currencies that this FinancialAccount can hold.
sig { returns(T::Array[String]) }
def holds_currencies; end
sig { params(_holds_currencies: T::Array[String]).returns(T::Array[String]) }
def holds_currencies=(_holds_currencies); end
sig { params(holds_currencies: T::Array[String]).void }
def initialize(holds_currencies: nil); end
end
# A descriptive name for the FinancialAccount, up to 50 characters long. This name will be used in the Stripe Dashboard and embedded components.
sig { returns(T.nilable(String)) }
def display_name; end
sig { params(_display_name: T.nilable(String)).returns(T.nilable(String)) }
def display_name=(_display_name); end
# Metadata associated with the FinancialAccount.
sig { returns(T.nilable(T::Hash[String, String])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# Parameters specific to creating `storage` type FinancialAccounts.
sig {
returns(T.nilable(::Stripe::V2::MoneyManagement::FinancialAccountService::CreateParams::Storage))
}
def storage; end
sig {
params(_storage: T.nilable(::Stripe::V2::MoneyManagement::FinancialAccountService::CreateParams::Storage)).returns(T.nilable(::Stripe::V2::MoneyManagement::FinancialAccountService::CreateParams::Storage))
}
def storage=(_storage); end
# The type of FinancialAccount to create.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
sig {
params(display_name: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), storage: T.nilable(::Stripe::V2::MoneyManagement::FinancialAccountService::CreateParams::Storage), type: String).void
}
def initialize(display_name: nil, metadata: nil, storage: nil, type: nil); end
end
class RetrieveParams < Stripe::RequestParams; end
class CloseParams < Stripe::RequestParams
class ForwardingSettings < Stripe::RequestParams
# The address to send forwarded payments to.
sig { returns(T.nilable(String)) }
def payment_method; end
sig { params(_payment_method: T.nilable(String)).returns(T.nilable(String)) }
def payment_method=(_payment_method); end
# The address to send forwarded payouts to.
sig { returns(T.nilable(String)) }
def payout_method; end
sig { params(_payout_method: T.nilable(String)).returns(T.nilable(String)) }
def payout_method=(_payout_method); end
sig { params(payment_method: T.nilable(String), payout_method: T.nilable(String)).void }
def initialize(payment_method: nil, payout_method: nil); end
end
# The addresses to forward any incoming transactions to.
sig {
returns(T.nilable(::Stripe::V2::MoneyManagement::FinancialAccountService::CloseParams::ForwardingSettings))
}
def forwarding_settings; end
sig {
params(_forwarding_settings: T.nilable(::Stripe::V2::MoneyManagement::FinancialAccountService::CloseParams::ForwardingSettings)).returns(T.nilable(::Stripe::V2::MoneyManagement::FinancialAccountService::CloseParams::ForwardingSettings))
}
def forwarding_settings=(_forwarding_settings); end
sig {
params(forwarding_settings: T.nilable(::Stripe::V2::MoneyManagement::FinancialAccountService::CloseParams::ForwardingSettings)).void
}
def initialize(forwarding_settings: nil); end
end
# Closes a FinancialAccount with or without forwarding settings.
#
# ** raises NonZeroBalanceError
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::FinancialAccountService::CloseParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::FinancialAccount)
}
def close(id, params = {}, opts = {}); end
# Creates a new FinancialAccount.
#
# ** raises AlreadyExistsError
# ** raises FeatureNotEnabledError
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::FinancialAccountService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::FinancialAccount)
}
def create(params = {}, opts = {}); end
# Lists FinancialAccounts in this compartment.
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::FinancialAccountService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing FinancialAccount.
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::FinancialAccountService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::FinancialAccount)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
class FinancialAddressService < StripeService
class ListParams < Stripe::RequestParams
# The ID of the FinancialAccount for which FinancialAddresses are to be returned.
sig { returns(T.nilable(String)) }
def financial_account; end
sig { params(_financial_account: T.nilable(String)).returns(T.nilable(String)) }
def financial_account=(_financial_account); end
# Open Enum. A list of fields to reveal in the FinancialAddresses returned.
sig { returns(T.nilable(T::Array[String])) }
def include; end
sig { params(_include: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def include=(_include); end
# The page limit.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
sig {
params(financial_account: T.nilable(String), include: T.nilable(T::Array[String]), limit: T.nilable(Integer)).void
}
def initialize(financial_account: nil, include: nil, limit: nil); end
end
class CreateParams < Stripe::RequestParams
# Open Enum. The currency the FinancialAddress should support. Currently, only the `usd` and `gbp` values are supported.
sig { returns(String) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The ID of the FinancialAccount the new FinancialAddress should be associated with.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
sig { params(currency: String, financial_account: String).void }
def initialize(currency: nil, financial_account: nil); end
end
class RetrieveParams < Stripe::RequestParams
# Open Enum. A list of fields to reveal in the FinancialAddresses returned.
sig { returns(T.nilable(T::Array[String])) }
def include; end
sig { params(_include: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def include=(_include); end
sig { params(include: T.nilable(T::Array[String])).void }
def initialize(include: nil); end
end
# Create a new FinancialAddress for a FinancialAccount.
#
# ** raises FinancialAccountNotOpenError
# ** raises FeatureNotEnabledError
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::FinancialAddressService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::FinancialAddress)
}
def create(params = {}, opts = {}); end
# List all FinancialAddresses for a FinancialAccount.
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::FinancialAddressService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieve a FinancialAddress. By default, the FinancialAddress will be returned in its unexpanded state, revealing only the last 4 digits of the account number.
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::FinancialAddressService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::FinancialAddress)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
class InboundTransferService < StripeService
class ListParams < Stripe::RequestParams
# Filter for objects created at the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created; end
sig { params(_created: T.nilable(String)).returns(T.nilable(String)) }
def created=(_created); end
# Filter for objects created after the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_gt; end
sig { params(_created_gt: T.nilable(String)).returns(T.nilable(String)) }
def created_gt=(_created_gt); end
# Filter for objects created on or after the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_gte; end
sig { params(_created_gte: T.nilable(String)).returns(T.nilable(String)) }
def created_gte=(_created_gte); end
# Filter for objects created before the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_lt; end
sig { params(_created_lt: T.nilable(String)).returns(T.nilable(String)) }
def created_lt=(_created_lt); end
# Filter for objects created on or before the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_lte; end
sig { params(_created_lte: T.nilable(String)).returns(T.nilable(String)) }
def created_lte=(_created_lte); end
# The page limit.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
sig {
params(created: T.nilable(String), created_gt: T.nilable(String), created_gte: T.nilable(String), created_lt: T.nilable(String), created_lte: T.nilable(String), limit: T.nilable(Integer)).void
}
def initialize(
created: nil,
created_gt: nil,
created_gte: nil,
created_lt: nil,
created_lte: nil,
limit: nil
); end
end
class CreateParams < Stripe::RequestParams
class From < Stripe::RequestParams
# An optional currency field used to specify which currency is debited from the Payment Method.
# Since many Payment Methods support only one currency, this field is optional.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# ID of the Payment Method using which IBT will be made.
sig { returns(String) }
def payment_method; end
sig { params(_payment_method: String).returns(String) }
def payment_method=(_payment_method); end
sig { params(currency: T.nilable(String), payment_method: String).void }
def initialize(currency: nil, payment_method: nil); end
end
class To < Stripe::RequestParams
# The currency in which funds will land in.
sig { returns(String) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The FinancialAccount that funds will land in.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
sig { params(currency: String, financial_account: String).void }
def initialize(currency: nil, financial_account: nil); end
end
# The amount, in specified currency, by which the FinancialAccount balance will increase due to the InboundTransfer.
sig { returns(Stripe::V2::Amount) }
def amount; end
sig { params(_amount: Stripe::V2::Amount).returns(Stripe::V2::Amount) }
def amount=(_amount); end
# An optional, freeform description field intended to store metadata.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# Object containing details about where the funds will originate from.
sig { returns(::Stripe::V2::MoneyManagement::InboundTransferService::CreateParams::From) }
def from; end
sig {
params(_from: ::Stripe::V2::MoneyManagement::InboundTransferService::CreateParams::From).returns(::Stripe::V2::MoneyManagement::InboundTransferService::CreateParams::From)
}
def from=(_from); end
# Object containing details about where the funds will land.
sig { returns(::Stripe::V2::MoneyManagement::InboundTransferService::CreateParams::To) }
def to; end
sig {
params(_to: ::Stripe::V2::MoneyManagement::InboundTransferService::CreateParams::To).returns(::Stripe::V2::MoneyManagement::InboundTransferService::CreateParams::To)
}
def to=(_to); end
sig {
params(amount: Stripe::V2::Amount, description: T.nilable(String), from: ::Stripe::V2::MoneyManagement::InboundTransferService::CreateParams::From, to: ::Stripe::V2::MoneyManagement::InboundTransferService::CreateParams::To).void
}
def initialize(amount: nil, description: nil, from: nil, to: nil); end
end
class RetrieveParams < Stripe::RequestParams; end
# InboundTransfers APIs are used to create, retrieve or list InboundTransfers.
#
# ** raises BlockedByStripeError
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::InboundTransferService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::InboundTransfer)
}
def create(params = {}, opts = {}); end
# Retrieves a list of InboundTransfers.
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::InboundTransferService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieve an InboundTransfer by ID.
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::InboundTransferService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::InboundTransfer)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
class OutboundPaymentService < StripeService
class ListParams < Stripe::RequestParams
# Filter for objects created at the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created; end
sig { params(_created: T.nilable(String)).returns(T.nilable(String)) }
def created=(_created); end
# Filter for objects created after the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_gt; end
sig { params(_created_gt: T.nilable(String)).returns(T.nilable(String)) }
def created_gt=(_created_gt); end
# Filter for objects created on or after the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_gte; end
sig { params(_created_gte: T.nilable(String)).returns(T.nilable(String)) }
def created_gte=(_created_gte); end
# Filter for objects created before the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_lt; end
sig { params(_created_lt: T.nilable(String)).returns(T.nilable(String)) }
def created_lt=(_created_lt); end
# Filter for objects created on or before the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_lte; end
sig { params(_created_lte: T.nilable(String)).returns(T.nilable(String)) }
def created_lte=(_created_lte); end
# The maximum number of results to return.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Only return OutboundPayments sent to this recipient.
sig { returns(T.nilable(String)) }
def recipient; end
sig { params(_recipient: T.nilable(String)).returns(T.nilable(String)) }
def recipient=(_recipient); end
# Closed Enum. Only return OutboundPayments with this status.
sig { returns(T.nilable(T::Array[String])) }
def status; end
sig { params(_status: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def status=(_status); end
sig {
params(created: T.nilable(String), created_gt: T.nilable(String), created_gte: T.nilable(String), created_lt: T.nilable(String), created_lte: T.nilable(String), limit: T.nilable(Integer), recipient: T.nilable(String), status: T.nilable(T::Array[String])).void
}
def initialize(
created: nil,
created_gt: nil,
created_gte: nil,
created_lt: nil,
created_lte: nil,
limit: nil,
recipient: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class DeliveryOptions < Stripe::RequestParams
# Open Enum. Method for bank account.
sig { returns(T.nilable(String)) }
def bank_account; end
sig { params(_bank_account: T.nilable(String)).returns(T.nilable(String)) }
def bank_account=(_bank_account); end
sig { params(bank_account: T.nilable(String)).void }
def initialize(bank_account: nil); end
end
class From < Stripe::RequestParams
# Describes the FinancialAmount's currency drawn from.
sig { returns(String) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The FinancialAccount that funds were pulled from.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
sig { params(currency: String, financial_account: String).void }
def initialize(currency: nil, financial_account: nil); end
end
class RecipientNotification < Stripe::RequestParams
# Closed Enum. Configuration option to enable or disable notifications to recipients.
# Do not send notifications when setting is NONE. Default to account setting when setting is CONFIGURED or not set.
sig { returns(String) }
def setting; end
sig { params(_setting: String).returns(String) }
def setting=(_setting); end
sig { params(setting: String).void }
def initialize(setting: nil); end
end
class To < Stripe::RequestParams
# Describes the currency to send to the recipient.
# If included, this currency must match a currency supported by the destination.
# Can be omitted in the following cases:
# - destination only supports one currency
# - destination supports multiple currencies and one of the currencies matches the FA currency
# - destination supports multiple currencies and one of the currencies matches the presentment currency
# Note - when both FA currency and presentment currency are supported, we pick the FA currency to minimize FX.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The payout method which the OutboundPayment uses to send payout.
sig { returns(T.nilable(String)) }
def payout_method; end
sig { params(_payout_method: T.nilable(String)).returns(T.nilable(String)) }
def payout_method=(_payout_method); end
# To which account the OutboundPayment is sent.
sig { returns(String) }
def recipient; end
sig { params(_recipient: String).returns(String) }
def recipient=(_recipient); end
sig {
params(currency: T.nilable(String), payout_method: T.nilable(String), recipient: String).void
}
def initialize(currency: nil, payout_method: nil, recipient: nil); end
end
# The "presentment amount" to be sent to the recipient.
sig { returns(Stripe::V2::Amount) }
def amount; end
sig { params(_amount: Stripe::V2::Amount).returns(Stripe::V2::Amount) }
def amount=(_amount); end
# Delivery options to be used to send the OutboundPayment.
sig {
returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams::DeliveryOptions))
}
def delivery_options; end
sig {
params(_delivery_options: T.nilable(::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams::DeliveryOptions)).returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams::DeliveryOptions))
}
def delivery_options=(_delivery_options); end
# An arbitrary string attached to the OutboundPayment. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# From which FinancialAccount and BalanceType to pull funds from.
sig { returns(::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams::From) }
def from; end
sig {
params(_from: ::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams::From).returns(::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams::From)
}
def from=(_from); end
# Set of key-value pairs 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# The quote for this OutboundPayment. Only required for countries with regulatory mandates to display fee estimates before OutboundPayment creation.
sig { returns(T.nilable(String)) }
def outbound_payment_quote; end
sig { params(_outbound_payment_quote: T.nilable(String)).returns(T.nilable(String)) }
def outbound_payment_quote=(_outbound_payment_quote); end
# Details about the notification settings for the OutboundPayment recipient.
sig {
returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams::RecipientNotification))
}
def recipient_notification; end
sig {
params(_recipient_notification: T.nilable(::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams::RecipientNotification)).returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams::RecipientNotification))
}
def recipient_notification=(_recipient_notification); end
# To which payout method to send the OutboundPayment.
sig { returns(::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams::To) }
def to; end
sig {
params(_to: ::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams::To).returns(::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams::To)
}
def to=(_to); end
sig {
params(amount: Stripe::V2::Amount, delivery_options: T.nilable(::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams::DeliveryOptions), description: T.nilable(String), from: ::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams::From, metadata: T.nilable(T::Hash[String, String]), outbound_payment_quote: T.nilable(String), recipient_notification: T.nilable(::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams::RecipientNotification), to: ::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams::To).void
}
def initialize(
amount: nil,
delivery_options: nil,
description: nil,
from: nil,
metadata: nil,
outbound_payment_quote: nil,
recipient_notification: nil,
to: nil
); end
end
class RetrieveParams < Stripe::RequestParams; end
class CancelParams < Stripe::RequestParams; end
# Cancels an OutboundPayment. Only processing OutboundPayments can be canceled.
#
# ** raises AlreadyCanceledError
# ** raises NotCancelableError
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::OutboundPaymentService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::OutboundPayment)
}
def cancel(id, params = {}, opts = {}); end
# Creates an OutboundPayment.
#
# ** raises InsufficientFundsError
# ** raises QuotaExceededError
# ** raises RecipientNotNotifiableError
# ** raises FeatureNotEnabledError
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::OutboundPaymentService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::OutboundPayment)
}
def create(params = {}, opts = {}); end
# Returns a list of OutboundPayments that match the provided filters.
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::OutboundPaymentService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment create or list response.
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::OutboundPaymentService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::OutboundPayment)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
class OutboundPaymentQuoteService < StripeService
class CreateParams < Stripe::RequestParams
class DeliveryOptions < Stripe::RequestParams
# Open Enum. Method for bank account.
sig { returns(T.nilable(String)) }
def bank_account; end
sig { params(_bank_account: T.nilable(String)).returns(T.nilable(String)) }
def bank_account=(_bank_account); end
sig { params(bank_account: T.nilable(String)).void }
def initialize(bank_account: nil); end
end
class From < Stripe::RequestParams
# Describes the FinancialAccount's currency drawn from.
sig { returns(String) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The FinancialAccount that funds were pulled from.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
sig { params(currency: String, financial_account: String).void }
def initialize(currency: nil, financial_account: nil); end
end
class To < Stripe::RequestParams
# Describes the currency to send to the recipient.
# If included, this currency must match a currency supported by the destination.
# Can be omitted in the following cases:
# - destination only supports one currency
# - destination supports multiple currencies and one of the currencies matches the FA currency
# - destination supports multiple currencies and one of the currencies matches the presentment currency
# Note - when both FA currency and presentment currency are supported, we pick the FA currency to minimize FX.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The payout method which the OutboundPayment uses to send payout.
sig { returns(T.nilable(String)) }
def payout_method; end
sig { params(_payout_method: T.nilable(String)).returns(T.nilable(String)) }
def payout_method=(_payout_method); end
# To which account the OutboundPayment is sent.
sig { returns(String) }
def recipient; end
sig { params(_recipient: String).returns(String) }
def recipient=(_recipient); end
sig {
params(currency: T.nilable(String), payout_method: T.nilable(String), recipient: String).void
}
def initialize(currency: nil, payout_method: nil, recipient: nil); end
end
# The "presentment amount" to be sent to the recipient.
sig { returns(Stripe::V2::Amount) }
def amount; end
sig { params(_amount: Stripe::V2::Amount).returns(Stripe::V2::Amount) }
def amount=(_amount); end
# Method to be used to send the OutboundPayment.
sig {
returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundPaymentQuoteService::CreateParams::DeliveryOptions))
}
def delivery_options; end
sig {
params(_delivery_options: T.nilable(::Stripe::V2::MoneyManagement::OutboundPaymentQuoteService::CreateParams::DeliveryOptions)).returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundPaymentQuoteService::CreateParams::DeliveryOptions))
}
def delivery_options=(_delivery_options); end
# Request details about the sender of an OutboundPaymentQuote.
sig {
returns(::Stripe::V2::MoneyManagement::OutboundPaymentQuoteService::CreateParams::From)
}
def from; end
sig {
params(_from: ::Stripe::V2::MoneyManagement::OutboundPaymentQuoteService::CreateParams::From).returns(::Stripe::V2::MoneyManagement::OutboundPaymentQuoteService::CreateParams::From)
}
def from=(_from); end
# Request details about the recipient of an OutboundPaymentQuote.
sig {
returns(::Stripe::V2::MoneyManagement::OutboundPaymentQuoteService::CreateParams::To)
}
def to; end
sig {
params(_to: ::Stripe::V2::MoneyManagement::OutboundPaymentQuoteService::CreateParams::To).returns(::Stripe::V2::MoneyManagement::OutboundPaymentQuoteService::CreateParams::To)
}
def to=(_to); end
sig {
params(amount: Stripe::V2::Amount, delivery_options: T.nilable(::Stripe::V2::MoneyManagement::OutboundPaymentQuoteService::CreateParams::DeliveryOptions), from: ::Stripe::V2::MoneyManagement::OutboundPaymentQuoteService::CreateParams::From, to: ::Stripe::V2::MoneyManagement::OutboundPaymentQuoteService::CreateParams::To).void
}
def initialize(amount: nil, delivery_options: nil, from: nil, to: nil); end
end
class RetrieveParams < Stripe::RequestParams; end
# Creates an OutboundPaymentQuote usable in an OutboundPayment.
#
# ** raises FeatureNotEnabledError
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::OutboundPaymentQuoteService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::OutboundPaymentQuote)
}
def create(params = {}, opts = {}); end
# Retrieves the details of an existing OutboundPaymentQuote by passing the unique OutboundPaymentQuote ID.
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::OutboundPaymentQuoteService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::OutboundPaymentQuote)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
class OutboundSetupIntentService < StripeService
class ListParams < Stripe::RequestParams
# The page size.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
sig { params(limit: T.nilable(Integer)).void }
def initialize(limit: nil); end
end
class CreateParams < Stripe::RequestParams
class PayoutMethodData < Stripe::RequestParams
class BankAccount < Stripe::RequestParams
# The account number or IBAN of the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Closed Enum. The type of the bank account (checking or savings).
sig { returns(T.nilable(String)) }
def bank_account_type; end
sig { params(_bank_account_type: T.nilable(String)).returns(T.nilable(String)) }
def bank_account_type=(_bank_account_type); end
# The branch number of the bank account, if present.
sig { returns(T.nilable(String)) }
def branch_number; end
sig { params(_branch_number: T.nilable(String)).returns(T.nilable(String)) }
def branch_number=(_branch_number); end
# The country code of the bank account.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# The routing number of the bank account, if present.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
# The swift code of the bank account, if present.
sig { returns(T.nilable(String)) }
def swift_code; end
sig { params(_swift_code: T.nilable(String)).returns(T.nilable(String)) }
def swift_code=(_swift_code); end
sig {
params(account_number: String, bank_account_type: T.nilable(String), branch_number: T.nilable(String), country: String, routing_number: T.nilable(String), swift_code: T.nilable(String)).void
}
def initialize(
account_number: nil,
bank_account_type: nil,
branch_number: nil,
country: nil,
routing_number: nil,
swift_code: nil
); end
end
class Card < Stripe::RequestParams
# The expiration month of the card.
sig { returns(String) }
def exp_month; end
sig { params(_exp_month: String).returns(String) }
def exp_month=(_exp_month); end
# The expiration year of the card.
sig { returns(String) }
def exp_year; end
sig { params(_exp_year: String).returns(String) }
def exp_year=(_exp_year); end
# The card number.
sig { returns(String) }
def number; end
sig { params(_number: String).returns(String) }
def number=(_number); end
sig { params(exp_month: String, exp_year: String, number: String).void }
def initialize(exp_month: nil, exp_year: nil, number: nil); end
end
# Closed Enum. The type of payout method to be created.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The type specific details of the bank account payout method.
sig {
returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::CreateParams::PayoutMethodData::BankAccount))
}
def bank_account; end
sig {
params(_bank_account: T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::CreateParams::PayoutMethodData::BankAccount)).returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::CreateParams::PayoutMethodData::BankAccount))
}
def bank_account=(_bank_account); end
# The type specific details of the card payout method.
sig {
returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::CreateParams::PayoutMethodData::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::CreateParams::PayoutMethodData::Card)).returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::CreateParams::PayoutMethodData::Card))
}
def card=(_card); end
sig {
params(type: String, bank_account: T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::CreateParams::PayoutMethodData::BankAccount), card: T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::CreateParams::PayoutMethodData::Card)).void
}
def initialize(type: nil, bank_account: nil, card: nil); end
end
# If provided, the existing payout method resource to link to this setup intent.
# Any payout_method_data provided is used to update information on this linked payout method resource.
sig { returns(T.nilable(String)) }
def payout_method; end
sig { params(_payout_method: T.nilable(String)).returns(T.nilable(String)) }
def payout_method=(_payout_method); end
# If no payout_method provided, used to create the underlying credential that is set up for outbound money movement.
# If a payout_method provided, used to update data on the credential linked to this setup intent.
sig {
returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::CreateParams::PayoutMethodData))
}
def payout_method_data; end
sig {
params(_payout_method_data: T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::CreateParams::PayoutMethodData)).returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::CreateParams::PayoutMethodData))
}
def payout_method_data=(_payout_method_data); end
# Specify which type of outbound money movement this credential should be set up for (payment | transfer).
# If not provided, defaults to payment.
sig { returns(T.nilable(String)) }
def usage_intent; end
sig { params(_usage_intent: T.nilable(String)).returns(T.nilable(String)) }
def usage_intent=(_usage_intent); end
sig {
params(payout_method: T.nilable(String), payout_method_data: T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::CreateParams::PayoutMethodData), usage_intent: T.nilable(String)).void
}
def initialize(payout_method: nil, payout_method_data: nil, usage_intent: nil); end
end
class RetrieveParams < Stripe::RequestParams; end
class UpdateParams < Stripe::RequestParams
class PayoutMethodData < Stripe::RequestParams
class BankAccount < Stripe::RequestParams
# The account number or IBAN of the bank account.
sig { returns(String) }
def account_number; end
sig { params(_account_number: String).returns(String) }
def account_number=(_account_number); end
# Closed Enum. The type of the bank account (checking or savings).
sig { returns(T.nilable(String)) }
def bank_account_type; end
sig { params(_bank_account_type: T.nilable(String)).returns(T.nilable(String)) }
def bank_account_type=(_bank_account_type); end
# The branch number of the bank account, if present.
sig { returns(T.nilable(String)) }
def branch_number; end
sig { params(_branch_number: T.nilable(String)).returns(T.nilable(String)) }
def branch_number=(_branch_number); end
# The country code of the bank account.
sig { returns(String) }
def country; end
sig { params(_country: String).returns(String) }
def country=(_country); end
# The routing number of the bank account, if present.
sig { returns(T.nilable(String)) }
def routing_number; end
sig { params(_routing_number: T.nilable(String)).returns(T.nilable(String)) }
def routing_number=(_routing_number); end
# The swift code of the bank account, if present.
sig { returns(T.nilable(String)) }
def swift_code; end
sig { params(_swift_code: T.nilable(String)).returns(T.nilable(String)) }
def swift_code=(_swift_code); end
sig {
params(account_number: String, bank_account_type: T.nilable(String), branch_number: T.nilable(String), country: String, routing_number: T.nilable(String), swift_code: T.nilable(String)).void
}
def initialize(
account_number: nil,
bank_account_type: nil,
branch_number: nil,
country: nil,
routing_number: nil,
swift_code: nil
); end
end
class Card < Stripe::RequestParams
# The expiration month of the card.
sig { returns(T.nilable(String)) }
def exp_month; end
sig { params(_exp_month: T.nilable(String)).returns(T.nilable(String)) }
def exp_month=(_exp_month); end
# The expiration year of the card.
sig { returns(T.nilable(String)) }
def exp_year; end
sig { params(_exp_year: T.nilable(String)).returns(T.nilable(String)) }
def exp_year=(_exp_year); end
# The card number. This can only be passed when creating a new credential on an outbound setup intent in the requires_payout_method state.
sig { returns(T.nilable(String)) }
def number; end
sig { params(_number: T.nilable(String)).returns(T.nilable(String)) }
def number=(_number); end
sig {
params(exp_month: T.nilable(String), exp_year: T.nilable(String), number: T.nilable(String)).void
}
def initialize(exp_month: nil, exp_year: nil, number: nil); end
end
# Closed Enum. The type of payout method to be created/updated.
sig { returns(String) }
def type; end
sig { params(_type: String).returns(String) }
def type=(_type); end
# The type specific details of the bank account payout method.
sig {
returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::UpdateParams::PayoutMethodData::BankAccount))
}
def bank_account; end
sig {
params(_bank_account: T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::UpdateParams::PayoutMethodData::BankAccount)).returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::UpdateParams::PayoutMethodData::BankAccount))
}
def bank_account=(_bank_account); end
# The type specific details of the card payout method.
sig {
returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::UpdateParams::PayoutMethodData::Card))
}
def card; end
sig {
params(_card: T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::UpdateParams::PayoutMethodData::Card)).returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::UpdateParams::PayoutMethodData::Card))
}
def card=(_card); end
sig {
params(type: String, bank_account: T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::UpdateParams::PayoutMethodData::BankAccount), card: T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::UpdateParams::PayoutMethodData::Card)).void
}
def initialize(type: nil, bank_account: nil, card: nil); end
end
# If provided, the existing payout method resource to link to this outbound setup intent.
sig { returns(T.nilable(String)) }
def payout_method; end
sig { params(_payout_method: T.nilable(String)).returns(T.nilable(String)) }
def payout_method=(_payout_method); end
# If no payout_method provided, used to create the underlying credential that is set up for outbound money movement.
# If a payout_method provided, used to update data on the credential linked to this setup intent.
sig {
returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::UpdateParams::PayoutMethodData))
}
def payout_method_data; end
sig {
params(_payout_method_data: T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::UpdateParams::PayoutMethodData)).returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::UpdateParams::PayoutMethodData))
}
def payout_method_data=(_payout_method_data); end
sig {
params(payout_method: T.nilable(String), payout_method_data: T.nilable(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::UpdateParams::PayoutMethodData)).void
}
def initialize(payout_method: nil, payout_method_data: nil); end
end
class CancelParams < Stripe::RequestParams; end
# Cancel an OutboundSetupIntent object.
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::OutboundSetupIntent)
}
def cancel(id, params = {}, opts = {}); end
# Create an OutboundSetupIntent object.
#
# ** raises BlockedByStripeError
# ** raises InvalidPayoutMethodError
# ** raises QuotaExceededError
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::OutboundSetupIntent)
}
def create(params = {}, opts = {}); end
# List the OutboundSetupIntent objects.
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieve an OutboundSetupIntent object.
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::OutboundSetupIntent)
}
def retrieve(id, params = {}, opts = {}); end
# Update an OutboundSetupIntent object.
#
# ** raises QuotaExceededError
# ** raises BlockedByStripeError
# ** raises InvalidPayoutMethodError
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::OutboundSetupIntentService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::OutboundSetupIntent)
}
def update(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
class OutboundTransferService < StripeService
class ListParams < Stripe::RequestParams
# Filter for objects created at the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created; end
sig { params(_created: T.nilable(String)).returns(T.nilable(String)) }
def created=(_created); end
# Filter for objects created after the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_gt; end
sig { params(_created_gt: T.nilable(String)).returns(T.nilable(String)) }
def created_gt=(_created_gt); end
# Filter for objects created on or after the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_gte; end
sig { params(_created_gte: T.nilable(String)).returns(T.nilable(String)) }
def created_gte=(_created_gte); end
# Filter for objects created before the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_lt; end
sig { params(_created_lt: T.nilable(String)).returns(T.nilable(String)) }
def created_lt=(_created_lt); end
# Filter for objects created on or before the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_lte; end
sig { params(_created_lte: T.nilable(String)).returns(T.nilable(String)) }
def created_lte=(_created_lte); end
# The maximum number of results to return.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Closed Enum. Only return OutboundTransfers with this status.
sig { returns(T.nilable(T::Array[String])) }
def status; end
sig { params(_status: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
def status=(_status); end
sig {
params(created: T.nilable(String), created_gt: T.nilable(String), created_gte: T.nilable(String), created_lt: T.nilable(String), created_lte: T.nilable(String), limit: T.nilable(Integer), status: T.nilable(T::Array[String])).void
}
def initialize(
created: nil,
created_gt: nil,
created_gte: nil,
created_lt: nil,
created_lte: nil,
limit: nil,
status: nil
); end
end
class CreateParams < Stripe::RequestParams
class DeliveryOptions < Stripe::RequestParams
# Open Enum. Method for bank account.
sig { returns(T.nilable(String)) }
def bank_account; end
sig { params(_bank_account: T.nilable(String)).returns(T.nilable(String)) }
def bank_account=(_bank_account); end
sig { params(bank_account: T.nilable(String)).void }
def initialize(bank_account: nil); end
end
class From < Stripe::RequestParams
# Describes the FinancialAmount's currency drawn from.
sig { returns(String) }
def currency; end
sig { params(_currency: String).returns(String) }
def currency=(_currency); end
# The FinancialAccount that funds were pulled from.
sig { returns(String) }
def financial_account; end
sig { params(_financial_account: String).returns(String) }
def financial_account=(_financial_account); end
sig { params(currency: String, financial_account: String).void }
def initialize(currency: nil, financial_account: nil); end
end
class To < Stripe::RequestParams
# Describes the currency to send to the recipient.
# If included, this currency must match a currency supported by the destination.
# Can be omitted in the following cases:
# - destination only supports one currency
# - destination supports multiple currencies and one of the currencies matches the FA currency
# - destination supports multiple currencies and one of the currencies matches the presentment currency
# Note - when both FA currency and presentment currency are supported, we pick the FA currency to minimize FX.
sig { returns(T.nilable(String)) }
def currency; end
sig { params(_currency: T.nilable(String)).returns(T.nilable(String)) }
def currency=(_currency); end
# The payout method which the OutboundTransfer uses to send payout.
sig { returns(String) }
def payout_method; end
sig { params(_payout_method: String).returns(String) }
def payout_method=(_payout_method); end
sig { params(currency: T.nilable(String), payout_method: String).void }
def initialize(currency: nil, payout_method: nil); end
end
# The "presentment amount" for the OutboundPayment.
sig { returns(Stripe::V2::Amount) }
def amount; end
sig { params(_amount: Stripe::V2::Amount).returns(Stripe::V2::Amount) }
def amount=(_amount); end
# Delivery options to be used to send the OutboundTransfer.
sig {
returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundTransferService::CreateParams::DeliveryOptions))
}
def delivery_options; end
sig {
params(_delivery_options: T.nilable(::Stripe::V2::MoneyManagement::OutboundTransferService::CreateParams::DeliveryOptions)).returns(T.nilable(::Stripe::V2::MoneyManagement::OutboundTransferService::CreateParams::DeliveryOptions))
}
def delivery_options=(_delivery_options); end
# An arbitrary string attached to the OutboundTransfer. Often useful for displaying to users.
sig { returns(T.nilable(String)) }
def description; end
sig { params(_description: T.nilable(String)).returns(T.nilable(String)) }
def description=(_description); end
# The FinancialAccount to pull funds from.
sig {
returns(::Stripe::V2::MoneyManagement::OutboundTransferService::CreateParams::From)
}
def from; end
sig {
params(_from: ::Stripe::V2::MoneyManagement::OutboundTransferService::CreateParams::From).returns(::Stripe::V2::MoneyManagement::OutboundTransferService::CreateParams::From)
}
def from=(_from); end
# Set of key-value pairs 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])) }
def metadata; end
sig {
params(_metadata: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String]))
}
def metadata=(_metadata); end
# To which payout method to send the OutboundTransfer.
sig { returns(::Stripe::V2::MoneyManagement::OutboundTransferService::CreateParams::To) }
def to; end
sig {
params(_to: ::Stripe::V2::MoneyManagement::OutboundTransferService::CreateParams::To).returns(::Stripe::V2::MoneyManagement::OutboundTransferService::CreateParams::To)
}
def to=(_to); end
sig {
params(amount: Stripe::V2::Amount, delivery_options: T.nilable(::Stripe::V2::MoneyManagement::OutboundTransferService::CreateParams::DeliveryOptions), description: T.nilable(String), from: ::Stripe::V2::MoneyManagement::OutboundTransferService::CreateParams::From, metadata: T.nilable(T::Hash[String, String]), to: ::Stripe::V2::MoneyManagement::OutboundTransferService::CreateParams::To).void
}
def initialize(
amount: nil,
delivery_options: nil,
description: nil,
from: nil,
metadata: nil,
to: nil
); end
end
class RetrieveParams < Stripe::RequestParams; end
class CancelParams < Stripe::RequestParams; end
# Cancels an OutboundTransfer. Only processing OutboundTransfers can be canceled.
#
# ** raises AlreadyCanceledError
# ** raises NotCancelableError
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::OutboundTransferService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::OutboundTransfer)
}
def cancel(id, params = {}, opts = {}); end
# Creates an OutboundTransfer.
#
# ** raises InsufficientFundsError
# ** raises FeatureNotEnabledError
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::OutboundTransferService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::OutboundTransfer)
}
def create(params = {}, opts = {}); end
# Returns a list of OutboundTransfers that match the provided filters.
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::OutboundTransferService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundPayment create or list response.
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::OutboundTransferService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::OutboundTransfer)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
class PayoutMethodService < StripeService
class ListParams < Stripe::RequestParams
class UsageStatus < Stripe::RequestParams
# List of payments status to filter by.
sig { returns(T.nilable(T::Array[String])) }
def payments; end
sig {
params(_payments: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def payments=(_payments); end
# List of transfers status to filter by.
sig { returns(T.nilable(T::Array[String])) }
def transfers; end
sig {
params(_transfers: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def transfers=(_transfers); end
sig {
params(payments: T.nilable(T::Array[String]), transfers: T.nilable(T::Array[String])).void
}
def initialize(payments: nil, transfers: nil); end
end
# The page size.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Usage status filter.
sig {
returns(T.nilable(::Stripe::V2::MoneyManagement::PayoutMethodService::ListParams::UsageStatus))
}
def usage_status; end
sig {
params(_usage_status: T.nilable(::Stripe::V2::MoneyManagement::PayoutMethodService::ListParams::UsageStatus)).returns(T.nilable(::Stripe::V2::MoneyManagement::PayoutMethodService::ListParams::UsageStatus))
}
def usage_status=(_usage_status); end
sig {
params(limit: T.nilable(Integer), usage_status: T.nilable(::Stripe::V2::MoneyManagement::PayoutMethodService::ListParams::UsageStatus)).void
}
def initialize(limit: nil, usage_status: nil); end
end
class RetrieveParams < Stripe::RequestParams; end
class ArchiveParams < Stripe::RequestParams; end
class UnarchiveParams < Stripe::RequestParams; end
# Archive a PayoutMethod object. Archived objects cannot be used as payout methods
# and will not appear in the payout method list.
#
# ** raises ControlledByDashboardError
# ** raises InvalidPayoutMethodError
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::PayoutMethodService::ArchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::PayoutMethod)
}
def archive(id, params = {}, opts = {}); end
# List objects that adhere to the PayoutMethod interface.
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::PayoutMethodService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieve a PayoutMethod object.
#
# ** raises InvalidPayoutMethodError
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::PayoutMethodService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::PayoutMethod)
}
def retrieve(id, params = {}, opts = {}); end
# Unarchive an PayoutMethod object.
#
# ** raises ControlledByDashboardError
# ** raises InvalidPayoutMethodError
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::PayoutMethodService::UnarchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::PayoutMethod)
}
def unarchive(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
class PayoutMethodsBankAccountSpecService < StripeService
class RetrieveParams < Stripe::RequestParams
# The countries to fetch the bank account spec for.
sig { returns(T.nilable(T::Array[String])) }
def countries; end
sig {
params(_countries: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String]))
}
def countries=(_countries); end
sig { params(countries: T.nilable(T::Array[String])).void }
def initialize(countries: nil); end
end
# Fetch the specifications for a set of countries to know which
# credential fields are required, the validations for each fields, and how to translate these
# country-specific fields to the generic fields in the PayoutMethodBankAccount type.
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::PayoutMethodsBankAccountSpecService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::PayoutMethodsBankAccountSpec)
}
def retrieve(params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
class ReceivedCreditService < StripeService
class ListParams < Stripe::RequestParams
# Filter for objects created at the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created; end
sig { params(_created: T.nilable(String)).returns(T.nilable(String)) }
def created=(_created); end
# Filter for objects created after the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_gt; end
sig { params(_created_gt: T.nilable(String)).returns(T.nilable(String)) }
def created_gt=(_created_gt); end
# Filter for objects created on or after the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_gte; end
sig { params(_created_gte: T.nilable(String)).returns(T.nilable(String)) }
def created_gte=(_created_gte); end
# Filter for objects created before the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_lt; end
sig { params(_created_lt: T.nilable(String)).returns(T.nilable(String)) }
def created_lt=(_created_lt); end
# Filter for objects created on or before the specified timestamp.
# Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
sig { returns(T.nilable(String)) }
def created_lte; end
sig { params(_created_lte: T.nilable(String)).returns(T.nilable(String)) }
def created_lte=(_created_lte); end
# The page limit.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
sig {
params(created: T.nilable(String), created_gt: T.nilable(String), created_gte: T.nilable(String), created_lt: T.nilable(String), created_lte: T.nilable(String), limit: T.nilable(Integer)).void
}
def initialize(
created: nil,
created_gt: nil,
created_gte: nil,
created_lt: nil,
created_lte: nil,
limit: nil
); end
end
class RetrieveParams < Stripe::RequestParams; end
# Retrieves a list of ReceivedCredits.
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::ReceivedCreditService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieve a ReceivedCredit by ID.
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::ReceivedCreditService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::ReceivedCredit)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
class ReceivedDebitService < StripeService
class ListParams < Stripe::RequestParams
# The page limit.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
sig { params(limit: T.nilable(Integer)).void }
def initialize(limit: nil); end
end
class RetrieveParams < Stripe::RequestParams; end
# Retrieves a list of ReceivedDebits, given the selected filters.
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::ReceivedDebitService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves a single ReceivedDebit by ID.
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::ReceivedDebitService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::ReceivedDebit)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
class TransactionService < StripeService
class ListParams < Stripe::RequestParams
# Filter for Transactions created at an exact time.
sig { returns(T.nilable(String)) }
def created; end
sig { params(_created: T.nilable(String)).returns(T.nilable(String)) }
def created=(_created); end
# Filter for Transactions created after the specified timestamp.
sig { returns(T.nilable(String)) }
def created_gt; end
sig { params(_created_gt: T.nilable(String)).returns(T.nilable(String)) }
def created_gt=(_created_gt); end
# Filter for Transactions created at or after the specified timestamp.
sig { returns(T.nilable(String)) }
def created_gte; end
sig { params(_created_gte: T.nilable(String)).returns(T.nilable(String)) }
def created_gte=(_created_gte); end
# Filter for Transactions created before the specified timestamp.
sig { returns(T.nilable(String)) }
def created_lt; end
sig { params(_created_lt: T.nilable(String)).returns(T.nilable(String)) }
def created_lt=(_created_lt); end
# Filter for Transactions created at or before the specified timestamp.
sig { returns(T.nilable(String)) }
def created_lte; end
sig { params(_created_lte: T.nilable(String)).returns(T.nilable(String)) }
def created_lte=(_created_lte); end
# Filter for Transactions belonging to a FinancialAccount.
sig { returns(T.nilable(String)) }
def financial_account; end
sig { params(_financial_account: T.nilable(String)).returns(T.nilable(String)) }
def financial_account=(_financial_account); end
# Filter for Transactions corresponding to a Flow.
sig { returns(T.nilable(String)) }
def flow; end
sig { params(_flow: T.nilable(String)).returns(T.nilable(String)) }
def flow=(_flow); end
# The page limit.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
sig {
params(created: T.nilable(String), created_gt: T.nilable(String), created_gte: T.nilable(String), created_lt: T.nilable(String), created_lte: T.nilable(String), financial_account: T.nilable(String), flow: T.nilable(String), limit: T.nilable(Integer)).void
}
def initialize(
created: nil,
created_gt: nil,
created_gte: nil,
created_lt: nil,
created_lte: nil,
financial_account: nil,
flow: nil,
limit: nil
); end
end
class RetrieveParams < Stripe::RequestParams; end
# Returns a list of Transactions that match the provided filters.
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::TransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of a Transaction by ID.
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::TransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::Transaction)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
module MoneyManagement
class TransactionEntryService < StripeService
class ListParams < Stripe::RequestParams
# Filter for Transactions created at an exact time.
sig { returns(T.nilable(String)) }
def created; end
sig { params(_created: T.nilable(String)).returns(T.nilable(String)) }
def created=(_created); end
# Filter for Transactions created after the specified timestamp.
sig { returns(T.nilable(String)) }
def created_gt; end
sig { params(_created_gt: T.nilable(String)).returns(T.nilable(String)) }
def created_gt=(_created_gt); end
# Filter for Transactions created at or after the specified timestamp.
sig { returns(T.nilable(String)) }
def created_gte; end
sig { params(_created_gte: T.nilable(String)).returns(T.nilable(String)) }
def created_gte=(_created_gte); end
# Filter for Transactions created before the specified timestamp.
sig { returns(T.nilable(String)) }
def created_lt; end
sig { params(_created_lt: T.nilable(String)).returns(T.nilable(String)) }
def created_lt=(_created_lt); end
# Filter for Transactions created at or before the specified timestamp.
sig { returns(T.nilable(String)) }
def created_lte; end
sig { params(_created_lte: T.nilable(String)).returns(T.nilable(String)) }
def created_lte=(_created_lte); end
# The page limit.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
# Filter for TransactionEntries belonging to a Transaction.
sig { returns(T.nilable(String)) }
def transaction; end
sig { params(_transaction: T.nilable(String)).returns(T.nilable(String)) }
def transaction=(_transaction); end
sig {
params(created: T.nilable(String), created_gt: T.nilable(String), created_gte: T.nilable(String), created_lt: T.nilable(String), created_lte: T.nilable(String), limit: T.nilable(Integer), transaction: T.nilable(String)).void
}
def initialize(
created: nil,
created_gt: nil,
created_gte: nil,
created_lt: nil,
created_lte: nil,
limit: nil,
transaction: nil
); end
end
class RetrieveParams < Stripe::RequestParams; end
# Returns a list of TransactionEntries that match the provided filters.
sig {
params(params: T.any(::Stripe::V2::MoneyManagement::TransactionEntryService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of a TransactionEntry by ID.
sig {
params(id: String, params: T.any(::Stripe::V2::MoneyManagement::TransactionEntryService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::MoneyManagement::TransactionEntry)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
class PaymentService < StripeService
attr_reader :off_session_payments
end
end
end
# typed: true
module Stripe
module V2
module Payments
class OffSessionPaymentService < StripeService
class ListParams < Stripe::RequestParams
# The page size limit. If not provided, the default is 20.
sig { returns(T.nilable(Integer)) }
def limit; end
sig { params(_limit: T.nilable(Integer)).returns(T.nilable(Integer)) }
def limit=(_limit); end
sig { params(limit: T.nilable(Integer)).void }
def initialize(limit: nil); end
end
class CreateParams < Stripe::RequestParams
class RetryDetails < Stripe::RequestParams
# Indicates the strategy for how you want Stripe to retry the payment.
sig { returns(String) }
def retry_strategy; end
sig { params(_retry_strategy: String).returns(String) }
def retry_strategy=(_retry_strategy); end
sig { params(retry_strategy: String).void }
def initialize(retry_strategy: nil); end
end
class TransferData < Stripe::RequestParams
# The amount transferred to the destination account. This transfer will occur
# automatically after the payment succeeds. If no amount is specified, by default
# the entire payment amount is transferred to the destination account. The amount
# must be less than or equal to the
# [amount_requested](https://docs.corp.stripe.com/api/v2/off-session-payments/object?api-version=2025-05-28.preview#v2_off_session_payment_object-amount_requested),
# and must be a positive integer representing how much to transfer in the smallest
# currency unit (e.g., 100 cents to charge $1.00).
sig { returns(T.nilable(Integer)) }
def amount; end
sig { params(_amount: T.nilable(Integer)).returns(T.nilable(Integer)) }
def amount=(_amount); end
# The account (if any) that the payment is attributed to for tax reporting, and
# where funds from the payment are transferred to after payment success.
sig { returns(String) }
def destination; end
sig { params(_destination: String).returns(String) }
def destination=(_destination); end
sig { params(amount: T.nilable(Integer), destination: String).void }
def initialize(amount: nil, destination: nil); end
end
# The “presentment amount” to be collected from the customer.
sig { returns(Stripe::V2::Amount) }
def amount; end
sig { params(_amount: Stripe::V2::Amount).returns(Stripe::V2::Amount) }
def amount=(_amount); end
# The frequency of the underlying payment.
sig { returns(String) }
def cadence; end
sig { params(_cadence: String).returns(String) }
def cadence=(_cadence); end
# ID of the Customer to which this OffSessionPayment belongs.
sig { returns(String) }
def customer; end
sig { params(_customer: String).returns(String) }
def customer=(_customer); end
# Set of [key-value pairs](https://docs.corp.stripe.com/api/metadata) that you can
# attach to an object. This can be useful for storing additional information about
# the object in a structured format. Learn more about
# [storing information in metadata](https://docs.corp.stripe.com/payments/payment-intents#storing-information-in-metadata).
sig { returns(T::Hash[String, String]) }
def metadata; end
sig { params(_metadata: T::Hash[String, String]).returns(T::Hash[String, String]) }
def metadata=(_metadata); end
# The account (if any) for which the funds of the OffSessionPayment are intended.
sig { returns(T.nilable(String)) }
def on_behalf_of; end
sig { params(_on_behalf_of: T.nilable(String)).returns(T.nilable(String)) }
def on_behalf_of=(_on_behalf_of); end
# ID of the payment method used in this OffSessionPayment.
sig { returns(String) }
def payment_method; end
sig { params(_payment_method: String).returns(String) }
def payment_method=(_payment_method); end
# Details about the OffSessionPayment retries.
sig {
returns(T.nilable(::Stripe::V2::Payments::OffSessionPaymentService::CreateParams::RetryDetails))
}
def retry_details; end
sig {
params(_retry_details: T.nilable(::Stripe::V2::Payments::OffSessionPaymentService::CreateParams::RetryDetails)).returns(T.nilable(::Stripe::V2::Payments::OffSessionPaymentService::CreateParams::RetryDetails))
}
def retry_details=(_retry_details); end
# Text that appears on the customer’s statement as the statement descriptor for a
# non-card charge. This value overrides the account’s default statement descriptor.
# For information about requirements, including the 22-character limit, see the
# [Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
# Provides information about a card charge. Concatenated to the account’s
# [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
# to form the complete statement descriptor that appears on the customer’s statement.
sig { returns(T.nilable(String)) }
def statement_descriptor_suffix; end
sig { params(_statement_descriptor_suffix: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor_suffix=(_statement_descriptor_suffix); end
# Test clock that can be used to advance the retry attempts in a sandbox.
sig { returns(T.nilable(String)) }
def test_clock; end
sig { params(_test_clock: T.nilable(String)).returns(T.nilable(String)) }
def test_clock=(_test_clock); end
# The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for [connected accounts](https://docs.corp.stripe.com/payments/connected-accounts).
sig {
returns(T.nilable(::Stripe::V2::Payments::OffSessionPaymentService::CreateParams::TransferData))
}
def transfer_data; end
sig {
params(_transfer_data: T.nilable(::Stripe::V2::Payments::OffSessionPaymentService::CreateParams::TransferData)).returns(T.nilable(::Stripe::V2::Payments::OffSessionPaymentService::CreateParams::TransferData))
}
def transfer_data=(_transfer_data); end
sig {
params(amount: Stripe::V2::Amount, cadence: String, customer: String, metadata: T::Hash[String, String], on_behalf_of: T.nilable(String), payment_method: String, retry_details: T.nilable(::Stripe::V2::Payments::OffSessionPaymentService::CreateParams::RetryDetails), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), test_clock: T.nilable(String), transfer_data: T.nilable(::Stripe::V2::Payments::OffSessionPaymentService::CreateParams::TransferData)).void
}
def initialize(
amount: nil,
cadence: nil,
customer: nil,
metadata: nil,
on_behalf_of: nil,
payment_method: nil,
retry_details: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
test_clock: nil,
transfer_data: nil
); end
end
class RetrieveParams < Stripe::RequestParams; end
class CancelParams < Stripe::RequestParams; end
# Cancel an OffSessionPayment that has previously been created.
sig {
params(id: String, params: T.any(::Stripe::V2::Payments::OffSessionPaymentService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Payments::OffSessionPayment)
}
def cancel(id, params = {}, opts = {}); end
# Creates an OffSessionPayment object.
sig {
params(params: T.any(::Stripe::V2::Payments::OffSessionPaymentService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Payments::OffSessionPayment)
}
def create(params = {}, opts = {}); end
# Returns a list of OffSessionPayments matching a filter.
sig {
params(params: T.any(::Stripe::V2::Payments::OffSessionPaymentService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject)
}
def list(params = {}, opts = {}); end
# Retrieves the details of an OffSessionPayment that has previously been created.
sig {
params(id: String, params: T.any(::Stripe::V2::Payments::OffSessionPaymentService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Payments::OffSessionPayment)
}
def retrieve(id, params = {}, opts = {}); end
end
end
end
end
# typed: true
module Stripe
module V2
class TestHelperService < StripeService
attr_reader :financial_addresses
end
end
end
# typed: true
module Stripe
module V2
module TestHelpers
class FinancialAddressService < StripeService
class CreditParams < Stripe::RequestParams
# Object containing the amount value and currency to credit.
sig { returns(Stripe::V2::Amount) }
def amount; end
sig { params(_amount: Stripe::V2::Amount).returns(Stripe::V2::Amount) }
def amount=(_amount); end
# Open Enum. The network to use in simulating the funds flow. This will be the reflected in the resulting ReceivedCredit.
sig { returns(String) }
def network; end
sig { params(_network: String).returns(String) }
def network=(_network); end
# String explaining funds flow. Use this field to populate the statement descriptor of the ReceivedCredit created as an eventual result of this simulation.
sig { returns(T.nilable(String)) }
def statement_descriptor; end
sig { params(_statement_descriptor: T.nilable(String)).returns(T.nilable(String)) }
def statement_descriptor=(_statement_descriptor); end
sig {
params(amount: Stripe::V2::Amount, network: String, statement_descriptor: T.nilable(String)).void
}
def initialize(amount: nil, network: nil, statement_descriptor: nil); end
end
class GenerateMicrodepositsParams < Stripe::RequestParams; end
# Simulate crediting a FinancialAddress in a Sandbox environment. This can be used to add virtual funds and increase your balance for testing.
#
# ** raises FeatureNotEnabledError
sig {
params(id: String, params: T.any(::Stripe::V2::TestHelpers::FinancialAddressService::CreditParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::FinancialAddressCreditSimulation)
}
def credit(id, params = {}, opts = {}); end
# Generates microdeposits for a FinancialAddress in a Sandbox environment.
#
# ** raises FeatureNotEnabledError
sig {
params(id: String, params: T.any(::Stripe::V2::TestHelpers::FinancialAddressService::GenerateMicrodepositsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::FinancialAddressGeneratedMicrodeposits)
}
def generate_microdeposits(id, params = {}, opts = {}); end
end
end
end
end